204 lines
6.7 KiB
JSON
204 lines
6.7 KiB
JSON
{
|
|
"version": "arr-rate-info-contract/v1",
|
|
"catalog_version": "0.7.0",
|
|
"selected_operation": "searchRateInfo",
|
|
"operations": {
|
|
"getRateInfo": {
|
|
"method": "GET",
|
|
"path": "/api/v1/reservations/rate-info",
|
|
"capability_group": "reservations.read",
|
|
"integration": {
|
|
"pattern": "sync-read",
|
|
"prerequisites": [
|
|
"Approved reservations.read application capability",
|
|
"Oracle query span at most 21 days; split larger ranges explicitly in consuming code"
|
|
],
|
|
"retry": "Read-only query (including POST search); retry transient failures with bounded backoff and honor Retry-After. No reservation or price is modified."
|
|
},
|
|
"deprecated": true
|
|
},
|
|
"searchRateInfo": {
|
|
"method": "POST",
|
|
"path": "/api/v1/reservations/rate-info/searches",
|
|
"capability_group": "reservations.read",
|
|
"integration": {
|
|
"pattern": "sync-read",
|
|
"prerequisites": [
|
|
"Approved reservations.read application capability",
|
|
"Oracle query span at most 21 days; split larger ranges explicitly in consuming code"
|
|
],
|
|
"retry": "Read-only query (including POST search); retry transient failures with bounded backoff and honor Retry-After. No reservation or price is modified."
|
|
},
|
|
"deprecated": false
|
|
}
|
|
},
|
|
"request_properties": {
|
|
"adults": {
|
|
"description": "Defines the number of Adults.",
|
|
"type": "integer"
|
|
},
|
|
"blockId": {
|
|
"description": "A unique identifying value assigned by the creating system. Reference for block.",
|
|
"type": "string"
|
|
},
|
|
"blockIdType": {
|
|
"description": "A reference to the type of object defined by the UniqueID element.",
|
|
"type": "string"
|
|
},
|
|
"bucket1Count": {
|
|
"description": "Number of children classified under the first Age Qualifying Group(Child Bucket#1).",
|
|
"type": "integer"
|
|
},
|
|
"bucket2Count": {
|
|
"description": "Number of children classified under the second Age Qualifying Group(Child Bucket#2).",
|
|
"type": "integer"
|
|
},
|
|
"bucket3Count": {
|
|
"description": "Number of children classified under the third Age Qualifying Group(Child Bucket#3).",
|
|
"type": "integer"
|
|
},
|
|
"bucket4Count": {
|
|
"description": "Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).",
|
|
"type": "integer"
|
|
},
|
|
"bucket5Count": {
|
|
"description": "Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).",
|
|
"type": "integer"
|
|
},
|
|
"childAge": {
|
|
"description": "Age of a child in years.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"children": {
|
|
"description": "Defines the number of Children.",
|
|
"type": "integer"
|
|
},
|
|
"criteriaEndDate": {
|
|
"format": "date",
|
|
"type": "string"
|
|
},
|
|
"criteriaStartDate": {
|
|
"format": "date",
|
|
"type": "string"
|
|
},
|
|
"currencyCode": {
|
|
"description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.",
|
|
"type": "string"
|
|
},
|
|
"detailDate": {
|
|
"description": "Required when detailed results are needed. The date for the rate detail is needed.",
|
|
"format": "date",
|
|
"type": "string"
|
|
},
|
|
"effectiveRateEnd": {
|
|
"description": "The ending value(s) of the date range.",
|
|
"items": {
|
|
"format": "date",
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"effectiveRateStart": {
|
|
"description": "The starting value(s) of the date range.",
|
|
"items": {
|
|
"format": "date",
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"id": {
|
|
"description": "A unique identifying value assigned by the creating system.",
|
|
"type": "string"
|
|
},
|
|
"idContext": {
|
|
"description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
|
|
"type": "string"
|
|
},
|
|
"idExtension": {
|
|
"description": "Additional identifying value assigned by the creating system.",
|
|
"type": "integer"
|
|
},
|
|
"ratePlanCode": {
|
|
"description": "Used for codes in the OPERA Code tables. Example: 1, 101, 101.EQP, 101.EQP.X",
|
|
"type": "string"
|
|
},
|
|
"roomType": {
|
|
"description": "Code for the room type, eg 1, 101, 101.EQP, or 101.EQP.X",
|
|
"type": "string"
|
|
},
|
|
"summaryInfo": {
|
|
"description": "Flag to indicate if summary information is required.",
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"description": "A reference to the type of object defined by the UniqueID element.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"effective_rate_schema": {
|
|
"description": "Effective Rate for the specified reservation and date",
|
|
"type": "number"
|
|
},
|
|
"response_schema": {
|
|
"description": "Response will either be Summary or Detail type, but not both. See the request for the summary attribute flag.",
|
|
"properties": {
|
|
"detail": {
|
|
"description": "The revenue information for the rate code.",
|
|
"properties": {
|
|
"packages": {
|
|
"description": "Package information for the rate code.",
|
|
"items": {
|
|
"$ref": "#/components/schemas/rate_rsv_totalType"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"rateSuppressed": {
|
|
"description": "Indicates if the rate is to be hidden.",
|
|
"type": "boolean"
|
|
},
|
|
"revenue": {
|
|
"$ref": "#/components/schemas/rate_rsv_totalType",
|
|
"description": "The revenue information for the rate code."
|
|
},
|
|
"totalPackageAmount": {
|
|
"description": "A sum of the Package Prices for the specified reservation and date",
|
|
"type": "number"
|
|
},
|
|
"totalRateAmount": {
|
|
"description": "Effective Rate for the specified reservation and date",
|
|
"type": "number"
|
|
},
|
|
"totalTaxAmount": {
|
|
"description": "A sum of the Taxes for the specified reservation and date",
|
|
"type": "number"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"links": {
|
|
"$ref": "#/components/schemas/rate_rsv_links"
|
|
},
|
|
"summary": {
|
|
"$ref": "#/components/schemas/rate_rsv_reservationRateSummaryType"
|
|
},
|
|
"warnings": {
|
|
"$ref": "#/components/schemas/rate_rsv_warningsType"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"source_pins": {
|
|
"getRateInfo": {
|
|
"request_id": "f0218295-d8cd-460d-916b-39becbb4f40d",
|
|
"sha256": "9829280457e32e8e519deab33a6de6c3e92f9dc271c1f0b9c862a0226972102e"
|
|
},
|
|
"searchRateInfo": {
|
|
"request_id": "33b7cf76-a18a-4a14-b45e-f198d2837ba1",
|
|
"sha256": "abe3924962c807a833368bffbeb6eaa27b951a25256928b5f152b17f3201c604"
|
|
}
|
|
}
|
|
}
|