Inventory - API Example

05-11-2018

This section describes the Inventory API. Get to know its Operations, Type Definitions, Default-Headers, and Default Query Parameters.

If you would like to see our other API modules, just select the relevant link:

API Reference	Description
Availability API	Allows you to manage room availability.
Business Day API	Allows you to manage business day.
Cashiering API	Allows you to manage cashiering.
Configuration API	Allows you to read system configuration.
Event Management API	Allows you to manage system events.
Housekeeping API	Allows you to manage housekeeping work.
Identity API	Allows you to manage user’s identity.
Permission Management API	Allows you to manage system permissions.
Profiles API	Allows you to create and manage individual, company, and travel agent profiles.
Rate Manager API	Allows you to manage rate plans.
Reporting API	Allows you to manage reports.
Reservations API	Allows you to manage reservations.

Get a list of available rooms

GET /inventory/v0/available-rooms

Authentication

OAuth2

Use this method to get a list of all available rooms.

Request parameters

roomTypeCode

string optional

The code of the type of the available room.

Example:

DTW

fromDate

string date optional

The date from which the room is available.

Example:

2018-10-12

toDate

string date optional

The date until which the room is available.

Example:

2018-10-30

Request headers

AC-Property-ID

string required

Property ID header requested for each call that access data or operations under a specific property. Operations in different areas such as Reservation Creation/Update are strictly performed within a property context. Every such operation needs to include also this header. Other operations such as setting up configurations for a tenant are not executed within a property context, but within the tenant (or system) context. The default value is used to identify ACDEMO1 which is a test property used to try the API. How to find a property id:

Use GET /configuration/subsidiaries/views/organization-treeendpoint to get a list of each subsidiary and the count of it’s properties, for a given tenant.
Use GET /configuration/properties?subsidiaryId=<sub_id> to get a list of properties for the given subsidiary. Each entry will also contain a property Id.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Default:

21c8e592-a8c1-4163-8295-c671a8edc5ea

Authorization

string optional

Authorization token.

Example:

Bearer keroereordlkcp43515rwefdwqefuqwfqe

Responses

200 200

The request was successful.

Body

Array of available-room-details-response

400 400

Bad request. Response body contains error details.

Body

error-report

401 401

User is not authenticated. Please login before requesting this operation.

403 403

Authorisation failed. User is not authorize to request the operation on the defined resourse

500 500

Internal Server Error.

Body

error-report

Get a list of available room types

GET /inventory/v0/available-room-types

Authentication

OAuth2

Use this method to get a list of all available room types.

Request parameters

fromDate

string date optional

The date from which a specific room type is available.

Example:

2018-10-12

toDate

string date optional

The date until which a specific room type is available.

Example:

2018-10-30

roomTypeCode

string optional

The code of the type of the available room type.

Request headers

AC-Property-ID

string required

Property ID header requested for each call that access data or operations under a specific property. Operations in different areas such as Reservation Creation/Update are strictly performed within a property context. Every such operation needs to include also this header. Other operations such as setting up configurations for a tenant are not executed within a property context, but within the tenant (or system) context. The default value is used to identify ACDEMO1 which is a test property used to try the API. How to find a property id:

Use GET /configuration/subsidiaries/views/organization-treeendpoint to get a list of each subsidiary and the count of it’s properties, for a given tenant.
Use GET /configuration/properties?subsidiaryId=<sub_id> to get a list of properties for the given subsidiary. Each entry will also contain a property Id.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Default:

21c8e592-a8c1-4163-8295-c671a8edc5ea

Authorization

string optional

Authorization token.

Example:

Bearer keroereordlkcp43515rwefdwqefuqwfqe

Responses

200 200

The request was successful.

Body

Array of available-room-type-details-response

400 400

Bad request. Response body contains error details.

Body

error-report

401 401

User is not authenticated. Please login before requesting this operation.

403 403

Authorisation failed. User is not authorize to request the operation on the defined resourse

500 500

Internal server error.

Body

error-report

Get a list of house overbooking limits

GET /inventory/v0/house-overbooking-limits

Create a house overbooking limit

POST /inventory/v0/house-overbooking-limits

Get details of a house overbooking limit

GET /inventory/v0/house-overbooking-limits/{id}

Delete a house overbooking limit

DELETE /inventory/v0/house-overbooking-limits/{id}

Update a house overbooking limit

POST /inventory/v0/house-overbooking-limits/{id}/update

GET /inventory/v0/house-overbooking-limits

Authentication

OAuth2

Use this method to get a list of all house overbooking limits.

Request parameters

filter

string optional

Filter the results based on a pattern.

Allow empty value: true

Example:

?filter=arrivalDate=ge=2017-01-01,(arrivalDate=ge=2016-12-24;arrivalDate=le=2016-12-26)

sort

string optional

Comma separated list of fields to sort the returned results.

Example:

?sort=arrivalDate,-departureDate

fields

string optional

Comma separated list of field names to be returned with a query operation.

Example:

fields=userName,personalData.firstName,personalData.lastName

pageNumber

string optional

The current page number when querying a list of resources.

Pattern: ^[1-9]\d*$

Default:

1

pageSize

string optional

The maximum number of items to return with the current request.

Pattern: ^[1-9]\d*$

Request headers

AC-Tenant-ID

string optional

It is the unique identifier of the tenant/customer. The AC Project business perspective classifies the tenant as the AC customer.

If the method is calling out in the system administrator user context, an optional header parameter tenantID determines the property of the organizational structure to which the tenant/customer belongs. In other cases, the context determines it.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

AC-Property-ID

string required

Property ID header requested for each call that access data or operations under a specific property. Operations in different areas such as Reservation Creation/Update are strictly performed within a property context. Every such operation needs to include also this header. Other operations such as setting up configurations for a tenant are not executed within a property context, but within the tenant (or system) context. The default value is used to identify ACDEMO1 which is a test property used to try the API. How to find a property id:

Use GET /configuration/subsidiaries/views/organization-treeendpoint to get a list of each subsidiary and the count of it’s properties, for a given tenant.
Use GET /configuration/properties?subsidiaryId=<sub_id> to get a list of properties for the given subsidiary. Each entry will also contain a property Id.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Default:

21c8e592-a8c1-4163-8295-c671a8edc5ea

Authorization

string optional

Authorization token.

Example:

Bearer keroereordlkcp43515rwefdwqefuqwfqe

Responses

200 200

The request was successful.

Body

house-overbooking-limit-list-response

400 400

Request validation failed. Returned error-report contains validation error details.

Body

error-report

401 401

User is not authenticated. Please login before requesting this operation.

403 403

Authorisation failed. User is not authorize to request the operation on the defined resourse

404 404

The requested resource has been not found

500 500

Internal server error

Body

error-report

POST /inventory/v0/house-overbooking-limits

Authentication

OAuth2

Use this method to create a new house overbooking limit.

Request headers

AC-Tenant-ID

string optional

It is the unique identifier of the tenant/customer. The AC Project business perspective classifies the tenant as the AC customer.

If the method is calling out in the system administrator user context, an optional header parameter tenantID determines the property of the organizational structure to which the tenant/customer belongs. In other cases, the context determines it.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

AC-Property-ID

string required

Property ID header requested for each call that access data or operations under a specific property. Operations in different areas such as Reservation Creation/Update are strictly performed within a property context. Every such operation needs to include also this header. Other operations such as setting up configurations for a tenant are not executed within a property context, but within the tenant (or system) context. The default value is used to identify ACDEMO1 which is a test property used to try the API. How to find a property id:

Use GET /configuration/subsidiaries/views/organization-treeendpoint to get a list of each subsidiary and the count of it’s properties, for a given tenant.
Use GET /configuration/properties?subsidiaryId=<sub_id> to get a list of properties for the given subsidiary. Each entry will also contain a property Id.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Default:

21c8e592-a8c1-4163-8295-c671a8edc5ea

Authorization

string optional

Authorization token.

Example:

Bearer keroereordlkcp43515rwefdwqefuqwfqe

Request body

create-house-overbooking-limit-request

Responses

201 201

The resource created successfully.

Headers

Location

string optional

The URL of the created resource.

Body

created-response

400 400

Request validation failed. Returned error-report contains validation error details.

Body

error-report

401 401

User is not authenticated. Please login before requesting this operation.

403 403

Authorisation failed. User is not authorize to request the operation on the defined resourse

404 404

The requested resource has been not found

412 412

Optimistic Concurrency error: request was passed with a version that is outdated

Body

error-report

500 500

Internal server error

Body

error-report

GET /inventory/v0/house-overbooking-limits/{id}

Authentication

OAuth2

Use this method to get the details of a specific house overbooking limit.

Path variables

id

string required

The unique identifier of the house overbooking limit.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Request headers

AC-Tenant-ID

string optional

It is the unique identifier of the tenant/customer. The AC Project business perspective classifies the tenant as the AC customer.

If the method is calling out in the system administrator user context, an optional header parameter tenantID determines the property of the organizational structure to which the tenant/customer belongs. In other cases, the context determines it.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

AC-Property-ID

string required

Property ID header requested for each call that access data or operations under a specific property. Operations in different areas such as Reservation Creation/Update are strictly performed within a property context. Every such operation needs to include also this header. Other operations such as setting up configurations for a tenant are not executed within a property context, but within the tenant (or system) context. The default value is used to identify ACDEMO1 which is a test property used to try the API. How to find a property id:

Use GET /configuration/subsidiaries/views/organization-treeendpoint to get a list of each subsidiary and the count of it’s properties, for a given tenant.
Use GET /configuration/properties?subsidiaryId=<sub_id> to get a list of properties for the given subsidiary. Each entry will also contain a property Id.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Default:

21c8e592-a8c1-4163-8295-c671a8edc5ea

Authorization

string optional

Authorization token.

Example:

Bearer keroereordlkcp43515rwefdwqefuqwfqe

Responses

200 200

The request was successful.

Headers

ETag

string optional

Current version of Entity

Body

house-overbooking-limit-item-response

400 400

Request validation failed. Returned error-report contains validation error details.

Body

error-report

401 401

User is not authenticated. Please login before requesting this operation.

403 403

Authorisation failed. User is not authorize to request the operation on the defined resourse

404 404

The requested resource has been not found

500 500

Internal server error

Body

error-report

DELETE /inventory/v0/house-overbooking-limits/{id}

Authentication

OAuth2

Use this method to delete a specific house overbooking limit.

Path variables

id

string required

The unique identifier of the house overbooking limit.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Request headers

AC-Tenant-ID

string optional

It is the unique identifier of the tenant/customer. Tenant is the technichal concept in multi-tenant systems. From AC Project business perspective Tenant is the AC Customer

If the METHOD is called in system administator user context the optional header parameter tenantID defines the customer/tenant which organizational structure the property belongs to

If the method is called in customer user context, the context defines which customer/tenant organizatonal structure the property belongs to.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

AC-Property-ID

string required

Property ID header requested for each call that access data or operations under a specific property. Operations in different areas such as Reservation Creation/Update are strictly performed within a property context. Every such operation needs to include also this header. Other operations such as setting up configurations for a tenant are not executed within a property context, but within the tenant (or system) context. The default value is used to identify ACDEMO1 which is a test property used to try the API. How to find a property id:

Use GET /configuration/subsidiaries/views/organization-treeendpoint to get a list of each subsidiary and the count of it’s properties, for a given tenant.
Use GET /configuration/properties?subsidiaryId=<sub_id> to get a list of properties for the given subsidiary. Each entry will also contain a property Id.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Default:

21c8e592-a8c1-4163-8295-c671a8edc5ea

If-Match

string required

The method succeeds if the value of this subject header is identical with the value of the Etag received with the latest GET resource.

Authorization

string optional

Authorization token.

Example:

Bearer keroereordlkcp43515rwefdwqefuqwfqe

Responses

204 204

The server has fulfilled the request but does not need to return a message body.

400 400

Request validation failed. Returned error-report contains validation error details.

Body

error-report

401 401

User is not authenticated. Please login before requesting this operation.

403 403

Authorisation failed. User is not authorize to request the operation on the defined resourse

404 404

The requested resource has been not found

412 412

Optimistic Concurrency error: request was passed with a version that is outdated

Body

error-report

500 500

Internal server error

Body

error-report

POST /inventory/v0/house-overbooking-limits/{id}/update

Authentication

OAuth2

Use this method to update a specific house overbooking limit.

Path variables

id

string required

The unique identifier of the house overbooking limit.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Request headers

AC-Tenant-ID

string optional

It is the unique identifier of the tenant/customer. Tenant is the technichal concept in multi-tenant systems. From AC Project business perspective Tenant is the AC Customer

If the METHOD is called in system administator user context the optional header parameter tenantID defines the customer/tenant which organizational structure the property belongs to

If the method is called in customer user context, the context defines which customer/tenant organizatonal structure the property belongs to.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

AC-Property-ID

string required

Property ID header requested for each call that access data or operations under a specific property. Operations in different areas such as Reservation Creation/Update are strictly performed within a property context. Every such operation needs to include also this header. Other operations such as setting up configurations for a tenant are not executed within a property context, but within the tenant (or system) context. The default value is used to identify ACDEMO1 which is a test property used to try the API. How to find a property id:

Use GET /configuration/subsidiaries/views/organization-treeendpoint to get a list of each subsidiary and the count of it’s properties, for a given tenant.
Use GET /configuration/properties?subsidiaryId=<sub_id> to get a list of properties for the given subsidiary. Each entry will also contain a property Id.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Default:

21c8e592-a8c1-4163-8295-c671a8edc5ea

If-Match

string required

The method succeeds if the value of this subject header is identical with the value of the Etag received with the latest GET resource.

Authorization

string optional

Authorization token.

Example:

Bearer keroereordlkcp43515rwefdwqefuqwfqe

Request body

update-overbooking-limit-request

Responses

204 204

The server has fulfilled the request but does not need to return a message body.

400 400

Request validation failed. Returned error-report contains validation error details.

Body

error-report

401 401

User is not authenticated. Please login before requesting this operation.

403 403

Authorisation failed. User is not authorize to request the operation on the defined resourse

404 404

The requested resource has been not found

412 412

Optimistic Concurrency error: request was passed with a version that is outdated

Body

error-report

500 500

Internal server error

Body

error-report

Get a list of room type overbooking limits

GET /inventory/v0/room-type-overbooking-limits

Create a room type overbooking limit

POST /inventory/v0/room-type-overbooking-limits

Get details of a room type overbooking limit

GET /inventory/v0/room-type-overbooking-limits/{id}

Delete a room type overbooking limit

DELETE /inventory/v0/room-type-overbooking-limits/{id}

Update a room type overbooking limit

POST /inventory/v0/room-type-overbooking-limits/{id}/update

GET /inventory/v0/room-type-overbooking-limits

Authentication

OAuth2

Use this method to get a list of overbooking limits for a specific room type.

Request parameters

filter

string optional

Filter the results based on a pattern.

Allow empty value: true

Example:

?filter=arrivalDate=ge=2017-01-01,(arrivalDate=ge=2016-12-24;arrivalDate=le=2016-12-26)

sort

string optional

Comma separated list of fields to sort the returned results.

Example:

?sort=arrivalDate,-departureDate

fields

string optional

Comma separated list of field names to be returned with a query operation.

Example:

fields=userName,personalData.firstName,personalData.lastName

pageNumber

string optional

The current page number when querying a list of resources.

Pattern: ^[1-9]\d*$

Default:

1

pageSize

string optional

The maximum number of items to return with the current request.

Pattern: ^[1-9]\d*$

Request headers

AC-Tenant-ID

string optional

It is the unique identifier of the tenant/customer. Tenant is the technichal concept in multi-tenant systems. From AC Project business perspective Tenant is the AC Customer

If the METHOD is called in system administator user context the optional header parameter tenantID defines the customer/tenant which organizational structure the property belongs to

If the method is called in customer user context, the context defines which customer/tenant organizatonal structure the property belongs to.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

AC-Property-ID

string required

Property ID header requested for each call that access data or operations under a specific property. Operations in different areas such as Reservation Creation/Update are strictly performed within a property context. Every such operation needs to include also this header. Other operations such as setting up configurations for a tenant are not executed within a property context, but within the tenant (or system) context. The default value is used to identify ACDEMO1 which is a test property used to try the API. How to find a property id:

Use GET /configuration/subsidiaries/views/organization-treeendpoint to get a list of each subsidiary and the count of it’s properties, for a given tenant.
Use GET /configuration/properties?subsidiaryId=<sub_id> to get a list of properties for the given subsidiary. Each entry will also contain a property Id.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Default:

21c8e592-a8c1-4163-8295-c671a8edc5ea

Authorization

string optional

Authorization token.

Example:

Bearer keroereordlkcp43515rwefdwqefuqwfqe

Responses

200 200

The request was successful.

Body

roomtype-overbooking-limit-list-response

400 400

Request validation failed. Returned error-report contains validation error details.

Body

error-report

401 401

User is not authenticated. Please login before requesting this operation.

403 403

Authorisation failed. User is not authorize to request the operation on the defined resourse

404 404

The requested resource has been not found

500 500

Internal server error

Body

error-report

POST /inventory/v0/room-type-overbooking-limits

Authentication

OAuth2

Use this method to create a new overbooking limit for a specific room type.

Request headers

AC-Tenant-ID

string optional

It is the unique identifier of the tenant/customer. Tenant is the technichal concept in multi-tenant systems. From AC Project business perspective Tenant is the AC Customer

If the METHOD is called in system administator user context the optional header parameter tenantID defines the customer/tenant which organizational structure the property belongs to

If the method is called in customer user context, the context defines which customer/tenant organizatonal structure the property belongs to.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

AC-Property-ID

string required

Property ID header requested for each call that access data or operations under a specific property. Operations in different areas such as Reservation Creation/Update are strictly performed within a property context. Every such operation needs to include also this header. Other operations such as setting up configurations for a tenant are not executed within a property context, but within the tenant (or system) context. The default value is used to identify ACDEMO1 which is a test property used to try the API. How to find a property id:

Use GET /configuration/subsidiaries/views/organization-treeendpoint to get a list of each subsidiary and the count of it’s properties, for a given tenant.
Use GET /configuration/properties?subsidiaryId=<sub_id> to get a list of properties for the given subsidiary. Each entry will also contain a property Id.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Default:

21c8e592-a8c1-4163-8295-c671a8edc5ea

Authorization

string optional

Authorization token.

Example:

Bearer keroereordlkcp43515rwefdwqefuqwfqe

Request body

create-roomtype-overbooking-limit-request

Responses

201 201

The resource created successfully.

Headers

Location

string optional

The URL of the created resource.

Body

created-response

400 400

Request validation failed. Returned error-report contains validation error details.

Body

error-report

401 401

User is not authenticated. Please login before requesting this operation.

403 403

Authorisation failed. User is not authorize to request the operation on the defined resourse

404 404

The requested resource has been not found

412 412

Optimistic Concurrency error: request was passed with a version that is outdated

Body

error-report

500 500

Internal server error

Body

error-report

GET /inventory/v0/room-type-overbooking-limits/{id}

Authentication

OAuth2

Use this method to get the details of the overbooking limit for a specific room type.

Path variables

id

string required

The unique identifier of the room type overbooking limit.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Request headers

AC-Tenant-ID

string optional

It is the unique identifier of the tenant/customer. Tenant is the technichal concept in multi-tenant systems. From AC Project business perspective Tenant is the AC Customer

If the METHOD is called in system administator user context the optional header parameter tenantID defines the customer/tenant which organizational structure the property belongs to

If the method is called in customer user context, the context defines which customer/tenant organizatonal structure the property belongs to.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

AC-Property-ID

string required

Property ID header requested for each call that access data or operations under a specific property. Operations in different areas such as Reservation Creation/Update are strictly performed within a property context. Every such operation needs to include also this header. Other operations such as setting up configurations for a tenant are not executed within a property context, but within the tenant (or system) context. The default value is used to identify ACDEMO1 which is a test property used to try the API. How to find a property id:

Use GET /configuration/subsidiaries/views/organization-treeendpoint to get a list of each subsidiary and the count of it’s properties, for a given tenant.
Use GET /configuration/properties?subsidiaryId=<sub_id> to get a list of properties for the given subsidiary. Each entry will also contain a property Id.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Default:

21c8e592-a8c1-4163-8295-c671a8edc5ea

Authorization

string optional

Authorization token.

Example:

Bearer keroereordlkcp43515rwefdwqefuqwfqe

Responses

200 200

The request was successful.

Headers

ETag

string optional

Current version of Entity

Body

roomtype-overbooking-limit-item-response

400 400

Request validation failed. Returned error-report contains validation error details.

Body

error-report

401 401

User is not authenticated. Please login before requesting this operation.

403 403

Authorisation failed. User is not authorize to request the operation on the defined resourse

404 404

The requested resource has been not found

500 500

Internal server error

Body

error-report

DELETE /inventory/v0/room-type-overbooking-limits/{id}

Authentication

OAuth2

Use this method to delete the overbooking limit for a specific room type.

Path variables

id

string required

The unique identifier of the room type overbooking limit.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Request headers

AC-Tenant-ID

string optional

It is the unique identifier of the tenant/customer. Tenant is the technichal concept in multi-tenant systems. From AC Project business perspective Tenant is the AC Customer

If the METHOD is called in system administator user context the optional header parameter tenantID defines the customer/tenant which organizational structure the property belongs to

If the method is called in customer user context, the context defines which customer/tenant organizatonal structure the property belongs to.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

AC-Property-ID

string required

Property ID header requested for each call that access data or operations under a specific property. Operations in different areas such as Reservation Creation/Update are strictly performed within a property context. Every such operation needs to include also this header. Other operations such as setting up configurations for a tenant are not executed within a property context, but within the tenant (or system) context. The default value is used to identify ACDEMO1 which is a test property used to try the API. How to find a property id:

Use GET /configuration/subsidiaries/views/organization-treeendpoint to get a list of each subsidiary and the count of it’s properties, for a given tenant.
Use GET /configuration/properties?subsidiaryId=<sub_id> to get a list of properties for the given subsidiary. Each entry will also contain a property Id.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Default:

21c8e592-a8c1-4163-8295-c671a8edc5ea

If-Match

string required

The method succeeds if the value of this subject header is identical with the value of the Etag received with the latest GET resource.

Authorization

string optional

Authorization token.

Example:

Bearer keroereordlkcp43515rwefdwqefuqwfqe

Responses

204 204

The server has fulfilled the request but does not need to return a message body.

400 400

Request validation failed. Returned error-report contains validation error details.

Body

error-report

401 401

User is not authenticated. Please login before requesting this operation.

403 403

Authorisation failed. User is not authorize to request the operation on the defined resourse

404 404

The requested resource has been not found

412 412

Optimistic Concurrency error: request was passed with a version that is outdated

Body

error-report

500 500

Internal server error

Body

error-report

POST /inventory/v0/room-type-overbooking-limits/{id}/update

Authentication

OAuth2

Use this method to update the overbooking limit for a specific room type.

Path variables

id

string required

The unique identifier of the room type overbooking limit.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Request headers

AC-Tenant-ID

string optional

It is the unique identifier of the tenant/customer. Tenant is the technichal concept in multi-tenant systems. From AC Project business perspective Tenant is the AC Customer

If the METHOD is called in system administator user context the optional header parameter tenantID defines the customer/tenant which organizational structure the property belongs to

If the method is called in customer user context, the context defines which customer/tenant organizatonal structure the property belongs to.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

AC-Property-ID

string required

Property ID header requested for each call that access data or operations under a specific property. Operations in different areas such as Reservation Creation/Update are strictly performed within a property context. Every such operation needs to include also this header. Other operations such as setting up configurations for a tenant are not executed within a property context, but within the tenant (or system) context. The default value is used to identify ACDEMO1 which is a test property used to try the API. How to find a property id:

Use GET /configuration/subsidiaries/views/organization-treeendpoint to get a list of each subsidiary and the count of it’s properties, for a given tenant.
Use GET /configuration/properties?subsidiaryId=<sub_id> to get a list of properties for the given subsidiary. Each entry will also contain a property Id.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Default:

21c8e592-a8c1-4163-8295-c671a8edc5ea

If-Match

string required

The method succeeds if the value of this subject header is identical with the value of the Etag received with the latest GET resource.

Authorization

string optional

Authorization token.

Example:

Bearer keroereordlkcp43515rwefdwqefuqwfqe

Request body

update-overbooking-limit-request

Responses

204 204

The server has fulfilled the request but does not need to return a message body.

400 400

Request validation failed. Returned error-report contains validation error details.

Body

error-report

401 401

User is not authenticated. Please login before requesting this operation.

403 403

Authorisation failed. User is not authorize to request the operation on the defined resourse

404 404

The requested resource has been not found

412 412

Optimistic Concurrency error: request was passed with a version that is outdated

Body

error-report

500 500

Internal server error

Body

error-report

Object

startDate

string date required

The start date of the overbooking limit.

Example:

2018-05-12

endDate

string date

The end date of the overbooking limit.

Example:

2018-08-19

count

integer required

The number of rooms of a specific type that can be overbooked within a given date period.

Example:

5

Object

roomTypeId

string required

The unique identifier of the room type with the overbooking limit.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Example:

f319662a-0620-45d1-a007-0267b470ac1a

startDate

string date required

The start date of the overbooking limit.

Example:

2018-05-12

endDate

string date

The end date of the overbooking limit.

Example:

2018-08-19

count

integer required

The number of rooms of a specific type that can be overbooked within a given date period.

Example:

5

Object

startDate

string date required

The start date of the overbooking limit.

Example:

2018-05-12

endDate

string date

The end date of the overbooking limit.

Example:

2018-08-19

count

integer required

The number of rooms of a specific type that can be overbooked within a given date period.

Example:

5

Object

results

Array of house-overbooking-limit-item-response required

The list of overbooking limits on the requested page.

paging

paging-parameters-inventory

The requested page information.

Object

id

string required

The unique identifier of the overbooking limit.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Example:

f319662a-0620-45d1-a007-0267b470ac1a

startDate

string date required

The start date of the overbooking limit.

Example:

2018-05-12

endDate

string date

The end date of the overbooking limit.

Example:

2018-08-19

count

integer

The number of rooms of a specific type that can be overbooked within a given date period.

Example:

5

version

string

The current version of an object, used for concurrency handling.

Object

results

Array of roomtype-overbooking-limit-item-response required

The list of overbooking limits on the requested page.

paging

paging-parameters required

The requested page information.

Object

id

string required

The unique identifier of the overbooking limit.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Example:

f319662a-0620-45d1-a007-0267b470ac1a

roomTypeId

string required

The unique identifier of the room type with the overbooking limit.

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Example:

ef823b0a-7313-491b-afa5-b6496b0f2d26

startDate

string date required

The start date of the overbooking limit.

Example:

2018-05-12

endDate

string date

The end date of the overbooking limit.

Example:

2018-08-19

count

integer

The number of rooms of a specific type that can be overbooked within a given date period.

Example:

5

Object

roomTypeCode

code-value required

The code of the available room type.

availableRoomsCount

integer required

The number of available rooms.

Example:

60

availableRoomsCountIncludingOverbooking

integer

The number of available rooms including the overbooking limit.

Example:

65

Object

roomCode

code-value required

The code of the available room.

Object

date

string date required

The date for which the daily room occupancy is calculated.

Example:

2018-08-17

availableRooms

integer required

The number of available rooms.

Example:

40

availableRoomsIncludingOverbooking

integer

The number of available rooms including the overbooking limit.

Example:

45

occupiedRooms

integer required

The number of occupied rooms.

Example:

18

Object

languageCode

string required

The language code in which the content is written based on 2 char ISO 639-1 standard

Pattern: [a-zA-Z][a-zA-Z]

Example:

en

localizedContent

string required

The content written for a specific geographic area, in a specific language.

Max length: 500

Example:

Dear Sir or Madam

Object

code

string required

The code of the error.

Example:

InfrastructureException

message

string

A human-readable message describing what happened.

Example:

Room 112A is already occupied.

correlationId

string

The unique identifier of the request that caused the error.

Example:

c2037c4a-28aa-4f1a-b063-e19f6dbb2ae6

details

Array of error-detail required

A list of error details.

Object

code

string required

The code of the error.

Example:

EntityDoesNotExist

message

string required

A human-readable message describing what happened.

Example:

Room 112 is already occupied.

parameters

Array of exception-parameters

Exception-related names and values.

relatedFields

Array

The name of the field(s) with incorrect values in the input request.

string

Example:

roomNumber

Object

key

string required

The name of the exception.

Example:

RoomNumber

value

string required

The value of the exception.

Example:

112

Object

languageCode

string required

The language code in which the content is written based on 2 char ISO 639-1 standard

Pattern: [a-zA-Z][a-zA-Z]

Example:

en

localizedContent

string

The content written for a specific geographic area, in a specific language.

Max length: 100

Example:

Dear Sir or Madam

Array of localized-text-detail

Array of localized-name-detail

string

Object

code

string required

The unique code.

Max length: 20

Example:

DTW

description

string required

Descriptive information.

Example:

Deluxe Twin Room Water View

Object

amount

number required

An amount of money.

Example:

119.95

currency

string required

The ISO 4217 currency code.

Example:

EUR

Object

pageNumber

integer required

pageSize

integer required

totalCount

integer required

The total number of results for a specific query.

Example:

120

self

string

The current page of results for a specific query.

Example:

http://ac-project-example.net/apigateway/business-data?pageNumber=3

first

string

A link to the first page of results for a specific query.

Example:

http://ac-project-example.net/apigateway/business-data?pageNumber=1

A link to the previous page of results for a specific query.

Example:

http://ac-project-example.net/apigateway/business-data?pageNumber=2

A link to the next page of results for a specific query.

Example:

http://ac-project-example.net/apigateway/business-data?pageNumber=4

last

string

A link to the last page of results for a specific query.

Example:

http://ac-project-example.net/apigateway/business-data?pageNumber=312

Object

net

money required

The net amount.

gross

money required

The gross amount.

taxes

money required

Mandatory financial charges imposed by a governmental organization.

Object

pageNumber

integer required

The page number of the returned results.

pageSize

integer required

The page size of the returned results.

totalCount

integer required

The total number of results for a specific query.

Example:

120

Default headers that are used throughout the API.

Default query parameters that are used throughout the API.