Index | Authentication | Offices | Associates | Properties | Property Descriptions | Property Rooms | Property Images
Lookups | Geo data | Files

Lookups

General

Lookups are lists of standard values used by the API for various resource fields. If a field accepts a lookup value then you can only assign to that field a value that you can find it in a one of the lookup lists exposed here.

These values do not change often and we mostly add new values to the list. When we add new values we communicate this to our clients so they can take advantage of the change is applicable.

This list is to be used as programming and mapping reference.

Supported Methods

Get lookup list names

This method will return the list of available lookup list names.

Call

GET integrator/{integratorID}/lookups/names

Request

GET http://rexapi.gryphtech.com/api/v1/integrator/1005001/lookups/names HTTP/1.1
Accept: application/xml; charset=utf-8
Authorization: OAUTH oauth_token="pfl4PLrrHKChIRoDS2O9Wfoyr1yjKgbEjCxk+a", api_key="10D35802-C92A-42B3-88FC-A4489A3CD619"

Response XML

HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8

<RexApiList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <HasNextPage>false</HasNextPage>
  <HasPreviousPage>false</HasPreviousPage>
  <PageIndex>1</PageIndex>
  <PageSize>35</PageSize>
  <TotalCount>35</TotalCount>
  <TotalPageCount>1</TotalPageCount>
  <Items>
    <Lookup>
      <Name>Associate_Activity</Name>
    </Lookup>
    <Lookup>
      <Name>Associate_ClientPreferences</Name>
    </Lookup>
    .....
  </Items>
</RexApiList>

Response JSON

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
 "HasNextPage": false,
 "HasPreviousPage": false,
 "PageIndex": 1,
 "PageSize": 35,
 "TotalCount": 35,
 "TotalPageCount": 1,
 "Items": [
  {
   "Name": "Associate_Activity"
  },
  {
   "Name": "Associate_ClientPreferences"
  },
  .....
 ]
}


Get lookups in JSON or XML format

This method returns all lookups or a specific lookup list.
Response is not paginated, you get all values in one call.

Call

GET integrator/{integratorID}/lookups
or
GET integrator/{integratorID}/lookups?lookupName={lookupName}

Optional parameters

lookupName
The name of a lookup list

Request

GET http://rexapi.gryphtech.com/api/v1/integrator/1005001/lookups HTTP/1.1

Authorization: OAUTH oauth_token="pfl4PLrrHKChIRoDS2O9Wfoyr1yjKgbEjCxk+a", api_key="10D35802-C92A-42B3-88FC-A4489A3CD619"
Accept: application/xml; charset=utf-8

Response XML

HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8

<RexApiList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <HasNextPage>false</HasNextPage>
  <HasPreviousPage>false</HasPreviousPage>
  <PageIndex>1</PageIndex>
  <PageSize>1434</PageSize>
  <TotalCount>1434</TotalCount>
  <TotalPageCount>1</TotalPageCount>
  <Items>
    <Lookup>
      <Name>Associate_Activity</Name>
      <UID>1611</UID>
      <Value>Auction</Value>
    </Lookup>
    <Lookup>
      <Name>Associate_Activity</Name>
      <UID>1605</UID>
      <Value>Consulting</Value>
    </Lookup>
    .....
  </Items>
</RexApiList>

Response JSON

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
 "HasNextPage": false,
 "HasPreviousPage": false,
 "PageIndex": 1,
 "PageSize": 1434,
 "TotalCount": 1434,
 "TotalPageCount": 1,
 "Items": [
  {
   "Name": "Associate_Activity",
   "Value": "Auction",
   "UID": "1611"
  },
  {
   "Name": "Associate_Activity",
   "Value": "Consulting",
   "UID": "1605"
  },
  .....
 ]
}

Get lookups in Excel format

This method returns all lookups in Excel format.

Call

POST integrator/{integratorID}/lookups/excel

Request 

POST http://rexapi.gryphtech.com/api/v1/integrator/1005001/lookups HTTP/1.1

Authorization: OAUTH oauth_token="pfl4PLrrHKChIRoDS2O9Wfoyr1yjKgbEjCxk+a", api_key="10D35802-C92A-42B3-88FC-A4489A3CD619"
Accept: application/xml; charset=utf-8

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.ms-excel
Content-Length: 38038
Content-Disposition: inline; filename=RexAPI_Lookups.xlsx