Files
ARR-2.0-0918/integrations/ohip/profile-summary-catalog-20260916.json
T

114 lines
3.4 KiB
JSON

{
"ok": true,
"status": 200,
"request_id": "bf17cd78-c8c2-451a-ab7c-5249f57b2dc7",
"data": {
"components": {
"requestBodies": {
"OptionalOracleDocument": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OracleDocument"
}
}
},
"description": "JSON object shaped for the named fixed Oracle operation; an omitted body becomes an empty object.",
"required": false
}
},
"schemas": {
"OracleDocument": {
"additionalProperties": true,
"description": "Bounded operation-specific Oracle JSON. Hotel references, when present, must match the server's configured hotel. Exact fields follow the named Oracle Property API 26.3 schema.",
"type": "object"
},
"OHIPDocument": {
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/components/schemas/OracleDocument"
},
"hotel_id": {
"type": "string"
},
"operation_id": {
"type": "string"
},
"oracle_request_id": {
"type": "string"
}
},
"required": [
"operation_id",
"hotel_id",
"oracle_request_id",
"data"
],
"type": "object"
}
}
},
"operation": {
"operation_id": "searchProfiles",
"method": "POST",
"path": "/api/v1/profiles/searches",
"summary": "Search profiles using the Oracle search document",
"capability_group": "profiles.read",
"integration": {
"pattern": "sync-read",
"prerequisites": [
"Approved application capability"
],
"retry": "Read-only operation; retry transient failures with bounded backoff and honor Retry-After. Validation requests do not persist changes."
},
"query_names": [],
"contract": {
"operationId": "searchProfiles",
"requestBody": {
"$ref": "#/components/requestBodies/OptionalOracleDocument"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OHIPDocument"
}
}
},
"description": "Bounded Oracle document in the stable edge envelope.",
"headers": {
"Cache-Control": {
"schema": {
"const": "no-store",
"type": "string"
}
}
}
},
"default": {
"$ref": "#/components/responses/Error"
}
},
"security": [
{
"CallerAPIKey": []
}
],
"summary": "Search profiles using the Oracle search document",
"x-capability-group": "profiles.read",
"x-integration": {
"pattern": "sync-read",
"prerequisites": [
"Approved application capability"
],
"retry": "Read-only operation; retry transient failures with bounded backoff and honor Retry-After. Validation requests do not persist changes."
},
"x-oracle-api": "CRM"
}
},
"version": "0.7.0"
}
}