Listings: Units
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:
- None
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:
- None
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:
- None
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:
- None
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:
- None
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.