Property Descriptions

General

Property descriptions are essential in the presentation of a property. In our system you can add different type of descriptions in multiple languages.

The most used description types are ListingTitle (1113) and Web (629). See REXAPI Enumerated Values, Lookup Property_DescriptionType for more descriptions. Not all descriptioins might be available for your specific case. Please discuss with your account manager.

For a better exposure of your listing, please create ListingTitle and Web desccriptions for each property you add to our system.

The list of supported languages that you can use to save your descriptions can be found in REXAPI Enumerated Values, lookup SupportedLanguages.

Supported methods

• get list of descriptions for one property
• get description detail
• create description
• update description
• delete description
• delete all descriptions

* All listings are provided as example.They might not contain the entire list of fields. For the complete list of fields, please consult the corresponding data dictionary.

Get list of property descriptions

This method returns the list of all the descriptions for a property.
Response is not paginated, you get all values in one call.

Call

GET integrator/{integrator id}/propertydescriptions/{property id}

property id

ID or ExternalID of a property

Request

GET http://rexapi.gryphtech.com/api/v1/integrator/1005001/propertydescriptions/1005568017-155 HTTP/1.1 

Authorization: OAUTH oauth_token="pfl4PLrrHKChIRoDS2O9Wfoyr1yjKgbEjCxk+", 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>3</PageSize>
  <TotalCount>3</TotalCount>
  <TotalPageCount>1</TotalPageCount>
  <Items>
    <PropertyDescription>
      <DescriptionText>Well maintained single story home on a quiet cul-de-sac. This home offers brand new carpeting, brand new interior/exterior 
paint and wood shutters throughout! Open floor plan with a living room and an adjacent dining room.</DescriptionText> 
      <DescriptionType>629</DescriptionType> 
      <LanguageCode>ENG</LanguageCode> 
      <ModifiedDate>2014-11-28T10:27:17.497</ModifiedDate> 
    </PropertyDescription> 
    <PropertyDescription>
    .....
  </Items>
</RexApiList> 

Response JSON

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

{ 
 "HasNextPage": false,
 "HasPreviousPage": false,
 "PageIndex": 1,
 "PageSize": 3,
 "TotalCount": 3,
 "TotalPageCount": 1,
 "Items": [
  {
    "LanguageCode": "ENG", 
    "DescriptionText": "Well maintained single story home on a quiet cul-de-sac. This home offers brand new carpeting,", 
    "DescriptionType": 629, 
    "ModifiedDate": "2014-11-28T10:27:17.497" 
  },
  .....
 ]
}

Http Status Codes Responses & Messages

Get one property description

This method returns the details of one description

GET integrator/{integrator id}/propertydescriptions/{property id}/{description type}/{language code}

Required parameters:

property id

ID or ExternalID of a property

description type

The UID of the description type. See REXAPI Enumerated Values, Lookup Property_DescriptionType

language code

The language code of the description. REXAPI Enumerated Values, lookup SupportedLanguages

Request

GET http://rexapi.gryphtech.com/api/v1/integrator/1005001/propertydescriptions/1005568017-155/629/ENG HTTP/1.1 

Authorization: OAUTH oauth_token="pfl4PLrrHKChIRoDS2O9Wfoyr1yjKgbEjCxk+", 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

<PropertyDescription>
   <DescriptionText>Well maintained single story home on a quiet cul-de-sac. This home offers brand new carpeting, brand new interior/exterior 
paint and wood shutters throughout! Open floor plan with a living room and an adjacent dining room.</DescriptionText> 
   <DescriptionType>629</DescriptionType> 
   <LanguageCode>ENG</LanguageCode> 
   <ModifiedDate>2014-11-28T10:27:17.497</ModifiedDate> 
</PropertyDescription>

Response JSON

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

{ 
  "LanguageCode": "ENG", 
  "DescriptionText": "Well maintained single story home on a quiet cul-de-sac. This home offers brand new carpeting,", 
  "DescriptionType": 629, 
  "ModifiedDate": "2014-11-28T10:27:17.497" 
}

Http Status Codes Responses & Messages

Create property description

This method allows you to create a new property description.

Following values from your object model are ignored:

• PropertyID, PropertyExternalID, IntegratorID
• We get these values from the URL parameters
• ModifiedDate
• This is system generated value

Call

POST integrator/{integrator id}/propertydescriptions/{property id}

Required parameters:

property id

ID or ExternalID of a property

Request XML

In XML, elements order is important. The order is alphabetical.

POST http://rexapi.gryphtech.com/api/v1/integrator/1005001/propertydescriptions/1005568017-155 HTTP/1.1 
Accept: application/xml; charset=utf-8 
Content-Type: application/xml; charset=utf-8 
Authorization: OAUTH oauth_token="pfl4PLrrHKChIRoDS2O9Wfoyr1yjKgbEjCxk", api_key="10D35802-C92A-42B3-88FC-A4489A3CD619" 

<PropertyDescription>
   <DescriptionText>Well maintained single story home on a quiet cul-de-sac. This home offers brand new carpeting, brand new interior/exterior 
paint and wood shutters throughout! Open floor plan with a living room and an adjacent dining room.</DescriptionText> 
   <DescriptionType>629</DescriptionType> 
   <LanguageCode>ENG</LanguageCode> 
</PropertyDescription>

Response XML

HTTP/1.1 201 Created 
Content-Type: application/xml; charset=utf-8 
Location: http://rexapi.gryphtech.com/api/v1/integrator/1005001/propertydescriptions/1005568017-155/629/ENG

... created Property Description object ...

Request JSON

In JSON, element order does not matter. In our example they are ordered alphabetically just for comparation with the XML response.

POST http://rexapi.gryphtech.com/api/v1/integrator/1005001/propertydescriptions/1005568017-155 HTTP/1.1 
Accept: application/json; charset=utf-8 
Content-Type: application/json; charset=utf-8 
Authorization: OAUTH oauth_token="pfl4PLrrHKChIRoDS2O9Wfoyr1yjKgbEjCxk", api_key="10D35802-C92A-42B3-88FC-A4489A3CD619" 

{ 
  "LanguageCode": "ENG", 
  "DescriptionText": "Well maintained single story home on a quiet cul-de-sac. This home offers brand new carpeting,", 
  "DescriptionType": 629 
}

Response JSON

HTTP/1.1 201 Created 
Content-Type: application/json; charset=utf-8 
Location: http://rexapi.gryphtech.com/api/v1/integrator/1005001/propertydescriptions/1005568017-155/629/ENG

... created Property Description object ...

Http Status Codes Responses & Messages

Update property description

This method allows you to update an existing description.

Following values from your object model are ignored:

• PropertyID, PropertyExternalID, IntegratorID
• We get these values from the URL parameters
• ModifiedDate
• This is system generated value
• DescriptionType and LanguageCode
  • You cannot update these values. The resource to be updated is identified by them

Call

PUT integrator/{integrator id}/propertydescriptions/{property id}/{description type}/{language code}

Required parameters:

property id

ID or ExternalID of a property

description type

The UID of the description type. See REXAPI Enumerated Values, Lookup Property_DescriptionType

language code

The language code of the description. REXAPI Enumerated Values, lookup SupportedLanguages

Request XML

PUT http://rexapi.gryphtech.com/api/v1/integrator/1005001/propertydescriptions/1005344006-14  HTTP/1.1 
Accept: application/xml; charset=utf-8 
Content-Type: application/xml; charset=utf-8 
Authorization: OAUTH oauth_token="pfl4PLrrHKChIRoDS2O9Wfoyr1yjKgbEjCxk", api_key="10D35802-C92A-42B3-88FC-A4489A3CD619" 

<PropertyDescription>
   <DescriptionText>Well maintained single story home on a quiet cul-de-sac. This home offers brand new carpeting, brand new interior/exterior 
paint and wood shutters throughout! Open floor plan with a living room and an adjacent dining room.</DescriptionText> 
   <DescriptionType>629</DescriptionType> 
   <LanguageCode>ENG</LanguageCode> 
</PropertyDescription>

Request JSON

PUT http://rexapi.gryphtech.com/api/v1/integrator/1005001/propertydescriptions/1005344006-14 HTTP/1.1 
Accept: application/json; charset=utf-8 
Content-Type: application/json; charset=utf-8 
Authorization: OAUTH oauth_token="pfl4PLrrHKChIRoDS2O9Wfoyr1yjKgbEjCxk", api_key="10D35802-C92A-42B3-88FC-A4489A3CD619" 

{ 
  "LanguageCode": "ENG", 
  "DescriptionText": "Well maintained single story home on a quiet cul-de-sac. This home offers brand new carpeting,", 
  "DescriptionType": 629 
}

Response

If the update was successful you will get the resource object back with the updated values.
See Get Property method for XML and JSON responses.

Http Status Codes Responses & Messages

Delete property description

This method deletes a property description

Call

DELETE integrator/{integrator id}/propertydescriptions/{property id}/{description type}/{language code}

Required parameters:

property id

ID or ExternalID of a property

description type

The UID of the description type. See REXAPI Enumerated Values, Lookup Property_DescriptionType

language code

The language code of the description. REXAPI Enumerated Values, lookup SupportedLanguages

Request

DELETE http://rexapi.gryphtech.com/api/v1/integrator/1005001/propertydescriptions/1005568017-155/629/ENG HTTP/1.1 
Authorization: OAUTH oauth_token="pfl4PLrrHKChIRoDS2O9Wfoyr1yjKgbEjCxk", api_key="10D35802-C92A-42B3-88FC-A4489A3CD619" 

Response

HTTP/1.1 204 No Content

Http Status Codes Responses & Messages

Delete all descriptions

This method deletes all descriptions for a property

Call

DELETE integrator/{integrator id}/properties/{resource id}/propertydescriptions/{property id}

Required parameters:

property id

ID or ExternalID of a property

Request

DELETE http://rexapi.gryphtech.com/api/v1/integrator/1005001/propertydescriptions/1005568017-155 HTTP/1.1  HTTP/1.1 
Authorization: OAUTH oauth_token="pfl4PLrrHKChIRoDS2O9Wfoyr1yjKgbEjCxk", api_key="10D35802-C92A-42B3-88FC-A4489A3CD619" 

Response

HTTP/1.1 204 No Content

Status Codes Responses & Messages