Listings: Validation

This service validates a listing creation or update payload against listing rules defined for the listing's property type.

Supported Roles
Available Services
1. Listing Creation Validation
2. Listing Update Validation
Listing History Description
Expansions

Supported Roles

Role	Reads	Writes
IDX	No	No
Public	No	No
VOW	No	No
Portal	No	No
Private	No	Yes

More information about roles may be found here.

Available Services

Listing Creation Validation

`/<API Version>/listings/validation`

HTTP Method	Description	Conditional	Notes
GET	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
POST	Validates a listing creation payload. No data is persisted.	No
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

POST Request

Request body:

{
   "D": {
      "PropertyType": "A",
      "PropertySubType": "SF",
      "ListPrice": 1079900,
      "StreetNumber": "611",
      "StreetDirPrefix": null,
      "StreetName": "8th",
      "StreetSuffix": "St",
      "StreetDirSuffix": "S",
      "StreetAdditionalInfo": null,
      "City": "Fargo",
      "StateOrProvince": "ND",
      "PostalCode": "58103",
      "YearBuilt": 1884,
      "BuildingAreaTotal": 7275,
      "BathsThreeQuarter": 1,
      "BathsTotal": 8,
      "BathsFull": 5,
      "BedsTotal": 8,
      "BathsHalf": 2,
      "Longitude": -96.792246,
      "Latitude": 46.868464,
      "SubdivisionName": "Westgate",
      "MLSAreaMinor": "West",
      "CountyOrParish": null,
      "ListAgentId": "20080917142739989238000000",
      "CustomFields": {
        "Contract Information": {
          "Book Section": "Residential w/ Acreage",
          "Area": "North (Bonner & Boundary)"
        }
      }
   }
}

POST Response

The standard success/fail response with additional error information is returned.

Listing Update Validation

`/<API Version>/listings/<Listing.Id>/validation`

HTTP Method	Description	Conditional	Notes
GET	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Validates a listing update payload. No data is persisted.	No
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

PUT Request

Request body:

{
   "D": {
      "ListPrice": 1080000
   }
}

PUT Response

The standard success/fail response with additional error information is returned.

Listings: Validation Description

Available standard and custom fields will vary among users. Standard listing fields are discoverable using the Standard Fields service, and custom listing fields are advertised using the Custom Fields service.

Attribute	Data Type	Description
`StandardFields`	Character	All top-level attributes not otherwise documented here are standard listing fields.
`CustomFields`	Character	All custom listing fields must be provided as a hash of groups and their fields under the `CustomFields` attribute. Since these are not written to listings in order, these should not be presented in arrays as is returned by the listings service.

Expansions

None.