Path and query parameters for action/resource Calendar
Path and query template for the action/resource:
/xml/{partnerCode}/{consumerId}/calendar?changeTimestamp={changeTimestamp}&includeWeeks={includeWeeks}&dateFrom={dateFrom}&dateTo={dateTo}&rentalObjectNoStart={rentalObjectNoStart}&rentalObjectNoEnd={rentalObjectNoEnd}&countryIsoCode={countryIsoCode}®ionIds={regionIds}&includeRentalAgreementInfo={includeRentalAgreementInfo}
| Name | Description |
|---|---|
| partnerCode | A path parameter containing the partner code a.k.a. the login. Example: LHUSE |
| consumerId | A path parameter always assigned the integer number 1.Example: 1 |
| changeTimestamp | Return only rental objects that are changes after the requested date or all rental objects if this criterium is null. |
| includeWeeks | If true, the Weeks field is filled out in returned result, otherwise Weeks is null. Weeks is a series of both vacant and non-vacant weeks based on the rental objects preferred arrival weekday. |
| dateFrom | A date formatted as DD-MM-YYYY. Limit the result to rental objects that can be rented on this date or later. The lower limit for this field is 36 months. Hence if this field contains a date older than 36 months, when compared to today, the date of today will be used instead. |
| dateTo | A date formatted as DD-MM-YYYY. Limit the result to rental objects that can be rented on this date or earlier |
| rentalObjectNoStart | Limit the result to rental objects with a number large than or equal to this number. The format of the number: ##-#### where # is number between 0 and 9. Use the endpoint GET /feeds/xml/{partnerCode}/{consumerId}/rentalobjectnumber to get all possible numbers. |
| rentalObjectNoEnd | Limit the result to rental objects with a number smaller than or equal to this number. The format of the number is still: ##-#### |
| countryIsoCode | Country ISO(ISO 3166-1 alpha 2 standard) code from which to retrieve Rental Objects. If null all Rental Objects are retrieved regardless of country. |
| regionIds | A comma separated list of region ids from which to retrieve Rental Objects. If the list is empty all Rental Objects are retrieved regardless of region. If CountryIsoCode is empty this list is ignored. Otherwise the region ids must belong to the specified country or be empty. |
| includeRentalAgreementInfo | If true the field RentalAgreementInfo will be filled out on all items in the list field Calendar in returned result. Otherwise Calendar field is null. |