Friday, November 10, 2017

OMS API update version 1.7 - inactive properties

An update has been made for the OMS API, version 1.7.
It is documented in our OMS API documentation.



Retrieve inactive properties
You can now retrieve properties made inactive for the last 3 months using the following call:
https://omsflow.docs.apiary.io/#reference/property/inactive-properties-collection


Retrieve all property addresses
Under permission https://omsflow.docs.apiary.io/#introduction/authentication we've added a new module 5 "Access all property addresses". This can be enabled in the OMS to provide your developer with access to all property address info (unit number, complex name, street number and street name) for the property details (https://omsflow.docs.apiary.io/#reference/property/property-details/view-property?console=1) irrespective of whether you've checked the 'make map location' checkbox in the OMS for a listing. We've also included a new field 'location_makepublic' to indicate whether the agent has given permission to make the address public.

When module 5 access is included for developer OMS API key, the data can look as follows:

 "location_makepublic": 0,
 "location_streetNumber": "23",
 "location_streetName": "Main road",
 "location_unitNumber": "88",
 "location_complexName": "Petervale Boulevard",

Note although the agent has not selected the 'make map location available' in the OMS (location_makepublic = 0) it will still retrieve the address details through the module 5 access. It should therefor be used with consideration and only for internal system integrations. 
To add module 5 access for an OMS API key, simply create a new key and revoke (delete) the previous key.


The OMS API can be used to extract data from the OMS to external systems. It is included free of charge to all clients. Clients can generate their own API keys for web developers. 

2 comments:

  1. WHere can one do this? "To add module 5 access for an OMS API key, simply create a new key and revoke (delete) the previous key"

    ReplyDelete
    Replies
    1. herewith instructions http://productblog.entegral.net/2017/07/generate-your-own-oms-api-keys-for.html - under settings/office/api keys - also welcome to email our support team at support@entegral.net to assist.

      Delete