Listings: Incomplete

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

Supported Roles
Available Services
All Incomplete Listings Description
Expansions

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 set of `StandardFields` for all incomplete listing records viewable by the current user.	No	The fields in this view include the following fields: `UnparsedAddress` `UnparsedFirstLineAddress` `ListingKey` `ListAgentId` `ListPrice` `ListAgent*` fields `MlsId` `ModificationTimestamp`
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": "20080917142739989238000000",
                "ListAgentFirstName": "Joe",
                "ListAgentMiddleName": "J.",
                "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",
                "MlsId": "20000426143505724628000000",
                "ModificationTimestamp": "2013-10-12T10:19:34Z"
            }
        }]
    }
}

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.

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.

Nearby Incomplete Listings

`/<API Version>/listings/incomplete/nearby`

Sorts incomplete listings results by proximity to the provided _lat and _lon values, nearest first.

HTTP Method	Description	Conditional	Notes
GET	Retrieve incomplete listings near a specified point.	No
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
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
Standard proximity parameters	Yes
Pagination	No

GET Response

See the GET request section for for the incomplete listings service.

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	Searchable	Description
`Location`	Character	Yes	(Searching only) Incomplete listings can be filtered by `Location`.
`StreetAddress`	Character	Yes	(Searching only) Incomplete listings can be filtered by `StreetAddress`.
`Id`	Character	Yes	The unique id for the record.
`StandardFields`	JSON Object	No	Incomplete listings only return a subset of the standard field listing data.
`ListingKey`	Character	Yes	Mirrors `Listing.Id`.
`UnparsedFirstLineAddress`	Character	No	The first line of the street address for the listing.
`UnparsedAddress`	Character	No	The street address for the listing.
`ListPrice`	Decimal	No	The listing price.
`ListAgentId`	Character	No	The Id of the listing agent.
`ListAgent*`	Varies	No	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.
`MlsId`	Character	No	The Id of the MLS the listing belongs to.
`ModificationTimestamp`	DateTime	No	The time the incomplete listing was last modified.
`Permissions`	Expansion		The Permissions expansion details if and how the current user can modify the listing. See the Permissions expansion for more details. `"Permissions": { "Editable": true, "EditableSettings": { "Photos": true, "Documents": true, "Videos": true, "VirtualTours": true, "PriceChange": true, "StatusChange": true, "BrokerTours": true, "OpenHouses": true, "TourOfHomes": true, "AddListing": true, "ChangeListing": true }, "AvailableStandardStatusChanges": [ "Active", "Pending", "Closed" ] }`

Expansions

Expansion	Roles	Single Record Only?	Selection Support?	Description
`BrokerDistributionExclusions`	Private	Yes	No	The distributions which this listing should be excluded from. Use this expansion in conjunction with the broker distribution meta data.
`CustomFields`	All	No	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	No	No	Nearly identical to the `CustomFields` expansions, with the exception that human-friendly labels are not applied to fields and values. Use this expansion in conjunction with the custom fields meta data.
`FloPlans`	All	Yes	No	The FloPlans attached to the listing.
`Permissions`	Private	Yes	No	Details if the current user can edit the listing as well as what actions can be performed on the current listing. See more info in the Response Description.
`Rooms`	All	Yes	Yes	Room data for the listing.
`RoomsRaw`	All	Yes	Yes	Nearly identical to the `Rooms` expansions, with the exception that human-friendly labels are not applied to fields and values. Use this expansion in conjunction with the rooms meta data.
`Units`	All	Yes	Yes	A list of units associated with the listing.
`UnitsRaw`	All	Yes	Yes	Nearly identical to the `Units` expansions, with the exception that human-friendly labels are not applied to fields and values. Use this expansion in conjunction with the units meta data.
`Videos`	All	Yes	No	Videos for the listing.
`VirtualTours`	All	Yes	No	Virtual tours for the listing.