Skip to content

Commit

Permalink
Merge pull request #80 from oracle/distribution_24.3.0.0
Browse files Browse the repository at this point in the history
Added distribution specs for release 24.3.0.0
  • Loading branch information
rb80 authored Nov 22, 2024
2 parents cd53d28 + 85d7f30 commit 1caf0cd
Show file tree
Hide file tree
Showing 5 changed files with 88 additions and 14 deletions.
4 changes: 2 additions & 2 deletions rest-api-specs/distribution/distributionauthentication.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"swagger": "2.0",
"info": {
"title": "OPERA Cloud Distribution Authentication API",
"version": "24.2",
"description": "<p> API to obtain the access token (in the JWT format) that matches the provided credentials issued by the Oracle Hospitality Distribution administrator for a specific Distribution channel partner. The token will then be used by API users to access OPERA Cloud Distribution APIS. Once a token is created, it can be used in multiple subsequent calls until it expires as defined in this API response. </p>\n<p> Username for a channel partner Distribution API account is provisioned by an Oracle administrator at the channel level. It is not an OPERA Cloud (PMS) user and not created or approved by the hotelier. Additionally, for each property, the hotelier will need to enable the channel so that it can access data for their specific hotel in the reservation context. </p>\n<p> More information on how to request a username and temporary password for a registered channel for Distribution APIs:\n <ul>\n <li>Channel partners registered via OHIP receive credential(s) from the Oracle Hospitality Distribution administrator during the channel registration.</li>\n </ul>\n</p><br /><br /> Compatible with OPERA Cloud release 24.2.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.</p>",
"version": "24.3",
"description": "<p> API to obtain the access token (in the JWT format) that matches the provided credentials issued by the Oracle Hospitality Distribution administrator for a specific Distribution channel partner. The token will then be used by API users to access OPERA Cloud Distribution APIS. Once a token is created, it can be used in multiple subsequent calls until it expires as defined in this API response. </p>\n<p> Username for a channel partner Distribution API account is provisioned by an Oracle administrator at the channel level. It is not an OPERA Cloud (PMS) user and not created or approved by the hotelier. Additionally, for each property, the hotelier will need to enable the channel so that it can access data for their specific hotel in the reservation context. </p>\n<p> More information on how to request a username and temporary password for a registered channel for Distribution APIs:\n <ul>\n <li>Channel partners registered via OHIP receive credential(s) from the Oracle Hospitality Distribution administrator during the channel registration.</li>\n </ul>\n</p><br /><br /> Compatible with OPERA Cloud release 24.3.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.</p>",
"x-summary": "HDP edge service applying pre authorization and pre routing logic. Example: curl --request POST https://HOSTNAME/hdpba/oauth2/v0/token --header 'Content-Type: application/x-www-form-urlencoded;charset=UTF-8' --header 'Accept: */*' --data-urlencode 'username=USERNAME' --data-urlencode 'password=USERPASSWORD'",
"termsOfService": "https://www.oracle.com/legal/terms.html",
"contact": {
Expand Down
23 changes: 20 additions & 3 deletions rest-api-specs/distribution/distributionreservationbook.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"swagger": "2.0",
"info": {
"title": "OPERA Cloud Distribution Book",
"description": "OPERA Cloud Distribution Reservations API allows authorized channel partners to create and update reservations for any active property in Oracle Hospitality Distribution (regardless if the property is using OPERA Cloud / OPERA V5 / on-premise PMS Versions).<br /><br /> Compatible with OPERA Cloud release 24.2.0.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.</p>",
"version": "24.2.0",
"description": "OPERA Cloud Distribution Reservations API allows authorized channel partners to create and update reservations for any active property in Oracle Hospitality Distribution (regardless if the property is using OPERA Cloud / OPERA V5 / on-premise PMS Versions).<br /><br /> Compatible with OPERA Cloud release 24.3.0.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.</p>",
"version": "24.3.0",
"termsOfService": "https://www.oracle.com/legal/terms.html",
"contact": {
"email": "[email protected]"
Expand Down Expand Up @@ -1248,7 +1248,9 @@
"cardType": "MC",
"cardNumber": "5105 1051 0510 5100 ",
"expirationDate": "06/21",
"cardHolderName": "Mary Smith"
"cardHolderName": "Mary Smith",
"cardNumberMasked": "XXXXXXXXXXXX0005",
"cardOrToken": "Token"
}
}
],
Expand Down Expand Up @@ -3263,6 +3265,21 @@
"description": "Credit card holder name",
"type": "string",
"example": "Mary Smith"
},
"cardNumberMasked": {
"description": "Masked card number.",
"type": "string",
"example": "XXXXXXXXXXXX0005",
"minLength": 0,
"maxLength": 80
},
"cardOrToken": {
"type": "string",
"description": "This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates cardNumber holds token value and 'CardNumber' indicates cardNumber holds credit card number.",
"enum": [
"CardNumber",
"Token"
]
}
},
"required": [
Expand Down
19 changes: 17 additions & 2 deletions rest-api-specs/distribution/distributionreservationnotif.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"swagger": "2.0",
"info": {
"title": "OPERA Cloud Distribution Reservation Notification",
"description": "OPERA Cloud Distribution Reservation Notifications API allows authorized channel partners to create and update reservations for any active property in Oracle Hospitality Distribution (regardless if the property is using OPERA Cloud / OPERA V5 / on-premise PMS Versions). This API is meant to transmit reservations already created and committed in the channel external system and does not perform any Pricing and Availability validation.<br /><br /> Compatible with OPERA Cloud release 24.2.0.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.</p>",
"version": "24.2.0",
"description": "OPERA Cloud Distribution Reservation Notifications API allows authorized channel partners to create and update reservations for any active property in Oracle Hospitality Distribution (regardless if the property is using OPERA Cloud / OPERA V5 / on-premise PMS Versions). This API is meant to transmit reservations already created and committed in the channel external system and does not perform any Pricing and Availability validation.<br /><br /> Compatible with OPERA Cloud release 24.3.0.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.</p>",
"version": "24.3.0",
"termsOfService": "https://www.oracle.com/legal/terms.html",
"contact": {
"email": "[email protected]"
Expand Down Expand Up @@ -2777,6 +2777,21 @@
"description": "Credit card holder name",
"type": "string",
"example": "Mary Smith"
},
"cardNumberMasked": {
"description": "Masked card number.",
"example": "XXXXXXXXXXXX0005",
"type": "string",
"minLength": 0,
"maxLength": 80
},
"cardOrToken": {
"description": "This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates cardNumber holds token value and 'CardNumber' indicates cardNumber holds credit card number.",
"type": "string",
"enum": [
"CardNumber",
"Token"
]
}
},
"required": [
Expand Down
48 changes: 45 additions & 3 deletions rest-api-specs/distribution/distributionshop.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"swagger": "2.0",
"info": {
"title": "OPERA Cloud Distribution Shop",
"description": "Oracle Hospitality Distribution Shop is for distribution partners to find properties availability, room-rates offers for a single property or a specific room-rate offer detail.<br /><br /> Compatible with OPERA Cloud release 24.2.0.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.</p>",
"version": "24.2.0",
"description": "Oracle Hospitality Distribution Shop is for distribution partners to find properties availability, room-rates offers for a single property or a specific room-rate offer detail.<br /><br /> Compatible with OPERA Cloud release 24.3.0.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.</p>",
"version": "24.3.0",
"contact": {
"email": "[email protected]"
},
Expand Down Expand Up @@ -983,7 +983,7 @@
"RatePlanCodeMatchOnly": {
"name": "ratePlanCodeMatchOnly",
"in": "query",
"description": "If true, only requested rate plan code will be shown, otherwise all avalable public rate plan codes will be shown along with requested rate plan code.",
"description": "If true, only rate plan code specified, otherwise public rate plan codes too",
"type": "boolean",
"default": false,
"required": false,
Expand Down Expand Up @@ -1524,6 +1524,13 @@
"availability": {
"$ref": "#/definitions/HotelAvailabilityStatus"
},
"restrictions": {
"description": "List of restrictions for property, only populated when no rate plan codes are given in request",
"type": "array",
"items": {
"$ref": "#/definitions/Restriction"
}
},
"roomTypes": {
"description": "List of the room types selected during the request including room type information, availability status of the room type, and room amenities.",
"type": "array",
Expand Down Expand Up @@ -1704,8 +1711,36 @@
}
]
},
"Restriction": {
"type": "object",
"description": "Holds restriction information that is restricting offer from being available",
"properties": {
"restrictionType": {
"type": "string",
"description": "Type of restriction. <p> Closed: The offer is not restricted to be available. </p> <p> ClosedForArrival: Offer is not available with arrival date with this restriction. </p> <p> ClosedForDeparture: Offer is not available with departure date with this restriction. </p> <p> MinimumStayThrough: Offer duration falls in to this restriction date is not available if minimum number of nights less than set restriction nights. Example if minimum stay through is 2, the offer is not available for less than 2 nights stay. </p> <p> MaximumStayThrough: MaximumStayThrough: Offer duration falls in to this restriction date is not available if maximum number of nights are greater than set restriction nights. Example if maximum stay through is 10, the offer is not available for greater than 10 nights stay. </p> <p> MinimumAdvancedBooking: Offer is not available if arrival date and booking date window is less than this restriction setting. </p> <p> MaximumAdvancedBooking: Offer is not available if arrival date and booking date window is greater than this restriction setting. </p> <p> LOSNotAvailable: If the offer arrival date has this restriction, the offer is available for the duration where length of stay is not restricted. Example if length of stay not available set to Open, close, close, open, open, close, open. Offer arrival date with this restriction is available for number of nights, 1, 4,5, 7, and onwards.</p>",
"enum": [
"Closed",
"ClosedForArrival",
"ClosedForDeparture",
"MinimumStayThrough",
"MaximumStayThrough",
"MinimumLengthOfStay",
"MaximumLengthOfStay",
"MinimumAdvancedBooking",
"MaximumAdvancedBooking",
"LOSNotAvailable"
]
},
"restrictionValue": {
"type": "integer",
"description": "The specific number of days for the selected restriction. This field applies to restriction type MinimumStayThrough, MaximumStayThrough, MinimumLengthOfStay, MaximumLengthOfStay, MinimumAdvancedBooking, and MaximumAdvancedBooking only.",
"example": 10
}
}
},
"PropertyOffersRoomType": {
"type": "object",
"description": "Room Type information",
"properties": {
"availabilityStatus": {
"type": "object",
Expand Down Expand Up @@ -1892,6 +1927,13 @@
"items": {
"$ref": "#/definitions/PromotionCodeItem"
}
},
"restrictions": {
"description": "List of restrictions for rate plan, only populated when rate plan codes are given in request",
"type": "array",
"items": {
"$ref": "#/definitions/Restriction"
}
}
}
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"swagger": "2.0",
"info": {
"title": "OPERA Cloud Distribution ARI Publication",
"version": "24.2",
"description": "Oracle Hospitality Distribution ARI publication message specification for distribution partners to receive in real time property restrictions/availability, rate, and inventory schedules updates, also known as ARI. Partner receives this message will respond with success or error/warning so that property/CRS user can see the status of message delivery in OPERA. A channel code identifier is required in Oracle Hospitality Distribution to receive those messages.<br /><br /> Compatible with OPERA Cloud release 24.2.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.</p>",
"version": "24.3",
"description": "Oracle Hospitality Distribution ARI publication message specification for distribution partners to receive in real time property restrictions/availability, rate, and inventory schedules updates, also known as ARI. Partner receives this message will respond with success or error/warning so that property/CRS user can see the status of message delivery in OPERA. A channel code identifier is required in Oracle Hospitality Distribution to receive those messages.<br /><br /> Compatible with OPERA Cloud release 24.3.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.</p>",
"contact": {
"email": "[email protected]"
},
Expand Down Expand Up @@ -60,7 +60,7 @@
},
"summary": "Publish Inventory",
"operationId": "Publish Inventory",
"description": "This message will provide property room type inventory (rooms to sell) by date to the distribution (full synchronization or delta updates)<p><strong>OperationId:</strong>Publish Inventory</p>",
"description": "This message will provide property room type inventory (rooms to sell) by date to the distribution (full synchronization or delta updates). <p><strong>OperationId:</strong>Publish Inventory</p>",
"tags": [
"Publish Inventory"
],
Expand Down Expand Up @@ -182,7 +182,7 @@
},
"summary": "Publish Restrictions",
"operationId": "Publish Restrictions",
"description": "This message will provide property rate plan-room type restrictions by date to the distribution (full synchronization or delta updates)<p><strong>OperationId:</strong>Publish Restrictions</p>",
"description": "This message will provide property rate plan-room type restrictions by date to the distribution (full synchronization or delta updates) <p><strong>OperationId:</strong>Publish Restrictions</p>",
"tags": [
"Publish Restrictions"
],
Expand Down

0 comments on commit 1caf0cd

Please sign in to comment.