Listings: Rental Calendar
Listings of a Rental property type will often have Rental Calendar data associated with it.
This data informs when the listing will be unavailable for rental, and is particularly useful for seasonal rental
properties.
Consult the Property Types service to see which property types support this service.
Supported Roles
| Role | Reads | Writes | Notes |
|---|---|---|---|
| IDX | Yes | No | |
| Public | Yes | No | |
| VOW | Yes | No | |
| Portal | Yes | No | |
| Private | Yes | No |
More information about roles may be found here.
Available Services
Rental Calendar
/<API Version>/listings/<Listing.Id>/rentalcalendar
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns dates the listing is unavailable for rental. If no _filter parameter is supplied, all upcoming occupied dates are returned. |
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 search and paging syntax | No |
GET Response
{
"D": {
"Results": [{
"Id": "20110003930012897000000000",
"Type": "Rented", // Or "Unavailable"
"StartDate": "2011-03-14",
"EndDate": "2011-03-15"
}],
"Success": true
}
}
Rental Calendar Description
| Attribute | Data Type | Searchable | Description |
|---|---|---|---|
Id |
Character | No | The unique id for the record. |
Type |
Character | Yes | The type of rental event. Can be either Rented or Unavailable. |
StartDate |
Date | Yes | The first date that the property will be unavailable for rental. |
EndDate |
Date | Yes | The final date that the property will be unavailable for rental. |
Expansions
None.