Developer Documentation
Platform Overview
Authentication
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Listing Updates IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: FloPlans Listings: Historical Listings: History Listings: Hot Sheet Parameters Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics Messages News Feed News Feed: Curation News Feed: Events News Feed: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Portals Portal Groups Portal Groups: Current Portal Groups: Tags Portals: Listing Categories Portals: Metadata Preferences Properties Properties: Clusters Properties Meta: Standard Fields Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
API Explorer
Supporting Documentation
Examples
RESO Web API
RETS
Terms of Use

Listings: Units

 
  1. Supported Roles
  2. Available Services
    1. Units
    2. Unlabeled Units
    3. Individual Unit
    4. Individual Unlabeled Unit
  3. Listing Units Description
  4. Expansions
  5. API Explorer
 

Supported Roles

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

More information about roles may be found here.

 

Available Services

Units

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

HTTP Method Description Conditional Notes
GET Returns units for a listing with human readable labels No
POST Creates a unit record. Note that the actual attributes, not the labels, must be used. No
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:

 

GET Response

{
        "Success": true,
        "Results": [{
                "Id": "20110525151622697369000000",
                "ResourceUri": "/v1/listings/20101014195350951959000000/units/20110525151622697369000000",
                "Fields": [{
                                "Unit Number": "1A"
                        },
                        {
                                "Unit Sqft": "1200"
                        },
                        {
                                "Bedrooms": "2"
                        },
                        {
                                "Bathrooms": "2"
                        },
                        {
                                "Furnished": "Y"
                        },
                        {
                                "Stories": "2"
                        }
                ]
        }]

}
 

POST Request

Request body:

{
   "D":{
        "Fields": {
          "UnitNumber": "1A",
          "UnitSqft": "1200",
          "Bedroom": "2",
          "Bathroom": "2",
          "Furnished": "Y",
          "Stories": "2"
        }
   }
}
 

POST Response

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

 
 

Unlabeled Units

/<API Version>/listings/<Listing.Id>/units/raw
/<API Version>/listings/incomplete/<IncompleteListing.Id>/units/raw

HTTP Method Description Conditional Notes
GET Returns units for a listing 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:

 

GET Response

{
        "Success": true,
        "Results": [{
                "Id": "20110525151622697369000000",
                "ResourceUri": "/v1/listings/20101014195350951959000000/units/20110525151622697369000000",
                "Fields": [
                    {
                            "UnitNumber": "1A"
                    },
                    {
                            "UnitSqft": "1200"
                    },
                    {
                            "Bedroom": "2"
                    },
                    {
                            "Bathroom": "2"
                    },
                    {
                            "Furnished": "Y"
                    },
                    {
                            "Stories": "2"
                    }
                ]

}
 
 

Individual Unit

/<API Version>/listings/<Listing.Id>/units/<Unit.Id>
/<API Version>/listings/incomplete/<IncompleteListing.Id>/units/<Unit.Id>

HTTP Method Description Conditional Notes
GET Returns a specified unit record No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Updates a unit record. As with creation, the actual attributes, not the labels, must be used. No
DELETE Deletes a unit record No

GET Request

Parameters:

 

GET Response

See the GET request section for for the Units serivice.

PUT Request

Request body:

{
   "D":{
        "Fields": {
          "UnitNumber": "1A",
          "UnitSqft": "1200",
          "Bedroom": "2",
          "Bathroom": "2",
          "Furnished": "Y",
          "Stories": "2"
        }
   }
}
 

PUT Response

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

 

DELETE Request

Parameters:

 

DELETE Response

The standard success/fail response is returned.

 
 

Individual Unlabeled Unit

/<API Version>/listings/<Listing.Id>/units/raw/<Unit.Id>
/<API Version>/listings/incomplete/<IncompleteListing.Id>/units/raw/<Unit.Id>

HTTP Method Description Conditional Notes
GET Returns a specified unit record 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:

 

GET Response

See the GET request section for for the Unlabeled Units serivice.

 

Listings: Units Description

Attribute Data Type Writeable Required Description
Id Character No No The unique id for the unit record.
ResourceUri Character No No The URI to the particular unit record.
Fields Array of JSON Objects Yes Yes A list of key/value pairs for the units data. Available fields are listed in the Units Meta service.
 

Expansions

None.

 

API Explorer

The API Explorer does not currently support this service.