APapaleo
TimeSliceDefinitions

Get a specific time slice definition

Get a specific time slice definition for a property. A time slice definition specifies the pattern for recurring time slots. The time slots define when reservations in the property can start or end. It is used in the rate plans when managing prices for renting out the units.<br>You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.

get/settings/v1/properties/{propertyId}/time-slice-definitions/{id}

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: settings.read, setup.read, setup.manage, admin

Path parameters

propertyIdstring required

The id of the property.

idstring required

The id of the time slice definition.

Query parameters

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored.

Response

Returns the time slice definition.

idstring required
namestring required
template'DayUse' | 'OverNight' required
checkInTimestring required

<br />A time (without fractional second part) as defined in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

checkOutTimestring required

<br />A time (without fractional second part) as defined in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

isUsedboolean required

Example response

{
  "id": "MUC-NIGHT",
  "name": "Over Night",
  "template": "OverNight",
  "checkInTime": "17:00:00",
  "checkOutTime": "11:00:00",
  "isUsed": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.