Services
Last updated
Was this helpful?
Last updated
Was this helpful?
Returns all services offered by the enterprise. Note this operation uses and supports .
[PlatformAddress]/api/connector/v1/services/getAll
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseIds
array of string
optional, max 1000 items
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
ServiceIds
array of string
optional, max 1000 items
UpdatedUtc
optional, max length 3 months
Interval in which Services were updated.
Limitation
required
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
Services
required
Services offered by the enterprise.
Cursor
string
optional
Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
Id
string
required
Unique identifier of the service.
EnterpriseId
string
required
IsActive
boolean
required
Whether the service is still active.
Names
required
All translations of the name.
Options
required
Options of the service.
Ordering
integer
required
Order value for presentation purposes.
Data
required
Additional information about the specific service.
ExternalIdentifier
string
optional, max length 255 characters
Identifier of the service from external system.
CreatedUtc
string
required
Creation date and time of the service in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the service in UTC timezone in ISO 8601 format.
Name
string
required
Name of the service. Deprecated! Use Names instead
StartTime
string
optional
Deprecated!
EndTime
string
optional
Deprecated!
Promotions
optional
Deprecated! Use Promotions in Data instead.
Type
string
optional
Deprecated!
Options of the service.
BillAsPackage
boolean
required
Products should be displayed as a single package instead of individual items.
BeforeCheckIn
boolean
required
Whether it can be promoted before check-in.
AfterCheckIn
boolean
required
Whether it can be promoted after check-in.
DuringStay
boolean
required
Whether it can be promoted during stay.
BeforeCheckOut
boolean
required
Whether it can be promoted before check-out.
AfterCheckOut
boolean
required
Whether it can be promoted after check-out.
DuringCheckOut
boolean
required
Whether it can be promoted during check-out.
Additional information about the specific service.
Discriminator
required
Determines type of value.
Value
object
required
Structure of object depends on Discriminator.
Bookable
Additional
StartOffset
string
required
EndOffset
string
required
OccupancyStartOffset
string
required
OccupancyEndOffset
string
required
TimeUnitPeriod
required
TimeUnit
required
Deprecated! Use TimeUnitPeriod instead.
Day
Month
Hour
Promotions
required
Promotions of the service.
Restricted!This operation is currently in beta-test and as such it is subject to change.
[PlatformAddress]/api/connector/v1/services/getAvailability/2024-01-22
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ServiceId
string
required
FirstTimeUnitStartUtc
string
required
LastTimeUnitStartUtc
string
required
Metrics
required
OutOfOrderBlocks - Number of resources that are out of order for the resource category (see Resource Block).
PublicAvailabilityAdjustment - Number of resources marked as manual availability adjustments.
OtherServiceReservationCount - Number of resources occupied by another service.
Occupied - Number of bookings that have been assigned to the resource category (i.e. reservations and blocks).
ConfirmedReservations - Number of confirmed reservations that have been assigned to the resource category.
OptionalReservations - Number of optional reservations that have been assigned to the resource category.
BlockAvailability - Number of blocked resources (from an availability block / allotment).
AllocatedBlockAvailability - Number of blocked resources that are in a deducting state (from an availability block / allotment).
UsableResources - Number of usable resources (i.e. which are not out of order).
ActiveResources - Number of active resources.
TimeUnitStartsUtc
array of string
required
Set of all time units covered by the time interval; expressed in UTC timezone ISO 8601 format.
ResourceCategoryAvailabilities
required
Resource category availabilities. Can be empty if no resource categories are assigned to the service.
ResourceCategoryId
string
required
Metrics
required
[PlatformAddress]/api/connector/v1/services/getAvailability
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ServiceId
string
required
FirstTimeUnitStartUtc
string
required
LastTimeUnitStartUtc
string
required
StartUtc
string
optional
Deprecated!
EndUtc
string
optional
Deprecated!
TimeUnitStartsUtc
array of string
required
Set of all time units covered by the time interval; expressed in UTC timezone ISO 8601 format.
CategoryAvailabilities
required
Resource category availabilities.
DatesUtc
array of string
optional
Deprecated!
CategoryId
string
required
Availabilities
array of integer
required
Absolute availabilities of the resource category in the covered dates.
Adjustments
array of integer
required
Relative availability adjustments set for resource category in the covered dates.
[PlatformAddress]/api/connector/v1/services/updateAvailability
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ServiceId
string
required
AvailabilityUpdates
required, max 1000 items
Availability updates.
FirstTimeUnitStartUtc
string
required
LastTimeUnitStartUtc
string
required
ResourceCategoryId
string
required
UnitCountAdjustment
required
Adjustment value to be applied on the interval, can be both positive and negative (relative adjustment, not an absolute number). If specified without Value parameter, removes all adjustments within the interval.
AvailabilityBlockId
string
optional
PaxCounts
optional, max 5 items
Collection of predicted occupancy of availability adjustments. Relates how many adjustments are assigned to each count of guests.
StartUtc
string
optional
Deprecated!
EndUtc
string
optional
Deprecated!
PersonCount
integer
required
Predicted guest count that will be assigned to the Resource. The guest count must fit within the Resource Category maximum capacity.
UnitCount
integer
required
Positive number of adjustments that are assigned to PersonCount. The sum of all UnitCount in PaxCounts should match the adjustment value applied to the interval.
Unique identifiers of .
array of
Unique identifier of the .
Offset from the start of the which defines the default start of the service; expressed in ISO 8601 duration format.
Offset from the end of the which defines the default end of the service; expressed in ISO 8601 duration format.
Offset from the start of the which defines the occupancy start of the service; expressed in ISO 8601 duration format. 'Occupancy start' is used for availability and reporting purposes, it implies the time at which the booked resource is considered occupied.
Offset from the end of the which defines the occupancy end of the service; expressed in ISO 8601 duration format. 'Occupancy end' is used for availability and reporting purposes, it implies the time at which the booked resource is no longer considered occupied.
The length of time or period represented by a , for which the service can be booked.
Returns selected availability and occupancy metrics of a bookable service for a specified time interval, similar to . Availability will be returned for all service time units that the specified time interval intersects. So, for example, an interval 1st Jan 23:00 UTC - 1st Jan 23:00 UTC will result in one time unit for 2nd Jan, while Interval 1st Jan 23:00 UTC - 2nd Jan 23:00 UTC will result in two time units for 2nd Jan and 3rd Jan (assuming a time unit period of "Day"). UTC timestamps must correspond to the start boundary of a time unit, e.g. 00:00 converted to UTC for a time unit of "Day". Other timestamps are not permitted. The maximum size of time interval depends on the service's time unit: 367 hours if hours, 367 days if days, or 60 months if months. For more information about time units, see .
Unique identifier of the whose availability should be returned.
Start of the time interval, expressed as the timestamp for the start of the first , in UTC timezone ISO 8601 format.
End of the time interval, expressed as the timestamp for the start of the last , in UTC timezone ISO 8601 format. The maximum size of time interval depends on the service's : 367 hours if hours, 367 days if days, or 60 months if months.
array of
Set of to be returned.
array of
Unique identifier of the .
Dictionary keys are names of , values are arrays of integers with metric values for corresponding time unit in TimeUnitStartsUtc.
Returns availability of a bookable service for a specified time interval including applied availability adjustments. Availability will be returned for all service time units that the specified time interval intersects. So, for example, an interval 1st Jan 23:00 UTC - 1st Jan 23:00 UTC will result in one price for 2nd Jan, while Interval 1st Jan 23:00 UTC - 2nd Jan 23:00 UTC will result in two prices for 2nd Jan and 3rd Jan (assuming a time unit period of "Day"). UTC timestamps must correspond to the start boundary of a time unit, e.g. 00:00 converted to UTC for a time unit of "Day". Other timestamps are not permitted. The maximum size of time interval depends on the service's time unit: 367 hours if hours, 367 days if days, or 60 months if months. For more information about time units, see .
Unique identifier of the whose availability should be returned.
Start of the time interval, expressed as the timestamp for the start of the first , in UTC timezone ISO 8601 format.
End of the time interval, expressed as the timestamp for the start of the last , in UTC timezone ISO 8601 format. The maximum size of time interval depends on the service's : 367 hours if hours, 367 days if days, or 60 months if months.
array of
Unique identifier of the .
Updates the number of available resources in by a certain amount (relative adjustment). Note that availabilities are defined per time unit, so when the server receives the UTC interval, it first converts it to enterprise timezone and updates the availability on all time units that the interval intersects. It's not allowed to update past availabilities outside of EditableHistoryInterval, future updates are allowed for up to 5 years.
Unique identifier of the to update.
array of
Start of the time interval, expressed as the timestamp for the start of the first , in UTC timezone ISO 8601 format.
End of the time interval, expressed as the timestamp for the start of the last , in UTC timezone ISO 8601 format. The maximum size of time interval depends on the service's : 367 hours if hours, 367 days if days, or 60 months if months.
Unique identifier of the whose availability to update.
Unique identifier of the whose availability to update.
array of