102 lines
2.6 KiB
JSON
102 lines
2.6 KiB
JSON
{
|
|
"request_id": "dcc4e1de-2920-4adc-8ae5-97786cc445cb",
|
|
"catalog_version": "0.7.0",
|
|
"operation": {
|
|
"operation_id": "getProfiles",
|
|
"method": "GET",
|
|
"path": "/api/v1/profiles",
|
|
"summary": "Search profiles with allowlisted query fields",
|
|
"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": [
|
|
"excludeInactive",
|
|
"limit",
|
|
"offset",
|
|
"searchType",
|
|
"summaryInfo",
|
|
"searchString",
|
|
"profileType",
|
|
"profileIds",
|
|
"externalReferenceIds",
|
|
"externalSystemCodes",
|
|
"corporateIds",
|
|
"profileName",
|
|
"givenName",
|
|
"city",
|
|
"postalCode",
|
|
"state",
|
|
"countryCode",
|
|
"streetAddress",
|
|
"keyword",
|
|
"communication",
|
|
"membership",
|
|
"membershipType",
|
|
"ownerCodes",
|
|
"membershipLevel",
|
|
"aRNumber",
|
|
"businessSegment",
|
|
"accountsReceivables",
|
|
"corporateProfiles",
|
|
"excludeIncompleteProfiles",
|
|
"negotiatedRates",
|
|
"fetchInstructions",
|
|
"vipCodes",
|
|
"phone",
|
|
"email",
|
|
"lastStayBefore"
|
|
],
|
|
"contract": {
|
|
"operationId": "getProfiles",
|
|
"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 with allowlisted query fields",
|
|
"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",
|
|
"x-sensitive-query-fields-excluded": [
|
|
"birthDate",
|
|
"taxID",
|
|
"identificationNo"
|
|
]
|
|
}
|
|
}
|
|
}
|