Versions Compared

Old Version 7

changes.mady.by.user Paul Collado Orta

Saved on

compared with

New Version 8

changes.mady.by.user Paul Collado Orta

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code

Description

Schema

200

OK

Hotel

401

Unauthorized

Error

403

Forbidden

Error

429

Too Many Requests

TooManyRequests

500

Internal Server Error

Error

...

RoomTypes

...

RoomType by Hotel

Method: GET
Path: ​/publisher​s/{publisherCode}​/hotel​s/{hotelCode}​/ratePlansroomTypes

Description: Lists all the Rate Plans Room Types for a specific hotel and publisher.

...

Code

Description

Schema

200

OK

RatePlanRoomType

401

Unauthorized

Error

403

Forbidden

Error

429

Too Many Requests

TooManyRequests

500

Internal Server Error

Error

...

RoomType by Room Type

Method: GET
Path: ​ ​/publisher​s/{publisherCode}​/hotel​s/{hotelCode}​/ratePlans​roomTypes​/{ratePlanCoderoomTypeCode}

Description: Get a specific rate plan room type for a specific hotel and publisher.

Parameters

Name

Located in

Description

Required

Type

publisherCode

path

The unique identifier for the data publisher. Please refer to PMS RequestorID/publisherCode list

Yes

string

hotelCode

path

The code that uniquely identifies a single hotel property.

Yes

string

ratePlanCoderoomTypeCode

path

The rate plan code that identifies a Room Type.

Yes

string

Responses

Code

Description

Schema

200

OK

RatePlanRoomType

401

Unauthorized

Error

403

Forbidden

Error

429

Too Many Requests

TooManyRequests

500

Internal Server Error

Error

...

Availability by

...

Room Type

Method: GET
Path: ​/publisherspublisher​s/{publisherCode}​/hotelshotel​s/{hotelCode}​/ratePlansroomTypes​/{ratePlanCoderoomTypeCode}​/ratesavailability

Description: Fetch the rates for a rate plan code based on given date range for a specific hotel and publisherNOTE If a publisher does not send a ratePlanCode with a rate then use ratePlanCode: NO_RATE_PLAN_PROVIDED_SM in the path for the GET method Get all availability for a specific room type, date range, hotel and publisher.

Parameters

Name

Located in

Description

Required

Type

publisherCode

path

The unique identifier for the data publisher. Please refer to PMS RequestorID/publisherCode list

Yes

string

hotelCode

path

The code that uniquely identifies a single hotel property.

Yes

string

ratePlanCoderoomTypeCode

path

The rate plan code . Note: If a publisher does not send a ratePlanCode with a rate then use ratePlanCode": "NO_RATE_PLAN_PROVIDED_SM"that identifies a Room Type.

Yes

string

startDate

query

Start date to query for ratesavailability. Format like yyyy-MM-dd i.e 2017-07-21.

Yes

date

range

query

The number of days to query for. Maximum 30.

No

number

...

Code

Description

Schema

200

OK

RateAvailability

401

Unauthorized

Error

403

Forbidden

Error

429

Too Many Requests

TooManyRequests

500

Internal Server Error

Error

RatePlans

...

RatePlan by

...

Hotel

Method: GET
Path: ​/publisherspublisher​s/{publisherCode}​/hotelshotel​s/{hotelCode}​/ratePlans/{ratePlanCode}/availability

Description: Fetch  Lists all the availability Rate Plans for a given rate plan, specific hotel , and publisher.

Parameters

Name

Located in

Description

Required

Type

publisherCode

path

The unique identifier for the data publisher. Please refer to PMS RequestorID/publisherCode list

Yes

string

hotelCode

path

The code that uniquely identifies a single hotel property.

Yes

string

ratePlanCode

path

The rate plan code.

Yes

string

startDate

query

Start date to query for rates. Format like yyyy-MM-dd i.e 2017-07-21.

Yes

date

range

query

The number of days to query for. Maximum 30.

No

number

Responses

Code

Description

Schema

200

OK

AvailabilityRatePlan

401

Unauthorized

Error

403

Forbidden

Error

429

Too Many Requests

TooManyRequests

500

Internal Server Error

Error

Rates

...

RatePlan by Rate Plan Code

Method: GET
Path:  ​/publisherspublisher​s/{publisherCode}​/hotelshotel​s/{hotelCode}​/ratePlansratePlans​/{ratePlanCode}/rates

Description: Fetch the rates for  Get a specific rate plan code based on given date range, hotel, for a hotel and publisher.

Parameters

Name

Located in

Description

Required

Type

publisherCode

path

The unique identifier for the data publisher. Please refer to PMS RequestorID/publisherCode list

Yes

string

hotelCode

path

The code that uniquely identifies a single hotel property.

Yes

string

ratePlanCode

path

The rate plan code.

Yes

string

startDate

query

Start date to query for rates. Format like yyyy-MM-dd i.e 2017-07-21.

Yes

date

range

query

The number of days to query for. Maximum 30.

No

number

Responses

Code

Description

Schema

200

OK

RateRatePlan

401

Unauthorized

Error

403

Forbidden

Error

429

Too Many Requests

TooManyRequests

500

Internal Server Error

Error

Availability

...

Rate by Rate Plan

Method: GET
Path: /publishers/{publisherCode}/hotels/{hotelCode}/ratePlans/{ratePlanCode}/availabilityrates

Description: Fetch the availability rates for a given rate plan , hotel, and publisher.code based on given date range for a specific hotel and publisher

NOTE If a publisher does not send a ratePlanCode with a rate then use ratePlanCode: NO_RATE_PLAN_PROVIDED_SM in the path for the GET method

Parameters

Name

Located in

Description

Required

Type

publisherCode

path

The unique identifier for the data publisher. Please refer to PMS RequestorID/publisherCode list

Yes

string

hotelCode

path

The code that uniquely identifies a single hotel property.

Yes

string

ratePlanCode

path

The rate plan code. Note: If a publisher does not send a ratePlanCode with a rate then use ratePlanCode": "NO_RATE_PLAN_PROVIDED_SM"

Yes

string

startDate

query

Start date to query for rates. Format like yyyy-MM-dd i.e 2017-07-21.

Yes

date

range

query

The number of days to query for. Maximum 30.

No

number

...

Code

Description

Schema

200

OK

AvailabilityRate

401

Unauthorized

Error

403

Forbidden

Error

429

Too Many Requests

TooManyRequests

500

Internal Server Error

Error

Availability by

...

Rate Plan

Method: GET
Path: /publishers/{publisherCode}/hotels/{hotelCode}/roomTypesratePlans/{roomTypeCoderatePlanCode}/availability

Description: Get all  Fetch the availability for a room type, date rangegiven rate plan, hotel, and publisher.

Parameters

Name

Located in

Description

Required

Type

publisherCode

path

The unique identifier for the data publisher. Please refer to PMS RequestorID/publisherCode list

Yes

string

hotelCode

path

The code that uniquely identifies a single hotel property.

Yes

string

roomTypeCoderatePlanCode

path

The rate plan code that identifies a Room Type.

Yes

string

startDate

query

Start date to query for availabilityrates. Format like yyyy-MM-dd i.e 2017-07-21.

Yes

date

range

query

The number of days to query for. Maximum 30.

No

number

...

Code

Description

Schema

200

OK

Availability

401

Unauthorized

Error

403

Forbidden

Error

429

Too Many Requests

TooManyRequests

500

Internal Server Error

Error

Availability

Availability by

...

Rate Plan

Method: GET
Path: /publishers/{publisherCode}/hotels/{hotelCode}/ratePlans/{ratePlanCode}/availability

Description: Get all  Fetch the availability for a specific given rate plan, hotel, and publisher and date range.

Parameters

Name

Located in

Description

Required

Type

publisherCode

path

The unique identifier for the data publisher. Please refer to PMS RequestorID/publisherCode list

Yes

string

hotelCode

path

The code that uniquely identifies a single hotel property.

Yes

string

ratePlanCode

path

The rate plan code.

Yes

string

startDate

query

Start date to query for availabilityrates. Format like yyyy-MM-dd i.e 2017-07-21.

Yes

date

range

query

The number of days to query for availability. Maximum 30.

No

number

Responses

Code

Description

Schema

200

OK

Availability

401

Unauthorized

Error

403

Forbidden

Error

429

Too Many Requests

TooManyRequests

500

Internal Server Error

Error

RoomTypes

...

Availability by Room Type

Method: GET
Path: /publisher​spublishers/{publisherCode}​/hotel​shotels/{hotelCode}​/roomTypes/{roomTypeCode}/availability

Description: Lists  Get all the Room Types availability for a specific hotel room type, date range, hotel, and publisher.

Parameters

Name

Located in

Description

Required

Type

publisherCode

path

The unique identifier for the data publisher. Please refer to PMS RequestorID/publisherCode list

Yes

string

hotelCode

path

The code that uniquely identifies a single hotel property.

Yes

string

roomTypeCode

path

The code that identifies a Room Type.

Yes

string

startDate

query

Start date to query for availability. Format like yyyy-MM-dd i.e 2017-07-21.

Yes

date

range

query

The number of days to query for. Maximum 30.

No

number

Responses

Code

Description

Schema

200

OK

RoomTypeAvailability

401

Unauthorized

Error

403

Forbidden

Error

429

Too Many Requests

TooManyRequests

500

Internal Server Error

Error

...

Availability by

...

Hotel

Method: GET
Path: ​/publisher​spublishers/{publisherCode}​/hotel​shotels/{hotelCode}​/roomTypes​/{roomTypeCode}availability

Description: Get a specific room type all availability for a specific hotel, publisher and publisher.date range

Parameters

Name

Located in

Description

Required

Type

publisherCode

path

The unique identifier for the data publisher. Please refer to PMS RequestorID/publisherCode list

Yes

string

hotelCode

path

The code that uniquely identifies a single hotel property.

Yes

string

roomTypeCode

path

The code that identifies a Room Type.

Yes

string

startDate

query

Start date to query for availability. Format like yyyy-MM-dd i.e 2017-07-21.

Yes

date

range

query

The number of days to query for availability. Maximum 30.

No

number

Responses

Code

Description

Schema

200

OK

RoomTypeAvailability

401

Unauthorized

Error

403

Forbidden

Error

429

Too Many Requests

TooManyRequests

500

Internal Server Error

Error

...

Rates

Rates by Rate Plan

Method: GET
Path: ​/publisher​spublishers/{publisherCode}​/hotel​shotels/{hotelCode}​/roomTypes​ratePlans/{roomTypeCoderatePlanCode}​/availabilityrates

Description: Get all availability for a specific room type,  Fetch the rates for a rate plan code based on given date range, hotel, and publisher.

Parameters

Name

Located in

Description

Required

Type

publisherCode

path

The unique identifier for the data publisher. Please refer to PMS RequestorID/publisherCode list

Yes

string

hotelCode

path

The code that uniquely identifies a single hotel property.

Yes

string

roomTypeCoderatePlanCode

path

The rate plan code that identifies a Room Type.

Yes

string

startDate

query

Start date to query for availabilityrates. Format like yyyy-MM-dd i.e 2017-07-21.

Yes

date

range

query

The number of days to query for. Maximum 30.

No

number

...

Code

Description

Schema

200

OK

AvailabilityRate

401

Unauthorized

Error

403

Forbidden

Error

429

Too Many Requests

TooManyRequests

500

Internal Server Error

Error

...