Skip to content
This repository has been archived by the owner on Apr 28, 2022. It is now read-only.

Working with ShelterZoom Database

Jump to bottom
NKoot edited this page Mar 22, 2018 · 14 revisions

Url for request: ‘https://us-central1-shelterzoom.cloudfunctions.net/api’

Authorization: Bearer authorization via header with special token (see "Getting API Key section": "a10dd8d6-5cfd-47fa-83fd-00b1d2a34123")

Content-Type: application/x-www-form-urlencoded or application/json

Endpoint: ‘property’

Create property

Request type: POST

Body:

{
SourceSystemID : ‘Source system ID, required’,
PropertyUniversalID : ‘Global property id, required’,
UnparsedAddress : ‘Property unparsed address, required’,
InternetAddressDisplayYN : ‘Boolean flag’
Country : ‘Country name’,
City : ‘City name’,
PostalCode : ‘Property postal code’,
StateOrProvince : ‘Postal abbreviation for the state or province’,
StreetName : ‘Street name’,
StreetNumber : ‘Street number (string)’,
StreetNumberNumeric : ‘Street number (numeric)’,
StreetSuffix : ‘Street suffix’,
StreetSuffixModifier : ‘Unique street suffix’,
StreetDirPrefix : ‘The direction indicator’,
StreetDirSuffix : ‘The direction indicator’,
StreetAdditionalInfo : ‘’,
PropertyPhoto : ‘Link to property photo’,
ListAgentKey : ‘Listing agent unique key’,
ListAgentFullName : ‘The full name of the listing agent’,
ListAgentMobilePhone : ‘North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens). Other conventions should use the common local standard. International numbers should be preceded by a plus symbol.’,
ListAgentEmail : ‘Listing agent email’,
CoListAgentKey : ‘Co-listing agent unique key’,
CoListAgentFullName : ‘The full name of the co-listing agent’,
CoListAgentMobilePhone : ‘North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens). Other conventions should use the common local standard. International numbers should be preceded by a plus symbol.’,
CoListAgentEmail : ‘Co-listing agent email’,
ListAgentMlsId : ‘The local, well-known identifier for the member. This value may not be unique, specifically in the case of aggregation systems, this value should be the identifier from the original system.’,
ListOfficeKey : ‘Listing office unique key’,
ListOfficeAOR : ‘The Office's Board or Association of REALTORS’,
ListOfficeAORkey : ‘A system unique identifier. Specifically, in aggregation systems, the OfficeAORkey is the system unique identifier from the system that the record was retrieved. This may be identical to the related xxxId. This is a foreign key relating to the AOR's member management system in which the record was originated”,
ListOfficeName : ‘The name of the listing office’,
ListOfficeMlsId : ‘The local, well-known identifier. This value may not be unique, specifically in the case of aggregation systems, this value should be the identifier from the original system.’,
ListOfficePhone : ‘North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens). Other conventions should use the common local standard. International numbers should be preceded by a plus symbol.’,
ListOfficeEmail : ‘The email address of the Listing Office’,
ListOfficeCity : ‘The city of the listing office’,
ListOfficePostalCode : ‘The postal code of the office’,
ListOfficeStateOrProvince : ‘The state or province in which the office is located’,
ListOfficeAddress1 : ‘The street number, direction, name and suffix of the listing office’,
ListOfficeAddress2 : ‘The unit/suite number of the office’,
ListOfficeBrokerKey : ‘The MemberKey of the responsible/owning broker. This is a foreign key relating to the Member resource's MemberKey.’,
ListBrokerFullName : ‘The full name of the listing broker’,
ListBrokerMobilePhone : ‘North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens). Other conventions should use the common local standard. International numbers should be preceded by a plus symbol.’,
ListBrokerEmail : ‘Listing broker email’,
OwnerName : ‘Name of the owner of the property being sold.’,
OwnerAddress : ‘Address of the owner of the property being sold.’,
OwnerPhone : ‘Mobile phone of the owner of the property being sold.’,
OwnerEmail : ‘Email of the owner of the property being sold.’,
BuyerOfficeKey : ‘A system unique identifier. Specifically, in aggregation systems, the Key is the system unique identifier from the system that the record was just retrieved. This may be identical to the related xxxId identifier, but the key is guaranteed unique for this record set. This is a foreign key relating to the Office resource's OfficeKey.’,
BuyerOfficeAOR : ‘The Buyer's Office's Board or Association of REALTORS.’,
BuyerOfficeAORkey : ‘A system unique identifier. Specifically, in aggregation systems, the OfficeAORkey is the system unique identifier from the system that the record was retrieved. This may be identical to the related xxxId. This is a foreign key relating to the AOR's member management system in which the record was originated.’,
BuyerOfficeName : ‘The legal name of the brokerage representing the buyer.’,
BuyerOfficeMlsId : ‘The local, well-known identifier. This value may not be unique, specifically in the case of aggregation systems, this value should be the identifier from the original system.’,
BuyerOfficePhone : ‘North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens). Other conventions should use the common local standard. International numbers should be preceded by a plus symbol.’,
BuyerOfficeEmail : ‘The email address of the Buyer's Office.’,
BuyerOfficeCity : ‘The city of the office.’,
BuyerOfficePostalCode : ‘The postal code of the office.’,
BuyerOfficeStateOrProvince : ‘The state or province in which the office is located.’,
BuyerOfficeAddress1 : ‘The street number, direction, name and suffix of the office.’,
BuyerOfficeAddress2 : ‘The unit/suite number of the office.’,
BuyerAgentKey : ‘Listing agent unique key’,
BuyerAgentFullName : ‘The full name of the buyer's agent. (First Middle Last)’,
BuyerAgentMlsId : ‘The local, well-known identifier. This value may not be unique, specifically in the case of aggregation systems, this value should be the identifier from the original system.’,
BuyerAgentMobilePhone : ‘North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens). Other conventions should use the common local standard. International numbers should be preceded by a plus symbol.’,
BuyerAgentEmail : ‘The email address of the Buyer's Agent.’,
ListingId : ‘MLS Number, Listing Number’
}

  • Success Response:

    • Code: 200
      Content: {status : "Property successfully added"}

  • Error Response:

    • Code: 500
      Content: { error : "description" }

Update property

Request type: PUT

Body: Same as when creating property

Response:

  • Success Response:

    • Code: 200
      Content: {status : "Property successfully updated"}

  • Error Response:

    • Code: 500
      Content: { error : "description" }

Create or update properties

Endpoint: ‘properties’

Request type: POST

Body:

{
SourceSystemID : ‘Source system ID’, required,
properties : ‘Non empty array, which contains property’, required,
}

Property :

{
PropertyUniversalID : ‘Global property id’, required,
UnparsedAddress : ‘Property unparsed address’, required,
…
//Other fields are optional. Full list of supported fields defined at Create property section
}

Response:

  • Success Response:

    • Code: 200
      Content: {created: [‘id1’, ‘id2’, ...], updated : [‘id3’, ‘id4’, ...], errors : [{PropertyUniversalID : ‘id5, error : ‘Error description’’}, ...]}

  • Error Response:

    • Code: 500
      Content: { error : "description" }

Get property

Request type: GET

Body:

{
SourceSystemID : ‘Source system ID, required’,
PropertyUniversalID : ‘Global property id, required’,
}

Response:

  • Code: 200
    Content: {status : "Property object"}

  • Error Response:

    • Code: 500
      Content: { error : "description" }

Delete property

Request type: DELETE

Body:

{
SourceSystemID : ‘Source system ID, required’,
PropertyUniversalID : ‘Global property id, required’,
}

Response:

  • Code: 200
    Content: {status : "Property successfully removed"}

  • Error Response:

    • Code: 500
      Content: { error : "description" }
Clone this wiki locally