Returning Tenancies and Tenants
Question: How do we associate tenants with tenancies?
Answer: This can be achieved using the following process:
- Use one of the available Inventory endpoints to find a property or properties:
/inventory/inventory/items/inventory/{inventoryId}/inventory/filter/inventory/search
- Next, you can find Tenancies by Inventory here:
/inventory/{inventoryId}/tenancies
- Then, once you have the Tenancies, the Contacts (Tenants) are found using the call below:
/tenancies/{tenancyId}/tenantIds(You will match thesecontactIdswith the next call).
- Now, to get the contact details you will use this endpoint which will return the details for the
contactIdsprovided:/contacts
- Finally, if you match the
contactIdsfrom/contactswithcontactIdsfound in/tenancies/{tenancyId}/tenantIds, you will have your relationship.
title: Alto Phone Number Types description: A list of phone number types for contacts in Alto.
Section titled “title: Alto Phone Number Types description: A list of phone number types for contacts in Alto.”Question: For the inventory object, in the phoneNumbers array under owners, the property type looks like it might be an enum. Is this the case or can I expect a consistent set of values? I can see from the mock data that “Home” is used, but I haven’t seen other values such as “Mobile”. Can you confirm if the values are fixed and what they are please?
Answer:
- Unknown
- Home
- Business
- Mobile
- Fax
- Work