Listings: Incomplete

Incomplete listings are drafts of listings not yet entered into the system.

  1. Supported Roles
  2. Available Services
    1. All Incomplete Listings
    2. Individual Incomplete Listing
  3. All Incomplete Listings Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads Writes Notes
IDX No No
Public No No
VOW No No
Portal No No
Private Yes Yes Privileged roles only for writes. Contact support to request this capability.
More information about roles may be found here.

Available Services

All Incomplete Listings

/<API Version>/listings/incomplete

HTTP Method Description Conditional Notes
GET Returns an abridged view of all incomplete listing records viewable by the current user. No
POST Creates a new incomplete listing record. No The Errors response attribute may be present even on successes, as many listing rule violations are considered as warnings for this service.
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:
Parameter Required Notes
Pagination No

GET Response

{
    "D": {
        "Success": true,
        "Results": [{
            "ResourceUri": "/vX/listings/incomplete/20060412165917817933000000",
            "Id": "20060412165917817933000000",
            "StandardFields": {
                "UnparsedAddress": "848 Sesame Street, West Fargo, ND 58078",
                "UnparsedFirstLineAddress": "848 Sesame Street",
                "ListingKey": "20060412165917817933000000",
                "ListPrice": 1079900,
                "ListAgentId": "Joe",
                "ListAgentMiddleName": "",
                "ListAgentLastName": "Agent",
                "ListAgentPreferredPhone": "123-456-7890",
                "ListAgentPreferredPhoneExt": "3",
                "ListAgentOfficePhone": "123-456-7890",
                "ListAgentOfficePhoneExt": "123-456-7890",
                "ListAgentCellPhone": "123-456-7890",
                "ListAgentDirectPhone": "123-456-7890",
                "ListAgentTollFreePhone": "123-456-7890",
                "ListAgentFax": "123-456-7890",
                "ListAgentPager": "123-456-7890",
                "ListAgentVoiceMail": "123-456-7890",
                "ListAgentVoiceMailExt": "123-456-7890",
                "ListAgentEmail": "joe@joeagent.com",
                "ListAgentURL": "http://joeagent.com/",
                "ListAgentStateLicense": "12345",
                "ListAgentDesignation": "CRS, GRI",
                "ListOfficeName": "BigBrokerCo",
                "ListOfficePhone": "987-654-3210",
                "ListOfficePhoneExt": "33",
                "ListOfficeFax": "987-654-3210",
                "ListOfficeEmail": "big@brokerco.com",
                "ListOfficeURL": "http://bigbrokerco.com",
                "CoListAgentFirstName": "Jimmy",
                "CoListAgentMiddleName": "",
                "CoListAgentLastName": "Agent",
                "CoListAgentPreferredPhone": "323-456-7890",
                "CoListAgentPreferredPhoneExt": "3",
                "CoListAgentOfficePhone": "123-456-7890",
                "CoListAgentOfficePhoneExt": "123-456-7890",
                "CoListAgentCellPhone": "123-456-7890",
                "CoListAgentDirectPhone": "123-456-7890",
                "CoListAgentTollFreePhone": "123-456-7890",
                "CoListAgentFax": "123-456-7890",
                "CoListAgentPager": "123-456-7890",
                "CoListAgentVoiceMail": "123-456-7890",
                "CoListAgentVoiceMailExt": "123-456-7890",
                "CoListAgentEmail": "jimmy@jimmyagent.com",
                "CoListAgentURL": "http://jimmyagent.com/",
                "CoListAgentStateLicense": "22345",
                "CoListAgentDesignation": "CRS, GRI",
                "CoListOfficeName": "BigBrokerCo",
                "CoListOfficePhone": "987-654-3210",
                "CoListOfficePhoneExt": "33",
                "CoListOfficeFax": "987-654-3210",
                "CoListOfficeEmail": "big@brokerco.com",
                "CoListOfficeURL": "http://bigbrokerco.com"
            }
        }]
    }
}

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,
      "ListingAgentId": "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.

Individual Incomplete Listing

/<API Version>/listings/incomplete/<Listing.Id>

HTTP Method Description Conditional Notes
GET Returns full StandardFields data for the incomplete listing with the specified Id No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Updates an incomplete listing record. No The Errors response attribute may be present even on successes, as many listing rule violations are considered as warnings for this service.
DELETE Deletes an incomplete listing No

GET Request

Parameters:
Parameter Required Notes
Standard expansion parameters No

GET Response

See the GET request section for for the Listings service.

PUT Request

Request body:
{
   "D":{
      "PostalCode": "58103",
      "YearBuilt": 1884
   }
}

PUT Response

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

DELETE Request

Parameters:
  • None

DELETE Response

The standard success/fail response is returned.

Incomplete Listing Description

Below are details on the fields present in the abridged payload for the All Incomplete Listings service.

Otherwise, like the listings service, editability, visibility, searchability and list item labels for standard fields will vary among users. Because of this, the settings for standard listing fields are discoverable using the Standard Fields service. Detailed below are attributes and expansions that are not documented in other services.

Attribute Data Type Description
Id Character The unique id for the record.
StandardFields JSON Object Incomplete listings only return a subset of the standard field listing data.
ListingKey Character Mirrors Listing.Id.
UnparsedFirstLineAddress Character The first line of the street address for the listing.
UnparsedAddress Character The street address for the listing.
ListPrice Decimal The listing price.
ListAgentId Character The Id of the listing agent.
ListAgent* Varies All listing agent profile data present in a normal listings response is also present in the incomplete listing response. See the Standard Fields service for more details.

Expansions

Expansion Roles Single Record Only? Selection Support? Description
CustomFields All Yes No Custom fields are unstandardized listing data. As such, they will not be consistent among different MLSs. They are also not guaranteed to be static, so avoid writing software whose functionality depends on a particular custom field.

Cannot be used in conjunction with any other custom fields expansion. This expansions applies the MLS-defined human-readable labels to all custom fields and values, and thus cannot be used with the custom fields meta data.
CustomFieldsRaw All Yes No Nearly identical to the CustomFields expansions, with the exception that human-friendly labels are not applied to fields an values. Use this expansion in conjunction with the custom fields meta data.
Videos All Yes No Videos for the listing.
VirtualTours All Yes No Virtual tours for the listing.

API Explorer

The API Explorer does not currently support this service.