{"components":{"parameters":{"AccountID":{"in":"path","name":"accountID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},"AuditCallerID":{"in":"query","name":"caller_id","required":false,"schema":{"type":"string"}},"AuditCursor":{"in":"query","name":"cursor","required":false,"schema":{"format":"int64","minimum":1,"type":"integer"}},"AuditFrom":{"description":"Inclusive UTC start; defaults to 24 hours before `to`.","in":"query","name":"from","required":false,"schema":{"format":"date-time","type":"string"}},"AuditLimit":{"in":"query","name":"limit","required":false,"schema":{"default":50,"maximum":200,"minimum":1,"type":"integer"}},"AuditOperationID":{"in":"query","name":"operation_id","required":false,"schema":{"type":"string"}},"AuditRequestID":{"in":"query","name":"request_id","required":false,"schema":{"type":"string"}},"AuditResult":{"in":"query","name":"result","required":false,"schema":{"enum":["succeeded","denied","rejected","failed","incomplete"],"type":"string"}},"AuditSurface":{"in":"query","name":"surface","required":false,"schema":{"enum":["business","admin"],"type":"string"}},"AuditTo":{"description":"Inclusive UTC end; defaults to the current time. Ranges are limited to 90 days.","in":"query","name":"to","required":false,"schema":{"format":"date-time","type":"string"}},"BlockID":{"in":"path","name":"blockID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},"CSRFToken":{"description":"Required for unsafe requests authenticated with AdminSession; omitted for AdminAPIKey requests.","in":"header","name":"X-CSRF-Token","required":false,"schema":{"type":"string"}},"CallerID":{"in":"path","name":"callerID","required":true,"schema":{"type":"string"}},"JobID":{"in":"path","name":"jobID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},"KeyID":{"in":"path","name":"keyID","required":true,"schema":{"type":"string"}},"ProfileID":{"in":"path","name":"profileID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},"RatePlanCode":{"in":"path","name":"ratePlanCode","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},"ReservationID":{"in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},"RoomTypeCode":{"in":"path","name":"roomTypeCode","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}},"requestBodies":{"ConfirmedWrite":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteRequest"}}},"required":true},"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},"RequiredOracleDocument":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OracleDocument"}}},"description":"JSON object shaped for the named fixed Oracle operation.","required":true}},"responses":{"Error":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Request failed with a stable edge error code."}},"schemas":{"APIKey":{"properties":{"caller_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"expires_at":{"format":"date-time","type":["string","null"]},"id":{"type":"string"},"issuance_id":{"description":"Correlation for cancelling a failed credential delivery; never a secret.","type":"string"},"revoked_at":{"format":"date-time","type":["string","null"]}},"required":["id","caller_id","created_at"],"type":"object"},"AdminUser":{"additionalProperties":false,"properties":{"capability_ceiling":{"$ref":"#/components/schemas/CapabilityGroupIDs"},"created_at":{"format":"date-time","type":"string"},"enabled":{"type":"boolean"},"id":{"type":"string"},"last_login_at":{"format":"date-time","type":"string"},"must_change_password":{"type":"boolean"},"password_changed_at":{"format":"date-time","type":"string"},"role":{"$ref":"#/components/schemas/UserRole"},"username":{"type":"string"}},"required":["id","username","enabled","created_at","role","capability_ceiling","must_change_password"],"type":"object"},"AuditChange":{"additionalProperties":false,"properties":{"after":{"$ref":"#/components/schemas/AuditState"},"api_key_id":{"type":"string"},"before":{"$ref":"#/components/schemas/AuditState"},"caller_id":{"type":"string"},"owner_user_id":{"type":"string"},"target_principal_id":{"type":"string"},"target_user_id":{"type":"string"}},"type":"object"},"AuditPage":{"additionalProperties":false,"properties":{"items":{"items":{"$ref":"#/components/schemas/AuditRecord"},"type":"array"},"next_cursor":{"format":"int64","minimum":1,"type":"integer"}},"required":["items"],"type":"object"},"AuditRecord":{"additionalProperties":false,"properties":{"admin_user_id":{"type":"string"},"api_key_id":{"type":"string"},"automation_principal_id":{"type":"string"},"caller_id":{"type":"string"},"capability_groups":{"$ref":"#/components/schemas/CapabilityGroupIDs"},"change":{"$ref":"#/components/schemas/AuditChange"},"completed_at":{"format":"date-time","type":"string"},"deployment_environment":{"type":"string"},"duration_ms":{"format":"int64","minimum":0,"type":"integer"},"edge_error_code":{"type":"string"},"hotel_id":{"type":"string"},"method":{"type":"string"},"operation_id":{"type":"string"},"oracle_request_id":{"type":"string"},"owner_user_id":{"description":"Human owner of the acting Automation Principal at authentication time when recorded.","type":"string"},"request_id":{"type":"string"},"result_class":{"enum":["succeeded","denied","rejected","failed","incomplete"],"type":"string"},"retry_count":{"minimum":0,"type":"integer"},"route_pattern":{"type":"string"},"sequence_id":{"format":"int64","type":"integer"},"started_at":{"format":"date-time","type":"string"},"status_code":{"maximum":599,"minimum":100,"type":"integer"},"surface":{"enum":["business","admin"],"type":"string"}},"required":["sequence_id","request_id","surface","operation_id","method","route_pattern","capability_groups","deployment_environment","result_class","started_at"],"type":"object"},"AuditState":{"additionalProperties":false,"properties":{"automation_principal_id":{"type":"string"},"capability_ceiling":{"$ref":"#/components/schemas/CapabilityGroupIDs"},"capability_groups":{"$ref":"#/components/schemas/CapabilityGroupIDs"},"enabled":{"type":"boolean"},"must_change_password":{"type":"boolean"},"owner_user_id":{"type":"string"},"role":{"$ref":"#/components/schemas/UserRole"}},"type":"object"},"AuditSummary":{"additionalProperties":false,"properties":{"denied":{"format":"int64","minimum":0,"type":"integer"},"failed":{"format":"int64","minimum":0,"type":"integer"},"incomplete":{"format":"int64","minimum":0,"type":"integer"},"rejected":{"format":"int64","minimum":0,"type":"integer"},"succeeded":{"format":"int64","minimum":0,"type":"integer"},"total":{"format":"int64","minimum":0,"type":"integer"}},"required":["total","succeeded","denied","rejected","failed","incomplete"],"type":"object"},"AutomationPrincipal":{"additionalProperties":false,"properties":{"capability_ceiling":{"$ref":"#/components/schemas/CapabilityGroupIDs"},"created_at":{"format":"date-time","type":"string"},"effective_capability_ceiling":{"$ref":"#/components/schemas/CapabilityGroupIDs"},"expires_at":{"format":"date-time","type":"string"},"id":{"type":"string"},"name":{"type":"string"},"owner_role":{"enum":["admin","developer","auditor"],"type":"string"},"owner_user_id":{"type":"string"},"revoked_at":{"format":"date-time","type":"string"},"scopes":{"items":{"type":"string"},"type":"array"}},"required":["id","name","scopes","capability_ceiling","created_at","effective_capability_ceiling"],"type":"object"},"BookingPayload_postCancelReservation":{"additionalProperties":false,"properties":{"reason":{"additionalProperties":false,"properties":{"code":{"minLength":1,"type":"string"},"description":{"type":"string"}},"required":["code"],"type":"object"},"reservations":{"items":{"additionalProperties":false,"properties":{"externalCancellationId":{"maxLength":50,"minLength":1,"type":"string"},"hotelId":{"description":"Must match configured OHIP_HOTEL_ID and expected_hotel_id.","minLength":1,"type":"string"},"reservationIdList":{"items":{"additionalProperties":false,"properties":{"id":{"minLength":1,"type":"string"},"type":{"const":"Reservation","type":"string"}},"required":["id","type"],"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"required":["hotelId","reservationIdList"],"type":"object"},"maxItems":1,"minItems":1,"type":"array"},"verificationOnly":{"const":false,"type":"boolean"}},"required":["verificationOnly","reason","reservations"],"type":"object"},"BookingPayload_postProfile":{"additionalProperties":false,"properties":{"profileDetails":{"allOf":[{"$ref":"#/components/schemas/booking_crm_profileType"},{"properties":{"addresses":{"properties":{"addressInfo":{"items":{"properties":{"address":{"properties":{"country":{"properties":{"code":{"minLength":1,"type":"string"}},"required":["code"],"type":"object"}},"required":["country"],"type":"object"}},"required":["address"],"type":"object"},"minItems":1,"type":"array"}},"required":["addressInfo"],"type":"object"},"customer":{"properties":{"personName":{"items":{"properties":{"surname":{"minLength":1,"type":"string"}},"required":["surname"],"type":"object"},"minItems":1,"type":"array"}},"required":["personName"],"type":"object"},"profileType":{"const":"Guest"},"registeredProperty":{"description":"Must match configured OHIP_HOTEL_ID and expected_hotel_id.","minLength":1,"type":"string"}},"required":["profileType","registeredProperty","customer","addresses"],"type":"object"}]}},"required":["profileDetails"],"type":"object"},"BookingPayload_putBlockAllocation":{"additionalProperties":false,"properties":{"criteria":{"additionalProperties":false,"properties":{"allocationRoomTypes":{"items":{"additionalProperties":false,"properties":{"allocationGridDates":{"items":{"additionalProperties":false,"properties":{"allocation":{"enum":["INITIAL","ACTUAL"]},"roomAllocationInfo":{"items":{"additionalProperties":false,"properties":{"end":{"format":"date","type":"string"},"inventory":{"additionalProperties":false,"minProperties":1,"properties":{"fourPerson":{"minimum":0,"type":"integer"},"onePerson":{"minimum":0,"type":"integer"},"threePerson":{"minimum":0,"type":"integer"},"twoPerson":{"minimum":0,"type":"integer"}},"required":[],"type":"object"},"start":{"format":"date","type":"string"}},"required":["start","end","inventory"],"type":"object"},"minItems":1,"type":"array"}},"required":["allocation","roomAllocationInfo"],"type":"object"},"minItems":1,"type":"array"},"roomType":{"minLength":1,"type":"string"}},"required":["roomType","allocationGridDates"],"type":"object"},"minItems":1,"type":"array"},"blockId":{"additionalProperties":false,"properties":{"id":{"minLength":1,"type":"string"},"type":{"const":"Block","type":"string"}},"required":["id","type"],"type":"object"},"hotelId":{"description":"Must match configured OHIP_HOTEL_ID and expected_hotel_id.","minLength":1,"type":"string"}},"required":["hotelId","blockId","allocationRoomTypes"],"type":"object"}},"required":["criteria"],"type":"object"},"BookingPayload_putBlockStatus":{"additionalProperties":false,"properties":{"changeBlockStatus":{"additionalProperties":false,"properties":{"applyChangesToCateringSatus":{"const":false,"type":"boolean"},"blockId":{"additionalProperties":false,"properties":{"id":{"minLength":1,"type":"string"},"type":{"const":"Block","type":"string"}},"required":["id","type"],"type":"object"},"cancelAllPMReservations":{"const":false,"type":"boolean"},"cancellationDetails":{"additionalProperties":false,"properties":{"cancellationCode":{"additionalProperties":false,"properties":{"code":{"minLength":1,"type":"string"},"description":{"type":"string"}},"required":["code"],"type":"object"}},"required":["cancellationCode"],"type":"object"},"currentBlockStatus":{"minLength":1,"type":"string"},"hotelId":{"description":"Must match configured OHIP_HOTEL_ID and expected_hotel_id.","minLength":1,"type":"string"},"newBlockStatus":{"minLength":1,"type":"string"},"overbookAll":{"const":false,"type":"boolean"},"overrideEventsProcessingWarnings":{"const":false,"type":"boolean"}},"required":["hotelId","blockId","currentBlockStatus","newBlockStatus","cancellationDetails"],"type":"object"},"verificationOnly":{"const":false,"type":"boolean"}},"required":["verificationOnly","changeBlockStatus"],"type":"object"},"BookingWriteResult":{"additionalProperties":false,"properties":{"hotel_id":{"minLength":1,"type":"string"},"operation_id":{"minLength":1,"type":"string"},"oracle_request_id":{"minLength":1,"type":"string"},"receipt":{"description":"Original Oracle receipt, including cancellation IDs when supplied; absent on replay. Not stored by Edge.","type":"object"},"replayed":{"type":"boolean"},"resource":{"description":"Oracle readback document, or empty document while pending. Allocation data contains pages, query and pagination_complete; complete pagination is not inventory equality.","type":"object"},"resource_id":{"minLength":1,"type":"string"},"status":{"enum":["verified","pending_verification"]},"upstream_status":{"enum":[200,201]}},"required":["operation_id","hotel_id","resource_id","status","replayed","oracle_request_id","upstream_status","resource"],"type":"object"},"BusinessDate":{"additionalProperties":false,"examples":[{"business_date":"2026-09-09","hotel_id":"TEST"}],"properties":{"business_date":{"format":"date","type":"string"},"hotel_id":{"type":"string"}},"required":["hotel_id","business_date"],"type":"object"},"Caller":{"properties":{"active_key_count":{"minimum":0,"type":"integer"},"automation_principal_id":{"description":"Explicit single Agent management binding.","type":"string"},"capability_groups":{"$ref":"#/components/schemas/CapabilityGroupIDs"},"created_at":{"format":"date-time","type":"string"},"enabled":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"},"owner_user_id":{"description":"Current human owner; omitted means platform-managed.","type":"string"}},"required":["id","name","enabled","capability_groups","active_key_count","created_at"],"type":"object"},"CapabilityGroup":{"additionalProperties":false,"properties":{"description":{"type":"string"},"id":{"enum":["hotel.read","reservations.read","reservations.write","profiles.read","blocks.read","blocks.write","configuration.read","configuration.write","reservations.async","finance.read","finance.async"],"type":"string"},"label":{"type":"string"}},"required":["id","label","description"],"type":"object"},"CapabilityGroupIDs":{"items":{"enum":["hotel.read","reservations.read","reservations.write","profiles.read","blocks.read","blocks.write","configuration.read","configuration.write","reservations.async","finance.read","finance.async"],"type":"string"},"type":"array","uniqueItems":true},"ConfirmedWriteRequest":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"description":"Must exactly equal the server's configured OHIP_HOTEL_ID.","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"$ref":"#/components/schemas/OracleDocument"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","payload"],"type":"object"},"ConfirmedWriteResult":{"additionalProperties":false,"properties":{"hotel_id":{"type":"string"},"operation_id":{"type":"string"},"oracle_request_id":{"type":"string"},"replayed":{"type":"boolean"},"resource":{"$ref":"#/components/schemas/OHIPDocument"},"resource_id":{"type":"string"},"status":{"const":"verified","type":"string"}},"required":["operation_id","hotel_id","resource_id","status","replayed","oracle_request_id","resource"],"type":"object"},"ErrorEnvelope":{"properties":{"error":{"properties":{"code":{"type":"string"},"message":{"type":"string"},"request_id":{"type":"string"}},"required":["code","message","request_id"],"type":"object"}},"required":["error"],"type":"object"},"IntegrationManifest":{"additionalProperties":false,"properties":{"acknowledged_operations":{"items":{"type":"string"},"type":"array"},"application":{"maxLength":100,"minLength":1,"type":"string"},"catalog_version":{"type":"string"},"operations":{"items":{"type":"string"},"minItems":1,"type":"array"},"version":{"const":"ohip.integration/v1","type":"string"}},"required":["version","catalog_version","application","operations","acknowledged_operations"],"type":"object"},"IntegrationPlan":{"additionalProperties":false,"properties":{"capability_groups":{"$ref":"#/components/schemas/CapabilityGroupIDs"},"implied_operations":{"items":{"type":"string"},"type":"array"},"manifest":{"$ref":"#/components/schemas/IntegrationManifest"},"ready":{"type":"boolean"}},"required":["manifest","capability_groups","implied_operations","ready"],"type":"object"},"IssuedAPIKey":{"properties":{"key":{"$ref":"#/components/schemas/APIKey"},"value":{"description":"Plaintext API Key shown only once.","type":"string"}},"required":["key","value"],"type":"object"},"IssuedUser":{"additionalProperties":false,"properties":{"temporary_password":{"description":"One-time secret, never in list or audit.","type":"string"},"user":{"$ref":"#/components/schemas/AdminUser"}},"required":["user","temporary_password"],"type":"object"},"JobAccepted":{"additionalProperties":false,"examples":[{"hotel_id":"TEST","job_id":"example-job","operation_id":"startReservationsDailySummaryProcess","oracle_request_id":"example-request","status":"accepted"}],"properties":{"hotel_id":{"type":"string"},"job_id":{"type":"string"},"operation_id":{"type":"string"},"oracle_request_id":{"type":"string"},"status":{"const":"accepted","type":"string"}},"required":["operation_id","hotel_id","job_id","status","oracle_request_id"],"type":"object"},"JobStatus":{"additionalProperties":false,"examples":[{"hotel_id":"TEST","job_id":"example-job","operation_id":"getReservationsProcessStatus","oracle_request_id":"example-request","poll_after":"5","status":"processing"}],"properties":{"hotel_id":{"type":"string"},"job_id":{"type":"string"},"operation_id":{"type":"string"},"oracle_request_id":{"type":"string"},"poll_after":{"description":"Seconds before the next poll, when supplied by Oracle.","type":"string"},"status":{"enum":["processing","completed","invalid"],"type":"string"}},"required":["operation_id","hotel_id","job_id","status","oracle_request_id"],"type":"object"},"OHIPDocument":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/OracleDocument"},"hotel_id":{"type":"string"},"operation_id":{"type":"string"},"oracle_request_id":{"type":"string"},"upstream_status":{"description":"Native Oracle HTTP status; 204 retains an empty data object.","type":"integer"}},"required":["operation_id","hotel_id","oracle_request_id","data"],"type":"object"},"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"},"Status":{"properties":{"status":{"type":"string"}},"required":["status"],"type":"object"},"UserPage":{"additionalProperties":false,"properties":{"items":{"items":{"$ref":"#/components/schemas/AdminUser"},"type":"array"},"next_cursor":{"type":"string"}},"required":["items"],"type":"object"},"UserRole":{"enum":["admin","developer","auditor"],"type":"string"},"blkcfg_blockCancellationReasonType":{"description":"Contains Common Master configuration detail.","properties":{"code":{"description":"Common Master unique code.","maxLength":40,"minLength":0,"type":"string"},"description":{"$ref":"#/components/schemas/blkcfg_translationTextType2000","description":"Description of the Master code."},"displayOrder":{"description":"Common Master record sequence number.","type":"number"},"inactive":{"description":"Indicates whether the Block Cancellation Reason is inactive or not, returns TRUE when inactive","type":"boolean"},"managedBy":{"$ref":"#/components/schemas/blkcfg_managedByOptions"}},"type":"object"},"blkcfg_blockCancellationReasonsCriteria":{"description":"Request object for creating Block Cancellation Reasons.","properties":{"blockCancellationReasons":{"$ref":"#/components/schemas/blkcfg_blockCancellationReasonsType","description":"Block Cancellation Reasons to be created."},"links":{"$ref":"#/components/schemas/blkcfg_links"},"warnings":{"$ref":"#/components/schemas/blkcfg_warningsType"}},"type":"object"},"blkcfg_blockCancellationReasonsToBeChanged":{"description":"Request object for changing Block Cancellation Reasons.","properties":{"blockCancellationReasons":{"$ref":"#/components/schemas/blkcfg_blockCancellationReasonsType","description":"Block Cancellation Reasons to be changed."},"links":{"$ref":"#/components/schemas/blkcfg_links"},"warnings":{"$ref":"#/components/schemas/blkcfg_warningsType"}},"type":"object"},"blkcfg_blockCancellationReasonsType":{"description":"List of Block Cancellation Reasons.","items":{"$ref":"#/components/schemas/blkcfg_blockCancellationReasonType"},"maxItems":4000,"type":"array"},"blkcfg_blockLostBookingCodeType":{"description":"Contains Common Master configuration detail.","properties":{"code":{"description":"Common Master unique code.","maxLength":40,"minLength":0,"type":"string"},"description":{"$ref":"#/components/schemas/blkcfg_translationTextType2000","description":"Description of the Master code."},"displayOrder":{"description":"Common Master record sequence number.","type":"number"},"inactive":{"description":"Indicates whether the Block Lost Reason is inactive or not, returns TRUE when inactive","type":"boolean"},"managedBy":{"$ref":"#/components/schemas/blkcfg_managedByOptions"}},"type":"object"},"blkcfg_blockLostBookingCodesCriteria":{"description":"Request object for creating Block Lost Booking Codes.","properties":{"blockLostBookingCodes":{"$ref":"#/components/schemas/blkcfg_blockLostBookingCodesType","description":"Block Lost Booking Codes to be created."},"links":{"$ref":"#/components/schemas/blkcfg_links"},"warnings":{"$ref":"#/components/schemas/blkcfg_warningsType"}},"type":"object"},"blkcfg_blockLostBookingCodesToBeChanged":{"description":"Request object for changing Block Lost Booking Codes.","properties":{"blockLostBookingCodes":{"$ref":"#/components/schemas/blkcfg_blockLostBookingCodesType","description":"Block Lost Booking Codes to be changed."},"links":{"$ref":"#/components/schemas/blkcfg_links"},"warnings":{"$ref":"#/components/schemas/blkcfg_warningsType"}},"type":"object"},"blkcfg_blockLostBookingCodesType":{"description":"List of Block Lost Booking Codes.","items":{"$ref":"#/components/schemas/blkcfg_blockLostBookingCodeType"},"maxItems":4000,"type":"array"},"blkcfg_blockRateOverrideReasonType":{"description":"Contains Common Master configuration detail.","properties":{"code":{"description":"Common Master unique code.","maxLength":40,"minLength":0,"type":"string"},"description":{"$ref":"#/components/schemas/blkcfg_translationTextType2000","description":"Description of the Master code."},"displayOrder":{"description":"Common Master record sequence number.","type":"number"},"managedBy":{"$ref":"#/components/schemas/blkcfg_managedByOptions"}},"type":"object"},"blkcfg_blockRateOverrideReasonsCriteria":{"description":"Request object for creating Block Rate Override Reasons.","properties":{"blockRateOverrideReasons":{"$ref":"#/components/schemas/blkcfg_blockRateOverrideReasonsType","description":"Block Rate Override Reasons to be created."},"links":{"$ref":"#/components/schemas/blkcfg_links"},"warnings":{"$ref":"#/components/schemas/blkcfg_warningsType"}},"type":"object"},"blkcfg_blockRateOverrideReasonsToBeChanged":{"description":"Request object for changing Block Rate Override Reasons.","properties":{"blockRateOverrideReasons":{"$ref":"#/components/schemas/blkcfg_blockRateOverrideReasonsType","description":"Block Rate Override Reasons to be changed."},"links":{"$ref":"#/components/schemas/blkcfg_links"},"warnings":{"$ref":"#/components/schemas/blkcfg_warningsType"}},"type":"object"},"blkcfg_blockRateOverrideReasonsType":{"description":"List of Block Rate Override Reasons.","items":{"$ref":"#/components/schemas/blkcfg_blockRateOverrideReasonType"},"maxItems":4000,"type":"array"},"blkcfg_blockRefusedReasonType":{"description":"Contains Common Master configuration detail.","properties":{"code":{"description":"Common Master unique code.","maxLength":40,"minLength":0,"type":"string"},"description":{"$ref":"#/components/schemas/blkcfg_translationTextType2000","description":"Description of the Master code."},"displayOrder":{"description":"Common Master record sequence number.","type":"number"},"inactive":{"description":"Indicates whether the Block Refused Reason is inactive or not, returns TRUE when inactive","type":"boolean"},"managedBy":{"$ref":"#/components/schemas/blkcfg_managedByOptions"}},"type":"object"},"blkcfg_blockRefusedReasonsCriteria":{"description":"Request object for creating Block Refused Reasons.","properties":{"blockRefusedReasons":{"$ref":"#/components/schemas/blkcfg_blockRefusedReasonsType","description":"Block Refused Reasons to be created."},"links":{"$ref":"#/components/schemas/blkcfg_links"},"warnings":{"$ref":"#/components/schemas/blkcfg_warningsType"}},"type":"object"},"blkcfg_blockRefusedReasonsToBeChanged":{"description":"Request object for changing Block Refused Reasons.","properties":{"blockRefusedReasons":{"$ref":"#/components/schemas/blkcfg_blockRefusedReasonsType","description":"Block Refused Reasons to be changed."},"links":{"$ref":"#/components/schemas/blkcfg_links"},"warnings":{"$ref":"#/components/schemas/blkcfg_warningsType"}},"type":"object"},"blkcfg_blockRefusedReasonsType":{"description":"List of Block Refused Reasons.","items":{"$ref":"#/components/schemas/blkcfg_blockRefusedReasonType"},"maxItems":4000,"type":"array"},"blkcfg_blockStatusCodeDetails":{"description":"Request object for updating block status code.","properties":{"blockStatusCode":{"$ref":"#/components/schemas/blkcfg_blockStatusCodeType","description":"Block status code information to be applied."},"links":{"$ref":"#/components/schemas/blkcfg_links"},"warnings":{"$ref":"#/components/schemas/blkcfg_warningsType"}},"type":"object"},"blkcfg_blockStatusCodeStatusType":{"description":"Simple type for block status code's room status type and catering status type. Valid status values are Waitlist,Cancel,Lost,Refused,Actual,Inquiry,NonDeductInv,DeductInv and Referral.","enum":["Waitlist","Cancel","Lost","Refused","Actual","Inquiry","NonDeductInv","DeductInv","Referral"],"type":"string"},"blkcfg_blockStatusCodeType":{"description":"Block status code information.","properties":{"allowPickup":{"description":"Indicates if the rooms with this status code will be allowed for pickup or not.","type":"boolean"},"cateringInUse":{"description":"Returns true if the status code is already used in Events.","type":"boolean"},"cateringStatusType":{"$ref":"#/components/schemas/blkcfg_blockStatusCodeStatusType","description":"Catering status type selected for status code. When the OPS Sales \u0026 Catering license code is active, the Sales \u0026 Catering status type for the status code is displayed."},"color":{"$ref":"#/components/schemas/blkcfg_statusColorType","description":"Color code for the status code."},"defaultReservationType":{"$ref":"#/components/schemas/blkcfg_codeDescriptionType","description":"Default reservation type to be used for the status code. The reservation type and status code must have the same deduct/no deduct status."},"inUse":{"description":"Returns true if the status code is already used in Block / Event / Status Flow.","type":"boolean"},"leadStatus":{"description":"Indicates the default status for all new leads. Only one lead status can be selected as the default.","type":"boolean"},"logCatering":{"description":"Indicates if the status code logs the catering changes or not.","type":"boolean"},"managedBy":{"$ref":"#/components/schemas/blkcfg_managedByOptions"},"opportunity":{"description":"Indicates that the business block created with this Status is an Opportunity.","type":"boolean"},"orderBy":{"description":"Indicates the order the status code is displayed in the status cycle.","type":"integer"},"reasonType":{"description":"Reason type for every block reservation cancellation. Block Cancellation Reason, Block Refused Reasons, and Block Lost Reasons.","type":"string"},"returnToInventory":{"description":"Indicates if the rooms with this status code can be returned to availability or not.","type":"boolean"},"roomStatusType":{"$ref":"#/components/schemas/blkcfg_blockStatusCodeStatusType","description":"Room status type selected for status code."},"showDiary":{"description":"Indicates if the function diary will be shown within the Sales and Catering.","type":"boolean"},"starting":{"description":"Indicates if the status code is the starting status of the status cycle or not.","type":"boolean"},"status":{"$ref":"#/components/schemas/blkcfg_codeDescriptionType","description":"Code and Description used to define a status e.g. (INT, TENT, DEF, CXL) (initial, tentative, definite, cancelled)."}},"type":"object"},"blkcfg_codeDescriptionType":{"description":"This contains a generic code and description information.","properties":{"code":{"description":"Code.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"description.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"blkcfg_destinationCodeType":{"description":"Contains Common Master configuration detail.","properties":{"code":{"description":"Common Master unique code.","maxLength":40,"minLength":0,"type":"string"},"description":{"$ref":"#/components/schemas/blkcfg_translationTextType2000","description":"Description of the Master code."},"displayOrder":{"description":"Common Master record sequence number.","type":"number"},"managedBy":{"$ref":"#/components/schemas/blkcfg_managedByOptions"}},"type":"object"},"blkcfg_destinationCodesCriteria":{"description":"Request object for creating Destination Codes.","properties":{"destinationCodes":{"$ref":"#/components/schemas/blkcfg_destinationCodesType","description":"Destination Codes to be created."},"links":{"$ref":"#/components/schemas/blkcfg_links"},"warnings":{"$ref":"#/components/schemas/blkcfg_warningsType"}},"type":"object"},"blkcfg_destinationCodesToBeChanged":{"description":"Request object for changing Destination Codes.","properties":{"destinationCodes":{"$ref":"#/components/schemas/blkcfg_destinationCodesType","description":"Destination Codes to be changed."},"links":{"$ref":"#/components/schemas/blkcfg_links"},"warnings":{"$ref":"#/components/schemas/blkcfg_warningsType"}},"type":"object"},"blkcfg_destinationCodesType":{"description":"List of Destination Codes.","items":{"$ref":"#/components/schemas/blkcfg_destinationCodeType"},"maxItems":4000,"type":"array"},"blkcfg_instanceLink":{"description":"Metadata describing link description objects that MAY appear in the JSON instance representation.","properties":{"href":{"description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.","type":"string"},"method":{"description":"HTTP method for requesting the target of the link.","enum":["GET","POST","PUT","DELETE","PATCH","OPTIONS","HEAD"],"type":"string"},"operationId":{"description":"The operationId of the path you can call to follow this link.  This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.","type":"string"},"rel":{"description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.","type":"string"},"targetSchema":{"description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..","type":"string"},"templated":{"default":false,"description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.","type":"boolean"},"title":{"description":"Exact copy of the \"summary\" field on the linked operation.","type":"string"}},"type":"object"},"blkcfg_links":{"items":{"$ref":"#/components/schemas/blkcfg_instanceLink"},"type":"array"},"blkcfg_managedByOptions":{"description":"Describes of the Configuration is Managed by Enterprise or Property.","enum":["EnterpriseManaged","PropertyManaged","EnterpriseEnforced","PropertyOverridden"],"type":"string"},"blkcfg_nextBlockStatusCode":{"description":"Request object for change block status code flow. Batch insert/update/delete of next status code list of a particular status code.","properties":{"links":{"$ref":"#/components/schemas/blkcfg_links"},"nextBlockStatusCodeList":{"$ref":"#/components/schemas/blkcfg_nextBlockStatusCodeListType","description":"Contains list of all available next status codes for a particular status code."},"warnings":{"$ref":"#/components/schemas/blkcfg_warningsType"}},"type":"object"},"blkcfg_nextBlockStatusCodeInfoListType":{"description":"List of all configured next status codes for the main status code.","items":{"$ref":"#/components/schemas/blkcfg_nextBlockStatusCodeInfoType"},"maxItems":4000,"type":"array"},"blkcfg_nextBlockStatusCodeInfoType":{"description":"Information of next block status code.","properties":{"order":{"description":"Order of next block status code","type":"integer"},"status":{"description":"Next block status code.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"blkcfg_nextBlockStatusCodeListType":{"description":"Block status code with its next configured and/or available status codes.","items":{"$ref":"#/components/schemas/blkcfg_nextBlockStatusCodeType"},"maxItems":4000,"type":"array"},"blkcfg_nextBlockStatusCodeType":{"description":"Next block status codes information. Contains list of all configured and/or available next status codes for a particular status code.","properties":{"managedBy":{"$ref":"#/components/schemas/blkcfg_managedByOptions"},"nextAvailableStatusList":{"$ref":"#/components/schemas/blkcfg_nextBlockStatusCodeInfoListType","description":"List of all available next status codes for the main status code."},"nextConfiguredStatusList":{"$ref":"#/components/schemas/blkcfg_nextBlockStatusCodeInfoListType","description":"List of all configured next status codes for the main status code."},"status":{"description":"Main block status code.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"blkcfg_reservationMethodType":{"description":"Contains Common Master configuration detail.","properties":{"code":{"description":"Common Master unique code.","maxLength":40,"minLength":0,"type":"string"},"description":{"$ref":"#/components/schemas/blkcfg_translationTextType2000","description":"Description of the Master code."},"displayOrder":{"description":"Common Master record sequence number.","type":"number"},"managedBy":{"$ref":"#/components/schemas/blkcfg_managedByOptions"}},"type":"object"},"blkcfg_reservationMethodsCriteria":{"description":"Request object for creating Reservation Methods.","properties":{"links":{"$ref":"#/components/schemas/blkcfg_links"},"reservationMethods":{"$ref":"#/components/schemas/blkcfg_reservationMethodsType","description":"Reservation Methods to be created."},"warnings":{"$ref":"#/components/schemas/blkcfg_warningsType"}},"type":"object"},"blkcfg_reservationMethodsToBeChanged":{"description":"Request object for changing Reservation Methods.","properties":{"links":{"$ref":"#/components/schemas/blkcfg_links"},"reservationMethods":{"$ref":"#/components/schemas/blkcfg_reservationMethodsType","description":"Reservation Methods to be changed."},"warnings":{"$ref":"#/components/schemas/blkcfg_warningsType"}},"type":"object"},"blkcfg_reservationMethodsType":{"description":"List of Reservation Methods.","items":{"$ref":"#/components/schemas/blkcfg_reservationMethodType"},"maxItems":4000,"type":"array"},"blkcfg_statusColorType":{"description":"Status code color configuration type.","enum":["White","Red","Blue","Cyan","Magenta","Green","Brown","Black","Yellow","Gray"],"type":"string"},"blkcfg_translationTextType2000":{"description":"Contains Multiple translated texts and language codes.","properties":{"defaultText":{"description":"Default text with Character length from 0 to 2000.","maxLength":2000,"minLength":0,"type":"string"},"translatedTexts":{"$ref":"#/components/schemas/blkcfg_translationsTextType","description":"List of translated text and language codes."}},"type":"object"},"blkcfg_translationsTextType":{"description":"Language code for the translation.","items":{"description":"Language code for the translation.","properties":{"language":{"description":"Language identification.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Used for Character Strings, length 0 to 2000.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"maxItems":4000,"type":"array"},"blkcfg_warningType":{"description":"Used when a message has been successfully processed to report any warnings or business errors that occurred.","properties":{"code":{"description":"If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.","maxLength":20,"minLength":0,"type":"string"},"docURL":{"description":"If present, this URL refers to an online description of the error that occurred.","maxLength":2000,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"recordId":{"description":"If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.","maxLength":2000,"type":"string"},"rph":{"description":"Reference Place Holder used as an index for this warning.","maxLength":8,"minLength":1,"type":"string"},"shortText":{"description":"An abbreviated version of the error in textual format.","maxLength":2000,"type":"string"},"status":{"description":"If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.","maxLength":2000,"type":"string"},"tag":{"description":"If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].","maxLength":2000,"type":"string"},"type":{"description":"The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"blkcfg_warningsType":{"description":"Used in conjunction with the Success element to define a business error.","items":{"$ref":"#/components/schemas/blkcfg_warningType"},"maxItems":4000,"type":"array"},"booking_blk_aRAccountShortInfoType":{"description":"Accounts Receivabales Account details type charged for batched posting.","properties":{"accountId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"The unique ID for the Account."},"accountName":{"description":"Name of the AR Account.","maxLength":200,"minLength":0,"type":"string"},"accountNo":{"description":"The Account Number for the Account.","maxLength":20,"minLength":0,"type":"string"},"status":{"$ref":"#/components/schemas/booking_blk_aRAccountStatusType","description":"The status of the account."}},"type":"object"},"booking_blk_aRAccountStatusType":{"description":"Type for the Account Status. Status can be restricted and a message/description added to the Account.","properties":{"description":{"description":"User defined status message on the Account.","maxLength":2000,"minLength":0,"type":"string"},"restricted":{"description":"Flag to indicate if the Account is restricted.","type":"boolean"},"restriction":{"description":"The Restriction Code added on the Account. This is available when the functionality for adding restriction codes is ON.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_accessRestrictionsType":{"description":"Block access exclusion/restriction type.","items":{"$ref":"#/components/schemas/booking_blk_blockAccessRestrictionType"},"maxItems":4000,"type":"array"},"booking_blk_actionStatusType":{"description":"Action status of the Track It item(Open, Closed).","enum":["Open","Closed"],"type":"string"},"booking_blk_activityList":{"description":"A collection of Activity objects.","items":{"description":"Represents a single instance of a scheduled activity.","properties":{"activityIds":{"$ref":"#/components/schemas/booking_blk_uniqueIDListType","description":"A collection of reference ID values that identify this uniquely scheduled activity instance. May contain one ID per external system plus an internal identifier."},"amount":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"The amount charged for the activity."},"deposit":{"description":"A monetary value expressed with a currency code.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"collectedBy":{"enum":["Vendor","Agent","Other"],"type":"string"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"}},"type":"object"},"description":{"description":"Description of the activity","items":{"maxLength":2000,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"duration":{"$ref":"#/components/schemas/booking_blk_dateTimeSpanType","description":"The time span of the activity falls"},"extensions":{"description":"Vendor extensions to the activity record.","items":{"type":"string"},"maxItems":4000,"type":"array"},"groupCode":{"description":"Any Block code associated with the activity if its a Group booking.","type":"string"},"inactiveDate":{"description":"The Date by which the activity is deemed Cancelled/Deleted.","format":"date-time","type":"string"},"link":{"description":"When true indicates that activity link only needs to be inserted or deleted for this record.","type":"boolean"},"location":{"description":"The Location where the activity takes place. Eg: Salon","type":"string"},"name":{"description":"Name of the people for whom the activity is scheduled. Can be more than one but should be equal to the number of persons","items":{"maxLength":200,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"note":{"description":"Any additional notes or comments regarding the scheduled activity.","items":{"maxLength":2000,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"numberOfPersons":{"description":"The total number of the people for whom the activity is scheduled. Can be more than one but should be equal to the number of persons","type":"integer"},"participants":{"description":"The names of the participants.","items":{"$ref":"#/components/schemas/booking_blk_personNameType"},"maxItems":4000,"type":"array"},"status":{"description":"Activity reservation status. Typical examples are RESERVED, BOOKED, CANCELLED, and TENTATIVE.","type":"string"},"statusDescription":{"description":"Activity reservation status description. Typical examples are RESERVED, BOOKED, CANCELLED, and TENTATIVE.","type":"string"},"timeSpan":{"$ref":"#/components/schemas/booking_blk_dateTimeSpanType","description":"The time with-in which an activity falls (Starts/Ends/Spans)"},"type":{"description":"The Type of the activity. Eg: SPA, Golf etc.","type":"string"},"uRLLink":{"description":"The URL link to launch the Activity Reservation System to view or edit full details of this activity.","type":"string"}},"type":"object"},"maxItems":4000,"type":"array"},"booking_blk_activityLookUpList":{"description":"Criteria for fetching Activity Bookings.","items":{"$ref":"#/components/schemas/booking_blk_fetchActivityBookingsType"},"maxItems":4000,"type":"array"},"booking_blk_additionalGuestAmountType":{"properties":{"ageQualifyingCode":{"enum":["ADULT","CHILD","OTHER","CHILDBUCKET1","CHILDBUCKET2","CHILDBUCKET3","CHILDBUCKET4","CHILDBUCKET5"],"type":"string"},"amount":{"$ref":"#/components/schemas/booking_blk_totalType"}},"type":"object"},"booking_blk_addressInfoType":{"description":"Provides address information.","properties":{"address":{"$ref":"#/components/schemas/booking_blk_addressType","description":"Address details for the profile."},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"warnings":{"$ref":"#/components/schemas/booking_blk_warningsType"}},"type":"object"},"booking_blk_addressSearchType":{"description":"Address Details such as city, state, country, postal code etc.","properties":{"cityName":{"description":"City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).","maxLength":40,"minLength":0,"type":"string"},"country":{"$ref":"#/components/schemas/booking_blk_countryNameType","description":"Country name (e.g., Ireland)."},"excludeNoCity":{"description":"When true indicates that only profiles with city will be fetched.","type":"boolean"},"postalCode":{"description":"Post Office Code number.","maxLength":15,"minLength":0,"type":"string"},"state":{"description":"State or Province name (e.g., Texas).","maxLength":20,"minLength":0,"type":"string"},"streetAddress":{"description":"First Line of Street Address. For profile search it matches the first Address line.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_addressType":{"description":"Provides address information.","properties":{"addressLine":{"description":"When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.","items":{"maxLength":80,"minLength":0,"type":"string"},"maxItems":4,"type":"array"},"cityExtension":{"description":"Post Office City Extension Code number. City Extension mainly used for UK addresses.","maxLength":20,"minLength":0,"type":"string"},"cityName":{"description":"City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).","maxLength":40,"minLength":0,"type":"string"},"country":{"$ref":"#/components/schemas/booking_blk_countryNameType","description":"Country name (e.g., Ireland)."},"county":{"description":"County or District Name (e.g., Fairfax). This is read only.","maxLength":20,"minLength":0,"type":"string"},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"isValidated":{"description":"Indicator to define if the Address is validated by the Address Validation System.","type":"boolean"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"postalCode":{"description":"Post Office Code number.","maxLength":15,"minLength":0,"type":"string"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"},"state":{"description":"State or Province name (e.g., Texas).","maxLength":20,"minLength":0,"type":"string"},"type":{"description":"Defines the type of address (e.g. home, business, other).","maxLength":20,"minLength":0,"type":"string"},"typeDescription":{"description":"Describes the type code","type":"string"},"updateReservations":{"description":"Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address.","type":"boolean"}},"type":"object"},"booking_blk_advanceCheckInType":{"description":"Information relating to Reservation's Advance Checked In state and Expected Time of Return","properties":{"advanceCheckedIn":{"description":"Indicates if the reservation is marked as Advance Checked In","type":"boolean"},"eTRComments":{"description":"ETR Comments","maxLength":2000,"minLength":0,"type":"string"},"expectedReturnTime":{"description":"Expected Return Time. Uses the hotel's time zone.","format":"date-time","type":"string"}},"type":"object"},"booking_blk_alertAreaType":{"enum":["CheckIn","CheckOut","Reservation","Billing","InHouse"],"type":"string"},"booking_blk_alertGuestInfoType":{"properties":{"birthDate":{"description":"Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.","format":"date","maxLength":8,"type":"string"},"birthDateMasked":{"description":"Indicates the date of birth as masked.","type":"string"},"comments":{"description":"Additional alert information regarding the membership of the guest.","type":"string"},"guestName":{"description":"Guest Name.","maxLength":200,"minLength":0,"type":"string"},"guestPreferredLanguage":{"$ref":"#/components/schemas/booking_blk_languageType","description":"Holds the language preferred by the guest."},"lastHotelCode":{"description":"Hotel code of the last stay location of the guest.","maxLength":20,"minLength":0,"type":"string"},"lastStayDate":{"description":"Last stay date at the property.","format":"date","maxLength":8,"type":"string"},"membership":{"$ref":"#/components/schemas/booking_blk_membershipType","description":"Membership information of the guest."},"preference":{"description":"Additional alert information regarding the guest.","type":"string"},"preference2":{"description":"Additional mandatory alert information regarding the guest preferences.","type":"string"},"totalBrandStay":{"description":"Holds total number of days that the guest have stayed in the properties for the same brand.","type":"integer"},"totalStay":{"description":"Holds total number of days that the guest have stayed in the property.","type":"integer"},"vipStatus":{"$ref":"#/components/schemas/booking_blk_vIPStatusType","description":"VIP status of the guest."}},"type":"object"},"booking_blk_alertType":{"properties":{"area":{"$ref":"#/components/schemas/booking_blk_alertAreaType","description":"The Area where the alert will be attached and shown."},"code":{"description":"Code identifying the type of alert.","maxLength":20,"minLength":0,"type":"string"},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"description":{"description":"The alert message.","type":"string"},"global":{"description":"Indicate whether the alert is a global that is automatically and dynamically attached to all reservations that meet the alert criteria.","type":"boolean"},"guestInfo":{"$ref":"#/components/schemas/booking_blk_alertGuestInfoType","description":"Contains information regarding the guest."},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"printerName":{"description":"Printer used to print the alert notification.","type":"string"},"printerNotification":{"description":"Notify by sending the message to the printer.","type":"boolean"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","maxLength":8,"type":"string"},"reportDescription":{"description":"Report description. Mainly used for as a parameter for printing the alerts.","maxLength":1000,"minLength":0,"type":"string"},"reportId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"The module id of the report. This is used to printer the alert."},"reportName":{"description":"Report name of the report type.","type":"string"},"screenNotification":{"description":"Notify by showing the alert on the screen","type":"boolean"},"stopCheckInCheckOut":{"description":"Indicates the Reservation Stop Check In/Check Out Global Alert.","type":"boolean"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"},"userDefinedFields":{"$ref":"#/components/schemas/booking_blk_userDefinedFieldsType","description":"Collections of user defined fields."},"welcomeOffer":{"$ref":"#/components/schemas/booking_blk_welcomeOfferType","description":"Contains information regarding welcome offer."}},"type":"object"},"booking_blk_alertsType":{"description":"List of alerts.","items":{"$ref":"#/components/schemas/booking_blk_alertType"},"maxItems":4000,"type":"array"},"booking_blk_allocationRoomTypeInfoType":{"description":"The information about the room types contained in the block room allocation.","properties":{"available":{"description":"Used to specify an availability status for the room type.","type":"boolean"},"bedTypeCodes":{"description":"Bed type code associated with room.","items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"bookingChannelMappings":{"description":"Booking Channels mapping for the Room Type.","items":{"$ref":"#/components/schemas/booking_blk_bookingChannelMappingType"},"maxItems":4000,"type":"array"},"component":{"description":"Indicates room type is a Component Room.","type":"boolean"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"invBlockCode":{"description":"Block code.","maxLength":40,"minLength":0,"type":"string"},"longDescription":{"description":"Detail description of the Room Type.","maxLength":2000,"minLength":0,"type":"string"},"promotionCode":{"description":"Represents the promotional code.","maxLength":40,"minLength":0,"type":"string"},"roomClass":{"maxLength":20,"minLength":0,"type":"string"},"roomFeatures":{"$ref":"#/components/schemas/booking_blk_roomFeaturesType","description":"Collection of room features."},"roomQualifierCode":{"description":"Represents the room qualifier code like Deluxe,Economy,Suite etc.","maxLength":40,"minLength":0,"type":"string"},"roomQualifierMatchIndicator":{"description":"Represents the match indicator of room qualifier code returned in the response with the requested room qualifier code.","maxLength":20,"minLength":0,"type":"string"},"roomType":{"maxLength":20,"minLength":0,"type":"string"},"roomTypeAttributes":{"$ref":"#/components/schemas/booking_blk_roomTypeAttributesType","description":"Room type attributes."},"roomViewCode":{"description":"Represents the room view code like City view, River view, Ocean view etc.","maxLength":40,"minLength":0,"type":"string"},"suite":{"description":"Indicates room type is a suite.","type":"boolean"},"webName":{"description":"Name corresponding to a RoomType.","maxLength":80,"minLength":0,"type":"string"},"webPage":{"description":"URL providing more information about the Room Type.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_allocationType":{"description":"Simple type for block allocation used in room rate grid.","enum":["Initial","Actual","Rates","Pickup","Contract","Available","Pickupperc","Changes","Released","Houseavailability","SellLimit","AvailableSellLimit","MasterAllocInitial","Allocated","SubAllocResv","CutoffDate","ForecastRooms","ForecastRates","ChildRates"],"type":"string"},"booking_blk_amountDeterminationType":{"description":"Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.","enum":["Inclusive","Exclusive"],"type":"string"},"booking_blk_amountType":{"description":"Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentages, total amount, and the rate description.","properties":{"additionalGuestAmounts":{"description":"Collection of incremental charges per age qualifying code for additional guests. Amount charged for additional occupant is with respect to age group of the base guests.","items":{"$ref":"#/components/schemas/booking_blk_additionalGuestAmountType"},"maxItems":4000,"type":"array"},"base":{"$ref":"#/components/schemas/booking_blk_totalType","description":"The base amount charged for the accommodation or service per unit of time (ex: Nightly, Weekly, etc). If TaxInclusive is set to True, then taxes are included in the base amount. Note that any additional charges should itemized in the other elements."},"discount":{"$ref":"#/components/schemas/booking_blk_discountType","description":"Discount percentage and/or Amount, code and textual reason for discount"},"effectiveRate":{"$ref":"#/components/schemas/booking_blk_totalType","description":"The reservation effective amount charged for the accommodation or service (i.e. base amount + amount for Add to Rate Combine Line packages) per unit of time"},"end":{"description":"The ending value of the date range.","format":"date","maxLength":8,"type":"string"},"requiredPoints":{"$ref":"#/components/schemas/booking_blk_pointsType","description":"The Points contains the number of points required to book a particular room type."},"shareDistributionInstruction":{"$ref":"#/components/schemas/booking_blk_shareDistributionInstructionType","description":"Last rate share distribution instruction applied on share reservation daily rate segment."},"shareRatePercentage":{"description":"Indicates the share rate percentage for the reservation if set to CUSTOMSPLIT.","maximum":100,"minimum":0,"type":"number"},"start":{"description":"The starting value of the date range.","format":"date","maxLength":8,"type":"string"},"total":{"$ref":"#/components/schemas/booking_blk_totalType","description":"The total amount charged for this rate including additional occupant amounts and fees."}},"type":"object"},"booking_blk_anonymizationStatusType":{"description":"Guest has been anonymized.","enum":["Requested","Anonymized"],"type":"string"},"booking_blk_anonymizationType":{"description":"Provides information about guest's anonymization status.","properties":{"anonymizationDate":{"description":"Date and Time when the guest was anonymized.","format":"date-time","type":"string"},"anonymizationStatus":{"$ref":"#/components/schemas/booking_blk_anonymizationStatusType","description":"Status of anonymization such as Requested or Anonymized."}},"type":"object"},"booking_blk_applicationUserType":{"properties":{"actAs":{"maxLength":20,"minLength":0,"type":"string"},"actAt":{"maxLength":20,"minLength":0,"type":"string"},"appUser":{"maxLength":250,"minLength":0,"type":"string"},"appUserId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type"},"attendantInfo":{"$ref":"#/components/schemas/booking_blk_attendantType"},"cashierId":{"type":"integer"},"cashierTitle":{"description":"Cashier title.","maxLength":2000,"minLength":0,"type":"string"},"department":{"maxLength":60,"minLength":0,"type":"string"},"departmentLocation":{"maxLength":60,"minLength":0,"type":"string"},"disabledUntil":{"format":"date","maxLength":8,"type":"string"},"expiryDate":{"format":"date","maxLength":8,"type":"string"},"hotel":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Hotel where user belongs."},"lDAPUser":{"maxLength":250,"minLength":0,"type":"string"},"passwordChangeDate":{"format":"date","maxLength":8,"type":"string"},"salesRepCode":{"maxLength":20,"minLength":0,"type":"string"},"userDefaultLanguage":{"maxLength":20,"minLength":0,"type":"string"},"userInfo":{"$ref":"#/components/schemas/booking_blk_employeeInfoType"},"userSessionInfo":{"$ref":"#/components/schemas/booking_blk_userSessionInfoType","description":"This is only used during log-in."}},"type":"object"},"booking_blk_applyEventAttendeesChangesToEventsType":{"description":"Non-Pkg Events on the same date.","enum":["All","None","Same","NonPackage","MatchingNonPackage","Package","Date"],"type":"string"},"booking_blk_articleInfoType":{"description":"Information regarding an article.","properties":{"articleCode":{"description":"Unique code of the article.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Description of the article.","maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel code to which the article belongs.","maxLength":20,"minLength":0,"type":"string"},"inactive":{"description":"Indicates whether the article is inactive or not.","type":"boolean"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"postIt":{"$ref":"#/components/schemas/booking_blk_articlePostItType","description":"Post it information of the article."},"price":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Default price of the article."},"transactionCode":{"description":"Transaction code to which the article belongs.","maxLength":20,"minLength":0,"type":"string"},"universalProductCode":{"description":"Unique Universal product code of the article.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_articlePostItType":{"description":"Post it information of an article.","properties":{"availableForPostIt":{"description":"Indicates whether the article is available for post it.","type":"boolean"},"color":{"$ref":"#/components/schemas/booking_blk_colorType","description":"Color indicator which is only configurable if article is available for post it."}},"type":"object"},"booking_blk_associatedResType":{"description":"Information regarding associated reservations to the reservation.","properties":{"originalMultiRoomRes":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Stores Unique ID of the original multi room reservation from which this reservation is split off."},"parentReservation":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Stores Unique ID of the parent reservation."}},"type":"object"},"booking_blk_attachmentType":{"description":"Attached files.","properties":{"description":{"description":"Description for the file.","maxLength":4000,"minLength":0,"type":"string"},"fileName":{"description":"Name of the file.","maxLength":2000,"minLength":0,"type":"string"},"fileSize":{"description":"Size of the file.","type":"integer"},"global":{"description":"Flag to say if attachment is available across properties.","type":"boolean"},"history":{"$ref":"#/components/schemas/booking_blk_dateTimeStampGroupType","description":"History data associated with Attachment."},"hotelId":{"description":"Hotel Code.","maxLength":20,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_attachmentsType":{"description":"Attachment List.","items":{"$ref":"#/components/schemas/booking_blk_attachmentType"},"maxItems":4000,"type":"array"},"booking_blk_attendantType":{"properties":{"attendantId":{"maxLength":20,"minLength":0,"type":"string"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_authorizationRuleType":{"description":"Configured rule for computing the amount to authorize.","properties":{"amount":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"The amount applicable to the authorization rule."},"code":{"description":"The authorization rule code.","pattern":"[0-9]{1,9}","type":"integer"},"percent":{"description":"A percentage value if the authorization rule is percentage based.","type":"number"}},"type":"object"},"booking_blk_authorizerInfoType":{"description":"Authorizer Information","properties":{"authorizerId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type"},"authorizerName":{"description":"Full name of the authorizer.","maxLength":100,"minLength":0,"type":"string"},"authorizerRateCode":{"description":"Rate code of the authorizer.","maxLength":20,"minLength":0,"type":"string"},"authorizerUserName":{"description":"Application user name of the authorizer","maxLength":40,"minLength":0,"type":"string"},"inheritAuthorizerRateCode":{"description":"Indicates whether user has the choice to have reservation inherit rate code from the authorizer.","type":"boolean"}},"type":"object"},"booking_blk_awardId":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_blk_awardKindType":{"description":"Indicates that this is electronic certificate.","enum":["Paper","ECertificate"],"type":"string"},"booking_blk_awardStatusType":{"description":"Indicates that certificate is in use.","enum":["Available","NotAvailable","InUse"],"type":"string"},"booking_blk_awardType":{"description":"Detailed information of the awards.","properties":{"awardCode":{"description":"Award category.","maxLength":20,"minLength":0,"type":"string"},"awardType":{"$ref":"#/components/schemas/booking_blk_awardKindType","description":"Can be P (Paper) or E (E-Certificate)."},"categoryValid":{"description":"Indicates whether the category of certificate is valid or not for this resort.","type":"boolean"},"certificateNo":{"description":"Certificate No.","maxLength":20,"minLength":0,"type":"string"},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"description":{"description":"Description of the award/certificate.","type":"string"},"detailedCertificate":{"description":"Indicates if this certificate is detailed or not.","type":"boolean"},"displaySequence":{"description":"Indicates the order in which the certificates received from MRW.","type":"number"},"expirationDate":{"description":"Expiration Date.","format":"date","maxLength":8,"type":"string"},"externalConfirmationNo":{"description":"Confirmation Number given by a CRS application for this reservation.","maxLength":20,"minLength":0,"type":"string"},"externalHotelCode":{"description":"Hotel Code of the CRS application that this certificate belongs to.","maxLength":20,"minLength":0,"type":"string"},"fBAInfo":{"$ref":"#/components/schemas/booking_blk_fBAInfoType","description":"FBA related fields."},"gift":{"description":"Signifies whether award is gift or not.","type":"boolean"},"hotelCategory":{"description":"Indicates the lowest hotel category for which the certificate is valid.","maxLength":20,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel Code for which the routing instructions are provided for a profile.","maxLength":20,"minLength":0,"type":"string"},"instantlyRedeemable":{"description":"Indicates if the award is an Instant Redemption award.","type":"boolean"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"masterCertificiateNo":{"description":"Master Certificate No.","maxLength":20,"minLength":0,"type":"string"},"membershipNo":{"description":"Membership No.","type":"string"},"nights":{"description":"Award Nights.","type":"integer"},"package":{"description":"Signifies whether upgrade is package or not.","type":"boolean"},"paidUpgrade":{"description":"Indicates if this certificate was ordered using the \"Paid Upgrade\" option in the E-Certs screen.","type":"boolean"},"points":{"description":"No. of points used to order this award.","type":"number"},"profileId":{"$ref":"#/components/schemas/booking_blk_profileId","description":"Unique profile identifier requested to be fetched."},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","maxLength":8,"type":"string"},"quantity":{"description":"Quantity of such awards needed to be ordered.","type":"integer"},"reservationCertificateType":{"$ref":"#/components/schemas/booking_blk_reservationCertificateType","description":"[R]=Reward, [I]=Incentive."},"reservationId":{"$ref":"#/components/schemas/booking_blk_reservationId","description":"Reservation IDs will be empty if award is not attached."},"rewardCertificateType":{"$ref":"#/components/schemas/booking_blk_rewardCertificateType","description":"[RE]=Regular Certificate, [SA]=Stay Anytime Certificate, [PS]=Point Saver Certificate."},"sourceType":{"description":"MRW : From MRW MAN:Entered manually.","type":"string"},"status":{"$ref":"#/components/schemas/booking_blk_awardStatusType","description":"Status of the award aka available."},"upgrade":{"description":"Signifies whether upgrade award or not.","type":"boolean"}},"type":"object"},"booking_blk_awardVouchersType":{"description":"This stores the Membership Awards code applied on the reservation.","items":{"properties":{"awardCode":{"description":"Membership Award code applied on the reservation.","maxLength":20,"minLength":0,"type":"string"},"voucherNo":{"description":"Membership Award number.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"maxItems":5,"type":"array"},"booking_blk_awardsType":{"description":"List of awards.","items":{"$ref":"#/components/schemas/booking_blk_awardType"},"maxItems":4000,"type":"array"},"booking_blk_basicEmailType":{"description":"Email address","maxLength":2000,"minLength":0,"type":"string"},"booking_blk_bedTaxReportingType":{"description":"This stores the information for Bed Tax Reporting. Mainly used in Maldives.","properties":{"taxRegistrationNo":{"description":"Tax Registration Number for Maldives Bed Tax Reporting.","type":"number"},"taxableDays":{"description":"Number of days for which the Maldives tax is applicable.","type":"integer"},"visaExpiryDate":{"description":"Visa Expiration Date used for Maldives Bed Tax Reporting","format":"date","maxLength":8,"type":"string"},"visaIssueDate":{"description":"Visa Issue Date used for Maldives Bed Tax Reporting.","format":"date","maxLength":8,"type":"string"},"visaNumber":{"description":"Visa number used for Maldives Bed Tax Reporting","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_benefitType":{"description":"Basic information about membership benefit.","properties":{"code":{"description":"Benefit code associated with a membership.","maxLength":20,"minLength":0,"type":"string"},"inactive":{"description":"Indicates whether membership benefit is active or inactive.","type":"boolean"},"message":{"description":"Processing message for membership benefit.","maxLength":4000,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_benefitsType":{"description":"Basic information about membership benefit.","items":{"$ref":"#/components/schemas/booking_blk_benefitType"},"maxItems":4000,"type":"array"},"booking_blk_billingInstructionType":{"description":"Configured Billing Instruction which represents a set of Transaction Codes.","properties":{"billingCode":{"description":"Unique identifier for the Billing Instruction.","maxLength":20,"minLength":0,"type":"string"},"desc":{"description":"Billing Instruction code description.","maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel context of the Billing Instruction.","maxLength":20,"minLength":0,"type":"string"},"routingInstructionsId":{"description":"This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer.","type":"number"}},"type":"object"},"booking_blk_billingInstructionsType":{"description":"Set of Billing Instruction codes.","items":{"$ref":"#/components/schemas/booking_blk_billingInstructionType"},"maxItems":4000,"type":"array"},"booking_blk_billingPrivilegesType":{"description":"This stores the information for Bed Tax Reporting. Mainly used in Maldives.","properties":{"allowAutoCheckin":{"description":"Indicated if a new reservation should be created and automatically checked in whenever the room is checked out. Available for pseudo room types only.","type":"boolean"},"autoSettlement":{"description":"Indicates if the is a candidate for auto folio settlement.","type":"boolean"},"autoSettlementFreq":{"description":"The interval of days between each auto folio settlement.","type":"integer"},"autoSettlementType":{"description":"The folio settlement type for auto folio settlement.","maxLength":40,"minLength":0,"type":"string"},"creditLimitAutoPay":{"description":"Indicates if the reservation will be included in the Automatic Credit Limit Overages process and also be listed in the Credit Limit Overages screen results.","type":"boolean"},"directBillAuthorized":{"description":"If Direct bill is authorized this will hold User ID who authorized it.","type":"boolean"},"folioCloseDate":{"description":"Date when folio was closed. This works with PostStayCharging flag.","format":"date","maxLength":8,"type":"string"},"postStayCharging":{"description":"Indicates if the reservation has charging privileges after checkout.","type":"boolean"},"postingRestriction":{"description":"Flag used by interface program during check in.","type":"boolean"},"preStayCharging":{"description":"Indicates if the reservation has charging privileges before arrival.","type":"boolean"},"scheduledCheckout":{"description":"Indicates if the guest is scheduled for automatic check out.","type":"boolean"},"scheduledCheckoutTime":{"description":"Time of automatic check out if guest is schedule for automatic check out.","format":"date","maxLength":8,"type":"string"},"videoCheckout":{"description":"Indicates if the guest can do video checkout","type":"boolean"}},"type":"object"},"booking_blk_blockAccessExclusionMessageType":{"description":"Access exclusion message.","properties":{"exclusionMessage":{"description":"Access Exclusion message for the block.","maxLength":4000,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_blockAccessExclusionType":{"description":"Access Exclusion information indicating the actions allowed under a HUB or Hotel for which the access exclusion is set.","properties":{"allowCancelReservation":{"description":"Allow to cancel a reservation under this access exclusion.","type":"boolean"},"allowCreateReservation":{"description":"Allow to create a reservation under this access exclusion.","type":"boolean"},"allowModifyReservation":{"description":"Allow to modify a reservation under this access exclusion.","type":"boolean"},"excludeFromAvailability":{"description":"Exclude a specific rate from availability","type":"boolean"},"inactive":{"description":"The rate access exclusion is inactive","type":"boolean"},"sourceType":{"description":"The type of source (CRO or Hotel code) for which the rate access exclusion is set.","maxLength":40,"minLength":0,"type":"string"},"sourceValue":{"description":"CRO or Hotel code value.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_blockAccessExclusionsType":{"description":"Access Exclusion information indicating the actions allowed under a HUB or hotel for which the access exclusion is set.","properties":{"accessExclusionMessage":{"$ref":"#/components/schemas/booking_blk_blockAccessExclusionMessageType","description":"Exclusion message for the block."},"blockAccessExclusion":{"items":{"$ref":"#/components/schemas/booking_blk_blockAccessExclusionType"},"maxItems":4000,"type":"array"},"hotelId":{"description":"Hotel code to which the block belongs to.","maxLength":20,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_blockAccessRestrictionType":{"description":"Simple type for block access exclusion/restriction types.","enum":["Availability","Create","Modify","Cancel"],"type":"string"},"booking_blk_blockAliasesType":{"description":"List of Block Aliases.","items":{"maxLength":40,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"booking_blk_blockAlternateDateType":{"description":"Information for Alternate date types","properties":{"alternateBeginDate":{"description":"Alternate Begin date.","format":"date","maxLength":8,"type":"string"},"blockRates":{"$ref":"#/components/schemas/booking_blk_blockGridRatesType","description":"Rate details for Alternate Dates."},"priority":{"description":"The Priority given to these alternate dates.","type":"integer"},"roomCategory":{"description":"The Room Category Label","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_blockCancellationTypeType":{"description":"Simple type for cancellation reasons which helps to decide type of cancellation.","enum":["Lost","Cancel","Refused"],"type":"string"},"booking_blk_blockClassificationType":{"description":"Simple type for block instructions to be used in requests for fetching blocks. Valid status values are MASTER_BLOCK, MASTER_TOUR, FIT_MASTER, MASTER_ALLOCATION, MASTER_ITINERARY, LEAD_MASTER, REGULAR_BOOKING, SUB_BLOCK, SUB_TOUR, FIT_CONTRACT, SUB_ALLOCATION, SUB_ITINERARY, LEAD.","enum":["MasterBlock","MasterTour","MasterAllocation","MasterItinerary","LeadMaster","RegularBooking","SubBlock","SubTour","FitContract","SubAllocation","SubItinerary","Lead","FitMaster","Opportunity"],"type":"string"},"booking_blk_blockDetailsType":{"description":"Information about the Block Details","properties":{"allowRateOverride":{"description":"Indicates whether rates of a block can be overridden. Applicable only for blocks with a Rate Code.","type":"boolean"},"autoloadContractGrid":{"description":"Indicates if contract grid will be auto loaded from original grid.","type":"boolean"},"autoloadForecastGrid":{"description":"Indicates if forecast grid will be auto loaded from original grid.","type":"boolean"},"blockAliases":{"$ref":"#/components/schemas/booking_blk_blockAliasesType","description":"Alias name(s) that can be used to search for the block."},"blockClassification":{"$ref":"#/components/schemas/booking_blk_blockClassificationType","description":"Indicate Block Classification."},"blockCode":{"description":"Block code for the block.","maxLength":20,"minLength":0,"type":"string"},"blockName":{"description":"Name of the block.","maxLength":2000,"minLength":0,"type":"string"},"blockNextStatusList":{"$ref":"#/components/schemas/booking_blk_blockNextStatusListType","description":"List of possible next booking statuses of the business block."},"blockOrigin":{"description":"Origin information of the block PMS/ORS/SC/SFA","maxLength":20,"minLength":0,"type":"string"},"blockStatus":{"$ref":"#/components/schemas/booking_blk_bookingStatusDetailType","description":"Current status of the block."},"blockStatusChangeHistory":{"$ref":"#/components/schemas/booking_blk_blockStatusChangeHistoryType","description":"List of booking status changes."},"blockType":{"description":"Internal type of the block.","maxLength":20,"minLength":0,"type":"string"},"bookingType":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Business Block Type field on the Business Block"},"businessDateArrivalsExist":{"description":"Indicate whether arrivals exists on current business date.","type":"boolean"},"cancellationDetails":{"$ref":"#/components/schemas/booking_blk_cancellationDetailsType","description":"Information on the canceled block."},"cateringOnlyBlock":{"description":"Indicates if this is a catering only block.","type":"boolean"},"centralSalesLeadId":{"description":"Central sales lead id of the central sales lead for this property lead.","maxLength":20,"minLength":0,"type":"string"},"centralSalesLeadResort":{"description":"Resort name of central sales lead for this property lead.","maxLength":80,"minLength":0,"type":"string"},"commissionPercent":{"description":"Indicate what percentage of this block is eligible for commission.","maximum":100,"minimum":0,"type":"number"},"controlBlockLocally":{"description":"Determines whether or not the block can be managed at the CRS level.","type":"boolean"},"conversionCode":{"description":"Indicates the likelihood description of the block moving to the next active block status.","maxLength":20,"minLength":0,"type":"string"},"conversionCodeDescription":{"description":"Indicates the likelihood of the block moving to the next active block status.","maxLength":2000,"minLength":0,"type":"string"},"currencyCode":{"description":"Currency Code attached to the business block.","maxLength":20,"minLength":0,"type":"string"},"externalLocked":{"description":"Indicates if the block is locked by an external system.","type":"boolean"},"flexibleDates":{"description":"Indicates if alternate dates are allowed for the booking.","type":"boolean"},"hasLinkedActivities":{"description":"Indicates if block has any linked activity(s).","type":"boolean"},"hotelName":{"description":"A text field used to communicate the proper name of the hotel.","maxLength":80,"minLength":0,"type":"string"},"hotelUse":{"$ref":"#/components/schemas/booking_blk_hotelUseType","description":"Indicates whether the block can be updated only by the Hotel to which it belongs."},"isCentralSalesLead":{"description":"Flag to determine if the given block is central lead or not.","type":"boolean"},"manualCutOff":{"description":"Indicates whether Block was cutoff manually.","type":"boolean"},"marketCode":{"$ref":"#/components/schemas/booking_blk_marketCodeInfoType","description":"Market code info of the block."},"nonCompeteDetails":{"$ref":"#/components/schemas/booking_blk_blockNonCompeteType","description":"Indicates the non-competing industry details."},"originalTimeSpan":{"$ref":"#/components/schemas/booking_blk_timeSpanType","description":"The Original Time Span(Arrival, Departure) which covers the Block Span."},"overbookAll":{"description":"Flag to determine if user wants to overbook sales allowance.","type":"boolean"},"overrideBlockCodeTemplate":{"description":"Indicates whether block code template can be overridden.","type":"boolean"},"paymentMethod":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Indicate which method of payment will be used for the block's charges."},"primaryOwners":{"description":"Primary owners for the block.","properties":{"blockOwner":{"$ref":"#/components/schemas/booking_blk_blockOwnerType","description":"Primary Block Owner"},"blockOwnerCount":{"description":"Total number of Block Owners.","type":"number"},"cateringOwner":{"$ref":"#/components/schemas/booking_blk_blockOwnerType","description":"Primary Catering Owner"},"cateringOwnerCount":{"description":"Total number of Catering Owners.","type":"number"},"roomsOwner":{"$ref":"#/components/schemas/booking_blk_blockOwnerType","description":"Primary Rooms Owner"},"roomsOwnerCount":{"description":"Total number of Rooms Owners.","type":"number"}},"type":"object"},"primaryProfiles":{"description":"Primary account and contact for the block.","properties":{"account":{"$ref":"#/components/schemas/booking_blk_blockProfilesType","description":"Primary Account"},"contact":{"$ref":"#/components/schemas/booking_blk_blockProfilesType","description":"Primary Contact"},"image":{"$ref":"#/components/schemas/booking_blk_imageSetType","description":"The primary profile image. If primary contact exists, Contact Image, otherwise primary Account Image"}},"type":"object"},"primaryRatePlanCodes":{"description":"Primary rates for the block.","properties":{"blockRatePlanCode":{"$ref":"#/components/schemas/booking_blk_blockRatePlanInfoType","description":"Primary Block Rate"},"blockRatePlanCodeCount":{"description":"Total number of Block Rates.","type":"number"},"shoulderEndRatePlanCode":{"$ref":"#/components/schemas/booking_blk_blockRatePlanInfoType","description":"Primary Shoulder End Rate"},"shoulderEndRatePlanCodeCount":{"description":"Total number of Shoulder End Rates.","type":"number"},"shoulderStartRatePlanCode":{"$ref":"#/components/schemas/booking_blk_blockRatePlanInfoType","description":"Primary Shoulder Start Rate"},"shoulderStartRatePlanCodeCount":{"description":"Total number of Shoulder Start Rates.","type":"number"}},"type":"object"},"quoteReferenceNumber":{"description":"Quote Reference Number is an alternate id number for the block that can be used in the SC Quote report and allows for tracking and managing revisions","maxLength":200,"minLength":0,"type":"string"},"rankingCode":{"description":"Indicates the ranking of the block.","maxLength":20,"minLength":0,"type":"string"},"rankingCodeDescription":{"description":"Indicates the ranking description of the block.","maxLength":2000,"minLength":0,"type":"string"},"rateOverrideReason":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Indicates the reason for overriding the rate amounts on a block."},"rateProtectionDetails":{"$ref":"#/components/schemas/booking_blk_blockRateProtectionType","description":"Indicates the Rate Protection details for the block."},"reservationMethod":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Reservation Method of the block. Indicates how the individual reservations will be handled (Individual Call In, Rooming List, etc)."},"reservationType":{"$ref":"#/components/schemas/booking_blk_reservationTypeInfoType","description":"Reservation Type info of the block."},"shoulderDates":{"$ref":"#/components/schemas/booking_blk_timeSpanType","description":"The Shoulder Dates (Arrival, Departure) which covers the Block Shoulder Span."},"shoulderRatePlanCode":{"description":"The shoulder rate plans which cover the block shoulder start and end dates.","properties":{"shoulderEnd":{"description":"The Rate Plan(s) for the days between the actual block end date and the shoulder end date.","items":{"$ref":"#/components/schemas/booking_blk_blockRatePlanInfoType"},"maxItems":4000,"type":"array"},"shoulderStart":{"description":"The Rate Plan(s) for the days between the shoulder start date and the actual block start date.","items":{"$ref":"#/components/schemas/booking_blk_blockRatePlanInfoType"},"maxItems":4000,"type":"array"}},"type":"object"},"sourceOfSale":{"$ref":"#/components/schemas/booking_blk_blockSourceOfSaleType","description":"Point of Sale of block. Identifies the entity/channel who made the block reservation."},"status":{"description":"Internal status for the block.","maxLength":20,"minLength":0,"type":"string"},"subBlockIdList":{"$ref":"#/components/schemas/booking_blk_subBlockIdList","description":"Sub Block code will be populated, when master block creation is in progress."},"synchronized":{"description":"Indicate if Master/Sub Blocks are Synchronized.","type":"boolean"},"taxType":{"description":"The Tax Type determines whether generates are applied when calculating prices and revenue. When populated, the Tax Type value will default on the Posting Master and will be used in the calculations for the Proforma Invoice report.","maxLength":20,"minLength":0,"type":"string"},"timeSpan":{"$ref":"#/components/schemas/booking_blk_timeSpanType","description":"The Time Span(Arrival, Departure) which covers the Block Span."},"tourCode":{"description":"The tour code that this block belongs to, if the block is a part of a tour series.","maxLength":20,"minLength":0,"type":"string"},"wholesaleBlock":{"description":"Indicates whether the business block should be considered as a wholesale block for revenue management block materialization forecasting","type":"boolean"}},"type":"object"},"booking_blk_blockGridChildRatesType":{"description":"Indicates the child rate amount values defined per age buckets. This type is introduced to support future child rate functionality and is not yet available for use.","properties":{"ageBucket1":{"description":"Indicates the rate amount for the first age bucket.","type":"number"},"ageBucket2":{"description":"Indicates the rate amount for the second age bucket.","type":"number"},"ageBucket3":{"description":"Indicates the rate amount for the third age bucket.","type":"number"}},"type":"object"},"booking_blk_blockGridInvType":{"description":"Indicates the inventory values ( occupancy or availability ) per person occupancy.","properties":{"cutoffDate":{"description":"Indicates the cutoff date.Date when inventory left in the block will be cut-off.","format":"date","maxLength":8,"type":"string"},"fourPerson":{"description":"Indicates the four person inventory value ( occupancy or availability ).","type":"integer"},"onePerson":{"description":"Indicates the one person inventory value ( occupancy or availability ).","type":"integer"},"sellLimit":{"description":"Indicates the sell limit","type":"integer"},"threePerson":{"description":"Indicates the three person inventory value ( occupancy or availability ).","type":"integer"},"twoPerson":{"description":"Indicates the two person inventory value ( occupancy or availability ).","type":"integer"}},"type":"object"},"booking_blk_blockGridRatesType":{"description":"Indicates the rate amount values per person occupancy.","properties":{"extraPerson":{"description":"Indicates the extra person occupancy rate amount.","type":"number"},"fourPerson":{"description":"Indicates the four person occupancy rate amount.","type":"number"},"onePerson":{"description":"Indicates the one person occupancy rate amount.","type":"number"},"threePerson":{"description":"Indicates the three person occupancy rate amount.","type":"number"},"twoPerson":{"description":"Indicates the two person occupancy rate amount.","type":"number"}},"type":"object"},"booking_blk_blockId":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_blk_blockIdList":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type"},"maxItems":4000,"type":"array"},"booking_blk_blockInventoryControlType":{"description":"Simple type for block inventory control values. This determines if it is a Non Elastic, Elastic or Sell Limits block.","enum":["NonElastic","Elastic","SellLimit"],"type":"string"},"booking_blk_blockInventoryItemSourceType":{"description":"Defines whether the item is setup due to a Rate Plan, Package or a Block.","properties":{"blockId":{"$ref":"#/components/schemas/booking_blk_blockId","description":"Block Unique ID, If populated specifies that the item is setup due to a Block."},"packageCode":{"description":"Package Code, If populated specifies that the item is setup due to a Package.","maxLength":20,"minLength":0,"type":"string"},"ratePlanCode":{"description":"Rate Plan Code, If populated specifies that the item is setup due to a Rate Plan.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_blockInventoryItemType":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"item":{"$ref":"#/components/schemas/booking_blk_itemInfoType","description":"Specifies Items and its attributes. When used for data manipulation for Items setup on reservation, etc only code is considered. Other Attributes are for used to provide information during fetch operation."},"quantity":{"description":"Number of items booked.","type":"integer"},"source":{"$ref":"#/components/schemas/booking_blk_blockInventoryItemSourceType","description":"If exists specifies whether the item is setup due to a Rate Plan, Package or a Block."},"timeSpan":{"$ref":"#/components/schemas/booking_blk_dateRangeType","description":"Begin and end date and time of the items applicability."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_blk_blockInventoryItemsType":{"description":"Inventory item attached to a block.","items":{"$ref":"#/components/schemas/booking_blk_blockInventoryItemType"},"maxItems":4000,"type":"array"},"booking_blk_blockNextStatusListType":{"description":"Next booking status of the business block.","items":{"$ref":"#/components/schemas/booking_blk_bookingStatusDetailType"},"maxItems":4000,"type":"array"},"booking_blk_blockNonCompeteType":{"description":"Block Non Compete code information.","properties":{"criteria":{"$ref":"#/components/schemas/booking_blk_rateProtectionType","description":"Indicates the type of Non-Compete. 'All' means all dates are Non-Compete. 'None' specifies Non-Compete is disabled. 'Selected' specifies few dates are Non-Compete."},"industry":{"description":"Specifies the Non-Compete Industry.\u003e","maxLength":20,"minLength":0,"type":"string"},"industryDescription":{"description":"Specifies the Non-Compete Industry description.\u003e","maxLength":2000,"minLength":0,"type":"string"},"protectedDates":{"$ref":"#/components/schemas/booking_blk_datesType","description":"Specifies all the Non-Compete dates in the selected date range."}},"type":"object"},"booking_blk_blockOwnerType":{"description":"Generic type for information about an owner.","properties":{"department":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Department to which the owner belongs to."},"email":{"$ref":"#/components/schemas/booking_blk_emailInfoType","description":"Email information of the owner."},"hotel":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Hotel to which the owner belongs to."},"name":{"$ref":"#/components/schemas/booking_blk_personNameType","description":"Provides name information of the owner."},"ownerCode":{"description":"Unique Code to identify the owner.","maxLength":20,"minLength":0,"type":"string"},"ownership":{"$ref":"#/components/schemas/booking_blk_blockOwnershipType","description":"Specifies the business block ownership type."},"phone":{"$ref":"#/components/schemas/booking_blk_telephoneInfoType","description":"Information on the telephone number of the owner."},"primary":{"description":"When true, this is a primary owner.","type":"boolean"},"profileId":{"$ref":"#/components/schemas/booking_blk_profileId","description":"Unique owner profile information."},"relationship":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Relationship of the owner within the profile or block."},"userId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Unique application user ID."},"userName":{"description":"Unique application user name of the owner.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_blockOwnersType":{"description":"Contains a list of block owners.","properties":{"lockBlockOwners":{"description":"When this flag is true, the logged in user cannot modify the existing block owners for the current block.","type":"boolean"},"lockCateringOwners":{"description":"When this flag is true, the logged in user cannot modify the existing catering owners for the current block.","type":"boolean"},"lockRoomsOwners":{"description":"When this flag is true, the logged in user cannot modify the existing room owners for the current block.","type":"boolean"},"owner":{"items":{"$ref":"#/components/schemas/booking_blk_blockOwnerType"},"maxItems":4000,"type":"array"}},"type":"object"},"booking_blk_blockOwnershipType":{"description":"Specifies the type of the owner associated with the business block(Block/Rooms/Catering).","enum":["Block","Rooms","Catering"],"type":"string"},"booking_blk_blockPMReservations":{"description":"The response object that contains the PM reservations belonging to a block.","properties":{"links":{"$ref":"#/components/schemas/booking_blk_links"},"reservations":{"$ref":"#/components/schemas/booking_blk_reservationSnapshotsType","description":"Collection of the PM reservations belonging to a block."},"warnings":{"$ref":"#/components/schemas/booking_blk_warningsType"}},"type":"object"},"booking_blk_blockPackageType":{"description":"This contains the full information and schedule of the block package.","properties":{"consumptionDetails":{"$ref":"#/components/schemas/booking_blk_packageConsumptionType","description":"Package consumption details. Includes information for quantity , allowance etc."},"endDate":{"description":"Required value when changing a package. If the original end date was null, then null is required.","format":"date","maxLength":8,"type":"string"},"newTimeSpan":{"$ref":"#/components/schemas/booking_blk_timeSpanType","description":"The changed dates(Start and End dates) for this product."},"packageCode":{"description":"Package code. This is the unique code used for the package and is a required element.","maxLength":20,"minLength":0,"type":"string"},"packageGroup":{"description":"Package group code. If this package is part of a package group, the group code is indicated here. This is a required element and is part of the key to fetch the correct package record .","maxLength":20,"minLength":0,"type":"string"},"packageHeaderType":{"$ref":"#/components/schemas/booking_blk_packageCodeHeaderType","description":"Package information from configuration."},"ratePlanCode":{"description":"The rate code which contains this package. If the package is not part of a rate code, this will be empty. Required element and part of the key to fetch the correct package record.","maxLength":20,"minLength":0,"type":"string"},"startDate":{"description":"Required value when changing a package. If the original start date was null, then null is required.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_blk_blockProfileTypeType":{"description":"Simple type for block profile types.","enum":["Company","Group","Agent","Source","CompanyContact","AgentContact","SourceContact"],"type":"string"},"booking_blk_blockProfilesType":{"description":"A collection of Profile objects or Unique IDs of Profiles.","properties":{"blockProfileType":{"$ref":"#/components/schemas/booking_blk_blockProfileTypeType","description":"Determines the type of the block profile."},"defaultPrint":{"description":"Indicates if profile is printable to customer reports by default.","type":"boolean"},"primary":{"description":"Is this profile attached to block is primary?","type":"boolean"},"profile":{"$ref":"#/components/schemas/booking_blk_profileType","description":"Provides detailed information regarding either a company or a customer profile."},"profileIdList":{"$ref":"#/components/schemas/booking_blk_uniqueIDListType","description":"Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id."}},"type":"object"},"booking_blk_blockRatePlanInfoType":{"description":"Rate Plan info type extension for block.","properties":{"cancelPenalty":{"$ref":"#/components/schemas/booking_blk_cancelPenaltyType","description":"Cancellation details for rate plan code."},"currencyCode":{"description":"Currency Code of the rate code.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Description of the Rate Code.","maxLength":2000,"minLength":0,"type":"string"},"guarantee":{"$ref":"#/components/schemas/booking_blk_guaranteeType","description":"Guarantee details for rate plan code."},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"longInfo":{"description":"Detail Information of the Rate Code.","maxLength":2000,"minLength":0,"type":"string"},"marketCode":{"description":"Market Code associated with the RatePlanCode.","maxLength":20,"minLength":0,"type":"string"},"mealPlans":{"$ref":"#/components/schemas/booking_blk_mealPlansType","description":"Meal plan codes for rate plan code."},"negotiated":{"description":"Indicates if the rate code is a negotiated rate code","type":"boolean"},"primary":{"description":"Is it a primary rate plan?","type":"boolean"},"ratePlanCategory":{"maxLength":20,"minLength":0,"type":"string"},"ratePlanCode":{"maxLength":20,"minLength":0,"type":"string"},"ratePlanLevel":{"description":"All rate codes are associated with rate plan level ( or rate category )for Channels. So if rate plans are given in the request, get all rate codes associated with the rate plan level.","maxLength":20,"minLength":0,"type":"string"},"serviceFeeInclusive":{"description":"Indicates if service fee is included in the rate code amount.","type":"boolean"},"shortInfo":{"description":"Brief Information of the Rate Code.","maxLength":2000,"minLength":0,"type":"string"},"showRateAmount":{"description":"Is the rate amount to be shown?","type":"boolean"},"sourceCode":{"description":"Source Code associated with the RatePlanCode.","maxLength":20,"minLength":0,"type":"string"},"taxInclusive":{"description":"Indicates if tax is included in the rate code amount.","type":"boolean"},"webPage":{"description":"URL providing more information about the Rate Code.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_blockRateProtectionType":{"description":"Block Rate Protection code information.","properties":{"criteria":{"$ref":"#/components/schemas/booking_blk_rateProtectionType","description":"Indicates the type of rate protection. 'All' means all dates are rate protected. 'None' specifies no rate protection. 'Selected' specifies few dates are rate protected."},"protectedDates":{"$ref":"#/components/schemas/booking_blk_datesType","description":"Specifies all the Rate protected dates in the selected range."}},"type":"object"},"booking_blk_blockReservationDetailsType":{"description":"Contains reservation related information for the block.","properties":{"activePostingMasterReservations":{"description":"Whether any active posting master reservations exist for the business block.","type":"boolean"},"arrivalTime":{"description":"Indicates the approximate check in time for the reservations made for the block. Uses the hotel's time zone.","format":"date-time","type":"string"},"breakfast":{"$ref":"#/components/schemas/booking_blk_breakfastType","description":"Indicates the breakfast information for the block room rates."},"controlBlockLocally":{"description":"Determines whether or not the block can be managed at the CRS level.","type":"boolean"},"cutOffDate":{"description":"Cut off date of the block.","format":"date","maxLength":8,"type":"string"},"cutOffDays":{"description":"Cut off days of the block.","type":"number"},"cutoffScheduleCode":{"description":"Cutoff Schedule Code for Business Block","maxLength":20,"minLength":0,"type":"string"},"decisionDate":{"description":"Contains information about the date by which the group must make a decision on the block.","format":"date","maxLength":8,"type":"string"},"departureTime":{"description":"Indicates the approximate check out time for the reservations made for the block. Uses the hotel's time zone.","format":"date-time","type":"string"},"elastic":{"description":"Elasticity of the block.","type":"number"},"followupDate":{"description":"This element informs about the systematic follow up on this business block. A Group Reservations Agent or Reservations Manager can use this date to identify when to followup with the customer.","format":"date","maxLength":8,"type":"string"},"guaranteeRequired":{"description":"Determines whether the CRS guarantee is required or not for the block.","type":"boolean"},"housing":{"description":"Determines whether or not the block can be managed at the CRS level.","type":"boolean"},"inventoryControl":{"$ref":"#/components/schemas/booking_blk_blockInventoryControlType","description":"Indicates whether the block is non elastic, elastic or sell limit block."},"personsPerRoom":{"description":"Indicates the expected number of guests per sleeping room when Occupancy Split Per Room Type parameter is N.","type":"number"},"porterage":{"$ref":"#/components/schemas/booking_blk_porterageType","description":"Indicates the Porterage information for the block room rates."},"postingMastersCancellable":{"description":"Indicates if posting master reservations can be cancelled.","type":"boolean"},"printRate":{"description":"Determines if the rate amounts are to be printed on the reservations picked up from the block. This becomes the default Print Rate setting for all reservations picked up from the block.","type":"boolean"},"rateGuarantee":{"description":"If this is true, then when a reservation is picked up for the block, the rate for that reservation is taken from the rate grid belonging to the block. If this is false, the rate amounts on the room grid are updated every time the Refresh Rates process is applied.","type":"boolean"},"ratePlanCode":{"description":"Rate Plan for the block.","items":{"$ref":"#/components/schemas/booking_blk_blockRatePlanInfoType"},"maxItems":4000,"type":"array"},"roomingListDueDate":{"description":"Due date for the rooming list for the block. This is the date by which the guest list should be provided by the customer.","format":"date","maxLength":8,"type":"string"},"suppressRate":{"description":"Are Rate amounts suppressed for the block.","type":"boolean"},"taRecordLocator":{"description":"Free format field to store information from Wholesaler for the block.","maxLength":50,"minLength":0,"type":"string"},"traceCode":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Trace code for the block."},"transactionCode":{"description":"Transaction Code for the block","maxLength":20,"minLength":0,"type":"string"},"updateGridOnCutoffChange":{"description":"Determines whether the CutOffDate or CutOffDays has changed for the block header. If CutOffDate or CutOffDays is changed then apply the changed cutoff date/ days as the new cutoff date/ days to all the room types in the Grid.","type":"boolean"}},"type":"object"},"booking_blk_blockRestrictionType":{"description":"Restriction details for a block.","properties":{"actualTimeSpan":{"$ref":"#/components/schemas/booking_blk_timeSpanType","description":"Actual time span of the restriction."},"blockRestrictionStatus":{"$ref":"#/components/schemas/booking_blk_restrictionStatusType","description":"Indicates the type of restriction along with parameters for restriction, if any."},"restrictionDate":{"$ref":"#/components/schemas/booking_blk_timeSpanDaysOfWeekType","description":"Date for which the restriction applies."},"roomType":{"description":"Room Type selected for the block restriction.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_blockRestrictionsType":{"description":"List of restrictions belonging to a block.","properties":{"blockId":{"$ref":"#/components/schemas/booking_blk_blockId","description":"Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA."},"blockRestriction":{"description":"Block restriction details.","items":{"$ref":"#/components/schemas/booking_blk_blockRestrictionType"},"maxItems":4000,"type":"array"},"hotelId":{"description":"Hotel to which the block belongs to.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_blockSourceOfSaleType":{"description":"Point of Sale of Block. Identifies the entity/channel who made the block reservation.","properties":{"sourceCode":{"$ref":"#/components/schemas/booking_blk_sourceCodeInfoType","description":"Identifies how this block came into the property."},"sourceType":{"description":"The of entity/channel where this business block originated.","maxLength":20,"minLength":0,"type":"string"},"sourceTypeDescription":{"description":"The of entity/channel where this business block originated.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_blockStatisticsSummaryType":{"description":"Type to store summary detail like rooms sold, average room rate and revenue for a statistic type.","properties":{"avgRoomRate":{"type":"number"},"revenueSummary":{"$ref":"#/components/schemas/booking_blk_revenueSummaryType"},"roomsSold":{"description":"Total Number of Rooms Picked Up.","type":"integer"},"statisticType":{"$ref":"#/components/schemas/booking_blk_statisticsSummaryType"}},"type":"object"},"booking_blk_blockStatisticsType":{"properties":{"actualCateringRevenue":{"description":"Indicates actualized catering revenue.","type":"number"},"actualRoomStatistics":{"$ref":"#/components/schemas/booking_blk_roomStatisticsType","description":"Indicates the room statistics for actualized rooms."},"allocatedRoomStatistics":{"$ref":"#/components/schemas/booking_blk_roomStatisticsType","description":"Indicates the room statistics for allocated rooms."},"cateringRevenueOnBooks":{"description":"Indicates the catering revenue on the books.","type":"number"}},"type":"object"},"booking_blk_blockStatusChangeHistoryType":{"description":"Collection of block status history.","items":{"$ref":"#/components/schemas/booking_blk_bookingStatusHistoryType"},"maxItems":4000,"type":"array"},"booking_blk_blockStatusTypeType":{"description":"Simple type for specifying the block status type.","enum":["Inquiry","Actual","Waitlist","Cancel","Referral"],"type":"string"},"booking_blk_blockTraceType":{"description":"Extended Trace object to hold information for a block.","properties":{"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"departmentId":{"description":"Indicates the Department code.","maxLength":20,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"reservationId":{"$ref":"#/components/schemas/booking_blk_reservationId","description":"Reservation ID of the reservation for which the traces are to be retrieved."},"resolveInfo":{"$ref":"#/components/schemas/booking_blk_traceResolveType","description":"Information regarding the status of the trace"},"timeInfo":{"$ref":"#/components/schemas/booking_blk_traceTimeInfoType","description":"Date of the trace."},"traceText":{"description":"The information this trace contains.","type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_blockTracesType":{"description":"List of Block traces.","items":{"$ref":"#/components/schemas/booking_blk_blockTraceType"},"maxItems":4000,"type":"array"},"booking_blk_blockType":{"properties":{"accessExclusions":{"$ref":"#/components/schemas/booking_blk_blockAccessExclusionsType","description":"List of access exclusions for the block."},"alternateDates":{"description":"Alternate Date information for the Block.","items":{"$ref":"#/components/schemas/booking_blk_blockAlternateDateType"},"maxItems":4000,"type":"array"},"attachments":{"$ref":"#/components/schemas/booking_blk_attachmentsType","description":"List of attachments for the Block."},"blockDetails":{"$ref":"#/components/schemas/booking_blk_blockDetailsType","description":"Detailed Block information for this block."},"blockIdList":{"$ref":"#/components/schemas/booking_blk_blockIdList","description":"Collection of unique block identifiers."},"blockIndicators":{"$ref":"#/components/schemas/booking_blk_indicatorsType","description":"Indicators of additional information attached to the block"},"blockOwners":{"$ref":"#/components/schemas/booking_blk_blockOwnersType","description":"Criteria to assign the owners of a business block."},"blockPackages":{"description":"A Block Package represents a non-room product provided to guests. Block Pacakges may have associated inventory and charges.","items":{"$ref":"#/components/schemas/booking_blk_blockPackageType"},"maxItems":4000,"type":"array"},"blockProfiles":{"description":"A collection of all the profiles associated to this block. Please note that during a change operation this performs a full overlay if the attribute FullOverlay is set to true. In a full overlay, all the profiles that should be associated to the block should be provided during a change operation. Any profiles not provided will be detached from this block. By default the full overlay is considered false if this tag is left blank. If values are provided for profiles, only the full overlay functionality is provided at this time.","properties":{"blockProfile":{"description":"The list of profiles associated with the block.","items":{"$ref":"#/components/schemas/booking_blk_blockProfilesType"},"maxItems":4000,"type":"array"},"fullOverlay":{"description":"Indicates whether to perform a full overlay for the profiles. Currently only the Fulloverlay functionality is provided.","type":"boolean"}},"type":"object"},"blockSecurity":{"description":"Block security information used for an external system. Only available if configured in OPERA Cloud.","properties":{"advanceCancelDays":{"description":"Number of days before the arrival date a reservation can be canceled without losing the deposit.","type":"number"},"allDescriptionDDSecured":{"description":"All Description DD Secured.","type":"boolean"},"commissionableYn":{"description":"Determines if Travel Agent commission will be paid on reservations booked through the HOLIDEX Plus TACP program.","type":"boolean"},"daysDepositRequired":{"description":"Number of Days Deposit due to guarantee the guest booking.","type":"number"},"housingInformationSecured":{"description":"Housing Information Secured.","type":"boolean"},"ratesSecuredfromAllDisplays":{"description":"Rates Secured from All Displays.","type":"boolean"},"ratesSecuredfromGNR":{"description":"Rates Secured from GNR.","type":"boolean"},"returnOneDayAtTimeYn":{"description":"Return One Day at a time.","type":"boolean"},"securedFromDIdisplayYn":{"description":"Secured from DI Display.","type":"boolean"}},"type":"object"},"blockStatistics":{"$ref":"#/components/schemas/booking_blk_blockStatisticsType","description":"Indicates the room and revenue statistics of the block."},"catering":{"$ref":"#/components/schemas/booking_blk_cateringType","description":"Details of catering Information for the Block."},"centralSalesLeads":{"$ref":"#/components/schemas/booking_blk_centralSalesLeadsType","description":"Basic information about the Central Sales Lead and its Property Leads."},"comments":{"description":"List of notes for the Block.","properties":{"commentInfo":{"items":{"$ref":"#/components/schemas/booking_blk_commentInfoType"},"maxItems":4000,"type":"array"},"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"externalAttributes":{"description":"Block attributes used for external systems. Only available if configured in OPERA Cloud.","properties":{"eventType":{"$ref":"#/components/schemas/booking_blk_eventTypeType","description":"Contract type of a block, which is used for external system. Only available if configured in OPERA Cloud."},"gIId":{"description":"Group IATA number validated by an external system and block can't be saved unless confirmed that GIID is valid. Only available if configured in OPERA Cloud.","type":"string"},"housingProtected":{"description":"Only available if configured in OPERA Cloud.","type":"boolean"},"rollEndDate":{"description":"When this flag is set it will be used to roll Block End Date and Block Rate Program End Date in the night audit process. Only available if configured in OPERA Cloud.","type":"boolean"}},"type":"object"},"externalReferences":{"$ref":"#/components/schemas/booking_blk_externalReferencesType","description":"External Reference information for Reservation."},"genericRoomAllocations":{"description":"Generic Room Type Allocations for the Block.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"masterInfo":{"$ref":"#/components/schemas/booking_blk_roomAllocationMasterInfoType","description":"Generic Room Allocations Master Information contains all the room types in the property."},"numberOfDays":{"type":"number"},"roomAllocationType":{"items":{"$ref":"#/components/schemas/booking_blk_roomAllocationTypeType"},"maxItems":4000,"type":"array"},"startDate":{"format":"date","maxLength":8,"type":"string"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"inventoryItems":{"$ref":"#/components/schemas/booking_blk_blockInventoryItemsType","description":"A collection of inventory items attached to a block."},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"markAsRecentlyAccessed":{"description":"Mark this block as recently accessed.","type":"boolean"},"masterBlockInfo":{"$ref":"#/components/schemas/booking_blk_masterBlockInfoType","description":"Basic information of master and sub blocks structure in tree manner, this element only used while retrieving Block Type."},"ratePrograms":{"description":"Rate Program contains rate information required for block creation, like room pool, rate amount, market code, etc. Only available if configured in OPERA Cloud.","items":{"$ref":"#/components/schemas/booking_blk_rateProgramType"},"maxItems":4000,"type":"array"},"reservationDetails":{"$ref":"#/components/schemas/booking_blk_blockReservationDetailsType","description":"Details of room Information for the Block."},"reservationPolicies":{"description":"A list of reservation policies.","items":{"$ref":"#/components/schemas/booking_blk_reservationPoliciesType"},"maxItems":4000,"type":"array"},"restrictions":{"$ref":"#/components/schemas/booking_blk_blockRestrictionsType","description":"List of restrictions for the Block."},"roomAllocations":{"description":"Room Allocations for the Block.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"masterInfo":{"$ref":"#/components/schemas/booking_blk_roomAllocationMasterInfoType","description":"Room Allocations Master Information contains all the room types in the property."},"numberOfDays":{"type":"number"},"roomAllocationType":{"items":{"$ref":"#/components/schemas/booking_blk_roomAllocationTypeType"},"maxItems":4000,"type":"array"},"startDate":{"format":"date","maxLength":8,"type":"string"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"sellMessages":{"$ref":"#/components/schemas/booking_blk_sellMessageConfigsType","description":"List of sell messages for the Block."},"statistics":{"description":"Statistics summary information including Rooms Sold, Room Revenue, Food and Beverage Revenue, Average Room Rate,etc.","items":{"$ref":"#/components/schemas/booking_blk_blockStatisticsSummaryType"},"maxItems":3,"type":"array"},"traces":{"$ref":"#/components/schemas/booking_blk_blockTracesType","description":"List of block traces."},"userDefinedFields":{"$ref":"#/components/schemas/booking_blk_userDefinedFieldsType","description":"Collections of user defined fields."},"washSchedules":{"$ref":"#/components/schemas/booking_blk_blockWashSchedulesType","description":"List of wash schedules for the Block."}},"type":"object"},"booking_blk_blockWashScheduleType":{"description":"Allows to select type of wash schedule: by number of rooms or by percentage.","properties":{"roomTypes":{"description":"A single room type on which wash operation should be performed.","items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"washByPercent":{"description":"When using the Wash by % option, indicate a wash percentage that will be applied it to the whole block.","maximum":100,"minimum":0,"type":"number"},"washByRooms":{"$ref":"#/components/schemas/booking_blk_blockGridInvType","description":"Wash by rooms contains the occupany details and sell values for a specific block wash schedule."},"washDate":{"description":"Date on which the block wash operation will be performed.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_blk_blockWashSchedulesType":{"description":"Wash Schedule attached to the block, which allows to release inventory based on selected wash schedule type.","items":{"$ref":"#/components/schemas/booking_blk_blockWashScheduleType"},"maxItems":4000,"type":"array"},"booking_blk_bookingChannelMappingType":{"properties":{"bookingChannelCode":{"maxLength":20,"minLength":0,"type":"string"},"code":{"maxLength":20,"minLength":0,"type":"string"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"name":{"maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_bookingStatusDetailType":{"description":"Booking Status details of the business block.","properties":{"allowPickup":{"description":"Indicates if business blocks with this status will be allowed for pickup or not.","type":"boolean"},"bookingStatus":{"$ref":"#/components/schemas/booking_blk_bookingStatusType","description":"Booking Status of the business block."},"cancellationType":{"$ref":"#/components/schemas/booking_blk_blockCancellationTypeType","description":"Cancellation reason type of the booking status. Populates only when the booking status is of return to inventory type."},"catDeductInventory":{"description":"Indicates if catering event's spaces are deducted from inventory","type":"boolean"},"catStatusType":{"$ref":"#/components/schemas/booking_blk_blockStatusTypeType","description":"Indicates status type Inquiry, Actual, Cancel, etc."},"deductInventory":{"description":"Indicates if blocked rooms are deducted from inventory.","type":"boolean"},"defaultReservationType":{"description":"Default reservation type for the booking status.","maxLength":20,"minLength":0,"type":"string"},"parentBookingStatus":{"description":"Parent status of the booking status, if one exists.","maxLength":20,"minLength":0,"type":"string"},"returnToInventory":{"description":"Indicates if blocked rooms will be returned to availability or not.","type":"boolean"},"statusType":{"$ref":"#/components/schemas/booking_blk_blockStatusTypeType","description":"Indicates status type Inquiry, Actual, Cancel, etc."}},"type":"object"},"booking_blk_bookingStatusHistoryType":{"properties":{"bookingStatus":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Booking status of the business block."},"modifierId":{"description":"User who modified the status.","maxLength":200,"minLength":0,"type":"string"},"modifyDateTime":{"description":"Date and time of the status change.","format":"date","maxLength":8,"type":"string"},"sequence":{"description":"Number indicating the sequence of status change.","type":"integer"}},"type":"object"},"booking_blk_bookingStatusType":{"description":"Booking status code, description and configured color of the status. This will be used for block and event statuses.","properties":{"color":{"$ref":"#/components/schemas/booking_blk_statusColorType","description":"Color from status configuration."},"returnToInventory":{"description":"Flag that indicates if there are return to inventory status blocks, sub-blocks or reservations.","type":"boolean"},"status":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Status code and description."}},"type":"object"},"booking_blk_breakfastType":{"description":"Information about breakfast charges.","properties":{"breakfastIncluded":{"description":"Indicates if the room rate quoted includes the breakfast cost.","type":"boolean"},"description":{"description":"The exact breakfast method for this business block that is included or offered as an extra.","maxLength":40,"minLength":0,"type":"string"},"price":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"The additional charges per person for breakfast, if breakfast is not included in the rate."}},"type":"object"},"booking_blk_callHistoryType":{"description":"Holds call information.","items":{"$ref":"#/components/schemas/booking_blk_callType"},"maxItems":4000,"type":"array"},"booking_blk_callType":{"description":"Holds call information.","properties":{"caller":{"$ref":"#/components/schemas/booking_blk_callerType","description":"Holds caller information."},"comments":{"description":"Call comments.","maxLength":200,"minLength":0,"type":"string"},"dateTimeSpan":{"$ref":"#/components/schemas/booking_blk_dateTimeSpanType","description":"Call Time Span. Start Date and End Date is used for the Call duration."},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"reservation":{"description":"Holds Reservation Id and Hotel Code.","properties":{"hotelId":{"description":"Holds Hotel Code.","maxLength":20,"minLength":0,"type":"string"},"reservationIdList":{"$ref":"#/components/schemas/booking_blk_reservationIdList","description":"Holds Reservation related Ids."}},"type":"object"},"turnawayCode":{"description":"Call turn away code.","maxLength":20,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_blk_callerType":{"description":"Holds caller information.","properties":{"email":{"description":"Caller Email.","maxLength":80,"minLength":0,"type":"string"},"fax":{"description":"Caller Fax Number.","maxLength":80,"minLength":0,"type":"string"},"givenName":{"description":"Caller First Name.","maxLength":280,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"phone":{"description":"Caller Phone Number.","maxLength":80,"minLength":0,"type":"string"},"surname":{"description":"Caller Last Name.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_blk_cancelPenaltyType":{"description":"The CancelPenalty class defines the cancellation policy of the hotel facility.","properties":{"amountPercent":{"$ref":"#/components/schemas/booking_blk_policyAmountPercentType","description":"Cancellation fee expressed as a fixed amount, or percentage of/or room nights."},"deadline":{"$ref":"#/components/schemas/booking_blk_policyDeadlineType","description":"Cancellation deadline, absolute or relative."},"effective":{"description":"Indicator if Cancellation Penalty is currently applicable or not.","type":"boolean"},"estimatedAmount":{"description":"Estimated Amount for the cancellation penalty.","type":"number"},"formattedRule":{"description":"Formatted Text Rule of the Cancellation Penalty.","maxLength":2000,"minLength":0,"type":"string"},"manual":{"description":"Flag to indicate if the cancellation policy is manual.","type":"boolean"},"nonRefundable":{"description":"Indicates if the amount is refundable if booking is canceled.","type":"boolean"},"offsetUnit":{"$ref":"#/components/schemas/booking_blk_offsetUnitType"},"penaltyDescription":{"description":"Text description of the Penalty in a given language.","maxLength":2000,"minLength":0,"type":"string"},"policyCode":{"description":"Policy Code.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_cancellationDetailsType":{"description":"This type holds information regarding booking status change to Cancel/ Lost.","properties":{"cancellationCode":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Code and description for cancellation reason."},"cancellationDate":{"description":"Date on which block was canceled.","format":"date","maxLength":8,"type":"string"},"cancellationInfo":{"description":"Cancellation information provided by the customer.","maxLength":2000,"minLength":0,"type":"string"},"cancellationNumber":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Cancellation number of the block."},"destination":{"description":"Alternate destination where the business is being taken.","maxLength":20,"minLength":0,"type":"string"},"lostToProperty":{"description":"Holds the name of the property or competitor brand business was lost to.","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_cardNumberTypeType":{"description":"Simple type for indicating if credit card number is tokenized.","enum":["CardNumber","Token"],"type":"string"},"booking_blk_cardProcessingType":{"enum":["Eft","Manual"],"type":"string"},"booking_blk_cardReIssueType":{"description":"Request to re issue a new card.","enum":["Pending","NotApplicable","Requested"],"type":"string"},"booking_blk_cardTypeType":{"description":"This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.","enum":["Ab","Am","Ax","Cb","Dc","Ds","Dt","Ec","Er","Jc","Jl","Mc","Nb","So","St","Sw","Va","Xy","Zz","Cp","Cu"],"type":"string"},"booking_blk_cateringEventsProcessedInfoList":{"description":"Status/Info of the processed events.","items":{"$ref":"#/components/schemas/booking_blk_cateringEventsProcessedInfoType"},"maxItems":4000,"type":"array"},"booking_blk_cateringEventsProcessedInfoType":{"description":"Status/Info of the processed events.","properties":{"blockId":{"$ref":"#/components/schemas/booking_blk_blockId","description":"BlockID of the event."},"eventDate":{"description":"Date of the event","format":"date","maxLength":8,"type":"string"},"eventName":{"description":"Name of event.","maxLength":60,"minLength":0,"type":"string"},"eventType":{"description":"Type of event.","maxLength":20,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel code where event will be copied.","maxLength":20,"minLength":0,"type":"string"},"processingInfoCode":{"description":"Erorr/Warning code for not processing th event.","maxLength":200,"minLength":0,"type":"string"},"processingInfoType":{"description":"Flag to indicate the warning messages from the API","type":"string"},"reason":{"description":"Reason for not processing the event.","type":"string"},"room":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"The function space room where the event takes place ."},"status":{"description":"Status of the processed event. e.g Completed, Not Processed.","type":"string"}},"type":"object"},"booking_blk_cateringNextStatusListType":{"description":"Next catering status of the business block.","items":{"$ref":"#/components/schemas/booking_blk_bookingStatusDetailType"},"maxItems":4000,"type":"array"},"booking_blk_cateringResInfoType":{"description":"Information regarding catering event and catering revenue type associated to the reservation.","properties":{"eventId":{"$ref":"#/components/schemas/booking_blk_eventId","description":"Unique ID on a catering event associated to the reservation."},"revenueType":{"description":"Catering revenue type associated to the reservation.","type":"string"}},"type":"object"},"booking_blk_cateringRevenueType":{"description":"Information about Catering Revenue.","properties":{"itemDiscount":{"description":"Item discount for the block.","type":"number"},"itemDiscountPercentage":{"description":"The discount percentage to be applied to resource items associated with catering events.","maximum":100,"minimum":0,"type":"number"},"serviceCharge":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"The service charge for the Catering Events that will be added to the business block."},"taxAmount":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"The tax amount for the Catering Events that will be added to the business block."}},"type":"object"},"booking_blk_cateringStatusChangeHistoryType":{"description":"Collection of catering status history.","items":{"$ref":"#/components/schemas/booking_blk_bookingStatusHistoryType"},"maxItems":4000,"type":"array"},"booking_blk_cateringType":{"description":"Contains catering related information for the block.","properties":{"applyBoardInfoToAllEvents":{"description":"Indicates whether BoardInfo changes can be applied to all events of the block.","type":"boolean"},"applyEventAttendeesChangesToEvents":{"$ref":"#/components/schemas/booking_blk_applyEventAttendeesChangesToEventsType","description":"Indicates to which the events of the block can the attendees changes be applied."},"applyEventsGuaranteeToAllEvents":{"description":"Indicates whether Guarantee changes can be applied to all events of the block.","type":"boolean"},"applyMoveEvents":{"description":"Indicates whether catering event dates are moved when the block dates are changed.","type":"boolean"},"boardInfo":{"description":"The name by which the group wishes to be identified in the hotel.","maxLength":80,"minLength":0,"type":"string"},"cancellationDetails":{"$ref":"#/components/schemas/booking_blk_cancellationDetailsType","description":"Information on the catering cancellation."},"cateringInternalStatus":{"description":"Internal status for the catering.","maxLength":20,"minLength":0,"type":"string"},"cateringNextStatusList":{"$ref":"#/components/schemas/booking_blk_cateringNextStatusListType","description":"Catering Status details of the block."},"cateringOwner":{"description":"Catering Owner of the block.","maxLength":20,"minLength":0,"type":"string"},"cateringRevenue":{"$ref":"#/components/schemas/booking_blk_cateringRevenueType","description":"Information about catering revenue."},"cateringStatus":{"$ref":"#/components/schemas/booking_blk_bookingStatusDetailType","description":"Catering Status details of the block."},"cateringStatusChangeHistory":{"$ref":"#/components/schemas/booking_blk_cateringStatusChangeHistoryType","description":"List of catering status changes."},"contractNumber":{"description":"Catering contract number for the block.","maxLength":20,"minLength":0,"type":"string"},"decisionDate":{"description":"Date by which event group must make a decision on the booking.","format":"date","maxLength":8,"type":"string"},"eventAttendees":{"$ref":"#/components/schemas/booking_blk_eventAttendeesType","description":"The catering attendees information for events associated with the block."},"eventOrder":{"$ref":"#/components/schemas/booking_blk_eventOrderType","description":"Indicates if the Banquet Event Orders have been distributed."},"followUpDate":{"description":"Date used by catering manager or coordinator to follow up on the event.","format":"date","maxLength":8,"type":"string"},"functionInfo":{"description":"This provides more detail the type of function for which the event is held. For example, Trade Show, Meeting, or Annual Convention.","maxLength":60,"minLength":0,"type":"string"},"hasPackageEvents":{"description":"Indicates if the block has any package events.","type":"boolean"},"onSiteName":{"description":"The name of the customer's in-house representative or contact on the day of the catering event.","maxLength":40,"minLength":0,"type":"string"},"overrideEventsProcessingWarnings":{"description":"Indicates whether to ignore any warning during applying the changes to the events associated with the current block.","type":"boolean"},"pkgsTmplt":{"description":"Indicates whether event packages or templates can be applied to the block.","type":"boolean"},"resourceDiscountPercentage":{"description":"Indicates the resource discount percentage to be applied to resource items associated with the catering event.","maximum":100,"minimum":0,"type":"number"},"resourceDiscountType":{"$ref":"#/components/schemas/booking_blk_resourceDiscountTypeType","description":"Attibute that indicates to which type of resource the discount should be applied to."},"trackChanges":{"description":"Indicates whether the catering change logging for the booking is active or not. Any change made to catering events and resources will be logged when this is true.","type":"boolean"}},"type":"object"},"booking_blk_centralSalesLeadsType":{"description":"Basic information about the Central Lead and its linked Property Leads.","properties":{"centralLead":{"$ref":"#/components/schemas/booking_blk_leadInfoType","description":"Basic information about the Central Lead."},"propertyLeads":{"description":"Basic information about the Property Leads.","items":{"$ref":"#/components/schemas/booking_blk_leadInfoType"},"maxItems":4000,"type":"array"}},"type":"object"},"booking_blk_changedBlockStatus":{"description":"Response object for the request to change block status. Response contains information on the block whose status was successfully changed.","properties":{"anyActivePMReservations":{"description":"Indicates whether block has any active PM reservations.","type":"boolean"},"block":{"$ref":"#/components/schemas/booking_blk_blockType","description":"Provides detailed information regarding a block."},"blockNextStatusList":{"$ref":"#/components/schemas/booking_blk_blockNextStatusListType","description":"List of possible next booking statuses of the business block."},"blockStatusChangeHistory":{"$ref":"#/components/schemas/booking_blk_blockStatusChangeHistoryType","description":"List of booking status changes."},"cancellationDetails":{"$ref":"#/components/schemas/booking_blk_cancellationDetailsType","description":"Information on the block that was canceled."},"cateringEventsProcessedInfo":{"$ref":"#/components/schemas/booking_blk_cateringEventsProcessedInfoList","description":"Status of the processed events after the block catering status change."},"links":{"$ref":"#/components/schemas/booking_blk_links"},"processId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Unique ID of the submitted background process."},"warnings":{"$ref":"#/components/schemas/booking_blk_warningsType"}},"type":"object"},"booking_blk_characterUDFType":{"description":"Used to hold user defined field of Character/String Type.","properties":{"alternateName":{"description":"Label of user defined field used by vendors or customers.","maxLength":2000,"minLength":0,"type":"string"},"name":{"description":"Used to hold user defined field of Character Type. It is highly recommended to use UDFC01, UDFC02,...UDFC40 (Total 40) as Character/String UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Value of user defined field.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_characterUDFsType":{"description":"Used to hold collection of user defined fields of Character/String Type.","items":{"$ref":"#/components/schemas/booking_blk_characterUDFType"},"maxItems":4000,"type":"array"},"booking_blk_childAgeType":{"description":"Defines Child's Age.","properties":{"age":{"description":"Age of a child in years.","type":"integer"}},"type":"object"},"booking_blk_childAgesType":{"description":"Age of a child in years.","items":{"$ref":"#/components/schemas/booking_blk_childAgeType"},"maxItems":4000,"type":"array"},"booking_blk_childBucketsType":{"description":"Defines children counts with Age Qualifying Group(Child Bucket) classification.","properties":{"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"}},"type":"object"},"booking_blk_codeDescriptionType":{"description":"This contains a generic code and description information.","properties":{"code":{"description":"Code.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"description.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_codeListType":{"items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"booking_blk_colorType":{"description":"Color configuration type. This color configuration provides a visual category of entities.","enum":["Red","DarkRed","Green","DarkGreen","LightGreen","Orange","White","Yellow","DarkYellow","Purple","Brown","Gray","Aqua","Chocolate","Blue","LightBlue","DarkBlue","Cyan","DarkCyan","Magenta","DarkMagenta","Black"],"type":"string"},"booking_blk_commentInfoType":{"description":"Comment related to the profile/reservation.","properties":{"comment":{"$ref":"#/components/schemas/booking_blk_commentType","description":"Comment details for the comment. It will be empty in case of delete comment."},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"warnings":{"$ref":"#/components/schemas/booking_blk_warningsType"}},"type":"object"},"booking_blk_commentType":{"description":"An indication of a new paragraph for a sub-section of a formatted text message.","properties":{"actionDate":{"description":"Indicates at which date an action described in the comment must be taken.","format":"date","maxLength":8,"type":"string"},"actionType":{"description":"Specifies type of action described in the comments.","maxLength":20,"minLength":0,"type":"string"},"commentTitle":{"description":"Specifies Comment's Title.","maxLength":4000,"minLength":0,"type":"string"},"confidential":{"description":"When true, the comment may be confidential.","type":"boolean"},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"hotelId":{"description":"If specified comment belongs to the Hotel, otherwise it is a global comment.","maxLength":20,"minLength":0,"type":"string"},"image":{"description":"An image for this paragraph.","type":"string"},"internal":{"description":"When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer.","type":"boolean"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"notificationLocation":{"description":"Notification Location associated with the Note.","maxLength":20,"minLength":0,"type":"string"},"overrideInternal":{"description":"When true, the note internal could be modified.","type":"boolean"},"protectDescription":{"description":"When true, the note title will be populated from the note type description and couldn't be modified.","type":"boolean"},"text":{"$ref":"#/components/schemas/booking_blk_formattedTextTextType","description":"Formatted text content."},"type":{"description":"Specifies type of the comment.","maxLength":20,"minLength":0,"type":"string"},"typeDescription":{"description":"Comment type Description.","maxLength":200,"minLength":0,"type":"string"},"url":{"description":"A URL for this paragraph.","type":"string"}},"type":"object"},"booking_blk_commissionPaymentMethods":{"description":"Check","enum":["Cent","Eft","Chk"],"type":"string"},"booking_blk_commissionPayoutToType":{"enum":["TravelAgent","Source","TravelAgentSource","None"],"type":"string"},"booking_blk_communicationStatusType":{"description":"Enum to denote the Status of Readiness messages sent to Guest Devices.","enum":["Pending","Completed","Failed","Sent","Received","Cancelled","PendingAvailability"],"type":"string"},"booking_blk_compAuthorizerInfoType":{"description":"Authorizer Information","properties":{"authorizerId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type"},"authorizerName":{"description":"Full name of the authorizer.","maxLength":100,"minLength":0,"type":"string"},"authorizerUserName":{"description":"Application user name of the authorizer","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_compRoutingRequestType":{"description":"Type for the details of a Comp Routing Request","properties":{"comments":{"maxLength":2000,"minLength":0,"type":"string"},"declinedBy":{"$ref":"#/components/schemas/booking_blk_userInfoType","description":"User information of user who declined comp routing request"},"requestedBy":{"$ref":"#/components/schemas/booking_blk_userInfoType","description":"User who requested the Comp Routing"},"status":{"$ref":"#/components/schemas/booking_blk_compRoutingStatusType","description":"Comp routing status"}},"type":"object"},"booking_blk_compRoutingStatusType":{"description":"Status which indicates that the Request of Comp Routing was declined","enum":["Request","Comp","Declined"],"type":"string"},"booking_blk_companyInfoType":{"description":"Company Information of the Profile.","properties":{"department":{"description":"Department of the Profile.","maxLength":20,"minLength":0,"type":"string"},"legalCompany":{"description":"Legal Company.","maxLength":20,"minLength":0,"type":"string"},"position":{"description":"Business Title or Position of the profile.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_companyType":{"properties":{"alternateName":{"description":"Alternate Name of the Company. Mainly, it's the name of the company written in the Alternate Language.","maxLength":40,"minLength":0,"type":"string"},"commissionCode":{"description":"Commission code of the company.","maxLength":20,"minLength":0,"type":"string"},"companyName":{"description":"Name of the company.","maxLength":40,"minLength":0,"type":"string"},"currencyCode":{"description":"The code specifying a monetary unit. Use ISO 4217, three alpha code.","maxLength":20,"minLength":0,"type":"string"},"currencySymbol":{"description":"The symbol for the currency, e.g, for currencyCode USD the symbol is $.","maxLength":10,"minLength":0,"type":"string"},"decimalPlaces":{"description":"Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).","type":"integer"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"nationality":{"description":"Nationality code identification","maxLength":20,"minLength":0,"type":"string"},"vipDescription":{"description":"Description of the VIP status.","maxLength":2000,"minLength":0,"type":"string"},"vipStatus":{"description":"VIP status of the company.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_confDeliveryInfoType":{"properties":{"communicationType":{"$ref":"#/components/schemas/booking_blk_confDeliveryMethod","description":"CommunicationType through which the confirmation letter was sent."},"lastAttempted":{"description":"Date of last attempt to send confirmation letter. Uses the hotel's time zone.","format":"date-time","type":"string"},"lastStatus":{"$ref":"#/components/schemas/booking_blk_sentConfirmationStatus","description":"Status of last sent confirmation."},"successfulTries":{"description":"Number of success letter sent.","type":"integer"}},"type":"object"},"booking_blk_confDeliveryInfoTypes":{"description":"List of confirmation letter delivery methods and their status","items":{"$ref":"#/components/schemas/booking_blk_confDeliveryInfoType"},"maxItems":4,"type":"array"},"booking_blk_confDeliveryMethod":{"enum":["Print","Email","Fax","Text","NotConfigured"],"type":"string"},"booking_blk_confRecipientInfoType":{"properties":{"addressInfo":{"$ref":"#/components/schemas/booking_blk_addressInfoType","description":"id of the address where to send confirmation letter."},"emailInfo":{"$ref":"#/components/schemas/booking_blk_emailInfoType","description":"id of the Email where to send confirmation letter."},"faxInfo":{"$ref":"#/components/schemas/booking_blk_telephoneInfoType","description":"id of the Fax where to send confirmation letter."},"formerName":{"$ref":"#/components/schemas/booking_blk_profileNameType","description":"Last Name of recipient."},"profileId":{"$ref":"#/components/schemas/booking_blk_profileId","description":"name id of the recipient."},"recipientType":{"$ref":"#/components/schemas/booking_blk_profileTypeType"},"telephoneInfo":{"$ref":"#/components/schemas/booking_blk_telephoneInfoType","description":"id of the Mobile where to send confirmation letter."}},"type":"object"},"booking_blk_configPackagePrimaryDetailsType":{"description":"A Config Package Info type.","properties":{"arrangementCode":{"description":"Arrangement Code.","maxLength":20,"minLength":0,"type":"string"},"beginSellDate":{"description":"Indicates the begin sell date of the package.","format":"date","maxLength":8,"type":"string"},"description":{"description":"The description of the package.","maxLength":2000,"minLength":0,"type":"string"},"endSellDate":{"description":"Indicates the end sell date of the package.","format":"date","maxLength":8,"type":"string"},"forecastGroup":{"description":"The Forecast group package belongs to.","maxLength":20,"minLength":0,"type":"string"},"shortDescription":{"description":"The short description of the package.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_configPackageTransactionType":{"description":"A HotelPackageTransaction type.","properties":{"allowance":{"description":"Package is marked as an allowance, in case charge is expected back to the guest account from external interface eg. POS. which need to be offset against a consumption allowance.","type":"boolean"},"calculationRule":{"description":"The price calculation rule for this package.","maxLength":80,"minLength":0,"type":"string"},"currency":{"description":"The currency code for this package.","maxLength":20,"minLength":0,"type":"string"},"packagePostingRules":{"$ref":"#/components/schemas/booking_blk_packagePostingRulesType","description":"The package posting rule details."},"postingType":{"description":"The posting frequency for this package, e.g., daily, arrival, departure, etc.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_configPackageUsageDetailType":{"description":"A Config Package Usage Detail type.","properties":{"source":{"$ref":"#/components/schemas/booking_blk_productSourceType","description":"Indicates if the source of the product is Rate header, Rate Detail or Reservation."},"usedInHouseReservations":{"description":"Indicates if any checked in reservations are using this product.","type":"boolean"},"usedInRates":{"description":"Indicates if the package is used in any rate code.","type":"boolean"},"usedInReservations":{"description":"Indicates if the package is used in, reserved or prospect reservations.","type":"boolean"}},"type":"object"},"booking_blk_configPostingAttributesType":{"description":"A config Package posting attributes type.","properties":{"addToRate":{"description":"The package price is added to the room rate.","type":"boolean"},"calculatedPrice":{"description":"Calculated Package Price based from Number of Adults, Children and Calculation Rule.","type":"number"},"catering":{"description":"Is package used for catering?","type":"boolean"},"deliveryTimeRequired":{"description":"Indicates whether a delivery time is required for the package.","type":"boolean"},"endTime":{"description":"End time the package is valid.","type":"string"},"forecastNextDay":{"description":"Package will be forecasted for consumption the next business day.","type":"boolean"},"formula":{"description":"The custom formula used for this package, if any.","maxLength":2000,"minLength":0,"type":"string"},"formulaFunctionArguments":{"$ref":"#/components/schemas/booking_blk_functionArgumentsType","description":"The function argument name-value combination accepted by the custom formula used for this package."},"formulaFunctionName":{"description":"The custom formula function name used for this package, if any.","maxLength":2000,"minLength":0,"type":"string"},"inventoryItems":{"description":"Package Code Inventory Items type.","items":{"$ref":"#/components/schemas/booking_blk_pkgInventoryItemType"},"maxItems":4000,"type":"array"},"postNextDay":{"description":"package charges will be posted next business day.","type":"boolean"},"postingRhythm":{"$ref":"#/components/schemas/booking_blk_packagePostingRhythmType","description":"The posting rhythm for this package."},"priceCalculationRule":{"$ref":"#/components/schemas/booking_blk_packageCalculationRuleType","description":"The price calculation rule for this package."},"printSeparateLine":{"description":"The package price is printed on separate line of the folio.","type":"boolean"},"sellSeparate":{"description":"Can the package be sold separate from rate plan code?","type":"boolean"},"startTime":{"description":"Start time the package is valid.","type":"string"},"ticket":{"description":"Indicates whether a package is configured as a ticket or not.","type":"boolean"},"webBookable":{"description":"Can package be sold via Web channel.","type":"boolean"}},"type":"object"},"booking_blk_confirmationStyle":{"properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"style":{"description":"Name of the confirmation letter style.","type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_blk_confirmationType":{"properties":{"confirmationStyleInfo":{"$ref":"#/components/schemas/booking_blk_confirmationStyle","description":"Confirmation style."},"deliveryInfo":{"$ref":"#/components/schemas/booking_blk_confDeliveryInfoTypes","description":"The status of the confirmation letter sent via the specified CommunicationType."},"fromEmail":{"description":"Senders Email address.","maxLength":40,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"recipientInfo":{"$ref":"#/components/schemas/booking_blk_confRecipientInfoType","description":"Receipient's information."},"sendTextMessage":{"description":"Flag to indicate sending confirmation letter as text message.","type":"boolean"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_blk_confirmationsType":{"description":"List of confirmation letters.","items":{"$ref":"#/components/schemas/booking_blk_confirmationType"},"maxItems":4000,"type":"array"},"booking_blk_countryNameType":{"description":"Code for a country or a nationality.","properties":{"code":{"description":"Code for a country or a nationality.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Used for Character Strings, length 0 to 200.","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_currencyAmountType":{"description":"A monetary value expressed with a currency code.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"}},"type":"object"},"booking_blk_currentRoomInfoType":{"description":"Room information of the reservation for the current day.","properties":{"assignedByAI":{"description":"Represents the room was assigned by AI Room Assignment.","type":"boolean"},"roomDescription":{"description":"Current room description.","maxLength":2000,"minLength":0,"type":"string"},"roomId":{"description":"Current room number.","maxLength":20,"minLength":0,"type":"string"},"roomType":{"description":"Current room type.","maxLength":20,"minLength":0,"type":"string"},"roomViewCode":{"description":"Represents the room view code like City view, River view, Ocean view etc.","maxLength":40,"minLength":0,"type":"string"},"suggestedRoomNumbers":{"$ref":"#/components/schemas/booking_blk_codeListType","description":"Suggested room numbers."},"upgradedByAI":{"description":"Represents the room was upgraded by AI Room Assignment.","type":"boolean"}},"type":"object"},"booking_blk_customChargeExemptionDateType":{"description":"Contains Custom Charge Exemption information for a day.","properties":{"date":{"description":"Contains Custom Charge Exemption date.","format":"date","maxLength":8,"type":"string"},"quantity":{"description":"Contains number of Custom Charge Exemption for a day.","type":"integer"}},"type":"object"},"booking_blk_customChargeExemptionDatesType":{"description":"Contains List of Custom Charge Exemption information for a day.","items":{"$ref":"#/components/schemas/booking_blk_customChargeExemptionDateType"},"maxItems":4000,"type":"array"},"booking_blk_customChargeExemptionType":{"description":"Contains custom charges exemption information.","properties":{"customChargeDates":{"$ref":"#/components/schemas/booking_blk_customChargeExemptionDatesType","description":"Contains exemption detail information for each date."},"customChargeQuantity":{"$ref":"#/components/schemas/booking_blk_customChargeQuantityType","description":"Contains exemption quantity for the stay. When this value is configured, daily exemption quantities are not permitted."},"customChargesExemption":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Contains exemption code and description."},"excludedDates":{"$ref":"#/components/schemas/booking_blk_excludedDatesType","description":"Contains list of dates which are not valid for custom charge exemptions."},"percentage":{"description":"Exemption Percentage","maximum":100,"minimum":0,"type":"number"},"propertyExemption":{"description":"Flag specifying if custom charge exemptions is property level or not.","type":"boolean"}},"type":"object"},"booking_blk_customChargeExemptionsType":{"description":"List of Custom Charge Exemptions.","items":{"$ref":"#/components/schemas/booking_blk_customChargeExemptionType"},"maxItems":4000,"type":"array"},"booking_blk_customChargeQuantityType":{"description":"Contains quantity of custom charge exemptions.","properties":{"available":{"description":"Indicates if Custom Charges Exemption information is editable.","type":"boolean"},"quantity":{"description":"Contains number of Custom Charge Exemption for a day.","type":"integer"}},"type":"object"},"booking_blk_customerType":{"description":"Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.","properties":{"anonymization":{"$ref":"#/components/schemas/booking_blk_anonymizationType","description":"Provides information about the guest's anonymization status"},"birthDate":{"description":"Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.","format":"date","maxLength":8,"type":"string"},"birthDateMasked":{"description":"Indicates the date of birth as masked.","type":"string"},"blacklist":{"description":"This element tells if profile is blacklisted or not.","type":"boolean"},"businessTitle":{"description":"Business Title.","maxLength":80,"minLength":0,"type":"string"},"companyInfo":{"$ref":"#/components/schemas/booking_blk_companyInfoType","description":"Company Information of the Profile."},"currencyCode":{"description":"The code specifying a monetary unit. Use ISO 4217, three alpha code.","maxLength":20,"minLength":0,"type":"string"},"currencySymbol":{"description":"The symbol for the currency, e.g, for currencyCode USD the symbol is $.","maxLength":10,"minLength":0,"type":"string"},"decimalPlaces":{"description":"Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).","type":"integer"},"gender":{"description":"Identifies the profile gender code selected from Gender types List of values. Gender types LOV provides the values configured at gender configuration.","maxLength":20,"minLength":0,"type":"string"},"identifications":{"description":"List of identification of the customer.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"identificationInfo":{"description":"Collection of detailed information on the identification of the customer.","items":{"$ref":"#/components/schemas/booking_blk_identificationInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"nationality":{"description":"Nationality code identification","maxLength":20,"minLength":0,"type":"string"},"personName":{"description":"Detailed name information for the customer.","items":{"$ref":"#/components/schemas/booking_blk_personNameType"},"maxItems":5,"type":"array"},"privateProfile":{"description":"This element tells profile is property exclusive or not.","type":"boolean"},"profession":{"description":"Profession of a person.","maxLength":80,"minLength":0,"type":"string"},"vipDescription":{"description":"Description of the VIP status.","maxLength":2000,"minLength":0,"type":"string"},"vipStatus":{"description":"VIP status of the customer.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_dateRangeType":{"description":"Date Range with Start and End dates.","properties":{"end":{"description":"The ending value of the date range.","format":"date","maxLength":8,"type":"string"},"start":{"description":"The starting value of the date range.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_blk_dateTimeSpanType":{"description":"Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.","properties":{"endDateTime":{"description":"End date and time of the time span. Uses the hotel's time zone.","format":"date-time","type":"string"},"startDateTime":{"description":"Start date and time of the time span.  Uses the hotel's time zone.","format":"date-time","type":"string"}},"type":"object"},"booking_blk_dateTimeStampGroupType":{"properties":{"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_blk_dateUDFType":{"description":"Used to hold user defined field of Date Type.","properties":{"alternateName":{"description":"Label of user defined field used by vendors or customers.","maxLength":2000,"minLength":0,"type":"string"},"name":{"description":"Used to hold user defined field of Date Type. It is highly recommended to use UDFD01, UDFD02,...UDFN20 (Total 20) as Date UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Value of user defined field.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_blk_dateUDFsType":{"description":"Used to hold collection of user defined fields of Date Type.","items":{"$ref":"#/components/schemas/booking_blk_dateUDFType"},"maxItems":4000,"type":"array"},"booking_blk_datesType":{"description":"Specifies a single date.","items":{"format":"date","maxLength":8,"type":"string"},"maxItems":4000,"type":"array"},"booking_blk_depositCancelRevenueType":{"description":"The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.","enum":["Rooms","Catering","All"],"type":"string"},"booking_blk_depositPolicyType":{"description":"Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.","properties":{"amountPercent":{"$ref":"#/components/schemas/booking_blk_policyAmountPercentType","description":"Payment expressed as a fixed amount, or a percentage of/or room nights."},"deadline":{"$ref":"#/components/schemas/booking_blk_policyDeadlineType","description":"Payment deadline, absolute or relative."},"depositReceiptNo":{"description":"Receipt number associated with the deposit policy","type":"integer"},"depositReqReversed":{"description":"Flag to indicate if deposit policy is reversed","type":"boolean"},"description":{"description":"Text description of the Payment in a given language.","maxLength":2000,"minLength":0,"type":"string"},"effective":{"description":"Indicator if deposit policy is currently applicable or not.","type":"boolean"},"estimatedAmount":{"description":"Estimated Amount for the deposit policy.","type":"number"},"formattedRule":{"description":"Formatted Text Rule of the deposit policy.","maxLength":2000,"minLength":0,"type":"string"},"manual":{"description":"Flag to indicate if the deposit policy is manual.","type":"boolean"},"policyCode":{"description":"Deposit Policy Code","maxLength":20,"minLength":0,"type":"string"},"transactionDate":{"description":"Transaction Date associated with the deposit policy","format":"date","maxLength":8,"type":"string"},"typeOfCharges":{"$ref":"#/components/schemas/booking_blk_depositCancelRevenueType","description":"Defines if the deposit amount is calculated based on Room Charges, Catering Charges or both"}},"type":"object"},"booking_blk_directBillingType":{"description":"This is the preconfigured routing instruction type.","properties":{"aRNumber":{"description":"Hotel Code for which the details of direct billing is provided for a profile.","maxLength":20,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel Code for which the details of direct billing is provided for a profile.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_discountType":{"description":"Identifies and provides details about the discount. This allows for both percentages and flat amounts. If one field is used, the other should be zero/not specified since logically.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"},"discountCode":{"description":"Specifies the type of discount (e.g., No condition, LOS, Deposit or Total amount spent).","maxLength":20,"minLength":0,"type":"string"},"discountReason":{"maxLength":2000,"minLength":0,"type":"string"},"percent":{"description":"Percentage discount.","type":"number"}},"type":"object"},"booking_blk_downgradeType":{"description":"Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace.","enum":["Grace","Never","Period"],"type":"string"},"booking_blk_eCertificateClassficationType":{"description":"Enumeration of the different type of Ecertificate.","enum":["Promotion","Award","Benefit","Other"],"type":"string"},"booking_blk_eCertificateConsumeSourceType":{"description":"Indicates that OPERA E-Certificate is consumed by hotelPMS.","enum":["Central","Web","Hotel"],"type":"string"},"booking_blk_eCertificateConsumptionType":{"description":"E-Certificates details.","properties":{"authorizationCode":{"description":"Authorization code for consumption.","maxLength":100,"minLength":0,"type":"string"},"date":{"description":"Date the certificate was consumed.","format":"date","maxLength":8,"type":"string"},"email":{"description":"Email of the person who consumed the certificate.","maxLength":2000,"minLength":0,"type":"string"},"firstName":{"description":"First name of the person who consumed the certificate.","maxLength":40,"minLength":0,"type":"string"},"hotelId":{"description":"Property where certificate was consumed for.","maxLength":20,"minLength":0,"type":"string"},"locationType":{"description":"Consumption location type.","maxLength":20,"minLength":0,"type":"string"},"middleName":{"description":"Middle name of the person who consumed the certificate.","maxLength":40,"minLength":0,"type":"string"},"referenceId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Any reference like reservation no etc against which the certificate was consumed."},"serviceDate":{"description":"Date on which the service is due (arrival date in case of reservation).","format":"date","maxLength":8,"type":"string"},"source":{"$ref":"#/components/schemas/booking_blk_eCertificateConsumeSourceType","description":"Source of consumption."},"surname":{"description":"Last name of the person who consumed the certificate..","maxLength":40,"minLength":0,"type":"string"},"userName":{"description":"Application user who created the consumption.","maxLength":2000,"minLength":0,"type":"string"},"userNotes":{"description":"Any notes on the certificate entered at time of consumption.","maxLength":4000,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_eCertificateGenerationType":{"description":"E-Certificates details.","properties":{"generationDetail":{"description":"Reason for which e-certificate was generated.","maxLength":4000,"minLength":0,"type":"string"},"referenceValue":{"description":"Type of value that is in the certificate.valid values are membership_level.","maxLength":20,"minLength":0,"type":"string"},"ruleId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Key to identify the generation rule id."}},"type":"object"},"booking_blk_eCertificateInfoType":{"description":"E-Certificates details.","properties":{"awardCode":{"description":"Award type to which the certificate is linked to.","maxLength":20,"minLength":0,"type":"string"},"benefitSummary":{"description":"Summary of Benefits attached to this ECertificate.","maxLength":4000,"minLength":0,"type":"string"},"certificateType":{"description":"User defined certificate code.","maxLength":20,"minLength":0,"type":"string"},"cost":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Cost of certificate."},"description":{"description":"Description about the certificate.","maxLength":200,"minLength":0,"type":"string"},"hotels":{"description":"Hotel to which certificate is attached to.","properties":{"code":{"items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"scope":{"$ref":"#/components/schemas/booking_blk_eCertificateScopeType","description":"Scope of e-cert: global,single property or multi property."}},"type":"object"},"label":{"description":"Label for the certificate.","maxLength":40,"minLength":0,"type":"string"},"longDescription":{"description":"Detail description about the certificate.","maxLength":4000,"minLength":0,"type":"string"},"maxExtensionAllowed":{"description":"Number of times e-certificate can be extended.","type":"integer"},"membershipType":{"description":"Membership type to which the certificate is linked to.","maxLength":20,"minLength":0,"type":"string"},"promotionCode":{"description":"Promotion code to which certificate is attached to.","maxLength":20,"minLength":0,"type":"string"},"usageCriteria":{"$ref":"#/components/schemas/booking_blk_eCertificateUsageCriteriaType"},"value":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Value of the certificate for the guest."},"voucherBenefitCode":{"description":"Voucher benefit code attached to the certificate.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_eCertificateIssueSourceType":{"description":"Indicates that OPERA E-Certificate is issued by external system.","enum":["Opera","Web","Interface"],"type":"string"},"booking_blk_eCertificateIssueType":{"description":"Indicates that guest purchased OPERA E-Certificate.","enum":["Assigned","OptedIn","Purchased"],"type":"string"},"booking_blk_eCertificateScopeType":{"description":"Indicates that OPERA E-Certificate is available for a specific list of hotels.","enum":["Global","Hotel","MultiHotel"],"type":"string"},"booking_blk_eCertificateStatusType":{"description":"Indicates that OPERA E-Certificate is reserved.","enum":["Cancelled","Consumed","Deleted","Expired","Issued","Reserved"],"type":"string"},"booking_blk_eCertificateType":{"description":"E-Certificates details.","properties":{"awardId":{"$ref":"#/components/schemas/booking_blk_awardId","description":"AwardID."},"awardPoints":{"description":"Award points if any in case of certificate use membership award.","type":"integer"},"cancelRequestDate":{"description":"Date on which the cancellation was requested.","format":"date","maxLength":8,"type":"string"},"certificateId":{"description":"System generated unique certificate id.","type":"integer"},"certificateNo":{"description":"Printed certificate no. This has to be unique.","maxLength":40,"minLength":0,"type":"string"},"consumptionDetail":{"$ref":"#/components/schemas/booking_blk_eCertificateConsumptionType"},"databaseId":{"description":"External reference from which the record is created.","maxLength":20,"minLength":0,"type":"string"},"eCertificateInfo":{"$ref":"#/components/schemas/booking_blk_eCertificateInfoType"},"expiryDate":{"description":"Date of expiry.","format":"date","maxLength":8,"type":"string"},"extensionCount":{"description":"Number of times e-certificate is already extended.","type":"integer"},"generationDetail":{"$ref":"#/components/schemas/booking_blk_eCertificateGenerationType"},"inLieuSequence":{"description":"Seq of the in lieu of certificate. 1..n. original certificate will be treated as null = 0.","type":"integer"},"inactiveDate":{"description":"Date the record was marked as inactive.","format":"date","maxLength":8,"type":"string"},"issueDate":{"description":"Date when certificate was issued.","format":"date","maxLength":8,"type":"string"},"issueType":{"$ref":"#/components/schemas/booking_blk_eCertificateIssueType","description":"Process action issued the certificate. valid values are assigned (a),opt in (o) and purchased (p)."},"newExpiryDate":{"description":"New Date of expiry to extend e-certificate.","format":"date","maxLength":8,"type":"string"},"originalCertificateNo":{"description":"In case of in lieu of certificate this will contain the original certificate no.","maxLength":40,"minLength":0,"type":"string"},"originalVoucherNo":{"description":"In case of in lieu of certificate this will contain the original voucher no.","maxLength":40,"minLength":0,"type":"string"},"printed":{"description":"Print status of the certificate.","type":"boolean"},"profileId":{"$ref":"#/components/schemas/booking_blk_profileId","description":"NameId."},"source":{"$ref":"#/components/schemas/booking_blk_eCertificateIssueSourceType","description":"Source of e-certificate."},"status":{"$ref":"#/components/schemas/booking_blk_eCertificateStatusType","description":"Status of the certificate."},"voucherNo":{"description":"System generated unique voucher number.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_eCertificateUsageCriteriaType":{"description":"E-Certificates details.","properties":{"benefit":{"description":"Indicates to attach a rate code to the e-certificate as a benefit.","type":"boolean"},"cancelAllowed":{"description":"Identify if cancel is allowed or not.","type":"boolean"},"generateInLieuCertificate":{"description":"Identify if in lieu of certificate can be generated or not.","type":"boolean"},"hotel":{"description":"Indicates if web certificate can be consumed in hotel.","type":"boolean"},"reservation":{"description":"Indicates if certificate is to be used against reservation or not.","type":"boolean"},"verifyCertificateNo":{"description":"Specify if the certificate number verification is required at time of consumption or not.","type":"boolean"},"web":{"description":"Indicates if web certificate can be consumed in OWS.","type":"boolean"},"webAllowed":{"description":"Indicates if certificate consumption allowable on the web.","type":"boolean"}},"type":"object"},"booking_blk_eCertificatesType":{"description":"List of e-certificates for the profile.","items":{"$ref":"#/components/schemas/booking_blk_eCertificateType"},"maxItems":4000,"type":"array"},"booking_blk_eCouponType":{"description":"Reservation eCoupon Type Information.","properties":{"autoAttached":{"description":"Determines whether the eCoupon is attached through the Rate Code or not.","type":"boolean"},"code":{"description":"Code to attach the eCoupon to Reservation.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Description of the eCoupon attached to the Reservation.","maxLength":2000,"minLength":0,"type":"string"},"eCouponId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"ECouponID to attach the eCoupon to Reservation."},"issuedQuantity":{"description":"Assigned Quantity for the eCoupon when attached to Reservation.","type":"integer"},"ratePlanCode":{"description":"Rate plan of the attached eCoupon to Reservation.","maxLength":20,"minLength":0,"type":"string"},"reason":{"description":"Reason for attaching/modifing eCoupon.","maxLength":4000,"minLength":0,"type":"string"},"usedQuantity":{"description":"Used Quantity of the eCoupon for the Reservation.","type":"integer"},"welcomeOffer":{"description":"Determines whether this eCoupon is eligible for welcome offer or not.","type":"boolean"}},"type":"object"},"booking_blk_eCouponsType":{"description":"Collection of ECouponType object.","items":{"$ref":"#/components/schemas/booking_blk_eCouponType"},"maxItems":4000,"type":"array"},"booking_blk_emailInfoType":{"description":"Information on an email for the customer.","properties":{"email":{"$ref":"#/components/schemas/booking_blk_emailType","description":"eMail deatils for the profile."},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"warnings":{"$ref":"#/components/schemas/booking_blk_warningsType"}},"type":"object"},"booking_blk_emailType":{"description":"Information on an email for the customer.","properties":{"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"emailAddress":{"description":"Defines the e-mail address.","maxLength":2000,"minLength":0,"type":"string"},"emailFormat":{"description":"Supported Email format.","enum":["Html","Text"],"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"},"type":{"description":"Defines the purpose of the e-mail address (e.g. personal, business, listserve).","maxLength":20,"minLength":0,"type":"string"},"typeDescription":{"description":"Describes the Type code","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_employeeInfoType":{"properties":{"addressInfo":{"$ref":"#/components/schemas/booking_blk_addressInfoType"},"birthDate":{"description":"Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.","format":"date","maxLength":8,"type":"string"},"birthDateMasked":{"description":"Indicates the date of birth as masked.","type":"string"},"department":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType"},"emailInfo":{"$ref":"#/components/schemas/booking_blk_emailInfoType"},"gender":{"description":"Identifies the profile gender code selected from Gender types List of values. Gender types LOV provides the values configured at gender configuration.","maxLength":20,"minLength":0,"type":"string"},"personName":{"$ref":"#/components/schemas/booking_blk_personNameType"},"phoneInfo":{"$ref":"#/components/schemas/booking_blk_telephoneInfoType"},"profileId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type"}},"type":"object"},"booking_blk_entityType":{"description":"Indicates the rule is based on Minutes associated with the charge.","enum":["ThresholdCount","ThresholdQuantity","ThresholdMinutes"],"type":"string"},"booking_blk_eventAttendeesType":{"description":"Event attendees information.","properties":{"attendeesGuaranteed":{"description":"This denotes that the number of Attendees are the minimum guaranteed by the customer.","type":"boolean"},"noOfAttendees":{"description":"The maximum number of attendees for Catering events associated with the block.","type":"integer"}},"type":"object"},"booking_blk_eventId":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_blk_eventOrderType":{"description":"Event order distribution information.","properties":{"distributed":{"description":"Indicates if the Banquet Event Orders have been distributed.","type":"boolean"},"distributedDate":{"description":"This indicates which exchange rate date will be used for blocks when printing Banquet Event Orders. When the Distributed attribute is true this contains the date stamp of when the Distributed attribute was updated. When Distributed attribute is false, this is left blank. This date can also be taken into consideration as the 'Exchange Rate Date' when, for instance, converting catering revenue to base currency.","format":"date","maxLength":8,"type":"string"},"distributedDateTime":{"description":"This indicates which exchange rate date will be used for blocks when printing Banquet Event Orders. When the Distributed attribute is true this contains the date/time stamp of when the Distributed attribute was updated. When Distributed attribute is false, this is left blank. This date can also be taken into consideration as the 'Exchange Rate Date' when, for instance, converting catering revenue to base currency.","format":"date-time","type":"string"}},"type":"object"},"booking_blk_eventTypeType":{"description":"Contract type.","enum":["Convention","Contract"],"type":"string"},"booking_blk_excludedDateType":{"description":"Specifies all the enabled dates.","properties":{"date":{"description":"Contains exclusion date.","format":"date","maxLength":8,"type":"string"},"reason":{"$ref":"#/components/schemas/booking_blk_exclusionReasonType","description":"Contains reason for exclusion."}},"type":"object"},"booking_blk_excludedDatesType":{"description":"Contains list of dates which are valid for custom charge exemptions.","items":{"$ref":"#/components/schemas/booking_blk_excludedDateType"},"maxItems":4000,"type":"array"},"booking_blk_exclusionReasonType":{"description":"Custom Charge has already been Processed for this date within the reservation stay.","enum":["NotConfigured","CustomChargeProcessed"],"type":"string"},"booking_blk_externalReferenceType":{"description":"This type contains unique information of external reference.","properties":{"id":{"description":"Unique ID of external reference.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"ID context for external reference.","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"ID extension for external reference.","type":"integer"}},"type":"object"},"booking_blk_externalReferencesType":{"description":"This type contains unique information of external reference.","items":{"$ref":"#/components/schemas/booking_blk_externalReferenceType"},"maxItems":4000,"type":"array"},"booking_blk_fBAInfoType":{"description":"FBA ( Flexible Benefits Awards ) related fields.","properties":{"amount":{"description":"Award's FBA amount.","type":"number"},"currencyCode":{"description":"The code specifying a monetary unit. Use ISO 4217, three alpha code.","maxLength":20,"minLength":0,"type":"string"},"currencySymbol":{"description":"The symbol for the currency, e.g, for currencyCode USD the symbol is $.","maxLength":10,"minLength":0,"type":"string"},"decimalPlaces":{"description":"Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).","type":"integer"},"fbaBillGenDate":{"description":"Business date of the FBA bill generation.","format":"date","maxLength":8,"type":"string"},"flexibleBenefitAward":{"description":"Indicates if this certificate is a Flexible Benefit Award certificate.","type":"boolean"},"monetaryValue":{"description":"Award's FBA monetary values.","type":"number"},"orphanCertificate":{"description":"Indicates whether the certificate is Orphan or not.","type":"boolean"},"posted":{"description":"Indicates whether FBA has been posted.","type":"boolean"},"postedAmount":{"description":"Award's FBA posted amount.","type":"number"},"postingBusinessDate":{"description":"Business date of the FBA posting.","format":"date","maxLength":8,"type":"string"},"postingDateTime":{"description":"Date and time of the FBA posting.","format":"date","maxLength":8,"type":"string"},"reimburseAllowed":{"description":"Marks if the certificate is eligible for reimbursement.","type":"boolean"},"reimbursed":{"description":"Indicates whether FBA has been reimbursed.","type":"boolean"},"reimbursedAmount":{"description":"Award's FBA reimbursed amount.","type":"number"},"reimbursementBusinessDate":{"description":"Business date of the FBA reimbursement.","format":"date","maxLength":8,"type":"string"},"reimbursementDateTime":{"description":"Date and time of the FBA reimbursement.","format":"date","maxLength":8,"type":"string"},"resettleAllowed":{"description":"Marks if the certificate is eligible for resettlement","type":"boolean"},"settled":{"description":"Indicates whether FBA has been settled.","type":"boolean"},"settlementBusinessDate":{"description":"Business date of the FBA settlement.","format":"date","maxLength":8,"type":"string"},"settlementDateTime":{"description":"Date and time of the FBA settlement.","format":"date","maxLength":8,"type":"string"},"status":{"$ref":"#/components/schemas/booking_blk_fBAStatusType","description":"Possible FBA statuses."}},"type":"object"},"booking_blk_fBAStatusType":{"description":"Flexible benefit award has been reimbursed.","enum":["Ordered","Attached","Posted","Settled","Reimbursed"],"type":"string"},"booking_blk_facilityCodeType":{"description":"Facility Housekeeping Code, its description and quantity.","properties":{"code":{"description":"Facility code value.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Facility Code.","maxLength":80,"minLength":0,"type":"string"},"quantity":{"description":"Signifies the quantity.","type":"integer"}},"type":"object"},"booking_blk_facilityCodesType":{"description":"List of the facility codes.","items":{"$ref":"#/components/schemas/booking_blk_facilityCodeType"},"maxItems":4000,"type":"array"},"booking_blk_facilityTaskType":{"description":"Information regarding facility task on a reservation.","properties":{"date":{"description":"The Date on which the task is applicable.","format":"date","maxLength":8,"type":"string"},"supplies":{"$ref":"#/components/schemas/booking_blk_facilityCodesType","description":"Supplies associated with the task."},"task":{"$ref":"#/components/schemas/booking_blk_housekeepingTaskCodeType","description":"The Task Code."}},"type":"object"},"booking_blk_feeType":{"description":"Applicable service charges or fees.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"code":{"description":"Code identifying the fee (e.g.,agency fee, municipality fee).","maxLength":20,"minLength":0,"type":"string"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"type":{"$ref":"#/components/schemas/booking_blk_amountDeterminationType","description":"Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other)."}},"type":"object"},"booking_blk_feesType":{"description":"A collection of fees or service charges.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"},"fee":{"description":"An individual fee or service charge.","items":{"$ref":"#/components/schemas/booking_blk_feeType"},"maxItems":99,"type":"array"}},"type":"object"},"booking_blk_fetchActivityBookingsType":{"description":"Used in the request message to describe the \"filtering Criteria\" when executing an activity lookup.","properties":{"activities":{"$ref":"#/components/schemas/booking_blk_activityList","description":"The specific activity information to be used for filtering the Look-up."},"address":{"$ref":"#/components/schemas/booking_blk_addressType","description":"Detailed Address information for the customer."},"hotelId":{"description":"Hotel Code, It is used to filter hotel specific children to this specific hotel code.","maxLength":20,"minLength":0,"type":"string"},"personName":{"$ref":"#/components/schemas/booking_blk_personNameType","description":"Detailed name information for the customer."},"profileId":{"$ref":"#/components/schemas/booking_blk_uniqueIDListType","description":"ProfileID associated with the Activity under lookup."}},"type":"object"},"booking_blk_fixedChargeDetailType":{"description":"Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.","properties":{"article":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Holds related article code and description."},"chargeAmount":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Price of the product."},"percent":{"description":"Percentage of the rate amount.","maximum":100,"minimum":0,"type":"number"},"quantity":{"description":"Quantity of the product.","type":"integer"},"roomNights":{"description":"Holds number of comp or cash room night to allocate.","type":"integer"},"supplement":{"description":"Additional information regarding the fixed charge.","maxLength":2000,"minLength":0,"type":"string"},"transaction":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Transaction code and description of a fixed charge."}},"type":"object"},"booking_blk_fixedChargeFrequencyType":{"description":"Yearly.","enum":["O","D","W","M","Q","Y"],"type":"string"},"booking_blk_fixedChargeScheduleType":{"description":"Holds schedule of fixed charge.","properties":{"dateToExecute":{"description":"Date of when to execute yearly fixed charge. Applicable when frequency is Yearly.","format":"date","maxLength":8,"type":"string"},"dayToExecute":{"description":"Day of when to execute fixed charge. Applicable when frequency is Daily or Weekly.","maxLength":3,"minLength":0,"type":"string"},"end":{"description":"The ending value of the date range.","format":"date","maxLength":8,"type":"string"},"frequency":{"$ref":"#/components/schemas/booking_blk_fixedChargeFrequencyType","description":"Frequency of a fixed charge."},"start":{"description":"The starting value of the date range.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_blk_fixedChargeType":{"description":"Holds fixed charge information.","properties":{"charge":{"$ref":"#/components/schemas/booking_blk_fixedChargeDetailType","description":"Holds specific details of fixed charge."},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"schedule":{"$ref":"#/components/schemas/booking_blk_fixedChargeScheduleType","description":"Holds schedule of fixed charge."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_blk_fixedChargesType":{"description":"Holds fixed charge detail.","items":{"$ref":"#/components/schemas/booking_blk_fixedChargeType"},"maxItems":4000,"type":"array"},"booking_blk_folioTextsType":{"description":"This stores the description for the type of tax calculation especially with tax exemption, etc.","items":{"properties":{"row":{"description":"Row number of the additional text.","type":"integer"},"text":{"description":"Additional text field to display on the folio.","maxLength":50,"minLength":0,"type":"string"}},"type":"object"},"maxItems":2,"type":"array"},"booking_blk_foreignExchangeType":{"description":"Foreign Exchange info.","properties":{"effectiveDate":{"description":"Effective Exchange date for the foreign currency posting.","format":"date","maxLength":8,"type":"string"},"type":{"description":"Exchange Type for the postings.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_formattedTextTextType":{"description":"Provides text and indicates whether it is formatted or not.","properties":{"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"booking_blk_functionArgumentType":{"description":"This type provided details of a function argument and the value it holds.","properties":{"dataType":{"description":"Specifies the datatype of the function argument.","maxLength":40,"minLength":0,"type":"string"},"name":{"description":"Specifies the name of the function argument.","maxLength":200,"minLength":0,"type":"string"},"position":{"description":"Specifies the position of the function argument in the argument list.","type":"integer"},"required":{"description":"Argument of the function mandatory or not.","type":"boolean"},"value":{"description":"Specifies the value held by the function argument.","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_functionArgumentsType":{"description":"Collection of function arguments and their corresponding values.","items":{"$ref":"#/components/schemas/booking_blk_functionArgumentType"},"maxItems":4000,"type":"array"},"booking_blk_futureListType":{"description":"A collection of reservation history details attached to Profiles.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"reservationInfo":{"description":"Additional reservation information attached to the profile . Eg : Future reservation details","items":{"$ref":"#/components/schemas/booking_blk_reservationInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"booking_blk_givenNameType":{"description":"Given name, first name or names","maxLength":40,"minLength":0,"type":"string"},"booking_blk_guaranteeRequirementsType":{"description":"Specifies various requirement for the guarantee code.","properties":{"address":{"description":"When true indicates address on the reservation is required for this guarantee code.","type":"boolean"},"arrivalTime":{"description":"When true indicates arrival Time on the reservation is required for this guarantee code.","type":"boolean"},"cancellation":{"description":"When true indicates cancellation on the reservation is required for this guarantee code.","type":"boolean"},"creditCard":{"description":"When true indicates Credit Card on the reservation is required for this guarantee code.","type":"boolean"},"deposit":{"description":"When true indicates deposit is required for this guarantee code.","type":"boolean"},"phoneNumber":{"description":"When true indicates phone number on the reservation is required for this guarantee code.","type":"boolean"},"requirementCode":{"description":"Requirement Code.","type":"string"}},"type":"object"},"booking_blk_guaranteeType":{"description":"Specifies Guarantee Code attributes.","properties":{"description":{"description":"Description of the Guarantee Code.","maxLength":2000,"minLength":0,"type":"string"},"guaranteeCode":{"description":"Code assigned to the Guarantee.","maxLength":20,"minLength":0,"type":"string"},"lateArrival":{"description":"Represents the late arrival time.","type":"string"},"onHold":{"description":"If true indicates this Guarantee Code is used only to hold the inventory during reservation process.","type":"boolean"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"paymentTypes":{"$ref":"#/components/schemas/booking_blk_paymentTypesType","description":"Specifies various payment types for the guarantee code."},"requirements":{"$ref":"#/components/schemas/booking_blk_guaranteeRequirementsType","description":"Specifies various requirements for the guarantee code."},"reserveInventory":{"description":"If true indicates inventory will be reserved/deducted when reservation uses this Guarantee Code.","type":"boolean"},"shortDescription":{"$ref":"#/components/schemas/booking_blk_translationTextType80","description":"Brief description of the Guarantee Code."}},"type":"object"},"booking_blk_guestCountsType":{"description":"A collection of GuestCount by age group.","properties":{"adults":{"description":"Defines the number of Adults.","type":"integer"},"childAges":{"$ref":"#/components/schemas/booking_blk_childAgesType","description":"Defines Children's Ages. Number of children ages mentioned may mot match with children counts."},"childBuckets":{"$ref":"#/components/schemas/booking_blk_childBucketsType","description":"Defines children counts with Age Qualifying Group(Child Bucket#1) classification."},"children":{"description":"Defines the number of Children.","type":"integer"}},"type":"object"},"booking_blk_guestHousekeepingServiceRequestType":{"description":"Possible values for the Guest Service Status.","enum":["DoNotDisturb","MakeUpRoom","NoStatusSelected"],"type":"string"},"booking_blk_guestLastStayInfoType":{"description":"Contains last stay related details of the guest.","properties":{"lastStayDate":{"description":"Guest's last stay date.","format":"date","maxLength":8,"type":"string"},"lastStayRate":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"The Rate amount of the guest's last stay."},"lastStayRoom":{"description":"Room Number where the guest stayed.","maxLength":20,"minLength":0,"type":"string"},"totalStay":{"description":"The total number of previous stay of the guest.","type":"integer"}},"type":"object"},"booking_blk_guestMessageType":{"description":"Holds the Message information for a Reservation","properties":{"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"delivery":{"$ref":"#/components/schemas/booking_blk_messageDeliveryType","description":"Holds the Delivery Method Information"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"message":{"$ref":"#/components/schemas/booking_blk_messageType","description":"Holds the Message Information"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","maxLength":8,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_blk_guestMessagesType":{"description":"Holds the Message Information","items":{"$ref":"#/components/schemas/booking_blk_guestMessageType"},"maxItems":4000,"type":"array"},"booking_blk_historyListType":{"description":"A collection of reservation history details attached to Profiles.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"reservationInfo":{"description":"Additional reservation information attached to the profile . Eg : History reservation details","items":{"$ref":"#/components/schemas/booking_blk_reservationInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"booking_blk_hotelCodeListType":{"description":"Hotel code.","items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"booking_blk_hotelInterfaceStatusType":{"description":"Status of the Hotel Interface either STOPPED or RUNNING.","enum":["Stopped","Running","Waiting","StopInitiated","StartInitiated","RebootInitiated","Other"],"type":"string"},"booking_blk_hotelInterfaceType":{"properties":{"activeFlag":{"description":"Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.","type":"boolean"},"hotelId":{"description":"Hotel Code","maxLength":20,"minLength":0,"type":"string"},"interfaceId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Unique DB internal number of a Hotel Interface record."},"interfaceName":{"description":"Name of the Hotel Interface","maxLength":40,"minLength":0,"type":"string"},"interfaceType":{"$ref":"#/components/schemas/booking_blk_hotelInterfaceTypeType","description":"Three letter code for each interface that identifies the interface."},"logo":{"description":"Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.","maxLength":20,"minLength":0,"type":"string"},"machineName":{"description":"Unique machine name of the running IFC.","maxLength":80,"minLength":0,"type":"string"},"status":{"$ref":"#/components/schemas/booking_blk_hotelInterfaceStatusType","description":"The current status of the IFC."}},"type":"object"},"booking_blk_hotelInterfaceTypeType":{"description":"XML Posting Interface","enum":["Bms","Cas","Ccw","Dls","Eft","Exp","Mak","Mbs","Msc","Pbx","Pos","Svs","Tik","Vid","Vms","Www","Xml"],"type":"string"},"booking_blk_hotelReservationTraceType":{"description":"Extended Trace object to hold information for a reservation.","properties":{"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"departmentId":{"description":"Indicates the Department code.","maxLength":20,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","maxLength":8,"type":"string"},"reservationId":{"$ref":"#/components/schemas/booking_blk_reservationId","description":"Reservation ID of the reservation for which the traces are to be retrieved."},"resolveInfo":{"$ref":"#/components/schemas/booking_blk_traceResolveType","description":"Information regarding the status of the trace"},"timeInfo":{"$ref":"#/components/schemas/booking_blk_traceTimeInfoType","description":"Date of the trace."},"traceText":{"description":"The information this trace contains.","type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_blk_hotelReservationTracesType":{"description":"List of Reservation Traces.","items":{"$ref":"#/components/schemas/booking_blk_hotelReservationTraceType"},"maxItems":4000,"type":"array"},"booking_blk_hotelReservationType":{"description":"The Reservation class contains the current reservation being created or altered.","properties":{"accessRestriction":{"$ref":"#/components/schemas/booking_blk_resAccessRestrictionType","description":"Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both."},"accessRestrictionMessage":{"description":"Configurable Access Restriction Message for Excluded Block or Rate Code.","maxLength":4000,"minLength":0,"type":"string"},"additionalGuestInfo":{"$ref":"#/components/schemas/booking_blk_resGuestAdditionalInfoType","description":"Entry Date into the country. (Croatian Requirements)."},"advanceCheckIn":{"$ref":"#/components/schemas/booking_blk_advanceCheckInType","description":"Information relating to Reservation's Advance Checked In state and Expected Time of Return"},"alerts":{"$ref":"#/components/schemas/booking_blk_alertsType","description":"List of reservation alerts."},"allowAutoCheckin":{"description":"Flag to allow auto checkin","type":"boolean"},"allowMobileCheckout":{"description":"Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false.","type":"boolean"},"allowMobileViewFolio":{"description":"Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.","type":"boolean"},"allowPreRegistration":{"description":"Flag containing true or false value for reservation to be eligible for prior check in by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile check in yes / no. Upon fetch, the current state of the flag will show true or false.","type":"boolean"},"allowedActions":{"$ref":"#/components/schemas/booking_blk_reservationAllowedActionsType","description":"Collection of allowed actions for the reservation."},"associatedReservations":{"$ref":"#/components/schemas/booking_blk_associatedResType","description":"Information regarding associated reservations."},"attachments":{"$ref":"#/components/schemas/booking_blk_attachmentsType","description":"Collection of attachments available for that reservation"},"autoBorrowFromHouse":{"description":"This flag will force to borrow from house if borrow required for number of rooms requested, this will only applicable when reservation is attached to a Block.","type":"boolean"},"callHistory":{"$ref":"#/components/schemas/booking_blk_callHistoryType","description":"List of reservation calls."},"cancellation":{"description":"Information regarding why reservation has been/was cancelled. This could hold information as history even if reservation is no more in in Cancelled status.","properties":{"cancellationNo":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Cancellation Number given when reservation was last cancelled."},"code":{"maxLength":20,"minLength":0,"type":"string"},"date":{"description":"Date when reservation was last cancelled.","format":"date","maxLength":8,"type":"string"},"description":{"maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"cashiering":{"$ref":"#/components/schemas/booking_blk_resCashieringType","description":"Holds cashiering related information for the reservation."},"catering":{"$ref":"#/components/schemas/booking_blk_cateringResInfoType","description":"Catering event information if reservation is associated with the catering event."},"chargeCardNumber":{"description":"This attribute represents Hotel charge card number. This number is generated automatically in OPERA when a reservation is created in OPERA. It is part of a functionality that provide the guest with the convenience of placing all their charges directly on their reservation folio.","maxLength":100,"minLength":0,"type":"string"},"comments":{"description":"List of Notes for the Guest related to the reservation.","items":{"$ref":"#/components/schemas/booking_blk_commentInfoType"},"maxItems":4000,"type":"array"},"compAuthorizer":{"$ref":"#/components/schemas/booking_blk_compAuthorizerInfoType","description":"Reservation Comp Authorizer."},"computedReservationStatus":{"$ref":"#/components/schemas/booking_blk_pMS_ResStatusType","description":"Indicates the Computed status of the reservation."},"confirmationLetters":{"$ref":"#/components/schemas/booking_blk_confirmationsType","description":"List of reservation confirmation letters."},"createBusinessDate":{"description":"Business Date when the reservation was created.","format":"date","maxLength":8,"type":"string"},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"customChargeExemptionDetails":{"$ref":"#/components/schemas/booking_blk_customChargeExemptionsType","description":"List of Custom Charge Exemptions attached to the reservation."},"customNameValueDetail":{"$ref":"#/components/schemas/booking_blk_nameValueDetailType","description":"List of Custom Name Value Information attached to the reservation."},"customReference":{"description":"Custom Reference to identify reservation.","maxLength":50,"minLength":0,"type":"string"},"displayColor":{"description":"The color to display this reservation on room grid displays.","maxLength":20,"minLength":0,"type":"string"},"eCertificates":{"$ref":"#/components/schemas/booking_blk_reservationECertificatesType","description":"List of ECertificates attached to the reservation."},"eCoupons":{"$ref":"#/components/schemas/booking_blk_eCouponsType","description":"List of eCoupons."},"extSystemSync":{"type":"boolean"},"externalReferences":{"$ref":"#/components/schemas/booking_blk_externalReferencesType","description":"External Reference information for Reservation."},"fixedCharges":{"$ref":"#/components/schemas/booking_blk_fixedChargesType","description":"List of reservation fixed charges."},"guestComments":{"description":"List of Notes for the Guest related to the profile.","items":{"$ref":"#/components/schemas/booking_blk_commentInfoType"},"maxItems":4000,"type":"array"},"guestMemberships":{"description":"List of Memberships for the Guest related to the reservation.","items":{"$ref":"#/components/schemas/booking_blk_membershipType"},"maxItems":4000,"type":"array"},"guestMessages":{"$ref":"#/components/schemas/booking_blk_guestMessagesType","description":"List of Messages."},"hasOpenFolio":{"type":"boolean"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"housekeeping":{"$ref":"#/components/schemas/booking_blk_resHousekeepingType","description":"Holds rooms housekeeping information."},"inventoryItems":{"$ref":"#/components/schemas/booking_blk_resInventoryItemsType","description":"A collection of inventory items attached to a reservation."},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"linkedReservation":{"$ref":"#/components/schemas/booking_blk_linkedReservationsInfoType","description":"Reservations related to the current Reservation."},"locators":{"$ref":"#/components/schemas/booking_blk_reservationLocatorsType","description":"Collection of Locators available for that reservation"},"lockHandle":{"description":"An id representing the record lock for this reservation. When passed, update operation will verify that this lock is still valid.","type":"number"},"markAsRecentlyAccessed":{"description":"Mark this reservation as recently accessed.","type":"boolean"},"optedForCommunication":{"description":"Flag containing true or false value to determine if the guest has opted for communications pertaining to this reservation.Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is marked for communication. Upon fetch, the current state of the flag will show true or false.","type":"boolean"},"overrideBlockRestriction":{"type":"boolean"},"overrideExternalChecks":{"description":"Forcefully override the create/update action on the Reservation. For real-time CRS interfaces, this element is used as force selling indicator in case of Create or Update Reservation","type":"boolean"},"overrideInstructions":{"$ref":"#/components/schemas/booking_blk_overrideInstructionsType","description":"List of overrides done for the reservation."},"overrideInventoryCheck":{"description":"Indicates to Override the Room Inventory Check if applicable.","type":"boolean"},"party":{"description":"Party/PartyCode when reservation is part of a party(a small group).","maxLength":50,"minLength":0,"type":"string"},"preRegistered":{"description":"Is the reservation pre-registered.","type":"boolean"},"preferenceCollection":{"description":"Collection of reservation preferences.","items":{"$ref":"#/components/schemas/booking_blk_preferenceTypeType"},"maxItems":4000,"type":"array"},"prepaidCards":{"$ref":"#/components/schemas/booking_blk_prepaidCardsType","description":"Collection of Prepaid Cards available for that reservation"},"primaryEnrollmentChain":{"description":"Name of the Chain for the primary enrollment","maxLength":80,"minLength":0,"type":"string"},"primaryEnrollmentResort":{"description":"Name Of the Resort/Hotel for the primary enrollment","maxLength":80,"minLength":0,"type":"string"},"printRate":{"description":"Indicates whether to show the rate or not on a printed document which includes the rate.","type":"boolean"},"profileAwards":{"$ref":"#/components/schemas/booking_blk_awardsType","description":"Collection of profile awards available for that reservation"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","maxLength":8,"type":"string"},"queue":{"$ref":"#/components/schemas/booking_blk_reservationQueueInformationType","description":"Information about the time and duration this reservation was on Queue for Checkin."},"reinstateDate":{"description":"Business Date when the reservation was last reinstated.","format":"date","maxLength":8,"type":"string"},"reservationActivities":{"$ref":"#/components/schemas/booking_blk_activityLookUpList","description":"Collection of Reservation Activities available for that reservation"},"reservationAwards":{"$ref":"#/components/schemas/booking_blk_awardsType","description":"Collection of Awards,Certificates for the guest profile."},"reservationCommunication":{"$ref":"#/components/schemas/booking_blk_resCommunicationType","description":"Collection of reservation communication details."},"reservationGuests":{"description":"Collection of guests associated with the reservation.","items":{"$ref":"#/components/schemas/booking_blk_resGuestType"},"maxItems":4000,"type":"array"},"reservationIdList":{"$ref":"#/components/schemas/booking_blk_reservationIdList","description":"Used to provide PMS and/or CRS identifiers."},"reservationIndicators":{"$ref":"#/components/schemas/booking_blk_indicatorsType","description":"Indicators of additional information attached to the reservation"},"reservationMemberships":{"description":"List of reservation memberships.","items":{"$ref":"#/components/schemas/booking_blk_reservationMembershipType"},"maxItems":4000,"type":"array"},"reservationPackages":{"description":"A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges.","items":{"$ref":"#/components/schemas/booking_blk_reservationPackageType"},"maxItems":4000,"type":"array"},"reservationPaymentMethods":{"$ref":"#/components/schemas/booking_blk_reservationPaymentMethodsType","description":"A collection of Payment Method objects."},"reservationPolicies":{"$ref":"#/components/schemas/booking_blk_reservationPoliciesType","description":"A collection of Cancellation Penalties objects."},"reservationProfiles":{"description":"Collection of guests associated with the reservation.","properties":{"commissionPayoutTo":{"$ref":"#/components/schemas/booking_blk_commissionPayoutToType","description":"If not null, reservation is considered to pay out commission to either Travel Agent, Source or both."},"reservationProfile":{"items":{"$ref":"#/components/schemas/booking_blk_reservationProfileType"},"maxItems":4000,"type":"array"}},"type":"object"},"reservationStatus":{"$ref":"#/components/schemas/booking_blk_pMS_ResStatusType","description":"Indicates the Actual status of the reservation."},"roomStay":{"$ref":"#/components/schemas/booking_blk_roomStayType","description":"Room stays information."},"roomStayReservation":{"description":"Boolean True if this reservation is reserving rooms. False if it is only reserving services.","type":"boolean"},"routingInstructions":{"$ref":"#/components/schemas/booking_blk_routingInfoListType","description":"Set of Routing Instructions."},"scheduledActivities":{"$ref":"#/components/schemas/booking_blk_activityLookUpList","description":"Collection of Scheduled Activities available for that reservation"},"serviceRequests":{"$ref":"#/components/schemas/booking_blk_serviceRequests","description":"Collection of Service Requests available for that reservation"},"sharedGuests":{"$ref":"#/components/schemas/booking_blk_resSharedGuestListType","description":"Collection of guests who share this reservation."},"shares":{"$ref":"#/components/schemas/booking_blk_hotelReservationsType","description":"Collection of share reservation available for that reservation"},"sourceOfSale":{"$ref":"#/components/schemas/booking_blk_sourceOfSaleType","description":"Point of Sale of reservation. Identifies the entity/channel who made the reservation."},"statisticalClassification":{"$ref":"#/components/schemas/booking_blk_resStatClassificationType","description":"Catering event information if reservation is associated with the catering event."},"tickets":{"$ref":"#/components/schemas/booking_blk_ticketsType","description":"List of Reservation Tickets."},"traces":{"$ref":"#/components/schemas/booking_blk_hotelReservationTracesType","description":"List of reservation Traces."},"trackItItems":{"$ref":"#/components/schemas/booking_blk_trackItItemsType","description":"Collection of TrackIt Items available for that reservation"},"transactionDiversions":{"description":"List of transaction diversions attached to the reservation.","properties":{"actionType":{"maxLength":2000,"type":"string"},"transactionDiversions":{"items":{"$ref":"#/components/schemas/booking_blk_reservationTransactionDiversionsType"},"maxItems":4000,"type":"array"}},"type":"object"},"upgradeEligible":{"description":"Indicates whether the reservation is eligible for upgrade.","type":"boolean"},"userDefinedFields":{"$ref":"#/components/schemas/booking_blk_userDefinedFieldsType","description":"Collections of user defined fields."},"waitlist":{"$ref":"#/components/schemas/booking_blk_waitlistResType","description":"Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is no more in Waitlist status."},"walkIn":{"description":"When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in.","type":"boolean"},"webRegistrationCards":{"$ref":"#/components/schemas/booking_blk_attachmentsType","description":"Collection of Web Registration Cards available for that reservation"}},"type":"object"},"booking_blk_hotelReservationsType":{"description":"A collection of Reservation objects and Unique IDs of Reservation.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"reservation":{"description":"A collection of Reservations.","items":{"$ref":"#/components/schemas/booking_blk_hotelReservationType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"booking_blk_hotelUseType":{"properties":{"accessRestrictions":{"$ref":"#/components/schemas/booking_blk_accessRestrictionsType","description":"List of block access exclusion/restriction types. The field HotelUseOnly and Modify under this will behave the same. User can pass either of them. For new development use this field."},"hotelUseOnly":{"description":"Indicates whether this business block can be updated only by the Hotel to which it belongs. This is used to communicate to CRO that the business block can be only updated by the Hotel.","type":"boolean"},"hotelUseReason":{"description":"Explains the reason why the business block can be updated only by the Hotel.","maxLength":4000,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_housekeepingRoomStatusType":{"description":"Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.","enum":["Clean","Dirty","Pickup","Inspected","OutOfOrder","OutOfService"],"type":"string"},"booking_blk_housekeepingTaskCodeType":{"description":"Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.","properties":{"code":{"description":"The Code for the task.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Description of the Task Code.","maxLength":80,"minLength":0,"type":"string"},"facilityDepartureTask":{"description":"Indicates if this task code is the default departure task for Facility Tasks. This requires","type":"boolean"},"hotelId":{"description":"Property where this task code is configured.","maxLength":20,"minLength":0,"type":"string"},"instructions":{"description":"Instructions for this Task Code.","maxLength":2000,"minLength":0,"type":"string"},"linenChange":{"description":"Indicates if a linen change is necessary.","type":"boolean"},"sequence":{"description":"Ordering sequence for display.","type":"integer"}},"type":"object"},"booking_blk_identificationInfoType":{"description":"Information on the identification of the customer.","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"identification":{"$ref":"#/components/schemas/booking_blk_identificationType","description":"Detailed information on the identification of the customer."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"warnings":{"$ref":"#/components/schemas/booking_blk_warningsType"}},"type":"object"},"booking_blk_identificationType":{"description":"Identification information of the customer.","properties":{"expirationDate":{"description":"Expiration date of Identification.","format":"date","maxLength":8,"type":"string"},"idNumber":{"description":"Identification Number.","maxLength":80,"minLength":0,"type":"string"},"idNumberMasked":{"description":"Masked Identification Number.","maxLength":80,"minLength":0,"type":"string"},"idType":{"description":"Identification Type. Eg Passport, Driving License etc.","maxLength":40,"minLength":0,"type":"string"},"issuedCountry":{"description":"The country where Identification was issued.","maxLength":20,"minLength":0,"type":"string"},"issuedDate":{"description":"Issued date of Identification.","format":"date","maxLength":8,"type":"string"},"issuedPlace":{"description":"The place where Identification was issued.","maxLength":80,"minLength":0,"type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"},"registeredProperty":{"description":"Property where the identification belongs to.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_imageSetType":{"description":"Represents on image set record.","properties":{"chainCode":{"description":"The image set chain code.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"The image set description.","maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"description":"The image set hotel code.","maxLength":20,"minLength":0,"type":"string"},"imageOrder":{"description":"The image set order.","type":"integer"},"imageSet":{"description":"The image set name.","maxLength":800,"minLength":0,"type":"string"},"imageStyle":{"$ref":"#/components/schemas/booking_blk_imageStyleType","description":"The image set enumerated style."},"imageType":{"description":"The image set type.","maxLength":80,"minLength":0,"type":"string"},"imageURL":{"description":"The image set URL.","maxLength":2000,"minLength":0,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"sequenceId":{"description":"The image set sequence ID.","type":"integer"},"website":{"description":"The image set website.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_imageStyleType":{"description":"An enumeration of image styles.","enum":["Full","Thumbnail","Icon","Square","Banner","Button","Lowres","Highres"],"type":"string"},"booking_blk_indicatorType":{"description":"Lamp indicator Type.","properties":{"count":{"description":"Indicates number of occurrences of the indicator.","type":"integer"},"indicatorName":{"description":"Name of the indicator.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_indicatorsType":{"description":"Collection of lamp indicators.","items":{"$ref":"#/components/schemas/booking_blk_indicatorType"},"maxItems":4000,"type":"array"},"booking_blk_instanceLink":{"description":"Metadata describing link description objects that MAY appear in the JSON instance representation.","properties":{"href":{"description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.","type":"string"},"method":{"description":"HTTP method for requesting the target of the link.","enum":["GET","POST","PUT","DELETE","PATCH","OPTIONS","HEAD"],"type":"string"},"operationId":{"description":"The operationId of the path you can call to follow this link.  This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.","type":"string"},"rel":{"description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.","type":"string"},"targetSchema":{"description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..","type":"string"},"templated":{"default":false,"description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.","type":"boolean"},"title":{"description":"Exact copy of the \"summary\" field on the linked operation.","type":"string"}},"type":"object"},"booking_blk_interfaceRightsStatusType":{"properties":{"category":{"description":"Category code of this interface right.","maxLength":1,"minLength":0,"type":"string"},"description":{"description":"User defined description for an Interface Right.","maxLength":80,"minLength":0,"type":"string"},"right":{"description":"Internal code for each allowed right of a Hotel Interface record.","type":"integer"},"statusCode":{"description":"User defined code for an Interface Right.","maxLength":5,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_itemInfoType":{"description":"Basic information regarding an Item.","properties":{"availabilityPeriod":{"$ref":"#/components/schemas/booking_blk_timeWindowType","description":"Defines a Time period when the item is available."},"code":{"description":"Item Code.","maxLength":20,"minLength":0,"type":"string"},"defaultDuration":{"description":"Define the default duration in days when booking the item.","type":"integer"},"description":{"description":"Detail description of an item.","maxLength":2000,"minLength":0,"type":"string"},"fixedCharge":{"description":"If true indicates that item has fixed charge when it is attached to a reservation.","type":"boolean"},"itemHoldId":{"description":"ID reference for the hold Item","type":"number"},"itemPool":{"description":"Indicates if it is an item pool. Not applicable for Item within the Item Pool.","type":"boolean"},"name":{"description":"Name of an item.","maxLength":200,"minLength":0,"type":"string"},"outsideStay":{"description":"If true indicates that item could be held outside of the reservation stay days.","type":"boolean"},"quantity":{"description":"Quantity of hold Item","type":"integer"},"requiredForBooking":{"description":"If true indicates that item is required for the reservation.","type":"boolean"},"sellInEvent":{"description":"If true indicates that item can be sold in event.","type":"boolean"},"sellInReservation":{"description":"If true indicates that item can be sold in reservation.","type":"boolean"},"sellSeparate":{"description":"If true indicates that item is allowed to sell separately.","type":"boolean"},"timeSpan":{"$ref":"#/components/schemas/booking_blk_timeSpanType","description":"Date Range to get the inventories of the items."}},"type":"object"},"booking_blk_languageType":{"maxLength":40,"minLength":0,"type":"string"},"booking_blk_lastStayInfoType":{"description":"Contains last stay related details for the profile","properties":{"lastRate":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Used to hold last rate information for the profile."},"lastRoom":{"description":"Used to hold last room information for the profile.","type":"string"},"lastVisit":{"description":"Used to hold last stay information for the profile.","format":"date","maxLength":8,"type":"string"},"totalStay":{"description":"The total number of previous stay of the profile.","type":"integer"}},"type":"object"},"booking_blk_leadInfoType":{"properties":{"blockIdList":{"$ref":"#/components/schemas/booking_blk_blockIdList","description":"Collection of unique block identifiers."},"blockName":{"description":"Lead description.","maxLength":2000,"minLength":0,"type":"string"},"blockStatus":{"$ref":"#/components/schemas/booking_blk_bookingStatusType","description":"Current block status of the lead."},"blockType":{"$ref":"#/components/schemas/booking_blk_blockClassificationType","description":"Indicate Block Classification."},"cateringStatus":{"$ref":"#/components/schemas/booking_blk_bookingStatusType","description":"Current catering status of the lead."},"hotelId":{"description":"Hotel Id.","maxLength":20,"minLength":0,"type":"string"},"roomNightsBlocked":{"description":"Number of blocked rooms for the lead.","minimum":0,"type":"integer"},"roomNightsPickedup":{"description":"Number of reserved rooms for the lead.","minimum":0,"type":"integer"},"timeSpan":{"$ref":"#/components/schemas/booking_blk_timeSpanType","description":"The Time Span of the block."}},"type":"object"},"booking_blk_linkedReservationInfoType":{"properties":{"allowedActions":{"$ref":"#/components/schemas/booking_blk_reservationAllowedActionsType","description":"Collection of allowed actions for the linked reservation."},"balance":{"$ref":"#/components/schemas/booking_blk_currencyAmountType"},"displayColor":{"maxLength":20,"minLength":0,"type":"string"},"givenName":{"maxLength":40,"minLength":0,"type":"string"},"guarantee":{"$ref":"#/components/schemas/booking_blk_resGuaranteeType"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"linkReservationType":{"$ref":"#/components/schemas/booking_blk_linkedReservationType"},"rate":{"$ref":"#/components/schemas/booking_blk_currencyAmountType"},"ratePlanCode":{"maxLength":20,"minLength":0,"type":"string"},"reservationBlock":{"$ref":"#/components/schemas/booking_blk_reservationBlockType","description":"Key information about the block for the linked reservation."},"reservationIdList":{"$ref":"#/components/schemas/booking_blk_reservationIdList"},"reservationStatus":{"$ref":"#/components/schemas/booking_blk_pMS_ResStatusType","description":"Indicates the Actual status of the reservation."},"reverseCheckInAllowed":{"description":"This attribute is to verify if reverse check-in is allowed for the reservation.","type":"boolean"},"room":{"maxLength":20,"minLength":0,"type":"string"},"roomNumberLocked":{"description":"This attribute is to verify if room number is locked for the reservation. When true the room number cannot be changed","type":"boolean"},"roomType":{"maxLength":20,"minLength":0,"type":"string"},"suppressRate":{"description":"This attribute checks if rate is suppressed or not in order to properly show strike through.","type":"boolean"},"surname":{"maxLength":40,"minLength":0,"type":"string"},"timeSpan":{"$ref":"#/components/schemas/booking_blk_timeSpanType"},"title":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_linkedReservationType":{"description":"Enumeration of the different Linked Reservation Types.","enum":["Linked","Shared","Default"],"type":"string"},"booking_blk_linkedReservationsInfoType":{"description":"Linked Reservations.","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"reservationInfo":{"items":{"$ref":"#/components/schemas/booking_blk_linkedReservationInfoType"},"maxItems":4000,"type":"array"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_blk_links":{"items":{"$ref":"#/components/schemas/booking_blk_instanceLink"},"type":"array"},"booking_blk_marketCodeInfoType":{"properties":{"description":{"maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"marketCode":{"maxLength":20,"minLength":0,"type":"string"},"marketGroup":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_masterAccountInfoType":{"properties":{"masterAccountId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Unique ID of the Master account."},"masterAccountName":{"description":"Name of the Master account.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_masterBlockInfoType":{"description":"Basic information pertaining to the master block.","properties":{"blockIdList":{"$ref":"#/components/schemas/booking_blk_blockIdList","description":"Collection of unique block identifiers."},"blockName":{"description":"Block description.","maxLength":2000,"minLength":0,"type":"string"},"blockStatus":{"$ref":"#/components/schemas/booking_blk_bookingStatusType","description":"Current status of the block."},"blockType":{"$ref":"#/components/schemas/booking_blk_blockClassificationType","description":"Indicate Block Classification."},"cateringStatus":{"$ref":"#/components/schemas/booking_blk_bookingStatusType","description":"Catering Status details of the block."},"hotelId":{"description":"Master/Sub Block's Hotel Code.","maxLength":20,"minLength":0,"type":"string"},"masterSubHotels":{"description":"Pertains valid hotel code list for logged in user against Master/Sub header record.","items":{"$ref":"#/components/schemas/booking_blk_hotelCodeListType"},"maxItems":4000,"type":"array"},"roomNights":{"description":"Pertain value for blocked rooms for a block.","type":"integer"},"roomNightsPickedup":{"description":"Pertain value for reserved rooms for a block.","type":"integer"},"subBlockInfo":{"description":"Basic information pertaining to the sub block.","items":{"$ref":"#/components/schemas/booking_blk_masterSubBlockBaseInfoType"},"maxItems":4000,"type":"array"},"syncBlockDates":{"description":"Indicates to check if Block Dates to be in sync.","type":"boolean"},"syncBlockStatusDetails":{"description":"Indicates if Block Status Details to be in sync.","type":"boolean"},"syncOtherBlockDetails":{"description":"Indicates whether other BlockDetails to be in Sync.","type":"boolean"},"syncPackages":{"description":"Indicates if packages to be in Sync.","type":"boolean"},"timeSpan":{"$ref":"#/components/schemas/booking_blk_timeSpanType","description":"The Time Span(Arrival, Departure) which covers the Block Span."}},"type":"object"},"booking_blk_masterSubBlockBaseInfoType":{"properties":{"blockIdList":{"$ref":"#/components/schemas/booking_blk_blockIdList","description":"Collection of unique block identifiers."},"blockName":{"description":"Block description.","maxLength":2000,"minLength":0,"type":"string"},"blockStatus":{"$ref":"#/components/schemas/booking_blk_bookingStatusType","description":"Current status of the block."},"blockType":{"$ref":"#/components/schemas/booking_blk_blockClassificationType","description":"Indicate Block Classification."},"cateringStatus":{"$ref":"#/components/schemas/booking_blk_bookingStatusType","description":"Catering Status details of the block."},"hotelId":{"description":"Master/Sub Block's Hotel Code.","maxLength":20,"minLength":0,"type":"string"},"roomNights":{"description":"Pertain value for blocked rooms for a block.","type":"integer"},"roomNightsPickedup":{"description":"Pertain value for reserved rooms for a block.","type":"integer"},"syncBlockDates":{"description":"Indicates to check if Block Dates to be in sync.","type":"boolean"},"syncBlockStatusDetails":{"description":"Indicates if Block Status Details to be in sync.","type":"boolean"},"syncOtherBlockDetails":{"description":"Indicates whether other BlockDetails to be in Sync.","type":"boolean"},"syncPackages":{"description":"Indicates if packages to be in Sync.","type":"boolean"},"timeSpan":{"$ref":"#/components/schemas/booking_blk_timeSpanType","description":"The Time Span(Arrival, Departure) which covers the Block Span."}},"type":"object"},"booking_blk_mealPlanCodeType":{"description":"Meal plan codes associated with the rate codes.","properties":{"breakfastIncluded":{"description":"Represents if the meal plan code is available for breakfast or not.","type":"boolean"},"code":{"description":"Meal plan code.","maxLength":40,"minLength":0,"type":"string"},"dinnerIncluded":{"description":"Represents if the meal plan code is available for dinner or not.","type":"boolean"},"included":{"description":"Represents if the meal plan code is included in rate code or not.","type":"boolean"},"lunchIncluded":{"description":"Represents if the meal plan code is available for lunch or not.","type":"boolean"}},"type":"object"},"booking_blk_mealPlansType":{"description":"Meal plan codes associated with the rate codes.","items":{"$ref":"#/components/schemas/booking_blk_mealPlanCodeType"},"maxItems":4000,"type":"array"},"booking_blk_membershipEarningPreferenceType":{"description":"The earning preference of a membership, it depends on the type of property. eg. when the property is a airline it should be Miles, other than Points.","enum":["Points","Miles"],"type":"string"},"booking_blk_membershipInfoType":{"description":"The Membership object identifies the frequent customer reward program.","properties":{"accountId":{"description":"The account identification number for this particular member in this particular program.","maxLength":50,"minLength":0,"type":"string"},"bonusCode":{"description":"The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.)","maxLength":20,"minLength":0,"type":"string"},"membershipId":{"description":"Membership ID (Unique ID from the memberships table).","type":"number"},"membershipLevel":{"description":"The code or name of the membership level and indicates the level of membership (Gold Club, Platinum member, etc.). This is same as the BonusCode.","maxLength":20,"minLength":0,"type":"string"},"membershipLevelDesc":{"description":"The description of the Bonus Code.(Platinum for code P)","maxLength":2000,"minLength":0,"type":"string"},"membershipTypeDesc":{"description":"The description of the ProgramCode.(Delta Previlige for code DP)","maxLength":2000,"minLength":0,"type":"string"},"playerRanking":{"description":"Ranking assigned to the Player Profile by the Gaming system.","type":"integer"},"programCode":{"description":"The code or name of the membership program ('Hertz', 'AAdvantage', etc.).","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_membershipType":{"description":"Detailed information of the memberships.","properties":{"benefits":{"$ref":"#/components/schemas/booking_blk_benefitsType","description":"benefits for the membership."},"centralSetup":{"description":"Indicates how the award points for this membership type will be managed.","type":"boolean"},"comment":{"$ref":"#/components/schemas/booking_blk_paragraphType","description":"Additional comments regarding to the membership."},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"currentPoints":{"description":"Profile MemberShip Points.","type":"number"},"downgrade":{"$ref":"#/components/schemas/booking_blk_downgradeType","description":"Defines how downgrading will be handled for this membership."},"downgradeDescription":{"description":"Indicates information regarding the member's possible downgrades.","maxLength":32000,"minLength":0,"type":"string"},"earningPreference":{"$ref":"#/components/schemas/booking_blk_membershipEarningPreferenceType","description":"Earning preference to the membership."},"effectiveDate":{"description":"Indicates the starting date.","format":"date","maxLength":8,"type":"string"},"enrollmentResort":{"description":"Resort/CRO where enrollment is done.","maxLength":20,"minLength":0,"type":"string"},"enrollmentSource":{"description":"Source from where the enrollment is done.","maxLength":20,"minLength":0,"type":"string"},"excludeFromBatch":{"description":"True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false.","type":"boolean"},"expireDate":{"description":"Indicates the ending date.","format":"date","maxLength":8,"type":"string"},"expireDateExclusiveIndicator":{"description":"When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).","type":"boolean"},"inactive":{"description":"Indicates whether membership is active or inactive.","type":"boolean"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"memberStatus":{"description":"Indicates where the guest is in the membership enrollment process.","maxLength":20,"minLength":0,"type":"string"},"membershipClass":{"description":"Indicates the membership class.","type":"string"},"membershipEnrollmentCode":{"description":"Indicates how the guest enrolled in the program.","maxLength":20,"minLength":0,"type":"string"},"membershipId":{"description":"Card Number of the membership.","type":"string"},"membershipIdNo":{"description":"Membership ID Number.","type":"integer"},"membershipLevel":{"description":"Indicates the membership level.","type":"string"},"membershipLevelDescription":{"description":"Indicates the membership level description.","maxLength":200,"minLength":0,"type":"string"},"membershipType":{"description":"Type of membership.","type":"string"},"nameOnCard":{"description":"Name to be displayed on the membership card.","type":"string"},"newMembershipNumber":{"description":"Card Number of the membership.","type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"playerRanking":{"description":"Ranking assigned to the Player Profile by the Gaming system.","type":"integer"},"pointsLabel":{"description":"Label used to refer to points for this membership type","maxLength":20,"minLength":0,"type":"string"},"preferredCard":{"description":"Preferred Card.","type":"boolean"},"primaryMembership":{"description":"Boolean indicator set to True implies membership is a Primary Membership.","type":"boolean"},"primaryMembershipYn":{"description":"Indicator if Membership is a Primary Membership.","maxLength":1,"minLength":0,"type":"string"},"programDescription":{"description":"Description of the membership program.","type":"string"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","maxLength":8,"type":"string"},"rating":{"description":"Value Rating Type Description for this membership.","type":"string"},"reIssueNewCard":{"$ref":"#/components/schemas/booking_blk_cardReIssueType","description":"The status of issuing new membership card to the member."},"signupDate":{"description":"Indicates when the member signed up for the loyalty program.","format":"date","maxLength":8,"type":"string"},"tierAdministration":{"$ref":"#/components/schemas/booking_blk_tierAdministrationType","description":"Defines the degree of participation for this membership in the tier management portion of the program."},"upgradeDescription":{"description":"Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.","maxLength":32000,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_membershipTypeLevelType":{"properties":{"level":{"description":"Description type for Rule Details","maxLength":20,"minLength":0,"type":"string"},"type":{"description":"Code type for Rule Details","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_messageDeliveryType":{"description":"Holds the Delivery Information of the Message","properties":{"deliveredBy":{"description":"User who delivered the message (who marked message as received)","maxLength":40,"minLength":0,"type":"string"},"deliveryDate":{"description":"Date the message has been delivered (marked as received)","format":"date-time","type":"string"},"deliveryStatus":{"$ref":"#/components/schemas/booking_blk_messageStatusType","description":"Status of the Message (Received or Not Received)"},"printDate":{"description":"Date when message has been printed","format":"date-time","type":"string"},"textMessageRecipientNo":{"description":"Number in which the message is to be sent.","maxLength":2000,"minLength":0,"type":"string"},"textMessageSentBy":{"description":"User who sent the message","maxLength":40,"minLength":0,"type":"string"},"textMessageSentById":{"description":"User Id of who sent the message","type":"integer"},"textMessageSentDate":{"description":"Date when message has been sent via SMS","format":"date-time","type":"string"}},"type":"object"},"booking_blk_messageStatusType":{"description":"Status of the Message.","enum":["Mr","Nr"],"type":"string"},"booking_blk_messageType":{"description":"Holds the Message Information","properties":{"messageDate":{"description":"Date the message was created. Uses the hotel's time zone.","format":"date-time","type":"string"},"messageText":{"description":"Message Content","maxLength":2000,"minLength":0,"type":"string"},"operator":{"description":"User who created the Message","maxLength":40,"minLength":0,"type":"string"},"recipient":{"description":"Recipient of the Message","maxLength":80,"minLength":0,"type":"string"},"typeOfMessage":{"$ref":"#/components/schemas/booking_blk_typeOfMessageType","description":"Type of message (Voice/Text)"}},"type":"object"},"booking_blk_namePrefixType":{"description":"Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)","maxLength":40,"minLength":0,"type":"string"},"booking_blk_nameTypeType":{"enum":["Guest","Company","Agent","Contact","Source","Group","Employee","Hotel","Purge"],"type":"string"},"booking_blk_nameValueDataTypeType":{"enum":["String","Number","Date","Datetime","Time","Integer"],"type":"string"},"booking_blk_nameValueDetailType":{"description":"Detailed information returned during name value search.","properties":{"nameValues":{"$ref":"#/components/schemas/booking_blk_nameValuesType","description":"Name Value List."}},"type":"object"},"booking_blk_nameValueModuleType":{"enum":["Reservation","Folio","Profile","Fintrix"],"type":"string"},"booking_blk_nameValueOriginType":{"description":"Contains origin details.","properties":{"destination":{"description":"Contains destination column for Origin.","maxLength":200,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"originName":{"$ref":"#/components/schemas/booking_blk_nameValueModuleType","description":"Contains origin i.e. Reseravtion, Profile, Folio or FinTrx."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"warnings":{"$ref":"#/components/schemas/booking_blk_warningsType"}},"type":"object"},"booking_blk_nameValueType":{"description":"Contains name value pair.","properties":{"dataType":{"$ref":"#/components/schemas/booking_blk_nameValueDataTypeType","description":"Contains data type for values."},"formatString":{"description":"Contains format string for values.","maxLength":100,"minLength":0,"type":"string"},"name":{"description":"Contains unique key which represents for record field.","maxLength":100,"minLength":0,"type":"string"},"origin":{"$ref":"#/components/schemas/booking_blk_nameValueOriginType","description":"Contains Origin information."},"usageInstruction":{"$ref":"#/components/schemas/booking_blk_codeListType","description":"Contains value(s) to identify the reports to include the collected information in e.g. PFH=Print Folio Header, PFD=Print Folio Detail."},"value":{"description":"Contains value for the record/column.","maxLength":4000,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_nameValuesType":{"description":"List of name value pairs.","items":{"$ref":"#/components/schemas/booking_blk_nameValueType"},"maxItems":4000,"type":"array"},"booking_blk_nextBlockStatus":{"description":"Response object for FetchNextBlockStatus operation.","properties":{"blockNextStatusList":{"$ref":"#/components/schemas/booking_blk_blockNextStatusListType","description":"List of all the next statuses for the block status passed in the request. This also holds next statuses for all the next statuses of the status sent in request."},"cateringNextStatusList":{"$ref":"#/components/schemas/booking_blk_cateringNextStatusListType","description":"List of all the next statuses for the catering status passed in the request. This also holds next statuses for all the next statuses of the status sent in request."},"links":{"$ref":"#/components/schemas/booking_blk_links"},"warnings":{"$ref":"#/components/schemas/booking_blk_warningsType"}},"type":"object"},"booking_blk_numericUDFType":{"description":"Used to hold user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02,...UDFN40 (Total 40) as Numeric UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.","properties":{"alternateName":{"description":"Label of user defined field used by vendors or customers.","maxLength":2000,"minLength":0,"type":"string"},"name":{"description":"Name of user defined field.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Value of user defined field.","type":"number"}},"type":"object"},"booking_blk_numericUDFsType":{"description":"Used to hold collection of user defined fields of Numeric Type.","items":{"$ref":"#/components/schemas/booking_blk_numericUDFType"},"maxItems":4000,"type":"array"},"booking_blk_offsetUnitType":{"description":"Indicates deadline offset unit type.","enum":["Year","Month","Day","Hour"],"type":"string"},"booking_blk_overrideInstructionType":{"description":"Type for Overrides. Contains information for the override action performed while booking a reservation.","properties":{"date":{"description":"The date when the override was done.","format":"date","maxLength":8,"type":"string"},"description":{"description":"The description of the restriction for which the override was done.","maxLength":2000,"minLength":0,"type":"string"},"type":{"description":"The type of override done. If done for Availability, then it will be AVAILABILITY.","maxLength":80,"minLength":0,"type":"string"},"userId":{"description":"Login ID of the user who performed the override.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_overrideInstructionsType":{"description":"List of override actions done.","items":{"$ref":"#/components/schemas/booking_blk_overrideInstructionType"},"maxItems":4000,"type":"array"},"booking_blk_ownerResTypeType":{"enum":["Owner","AuthorizedUser"],"type":"string"},"booking_blk_ownerType":{"description":"Generic type for information about an owner.","properties":{"department":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Department to which the owner belongs to."},"email":{"$ref":"#/components/schemas/booking_blk_emailInfoType","description":"Email information of the owner."},"hotel":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Hotel to which the owner belongs to."},"name":{"$ref":"#/components/schemas/booking_blk_personNameType","description":"Provides name information of the owner."},"ownerCode":{"description":"Unique Code to identify the owner.","maxLength":20,"minLength":0,"type":"string"},"phone":{"$ref":"#/components/schemas/booking_blk_telephoneInfoType","description":"Information on the telephone number of the owner."},"primary":{"description":"When true, this is a primary owner.","type":"boolean"},"profileId":{"$ref":"#/components/schemas/booking_blk_profileId","description":"Unique owner profile information."},"relationship":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Relationship of the owner within the profile or block."},"userId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Unique application user ID."},"userName":{"description":"Unique application user name of the owner.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_pMS_ResStatusType":{"description":"This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.","enum":["Reserved","Requested","NoShow","Cancelled","InHouse","CheckedOut","Waitlisted","DueIn","DueOut","Walkin","PendingCheckout"],"type":"string"},"booking_blk_packageCalculationRuleType":{"description":"Simple type for package caluculation rules.","enum":["FlatRate","PerPerson","PerAdult","PerChild","PerRoom"],"type":"string"},"booking_blk_packageCodeHeaderType":{"properties":{"postingAttributes":{"$ref":"#/components/schemas/booking_blk_configPostingAttributesType","description":"Package code posting attributes."},"primaryDetails":{"$ref":"#/components/schemas/booking_blk_configPackagePrimaryDetailsType","description":"Package code header primary details."},"transactionDetails":{"$ref":"#/components/schemas/booking_blk_configPackageTransactionType","description":"Package code header transaction information."},"usageDetails":{"$ref":"#/components/schemas/booking_blk_configPackageUsageDetailType","description":"Package code usage information."}},"type":"object"},"booking_blk_packageConsumptionType":{"description":"Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.","properties":{"allowanceConsumed":{"description":"Indicates if Allowance(for POS packages) has been consumed/posted for today.","type":"boolean"},"defaultQuantity":{"description":"The default quantity attached in the package.","type":"integer"},"excludedQuantity":{"description":"The quantity which has been excluded in the package.","type":"integer"},"totalQuantity":{"description":"The total quantity of the package, calculated based on the calculation rule as defined in the PackageHeaderType.","type":"integer"}},"type":"object"},"booking_blk_packageElementType":{"properties":{"addRateCombinedLine":{"type":"boolean"},"addRateSeprateLine":{"type":"boolean"},"allowance":{"$ref":"#/components/schemas/booking_blk_currencyAmountType"},"amount":{"$ref":"#/components/schemas/booking_blk_currencyAmountType"},"calculationRule":{"type":"string"},"description":{"items":{"maxLength":2000,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"endDate":{"format":"date","maxLength":8,"type":"string"},"endTime":{"type":"string"},"includedInRate":{"type":"boolean"},"packageCode":{"type":"string"},"postingRhythm":{"type":"string"},"quantity":{"type":"integer"},"sellSeparate":{"type":"boolean"},"startDate":{"format":"date","maxLength":8,"type":"string"},"startTime":{"type":"string"}},"type":"object"},"booking_blk_packagePostingRhythmType":{"description":"Package Posting rhythm type.","properties":{"certainNightsOfTheWeek":{"description":"Post the package on certain nights of the week.","properties":{"friday":{"type":"boolean"},"monday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"thursday":{"type":"boolean"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"}},"type":"object"},"customNightSchedule":{"description":"The start and end of the posting period is determined as follows: If the package is attached to a rate code: The period starts with the date when the rate code to which the package is attached becomes effective for the stay. The period ends with the date of the last night for that rate code (or the last night of the stay if the rate code remains in effect until the departure date). If the package is attached separately to the reservation: The Begin Date specified on the reservation when the package was attached is the start date for the period. The End Date specified on the reservation when the package was attached is the end date for the period. If no Begin Date and/or End Date are specified when the package is attached to the reservation, the Begin Date is assumed to be the arrival date and the End Date is assumed to be the departure date of the reservation, irrespective of when the package is attached to the reservation.","properties":{"night1":{"description":"Night 1 indicator.","type":"boolean"},"night10":{"description":"Night 10 indicator.","type":"boolean"},"night11":{"description":"Night 11 indicator.","type":"boolean"},"night12":{"description":"Night 12 indicator.","type":"boolean"},"night13":{"description":"Night 13 indicator.","type":"boolean"},"night14":{"description":"Night 14 indicator.","type":"boolean"},"night2":{"description":"Night 2 indicator.","type":"boolean"},"night3":{"description":"Night 3 indicator.","type":"boolean"},"night4":{"description":"Night 4 indicator.","type":"boolean"},"night5":{"description":"Night 5 indicator.","type":"boolean"},"night6":{"description":"Night 6 indicator.","type":"boolean"},"night7":{"description":"Night 7 indicator.","type":"boolean"},"night8":{"description":"Night 8 indicator.","type":"boolean"},"night9":{"description":"Night 9 indicator.","type":"boolean"}},"type":"object"},"customStaySchedule":{"description":"This user defined schedule lets you enter a posting rhythm over a 14-day period, starting with the arrival date, by assigning the day (number) within a guest stay for posting this package price.","properties":{"night1":{"description":"Night 1 indicator.","type":"boolean"},"night10":{"description":"Night 10 indicator.","type":"boolean"},"night11":{"description":"Night 11 indicator.","type":"boolean"},"night12":{"description":"Night 12 indicator.","type":"boolean"},"night13":{"description":"Night 13 indicator.","type":"boolean"},"night14":{"description":"Night 14 indicator.","type":"boolean"},"night2":{"description":"Night 2 indicator.","type":"boolean"},"night3":{"description":"Night 3 indicator.","type":"boolean"},"night4":{"description":"Night 4 indicator.","type":"boolean"},"night5":{"description":"Night 5 indicator.","type":"boolean"},"night6":{"description":"Night 6 indicator.","type":"boolean"},"night7":{"description":"Night 7 indicator.","type":"boolean"},"night8":{"description":"Night 8 indicator.","type":"boolean"},"night9":{"description":"Night 9 indicator.","type":"boolean"}},"type":"object"},"everyXNightsStartingNightY":{"description":"Post the package every X nights Staring from Night Y.","properties":{"postEveryXNights":{"description":"Occurance of nights when the package needs to be posted and consumed.","type":"integer"},"startOnNightY":{"description":"Starting night for consumption and posting prices.","type":"integer"}},"type":"object"},"type":{"$ref":"#/components/schemas/booking_blk_postingRhythmType","description":"Posting Rhythm for the package."}},"type":"object"},"booking_blk_packagePostingRulesType":{"properties":{"alternateCodesList":{"description":"The alternate transaction code that can be consumed by the guest in place of the transaction code.","items":{"$ref":"#/components/schemas/booking_blk_packageTransactionCodeType"},"maxItems":4000,"type":"array"},"lossCode":{"$ref":"#/components/schemas/booking_blk_packageTransactionCodeType","description":"The transaction code to record package Loss, if any, from un-consumed allowance."},"overageCode":{"$ref":"#/components/schemas/booking_blk_packageTransactionCodeType","description":"The overage code to record over consumed allowance."},"profitCode":{"$ref":"#/components/schemas/booking_blk_packageTransactionCodeType","description":"The transaction code to record package profit, if any, from un-consumed allowance."},"transactionCode":{"$ref":"#/components/schemas/booking_blk_packageTransactionCodeType","description":"The Transaction code used to post the package price."}},"type":"object"},"booking_blk_packageTransactionCodeType":{"properties":{"code":{"description":"Posting / transaction code.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"The description of the code.","maxLength":200,"minLength":0,"type":"string"},"type":{"$ref":"#/components/schemas/booking_blk_amountDeterminationType","description":"Code is inclusive or exclusive of other charges such as taxes."}},"type":"object"},"booking_blk_paragraphType":{"description":"An indication of a new paragraph for a sub-section of a formatted text message.","properties":{"image":{"description":"An image for this paragraph.","type":"string"},"text":{"$ref":"#/components/schemas/booking_blk_formattedTextTextType","description":"Formatted text content."},"url":{"description":"A URL for this paragraph.","type":"string"}},"type":"object"},"booking_blk_parameterType":{"description":"Name value pair type that will hold generic parameter information. Only use this type when the parameters being passed are too dynamic to be defined.","properties":{"parameterName":{"description":"Name of the parameter.","type":"string"},"parameterValue":{"description":"Value of the parameter.","type":"string"}},"type":"object"},"booking_blk_parametersType":{"description":"Collection of generic Name-Value-Pair parameters.","items":{"$ref":"#/components/schemas/booking_blk_parameterType"},"maxItems":4000,"type":"array"},"booking_blk_payeeInfoType":{"description":"Payee information.","properties":{"payeeAccountInfo":{"$ref":"#/components/schemas/booking_blk_aRAccountShortInfoType","description":"AR account short info of the payee."},"payeeAddress":{"$ref":"#/components/schemas/booking_blk_addressInfoType","description":"Address of the payee."},"payeeAddressCount":{"description":"Payee multiple address count.","type":"integer"},"payeeId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Opera name id of the payee."},"payeeName":{"description":"Name of the payee.","maxLength":80,"minLength":0,"type":"string"},"payeeReferenceCurrency":{"description":"Reference currency of the payee.","maxLength":20,"minLength":0,"type":"string"},"payeeTaxNumber":{"description":"The tax number of the payee.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_paymentTypesType":{"description":"Payment card code like AX,VI etc.","items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"booking_blk_personNameType":{"description":"This provides name information for a person.","properties":{"envelopeGreeting":{"description":"Envelope Greeting of the profile","type":"string"},"externalSystem":{"description":"When name type is external, indicates the external system the name belongs to.","maxLength":40,"minLength":0,"type":"string"},"givenName":{"description":"Given name, first name or names.","maxLength":40,"minLength":0,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"middleName":{"description":"The middle name of the person name.","maxLength":40,"minLength":0,"type":"string"},"namePrefix":{"description":"Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)","maxLength":40,"minLength":0,"type":"string"},"nameSuffix":{"description":"Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)","maxLength":40,"minLength":0,"type":"string"},"nameTitle":{"description":"Degree or honors (e.g., Ph.D., M.D.)","maxLength":80,"minLength":0,"type":"string"},"nameTitleSuffix":{"description":"Title Suffix. Must be populated if ADVANCED_TITLE is on.","type":"integer"},"nameType":{"$ref":"#/components/schemas/booking_blk_personNameTypeType","description":"Type of name of the individual, such as former, nickname, alternate or alias name."},"salutation":{"description":"Salutation of the profile","type":"string"},"surname":{"description":"Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_personNameTypeType":{"description":"Person's name in an external system.","enum":["Primary","Alternate","Incognito","External","Phonetic"],"type":"string"},"booking_blk_phoneNumberType":{"description":"Phone number","maxLength":40,"minLength":0,"type":"string"},"booking_blk_pkgInventoryItemType":{"properties":{"articleNumber":{"description":"Article Number of the inventory item.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Description of the inventory item.","maxLength":200,"minLength":0,"type":"string"},"itemId":{"description":"Identifier for the inventory item.","type":"integer"},"quantity":{"description":"Quantity of the inventory item allocated to the package.","type":"integer"}},"type":"object"},"booking_blk_pointsType":{"description":"The Redeem Points contains the number of points required to book a room type.","properties":{"awardsType":{"description":"Awards type for the award type rate code.","type":"string"},"points":{"description":"No of points required to book this Room Stay.","type":"integer"}},"type":"object"},"booking_blk_policyAmountPercentType":{"description":"Defines the percentage basis for calculating the fee amount or the amount.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"basisType":{"$ref":"#/components/schemas/booking_blk_policyBasisTypeType","description":"Provides the basis for how the amount of the guarantee is calculated."},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"},"nights":{"description":"The number of nights of the hotel stay that are used to calculate the fee amount.","type":"integer"},"percent":{"description":"The percentage used to calculate the amount.","maximum":100,"minimum":0,"type":"number"}},"type":"object"},"booking_blk_policyBasisTypeType":{"description":"Full Amount.","enum":["FlatAmount","Percentage","Nights","NightPercentage","FullAmount"],"type":"string"},"booking_blk_policyDeadlineType":{"description":"Cancellation deadline, absolute or relative.","properties":{"absoluteDeadline":{"description":"Defines the absolute deadline. Either this or the offset attributes may be used.","format":"date-time","type":"string"},"offsetDropTime":{"description":"Time on offset day the cancellation penalties applies.","format":"date-time","type":"string"},"offsetFromArrival":{"description":"The number of days before arrival that allows cancellation without penalties.","type":"integer"},"offsetFromBookingDate":{"description":"The number of days after booking deposit must be paid.","type":"integer"}},"type":"object"},"booking_blk_porterageType":{"description":"Information about porterage charges.","properties":{"porterageIncluded":{"description":"Indicates if the room rate quoted includes any porterage cost.","type":"boolean"},"price":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"The additional charges per person for porterage service, if porterage is not included in the rate."}},"type":"object"},"booking_blk_postingRhythmType":{"description":"Simple type for posting Rhythm types.","enum":["EveryNight","ArrivalNight","EveryXNightsStartingNightY","CertainNightsOfTheWeek","LastNight","EveryNightExceptArrivalNight","EveryNightExceptLast","EveryNightExceptFirstAndLast","CustomStaySchedule","CustomNightSchedule","FloatingAllowancePerStay","TicketPosting"],"type":"string"},"booking_blk_preferenceType":{"description":"Guest Preference details for the profile.","properties":{"copyToProfile":{"description":"Specifies whether to copy the reservation preference to the profile or not.","type":"boolean"},"description":{"description":"Preference Description for display purposes.","maxLength":2000,"minLength":0,"type":"string"},"excludedPreferencesCount":{"description":"Specifies the count of preferences excluded for the attached reservation preference.","type":"integer"},"global":{"description":"Whether this preference is property specific or not.","type":"boolean"},"hotels":{"description":"If specified preference belongs to the Hotels listed, otherwise it is a global preference.","items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"preferenceCode":{"maxLength":20,"minLength":0,"type":"string"},"preferenceValue":{"description":"Preference value for display purposes.","maxLength":200,"minLength":0,"type":"string"},"source":{"description":"Source of the preference.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_preferenceTypeType":{"description":"Preference details for the profile.","properties":{"availableQuantity":{"description":"Available quantity of preferences (maximum quantity - Existing preferences)per preference group.","type":"integer"},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"maxQuantity":{"description":"Maximum quantity of preferences allowed per preference group.","type":"integer"},"maxResortUsedQuantity":{"description":"Maximum quantity of preferences used by any resort per preference group.","type":"integer"},"preference":{"description":"Collection of Preferences for the profile.","items":{"$ref":"#/components/schemas/booking_blk_preferenceType"},"maxItems":4000,"type":"array"},"preferenceType":{"description":"Preference group code.","maxLength":20,"minLength":0,"type":"string"},"preferenceTypeDescription":{"description":"Preference group description.","type":"string"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","maxLength":8,"type":"string"},"reservationPreference":{"description":"Whether this preference is reservation preference or not.","type":"boolean"},"sequence":{"description":"Preference Sequence.","type":"string"}},"type":"object"},"booking_blk_prepaidCardDetailsType":{"description":"Prepaid Card Details.","properties":{"activateDate":{"description":"Holds fixed charge detail.","format":"date","maxLength":8,"type":"string"},"balanceTotal":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Holds fixed charge detail."},"creditTotal":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Holds fixed charge detail."},"debitTotal":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Holds fixed charge detail."},"expiredDate":{"description":"Holds fixed charge detail.","format":"date","maxLength":8,"type":"string"},"initialCreditTotal":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Holds fixed charge detail."},"initialLoadDate":{"description":"Holds fixed charge detail.","format":"date","maxLength":8,"type":"string"},"reservedTotal":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Holds fixed charge detail."},"transactions":{"description":"Holds fixed charge detail.","items":{"$ref":"#/components/schemas/booking_blk_prepaidCardTransactionType"},"maxItems":4000,"type":"array"},"validUntilDate":{"description":"Holds fixed charge detail.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_blk_prepaidCardTransactionType":{"description":"Prepaid Card transaction.","properties":{"amount":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Prepaid Card Amount."},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","maxLength":8,"type":"string"},"transactionDate":{"description":"Transaction number of the Prepaid card transaction.","format":"date","maxLength":8,"type":"string"},"transactionNo":{"description":"Transaction number of the Prepaid card transaction.","type":"number"},"transactionType":{"$ref":"#/components/schemas/booking_blk_prepaidCardTrxTypeType","description":"Transaction type enumeration."}},"type":"object"},"booking_blk_prepaidCardTrxTypeType":{"description":"Reload transaction.","enum":["Activate","Cancel","Cashout","Inquiry","Issue","Redeem","Reload"],"type":"string"},"booking_blk_prepaidCardType":{"description":"Holds fixed charge information.","properties":{"amount":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Prepaid Card Amount."},"cardDetails":{"$ref":"#/components/schemas/booking_blk_prepaidCardDetailsType","description":"Prepaid Card details from vendor."},"cardNo":{"description":"Prepaid card / account number.","maxLength":80,"minLength":0,"type":"string"},"cardNumberMasked":{"description":"Masked Prepaid card / account number.","maxLength":80,"minLength":0,"type":"string"},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"firstName":{"description":"Given name, first name or names.","maxLength":80,"minLength":0,"type":"string"},"giftCard":{"description":"Indicates a gift card type.","type":"boolean"},"hotelId":{"description":"Hotel context for the Reservations.","maxLength":20,"minLength":0,"type":"string"},"interfaceId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"The unique ID for the Interface."},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"name":{"description":"Family name, last name or Company Name.","maxLength":80,"minLength":0,"type":"string"},"pinCode":{"description":"Prepaid card pin code.","maxLength":10,"minLength":0,"type":"string"},"profileId":{"$ref":"#/components/schemas/booking_blk_profileId","description":"Card / Account holder name ID"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","maxLength":8,"type":"string"},"reservationId":{"$ref":"#/components/schemas/booking_blk_reservationId","description":"The unique ID of the reservation to which this record applies."}},"type":"object"},"booking_blk_prepaidCardsType":{"description":"Holds fixed charge detail.","items":{"$ref":"#/components/schemas/booking_blk_prepaidCardType"},"maxItems":4000,"type":"array"},"booking_blk_primaryShareTypeType":{"enum":["Primary","NonPrimary"],"type":"string"},"booking_blk_privacyInfoType":{"description":"Defines Privacy related information for the profile.","properties":{"allowEmail":{"description":"Indicates if the profile wishes to allow Email.","type":"boolean"},"allowPhone":{"description":"Indicates if the profile wishes to allow phone calls.","type":"boolean"},"allowSMS":{"description":"Indicates if the profile wishes to allow SMS.","type":"boolean"},"autoEnrollLoyaltyProgram":{"description":"Indicates if the profile wishes to be automatically enrolled in the property's loyalty program.","type":"boolean"},"infoFromThirdParty":{"description":"Indicates if the profile is ok getting info from third parties.","type":"boolean"},"lastPrivacyPromptDate":{"description":"Indicate the last privacy prompt date of the guest.","format":"date","maxLength":8,"type":"string"},"marketResearchParticipation":{"description":"Indicates if the profile participates in market research.","type":"boolean"},"optInAutoEnrollmentMember":{"description":"Indicates if the profile wishes to opt in for Auto Enrolment Member.","type":"boolean"},"optInEmail":{"description":"Indicates if the profile wishes to opt in for Email.","type":"boolean"},"optInMailingList":{"description":"Indicates if the profile wishes to opt in for Mailing List.","type":"boolean"},"optInMarketResearch":{"description":"Indicates if the profile wishes to opt in for Market Research.","type":"boolean"},"optInPhone":{"description":"Indicates if the profile wishes to opt in for Phone.","type":"boolean"},"optInSms":{"description":"Indicates if the profile wishes to opt in for SMS.","type":"boolean"},"optInThirdParty":{"description":"Indicates if the profile wishes to opt in for Third Party.","type":"boolean"}},"type":"object"},"booking_blk_productSourceType":{"description":"Sources of Products","enum":["Reservation","RateHeader","RateDetail"],"type":"string"},"booking_blk_profileCashieringDetailType":{"description":"The type contains routing instructions for the profile.","properties":{"eCommerceId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"E-Commerce ID of the Profile"},"fiscalGuestType":{"description":"Guest type code.","maxLength":20,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel Code for which the routing instructions are provided for a profile.","maxLength":20,"minLength":0,"type":"string"},"paymentMethod":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Payment Method Details."},"routingInstructions":{"$ref":"#/components/schemas/booking_blk_profileRoutingInstructionsType","description":"Set of preconfigured transaction codes."},"taxType":{"description":"Tax type code.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_profileCashieringType":{"description":"Contains cashiering related details for the profile","properties":{"arNoCentral":{"description":"Account Receivables Central Number.","maxLength":20,"minLength":0,"type":"string"},"autoFolioSettlementType":{"description":"Contains the auto folio settlement type for the profile.","maxLength":40,"minLength":0,"type":"string"},"currencyCode":{"description":"The code specifying a monetary unit. Use ISO 4217, three alpha code.","maxLength":20,"minLength":0,"type":"string"},"currencySymbol":{"description":"The symbol for the currency, e.g, for currencyCode USD the symbol is $.","maxLength":10,"minLength":0,"type":"string"},"decimalPlaces":{"description":"Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).","type":"integer"},"directBillingList":{"description":"Contains the direct billing related information for the profile.","items":{"$ref":"#/components/schemas/booking_blk_directBillingType"},"maxItems":4000,"type":"array"},"paymentDueDays":{"description":"Ability to define on the account, the number of days after which the invoice should be paid.","type":"integer"},"referenceCurrency":{"description":"Reference Currency.","maxLength":20,"minLength":0,"type":"string"},"taxPercent1":{"description":"Tax1 Percentage for Collecting Agent.","type":"integer"},"taxPercent2":{"description":"Tax2 Percentage for Collecting Agent.","type":"integer"},"taxPercent3":{"description":"Tax3 Percentage for Collecting Agent.","type":"integer"},"taxPercent4":{"description":"Tax4 Percentage for Collecting Agent.","type":"integer"},"taxPercent5":{"description":"Tax5 Percentage for Collecting Agent.","type":"integer"},"vATOffsetYN":{"description":"VAT Offset Flag.","maxLength":1,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_profileCommissionType":{"description":"This is the preconfigured routing instruction type.","properties":{"bankAccount":{"description":"Bank account used for the commission for a profile.","maxLength":20,"minLength":0,"type":"string"},"commissionCode":{"description":"commission Code for a profile.","maxLength":20,"minLength":0,"type":"string"},"currencyCode":{"description":"The code specifying a monetary unit. Use ISO 4217, three alpha code.","maxLength":20,"minLength":0,"type":"string"},"currencySymbol":{"description":"The symbol for the currency, e.g, for currencyCode USD the symbol is $.","maxLength":10,"minLength":0,"type":"string"},"decimalPlaces":{"description":"Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).","type":"integer"},"hotelId":{"description":"Hotel Code for the commission being used for a profile.","maxLength":20,"minLength":0,"type":"string"},"paymentMethod":{"$ref":"#/components/schemas/booking_blk_commissionPaymentMethods","description":"Type of payment associated with the bank account."}},"type":"object"},"booking_blk_profileDeliveryMethod":{"description":"Delivery Information type to the profile.","properties":{"deliveryId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Delivery ID. It will be empty in case of new delivery method."},"deliveryModule":{"$ref":"#/components/schemas/booking_blk_profileDeliveryModuleType","description":"Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc.."},"deliveryType":{"description":"Delivery type can have a value EMAIL, ELECTRONIC etc and it depends on the parameter set in OPERA Control.","maxLength":20,"minLength":0,"type":"string"},"deliveryValue":{"description":"Delivery value holds the corresponding value of the delivery type..","maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"description":"Property that has delivery methods configured.","maxLength":20,"minLength":0,"type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"}},"type":"object"},"booking_blk_profileDeliveryModuleType":{"description":"Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..","enum":["EfolioExport"],"type":"string"},"booking_blk_profileId":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_blk_profileIdList":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type"},"maxItems":4000,"type":"array"},"booking_blk_profileMembershipType":{"description":"Detailed information of the memberships.","properties":{"benefits":{"$ref":"#/components/schemas/booking_blk_benefitsType","description":"benefits for the membership."},"centralSetup":{"description":"Indicates how the award points for this membership type will be managed.","type":"boolean"},"comment":{"$ref":"#/components/schemas/booking_blk_paragraphType","description":"Additional comments regarding to the membership."},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"currentPoints":{"description":"Profile MemberShip Points.","type":"number"},"downgrade":{"$ref":"#/components/schemas/booking_blk_downgradeType","description":"Defines how downgrading will be handled for this membership."},"downgradeDescription":{"description":"Indicates information regarding the member's possible downgrades.","maxLength":32000,"minLength":0,"type":"string"},"earningPreference":{"$ref":"#/components/schemas/booking_blk_membershipEarningPreferenceType","description":"Earning preference to the membership."},"effectiveDate":{"description":"Indicates the starting date.","format":"date","maxLength":8,"type":"string"},"enrollmentResort":{"description":"Resort/CRO where enrollment is done.","maxLength":20,"minLength":0,"type":"string"},"enrollmentSource":{"description":"Source from where the enrollment is done.","maxLength":20,"minLength":0,"type":"string"},"excludeFromBatch":{"description":"True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false.","type":"boolean"},"expireDate":{"description":"Indicates the ending date.","format":"date","maxLength":8,"type":"string"},"expireDateExclusiveIndicator":{"description":"When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).","type":"boolean"},"inactive":{"description":"Indicates whether membership is active or inactive.","type":"boolean"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"memberStatus":{"description":"Indicates where the guest is in the membership enrollment process.","maxLength":20,"minLength":0,"type":"string"},"membershipClass":{"description":"Indicates the membership class.","type":"string"},"membershipEnrollmentCode":{"description":"Indicates how the guest enrolled in the program.","maxLength":20,"minLength":0,"type":"string"},"membershipId":{"description":"Card Number of the membership.","type":"string"},"membershipIdNo":{"description":"Membership ID Number.","type":"integer"},"membershipLevel":{"description":"Indicates the membership level.","type":"string"},"membershipLevelDescription":{"description":"Indicates the membership level description.","maxLength":200,"minLength":0,"type":"string"},"membershipType":{"description":"Type of membership.","type":"string"},"nameOnCard":{"description":"Name to be displayed on the membership card.","type":"string"},"newMembershipNumber":{"description":"Card Number of the membership.","type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"playerRanking":{"description":"Ranking assigned to the Player Profile by the Gaming system.","type":"integer"},"pointsLabel":{"description":"Label used to refer to points for this membership type","maxLength":20,"minLength":0,"type":"string"},"preferredCard":{"description":"Preferred Card.","type":"boolean"},"primaryMembership":{"description":"Boolean indicator set to True implies membership is a Primary Membership.","type":"boolean"},"primaryMembershipYn":{"description":"Indicator if Membership is a Primary Membership.","maxLength":1,"minLength":0,"type":"string"},"programDescription":{"description":"Description of the membership program.","type":"string"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","maxLength":8,"type":"string"},"rating":{"description":"Value Rating Type Description for this membership.","type":"string"},"reIssueNewCard":{"$ref":"#/components/schemas/booking_blk_cardReIssueType","description":"The status of issuing new membership card to the member."},"signupDate":{"description":"Indicates when the member signed up for the loyalty program.","format":"date","maxLength":8,"type":"string"},"tierAdministration":{"$ref":"#/components/schemas/booking_blk_tierAdministrationType","description":"Defines the degree of participation for this membership in the tier management portion of the program."},"upgradeDescription":{"description":"Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.","maxLength":32000,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_profileNameType":{"description":"This provides name information for a person.","properties":{"fullName":{"description":"Full display Name.","maxLength":200,"minLength":0,"type":"string"},"givenName":{"description":"Given name, first name or names.","maxLength":40,"minLength":0,"type":"string"},"middleName":{"description":"The middle name of the person name.","maxLength":40,"minLength":0,"type":"string"},"name":{"description":"Family name, last name or Company Name.","maxLength":40,"minLength":0,"type":"string"},"namePrefix":{"description":"Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)","maxLength":40,"minLength":0,"type":"string"},"nameSuffix":{"description":"Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)","maxLength":40,"minLength":0,"type":"string"},"nameTitle":{"description":"Degree or honors (e.g., Ph.D., M.D.)","maxLength":80,"minLength":0,"type":"string"},"nameType":{"$ref":"#/components/schemas/booking_blk_personNameTypeType","description":"Type of name of the individual, such as former, nickname, alternate or alias name."}},"type":"object"},"booking_blk_profileRestrictions":{"properties":{"reason":{"description":"Restriction reason associated with the current profile.","maxLength":20,"minLength":0,"type":"string"},"reasonDescription":{"description":"Description of restriction reason.","maxLength":2000,"minLength":0,"type":"string"},"restricted":{"description":"True indicates there are restrictions associated with the current profile.","type":"boolean"}},"type":"object"},"booking_blk_profileRoutingInstructionsType":{"description":"The type contains routing instructions for the profile.","properties":{"autoPopulateRouting":{"description":"A flag which determines whether the instructions has to be automatically populated for this profile or not.","type":"boolean"},"billingInstructions":{"$ref":"#/components/schemas/booking_blk_billingInstructionsType","description":"Set of preconfigured Billing Instruction results."},"transactionCodes":{"$ref":"#/components/schemas/booking_blk_trxCodesInfoType","description":"Set of preconfigured transaction codes."}},"type":"object"},"booking_blk_profileStatusType":{"enum":["Active","Inactive"],"type":"string"},"booking_blk_profileTaxInfoType":{"description":"Profile information related to tax.","properties":{"businessId":{"description":"Business ID. The maximum length of this element should not exceed 120 characters.","maxLength":128,"minLength":0,"type":"string"},"businessRegistration":{"description":"Business Registration Code. The maximum length of this element should not exceed 120 characters.","maxLength":128,"minLength":0,"type":"string"},"tax1No":{"description":"The tax id of this profile. Usually issued by a government agency. Used by 1099 printing.","maxLength":40,"minLength":0,"type":"string"},"tax2No":{"description":"Tax 2 id of this profile.","maxLength":40,"minLength":0,"type":"string"},"taxCategory":{"description":"Tax Category to be changed.","maxLength":20,"minLength":0,"type":"string"},"taxOffice":{"description":"Tax Office to be changed.","maxLength":30,"minLength":0,"type":"string"},"taxType":{"description":"Tax type to be changed.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_profileType":{"description":"Type provides the detailed information about the profile and its children.","properties":{"addresses":{"description":"List of customer addresses.","properties":{"addressInfo":{"description":"Collection of Detailed information on an address for the customer.","items":{"$ref":"#/components/schemas/booking_blk_addressInfoType"},"maxItems":4000,"type":"array"},"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"cashiering":{"$ref":"#/components/schemas/booking_blk_profileCashieringType","description":"Contains cashiering related details for the profile"},"comments":{"description":"List of Notes for the customer.","properties":{"commentInfo":{"description":"Collection of Detailed information on comments for the customer.","items":{"$ref":"#/components/schemas/booking_blk_commentInfoType"},"maxItems":4000,"type":"array"},"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"commissionInfoList":{"description":"Contains commission related details for the profile.","items":{"$ref":"#/components/schemas/booking_blk_profileCommissionType"},"maxItems":4000,"type":"array"},"company":{"$ref":"#/components/schemas/booking_blk_companyType","description":"Detailed company information for this profile."},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"customer":{"$ref":"#/components/schemas/booking_blk_customerType","description":"Detailed customer information for this profile."},"eCertificates":{"$ref":"#/components/schemas/booking_blk_eCertificatesType","description":"E-Certificate assosiated with the profile."},"emails":{"description":"List of email address for the customer.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"emailInfo":{"description":"Collection of Detailed information on an eMail address for the customer.","items":{"$ref":"#/components/schemas/booking_blk_emailInfoType"},"maxItems":4000,"type":"array"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"hasCommission":{"description":"Populates true if the profile has commission configured false otherwise.","type":"boolean"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"lastStayInfo":{"$ref":"#/components/schemas/booking_blk_lastStayInfoType","description":"Information on last stay of the profile."},"markAsRecentlyAccessed":{"description":"Mark this profile as recently accessed.","type":"boolean"},"ownerCode":{"description":"Owner Code associated to the profile.","maxLength":40,"minLength":0,"type":"string"},"preferenceCollection":{"description":"List of customer preferences.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"preferenceType":{"description":"Collection of Detailed information on preferences of the customer.","items":{"$ref":"#/components/schemas/booking_blk_preferenceTypeType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"privacyInfo":{"$ref":"#/components/schemas/booking_blk_privacyInfoType","description":"Contains privacy related information associated with the profile"},"profileDeliveryMethods":{"description":"List of Delivery methods configured against a Property for this Profile.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"profileDeliveryMethod":{"description":"Collection of delivery methods for this Profile.","items":{"$ref":"#/components/schemas/booking_blk_profileDeliveryMethod"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"profileImage":{"$ref":"#/components/schemas/booking_blk_imageSetType","description":"The profile image."},"profileMemberships":{"description":"List of loyalty program(s) the profile is subscribed to.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"profileMembership":{"description":"Collection of Detailed information on memberships for the customer.","items":{"$ref":"#/components/schemas/booking_blk_profileMembershipType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"profileRestrictions":{"$ref":"#/components/schemas/booking_blk_profileRestrictions","description":"Detailed information on restrictions associated with the profile."},"profileType":{"$ref":"#/components/schemas/booking_blk_profileTypeType","description":"Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact."},"protectedBy":{"description":"What level this profile is protected.","maxLength":40,"minLength":0,"type":"string"},"relationships":{"description":"Contains a collection of profiles that have a relationship with this profile.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"relationship":{"description":"A collection of the profiles that have a relationship with this profile.","items":{"$ref":"#/components/schemas/booking_blk_relationshipInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"relationshipsSummary":{"description":"Contains a collection of profiles that have a relationship with this profile.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"relationship":{"description":"A collection of the profiles summary that have a relationship with this profile.","items":{"$ref":"#/components/schemas/booking_blk_relationshipInfoSummaryType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"reservationInfoList":{"$ref":"#/components/schemas/booking_blk_reservationHistoryFutureInfoType","description":"Collection of Detailed information on history and future reservations associated with the profile."},"roomOwnershipsList":{"description":"Room Ownership records.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"roomOwnershipInfo":{"description":"Collection of Detailed information on Room Ownership records.","items":{"$ref":"#/components/schemas/booking_blk_roomOwnershipType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"showInactiveRoomOwners":{"description":"Flag to show inactive Room Owners.","type":"boolean"},"statusCode":{"$ref":"#/components/schemas/booking_blk_profileStatusType","description":"Status of the profile. Active/Inactive"},"stayReservationInfoList":{"$ref":"#/components/schemas/booking_blk_reservationStayHistoryFutureInfoType","description":"Collection of Detailed information on history and future reservations associated with the profile."},"taxInfo":{"$ref":"#/components/schemas/booking_blk_profileTaxInfoType","description":"Profile information about tax."},"telephones":{"description":"List of Telephone Number Information","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"telephoneInfo":{"description":"Collection of Detailed information on telephone/fax for the customer.","items":{"$ref":"#/components/schemas/booking_blk_telephoneInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"traceCode":{"description":"Trace Code associated to the profile.","maxLength":40,"minLength":0,"type":"string"},"uRLs":{"description":"List of Information on a URL for the customer.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"totalResults":{"description":"Total number of rows queried","type":"integer"},"uRLInfo":{"description":"Collection of Detailed information on web url/address for the customer.","items":{"$ref":"#/components/schemas/booking_blk_uRLInfoType"},"maxItems":4000,"type":"array"}},"type":"object"},"userDefinedFields":{"$ref":"#/components/schemas/booking_blk_userDefinedFieldsType","description":"Collections of user defined fields."}},"type":"object"},"booking_blk_profileTypeType":{"description":"The types of Profile handled by the web service.","enum":["Guest","Agent","Company","Group","Source","Employee","Hotel","Vendor","Contact","Purge","BusinessHeader","BillingAccount","Activity","Potential","Account"],"type":"string"},"booking_blk_promotionType":{"description":"Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.","properties":{"couponCode":{"description":"Promotion Coupon Code when promotion is setup to have a valid coupon code.","maxLength":40,"minLength":0,"type":"string"},"promotionCode":{"description":"Promotion code associated with the rate plan.","maxLength":20,"minLength":0,"type":"string"},"promotionName":{"description":"Promotion code Name associated with the rate plan.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_queueTextInfoType":{"description":"Information regarding the message sent to guest.","properties":{"sentBy":{"description":"User name of the user who sent message.","maxLength":40,"minLength":0,"type":"string"},"sentTime":{"description":"Time the text was last sent to the user. Uses database time zone.","format":"date-time","type":"string"}},"type":"object"},"booking_blk_rateProgramRateType":{"description":"Room Pool Rate Program.","properties":{"commissionable":{"description":"Rate Program Commissionable Indicator.","type":"boolean"},"endDate":{"description":"End date of the Room Pool Rate Program.","format":"date","maxLength":8,"type":"string"},"mobileCheckout":{"description":"Rate Program Mobile Checkout Allowed Indicator.","type":"boolean"},"primary":{"description":"Rate Program Primary Rate Code Indicator.","type":"boolean"},"rateAmounts":{"$ref":"#/components/schemas/booking_blk_blockGridRatesType","description":"Rate Program Amounts."},"rateCode":{"description":"Rate Program Code.","maxLength":20,"minLength":0,"type":"string"},"rateMarketCode":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"RateMarketCode is a rate attribute required for external system in order to create a rate program. Only available if configured in OPERA Cloud."},"roomTypes":{"$ref":"#/components/schemas/booking_blk_rateProgramRoomType","description":"Rate Program Room Types."},"sequence":{"description":"Sequence Number of the Rate Program.","type":"integer"},"startDate":{"description":"Start date of the Room Pool Rate Program.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_blk_rateProgramRoomType":{"description":"Room type for which Rate Program Rate Applies.","items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"booking_blk_rateProgramType":{"description":"Rate Programs for the Block.","properties":{"rates":{"description":"Block Rate Program Rates.","items":{"$ref":"#/components/schemas/booking_blk_rateProgramRateType"},"maxItems":4000,"type":"array"},"roomPool":{"description":"Room Pool Code.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_rateProtectionType":{"description":"Simple type for specifying the block protection type.","enum":["All","Selected","None"],"type":"string"},"booking_blk_rateRangeType":{"description":"Rate Range details like maximum rate amount and minimum rate amount in each available rate category.","properties":{"base":{"description":"The base amount charged for the accommodation or service.","items":{"$ref":"#/components/schemas/booking_blk_totalType"},"maxItems":4000,"type":"array"},"rateChange":{"description":"Rate Change Indicator.","type":"boolean"}},"type":"object"},"booking_blk_ratesType":{"description":"Individual rate amount.","properties":{"rate":{"description":"The Rate contains a collection of elements that define the amount of the rate, associated fees, additional occupant amounts. Taxes can be broken out or included within the various amounts. A currency can be associated to each amount.","items":{"$ref":"#/components/schemas/booking_blk_amountType"},"maxItems":4000,"type":"array"},"rateRange":{"description":"Rate Range details like maximum rate amount and minimum rate amount in each available rate category.","items":{"$ref":"#/components/schemas/booking_blk_rateRangeType"},"maxItems":4000,"type":"array"}},"type":"object"},"booking_blk_relationshipAddressType":{"description":"Provides address information for a Relationship.","properties":{"addressLine":{"description":"When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.","items":{"maxLength":80,"minLength":0,"type":"string"},"maxItems":4,"type":"array"},"city":{"description":"City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).","maxLength":40,"minLength":0,"type":"string"},"country":{"description":"Country name (e.g., Ireland).","maxLength":200,"minLength":0,"type":"string"},"postalCode":{"description":"Post Office Code number.","maxLength":15,"minLength":0,"type":"string"},"state":{"description":"State or Province name (e.g., Texas).","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_relationshipInfoSummaryType":{"description":"RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.","properties":{"masterAccountDetails":{"$ref":"#/components/schemas/booking_blk_masterAccountInfoType","description":"Refer to Master Profile type document."},"relationshipID":{"description":"Relationship identifier.","maxLength":80,"minLength":0,"type":"string"},"relationshipProfile":{"$ref":"#/components/schemas/booking_blk_relationshipProfileSummaryType","description":"Refer to Relationship Profile Summary type document."},"sourceRelation":{"description":"Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).","maxLength":20,"minLength":0,"type":"string"},"sourceRelationDescription":{"description":"Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).","maxLength":200,"minLength":0,"type":"string"},"targetRelation":{"description":"Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).","maxLength":20,"minLength":0,"type":"string"},"targetRelationDescription":{"description":"Displays the description of the target relation(Target Profile).","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_relationshipInfoType":{"description":"Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.","properties":{"id":{"description":"Relationship identifier.","maxLength":80,"minLength":0,"type":"string"},"relation":{"description":"Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).","maxLength":20,"minLength":0,"type":"string"},"relationshipProfile":{"$ref":"#/components/schemas/booking_blk_relationshipProfileType","description":"Refer to Relationship Profile type document."},"targetRelation":{"description":"Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_relationshipProfileSummaryType":{"properties":{"address":{"$ref":"#/components/schemas/booking_blk_relationshipAddressType","description":"Information on address details for the customer/company"},"companyName":{"description":"Name of the company.","maxLength":40,"minLength":0,"type":"string"},"customerName":{"description":"Name of the customer","maxLength":40,"minLength":0,"type":"string"},"emailAddress":{"description":"Defines the e-mail address.","maxLength":2000,"minLength":0,"type":"string"},"ownerCode":{"description":"Unique Code to identify the owner.","maxLength":20,"minLength":0,"type":"string"},"primary":{"description":"Indicates if this relationship is the primary relationship.","type":"boolean"},"primaryOwnerCode":{"description":"When true, this is a primary owner.","type":"boolean"},"profileIdList":{"$ref":"#/components/schemas/booking_blk_uniqueIDListType","description":"Original profile details for which the relationships was created"},"profileStatus":{"$ref":"#/components/schemas/booking_blk_profileStatusType","description":"Status of the profile. Active/Inactive"},"profileType":{"$ref":"#/components/schemas/booking_blk_profileTypeType","description":"Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact."},"telephoneNumber":{"description":"Telephone number assigned to a single location","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_relationshipProfileType":{"properties":{"address":{"$ref":"#/components/schemas/booking_blk_addressInfoType","description":"Information on address details for the customer/company"},"company":{"$ref":"#/components/schemas/booking_blk_companyType","description":"Detailed information of the Company."},"customer":{"$ref":"#/components/schemas/booking_blk_customerType","description":"Detailed information of the customer"},"email":{"$ref":"#/components/schemas/booking_blk_emailInfoType","description":"Information on email address for the customer/company"},"id":{"description":"Relationship identifier.","maxLength":80,"minLength":0,"type":"string"},"primary":{"description":"Indicates if this relationship is the primary relationship.","maxLength":20,"minLength":0,"type":"string"},"primaryOwner":{"$ref":"#/components/schemas/booking_blk_ownerType","description":"Primary Owner of the profile"},"profileIdList":{"$ref":"#/components/schemas/booking_blk_uniqueIDListType","description":"Original profile details for which the relationships was created"},"profileType":{"$ref":"#/components/schemas/booking_blk_profileTypeType","description":"Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact."},"statusCode":{"$ref":"#/components/schemas/booking_blk_profileStatusType","description":"Status of the profile. Active/Inactive"},"telephone":{"$ref":"#/components/schemas/booking_blk_telephoneInfoType","description":"Information on telephone details for the customer/company"},"uRLs":{"$ref":"#/components/schemas/booking_blk_uRLInfoType","description":"Information on web url/address for the customer/company"}},"type":"object"},"booking_blk_requestActionType":{"enum":["Create","Remove","Query"],"type":"string"},"booking_blk_resAccessRestrictionType":{"description":"Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.","enum":["Change","Cancel","ChangeOrCancel"],"type":"string"},"booking_blk_resAccompanyGuestInfoType":{"properties":{"firstName":{"description":"Given name, first name or names","type":"string"},"fullName":{"description":"String representation of the full name","type":"string"},"lastName":{"description":"Family name, last name.","type":"string"},"profileIdList":{"$ref":"#/components/schemas/booking_blk_profileIdList","description":"Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id."},"registrationCardNo":{"description":"Unique identifier of the police registration card number.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_resAccompanyGuestListType":{"description":"Collection of accompany guests","items":{"$ref":"#/components/schemas/booking_blk_resAccompanyGuestInfoType"},"maxItems":4000,"type":"array"},"booking_blk_resAttachedProfileListType":{"items":{"$ref":"#/components/schemas/booking_blk_resAttachedProfileType"},"maxItems":4000,"type":"array"},"booking_blk_resAttachedProfileType":{"properties":{"name":{"description":"Attached profile name","type":"string"},"profileIdList":{"$ref":"#/components/schemas/booking_blk_profileIdList","description":"Collection of unique profile identifiers"},"reservationProfileType":{"$ref":"#/components/schemas/booking_blk_resProfileTypeType"}},"type":"object"},"booking_blk_resAwardsType":{"description":"Membership Awards code applied on the reservation.","properties":{"awardVouchers":{"$ref":"#/components/schemas/booking_blk_awardVouchersType"},"membershipNo":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Membership program under which the award is applied."},"originalRoomType":{"description":"Room Type before the Upgrade Award.","maxLength":20,"minLength":0,"type":"string"},"upgradeRoomType":{"description":"Room Type after the Upgrade Award.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_resCancelPenaltyType":{"description":"The CancelPenalty class defines the cancellation policy of the hotel facility.","properties":{"amountPercent":{"$ref":"#/components/schemas/booking_blk_policyAmountPercentType","description":"Cancellation fee expressed as a fixed amount, or percentage of/or room nights."},"deadline":{"$ref":"#/components/schemas/booking_blk_policyDeadlineType","description":"Cancellation deadline, absolute or relative."},"effective":{"description":"Indicator if Cancellation Penalty is currently applicable or not.","type":"boolean"},"formattedRule":{"description":"Formatted Text Rule of the Cancellation Penalty.","maxLength":2000,"minLength":0,"type":"string"},"manual":{"description":"Flag to indicate if the cancellation policy is manual.","type":"boolean"},"nonRefundable":{"description":"Indicates if the amount is refundable if booking is canceled.","type":"boolean"},"offsetUnit":{"$ref":"#/components/schemas/booking_blk_offsetUnitType"},"penaltyDescription":{"description":"Text description of the Penalty in a given language.","maxLength":2000,"minLength":0,"type":"string"},"policyCode":{"description":"Policy Code.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_resCancellationPoliciesType":{"description":"A list of reservation cancellation policies.","items":{"$ref":"#/components/schemas/booking_blk_resCancellationPolicyType"},"maxItems":4000,"type":"array"},"booking_blk_resCancellationPolicyType":{"description":"A cancellation policy attached with the reservation.","properties":{"comments":{"description":"Comments attached with the reservation cancellation.","maxLength":2000,"minLength":0,"type":"string"},"percentageDue":{"description":"The percentage amount due for reservation cancellation.","maximum":100,"minimum":0,"type":"number"},"policy":{"$ref":"#/components/schemas/booking_blk_resCancelPenaltyType","description":"Cancellation policy details."},"policyId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Unique ID of the Reservation Policy."},"revenueType":{"$ref":"#/components/schemas/booking_blk_depositCancelRevenueType","description":"Type of reservation."}},"type":"object"},"booking_blk_resCashieringType":{"description":"Cashiering Information for the reservation.","properties":{"bedTaxReporting":{"$ref":"#/components/schemas/booking_blk_bedTaxReportingType","description":"This stores the information for Bed Tax Reporting. Mainly used in Maldives."},"billingPrivileges":{"$ref":"#/components/schemas/booking_blk_billingPrivilegesType","description":"Billing privileges set on the reservation."},"compAccounting":{"$ref":"#/components/schemas/booking_blk_resCompAccountingType","description":"Information regarding comp accounting on the reservation."},"financiallyResponsible":{"description":"The guest from whom payment has to be recovered (direct guest).","type":"boolean"},"folioTexts":{"$ref":"#/components/schemas/booking_blk_folioTextsType","description":"Additional text fields to display on the folio."},"lastRoomAndTaxPostedDate":{"description":"Date of the last Room And Tax posting. Used primarily to know the date in case of Advance Billing.","format":"date","maxLength":8,"type":"string"},"periodicFolio":{"$ref":"#/components/schemas/booking_blk_resPeriodicFolioType","description":"Information regarding periodic folios set on the reservation."},"proratedBilling":{"description":"In case of Appartment style billing indicates whether a prorated amount should be used for an Apartment Style Billing rate.","type":"boolean"},"reservationPreConfiguredRoutingInstruction":{"$ref":"#/components/schemas/booking_blk_resPreConfiguredRoutingInstrType","description":"Information regarding the selected preconfigured routing instruction on the reservation."},"revenuesAndBalances":{"$ref":"#/components/schemas/booking_blk_resRevenueBalanceType","description":"Revenues and Balances Amount summary for the reservation."},"reverseAdvanceCheckInAllowed":{"description":"This attribute is to verify if reverse advance check-in is allowed for the reservation.","type":"boolean"},"reverseCheckInAllowed":{"description":"This attribute is to verify if reverse check-in is allowed for the reservation.","type":"boolean"},"taxType":{"$ref":"#/components/schemas/booking_blk_reservationTaxTypeInfo","description":"This stores the code for the type of tax calculation especially with tax exemption, etc."},"transactionsPosted":{"description":"Specifies whether reservation has a financial transaction associated with it.","type":"boolean"}},"type":"object"},"booking_blk_resCommunicationType":{"description":"Communication details for a reservation.","properties":{"emails":{"description":"List of email address for the customer.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"emailInfo":{"description":"Collection of Detailed information on an eMail address for the customer.","items":{"$ref":"#/components/schemas/booking_blk_emailInfoType"},"maxItems":4000,"type":"array"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"telephones":{"description":"List of Telephone Number Information","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"telephoneInfo":{"description":"Collection of Detailed information on telephone/fax for the customer.","items":{"$ref":"#/components/schemas/booking_blk_telephoneInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"}},"type":"object"},"booking_blk_resCompAccountingType":{"description":"Information regarding comp accounting on the reservation.","properties":{"authorizer":{"description":"ID of the employee who will act as the host for this guest.","maxLength":40,"minLength":0,"type":"string"},"compPostings":{"description":"Indicates if the Comp Billing/posting Exist","maxLength":5,"minLength":0,"type":"string"},"compType":{"description":"Code used to identify the casino comp type and ranking of a guest.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_resDepositPoliciesType":{"description":"A list of deposit policies attached with the reservation.","items":{"$ref":"#/components/schemas/booking_blk_resDepositPolicyType"},"maxItems":4000,"type":"array"},"booking_blk_resDepositPolicyType":{"description":"A deposit policy attached with the reservation.","properties":{"amountDue":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Total amount due against the reservation deposit."},"amountPaid":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Total amount paid against the reservation deposit."},"comments":{"description":"Comments attached with a deposit.","maxLength":2000,"minLength":0,"type":"string"},"policy":{"$ref":"#/components/schemas/booking_blk_depositPolicyType","description":"Reservation deposit policy details."},"policyId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Unique ID of the Reservation Policy."},"revenueType":{"$ref":"#/components/schemas/booking_blk_depositCancelRevenueType","description":"Type of reservation."}},"type":"object"},"booking_blk_resExpectedTimesType":{"description":"Holds the Arrival and Departure Time Information","properties":{"reservationExpectedArrivalTime":{"description":"Arrival Time. Uses the hotel's time zone.","format":"date-time","type":"string"},"reservationExpectedDepartureTime":{"description":"Departure Time. Uses the hotel's time zone.","format":"date-time","type":"string"}},"type":"object"},"booking_blk_resGuaranteeType":{"description":"Validations type record returned after Validations are done.","properties":{"guaranteeCode":{"description":"Guarantee Code.","maxLength":20,"minLength":0,"type":"string"},"onHold":{"description":"Guarantee Code.","type":"boolean"},"shortDescription":{"description":"Guarantee Code.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_resGuestAdditionalInfoType":{"properties":{"dateOfEntry":{"description":"Entry Date into the country. (Croatian Requirements).","format":"date","maxLength":8,"type":"string"},"guestClassification":{"description":"Guest Classification for the data export.","maxLength":40,"minLength":0,"type":"string"},"guestStatus":{"description":"Guest Status for the data export.","maxLength":40,"minLength":0,"type":"string"},"lastStay":{"$ref":"#/components/schemas/booking_blk_guestLastStayInfoType","description":"Last Stay information of the guest."},"nextDestination":{"description":"Entry Date into the country. (Croatian Requirements).","type":"string"},"portOfEntry":{"description":"Entry point into the country. (Croatian Requirements).","maxLength":40,"minLength":0,"type":"string"},"preferredRoomType":{"description":"Preferred Room Type of the guest.","maxLength":20,"minLength":0,"type":"string"},"purposeOfStay":{"description":"Purpose of stay.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_resGuestExternalInfoType":{"description":"Specifies Company or Travel Agent profile using IATA or Corp. No.","properties":{"givenName":{"$ref":"#/components/schemas/booking_blk_givenNameType","description":"Given name, first name or names"},"surname":{"$ref":"#/components/schemas/booking_blk_surnameType","description":"Family name, last name."}},"type":"object"},"booking_blk_resGuestInfoType":{"description":"Specifies Company or Travel Agent profile using IATA or Corp. No.","properties":{"accompanyGuests":{"$ref":"#/components/schemas/booking_blk_resAccompanyGuestListType","description":"List of guest names that are accompanying the reservation guest"},"address":{"$ref":"#/components/schemas/booking_blk_addressSearchType","description":"Address information that is attached to the reservation guest"},"alternateFullName":{"description":"Altername full display name","type":"string"},"alternateGivenName":{"description":"Alternate given name, first name or names","maxLength":40,"minLength":0,"type":"string"},"alternateSurname":{"description":"Alternate family name, last name.","maxLength":40,"minLength":0,"type":"string"},"anonymization":{"$ref":"#/components/schemas/booking_blk_anonymizationType","description":"Provides information about the guest's anonymization status"},"birthDate":{"description":"Date of birth","format":"date","maxLength":8,"type":"string"},"email":{"$ref":"#/components/schemas/booking_blk_basicEmailType","description":"Email address"},"externalInfo":{"$ref":"#/components/schemas/booking_blk_resGuestExternalInfoType","description":"External information about the guest associated with the reservation."},"fullName":{"description":"Full display name","type":"string"},"givenName":{"$ref":"#/components/schemas/booking_blk_givenNameType","description":"Given name, first name or names"},"guestLastStayInfo":{"$ref":"#/components/schemas/booking_blk_guestLastStayInfoType","description":"Contains information regarding the last stay of this guest."},"guestRestricted":{"description":"True indicates there are restrictions associated with the current profile.","type":"boolean"},"guestRestrictedCode":{"description":"Guest profile restricted reason code","type":"string"},"guestRestrictedReasonDesc":{"description":"Guest profile restricted reason description","type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"membership":{"$ref":"#/components/schemas/booking_blk_membershipInfoType","description":"The Membership object identifying the frequent customer reward program."},"middleName":{"description":"The middle name of the person name","maxLength":40,"minLength":0,"type":"string"},"namePrefix":{"$ref":"#/components/schemas/booking_blk_namePrefixType","description":"Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)"},"nameSuffix":{"description":"Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.).","maxLength":20,"minLength":0,"type":"string"},"nameTitle":{"description":"Degree or honors (e.g., Ph.D., M.D.)","maxLength":20,"minLength":0,"type":"string"},"nameType":{"$ref":"#/components/schemas/booking_blk_nameTypeType"},"nationality":{"$ref":"#/components/schemas/booking_blk_countryNameType","description":"Affiliation or ethnicity to a particular country."},"phoneNumber":{"$ref":"#/components/schemas/booking_blk_phoneNumberType","description":"Phone number"},"registrationCardNo":{"description":"Unique identifier of the police registration card number.","maxLength":40,"minLength":0,"type":"string"},"surname":{"$ref":"#/components/schemas/booking_blk_surnameType","description":"Family name, last name."},"surnamePrefix":{"description":"e.g \"van der\", \"von\", \"de\"","maxLength":20,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"vip":{"$ref":"#/components/schemas/booking_blk_vIPType","description":"The supplier's ranking of the customer (e.g., VIP, numerical ranking)."},"warnings":{"$ref":"#/components/schemas/booking_blk_warningsType"}},"type":"object"},"booking_blk_resGuestType":{"description":"A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGuestRPHs collection.","properties":{"arrivalTransport":{"$ref":"#/components/schemas/booking_blk_transportInfoType"},"departureTransport":{"$ref":"#/components/schemas/booking_blk_transportInfoType"},"primary":{"description":"When true indicates this is the primary guest.","type":"boolean"},"profileInfo":{"description":"A collection of Profiles or Unique IDs of Profiles.","properties":{"profile":{"$ref":"#/components/schemas/booking_blk_profileType","description":"Provides detailed information regarding either a company or a customer profile."},"profileCashieringDetail":{"$ref":"#/components/schemas/booking_blk_profileCashieringDetailType","description":"Cashiering details for the profile."},"profileIdList":{"$ref":"#/components/schemas/booking_blk_profileIdList","description":"Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id."},"registrationCardNo":{"description":"Unique identifier of the police registration card number.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"reservationGuestRPH":{"description":"This is a reference placeholder, used as an index for this guest in this reservation. In the ResGuest object it is used like all other RPH attributes to send the delta of a reservation. It is used by the RoomStay and Service objects to indicate which guests are associated with that room stay or service.","maxLength":8,"minLength":1,"type":"string"},"visaInfo":{"$ref":"#/components/schemas/booking_blk_visaInfoType"}},"type":"object"},"booking_blk_resHousekeepingType":{"description":"Holds housekeeping turndown service information for the room.","properties":{"expectedServiceTime":{"description":"Expected Start Time for housekeeping task(s).","type":"string"},"facilityTaskInfo":{"$ref":"#/components/schemas/booking_blk_facilityTaskType","description":"The facility task applicable for the current day. This will be information only and not used for any updates."},"instructions":{"description":"Turndown instructions for the room.","type":"string"},"linenChange":{"description":"Indicates if a linen change is necessary.","type":"boolean"},"roomStatus":{"$ref":"#/components/schemas/booking_blk_housekeepingRoomStatusType","description":"Current room status. Current room status is populated only if room is assigned to the reservation and reservation is due in or in house."},"serviceTime":{"description":"This is the Turndown room service time.","format":"date","maxLength":8,"type":"string"},"turndownRequested":{"description":"Indicates whether guest wants turndown facility or not.","type":"boolean"}},"type":"object"},"booking_blk_resInventoryItemSourceType":{"description":"Defines whether the item is setup due to a Rate Plan, Package or a Block.","properties":{"blockId":{"$ref":"#/components/schemas/booking_blk_blockId","description":"Block Unique ID, If populated specifies that the item is setup due to a Block."},"packageCode":{"description":"Package Code, If populated specifies that the item is setup due to a Package.","maxLength":20,"minLength":0,"type":"string"},"packageInternalID":{"description":"Source Reservation Package Opera Internal Unique Id. This is the unique Id used for the reservation package associated with this item.","type":"number"},"ratePlanCode":{"description":"Rate Plan Code, If populated specifies that the item is setup due to a Rate Plan.","maxLength":20,"minLength":0,"type":"string"},"welcomeOffer":{"description":"If true, it implies that the item has been attached to the reservation as part of a Welcome Offer","type":"boolean"}},"type":"object"},"booking_blk_resInventoryItemType":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"item":{"$ref":"#/components/schemas/booking_blk_itemInfoType","description":"Specifies Items and its attributes. When used for data manipulation for Items setup on reservation, etc only code is considered. Other Attributes are for used to provide information during fetch operation."},"quantity":{"description":"Number of items booked.","type":"integer"},"source":{"$ref":"#/components/schemas/booking_blk_resInventoryItemSourceType","description":"If exists specifies whether the item is setup due to a Rate Plan, Package or a Block."},"timeSpan":{"$ref":"#/components/schemas/booking_blk_dateRangeType","description":"Begin and end date and time of the items applicability."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_blk_resInventoryItemsType":{"description":"Defines a collection of inventory items attached to a reservation.","properties":{"item":{"description":"Inventory item attached to a reservation.","items":{"$ref":"#/components/schemas/booking_blk_resInventoryItemType"},"maxItems":4000,"type":"array"},"itemClassCode":{"description":"The Item Class ID which the item belongs to.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_resMobileNotificationsType":{"description":"Contains the status of Room Ready and Key Ready messages.","properties":{"checkoutMessageReceived":{"description":"Indicates if the Mobile checkout message is received.","type":"boolean"},"errorMessage":{"description":"Error message when Mobile Notification has failed.","type":"string"},"keyReady":{"$ref":"#/components/schemas/booking_blk_communicationStatusType","description":"Denotes the status of Key Ready message. It can have one of the values:PENDING, COMPLETED or FAILED"},"requiresAction":{"description":"Indicates if user action is required. The action could be for sending Room Ready or Key Ready Notification. It could also be for initiating Checkout","type":"boolean"},"roomReady":{"$ref":"#/components/schemas/booking_blk_communicationStatusType","description":"Denotes the status of Room Ready message. It can have one of the values:PENDING, COMPLETED or FAILED"}},"type":"object"},"booking_blk_resPaymentCardType":{"description":"Information on a credit card for the customer.","properties":{"approvalAmountNeeded":{"$ref":"#/components/schemas/booking_blk_currencyAmountType"},"approvalCode":{"description":"Approval code sent by the credit card company on a successful authorization.","maxLength":20,"minLength":0,"type":"string"},"attachCreditCardToProfile":{"description":"Attach the credit card to profile.","type":"boolean"},"cardHolderName":{"maxLength":200,"minLength":0,"type":"string"},"cardId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"credit card id"},"cardNumber":{"maxLength":80,"minLength":0,"type":"string"},"cardNumberLast4Digits":{"maxLength":80,"minLength":0,"type":"string"},"cardNumberMasked":{"maxLength":80,"minLength":0,"type":"string"},"cardOrToken":{"$ref":"#/components/schemas/booking_blk_cardNumberTypeType","description":"This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates credit card is token enabled and 'CardNumber' indicates non token environment for this payment card type."},"cardPresent":{"description":"Flag to determine if the credit card was swiped/manually entered , This element is only used when PAYMENT SERVICE DIRECTIVE(PSD) Opera Control is active.","type":"boolean"},"cardType":{"$ref":"#/components/schemas/booking_blk_cardTypeType","description":"Indicates the type of credit card from a defined list"},"citId":{"description":"Customer Initiated Transaction(CIT) Id for Credit Cards. This is only used when PAYMENT SERVICES DIRECTIVE (PSD2) Opera Control is active.","maxLength":30,"minLength":0,"type":"string"},"currentAuthorizedAmount":{"$ref":"#/components/schemas/booking_blk_currencyAmountType"},"expirationDate":{"description":"Expiration date of the credit card","format":"date","maxLength":8,"type":"string"},"expirationDateExpired":{"type":"boolean"},"expirationDateMasked":{"description":"Masked Expiration date of the credit card","maxLength":20,"minLength":0,"type":"string"},"processing":{"$ref":"#/components/schemas/booking_blk_cardProcessingType","description":"This contains information on whether EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type."},"swiped":{"type":"boolean"},"userDefinedCardType":{"description":"Indicates the user defined credit card type if credit card type from a defined list is not provided","maxLength":2,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_resPeriodicFolioType":{"description":"Information regarding periodic folios set on the reservation.","properties":{"frequency":{"description":"Frequency in number of days when folios should be printed for this reservation.","type":"integer"},"lastFolioDate":{"description":"Latest date when a folio was printed using the \"Periodic Batch Folios\" option","format":"date","maxLength":8,"type":"string"},"lastSettlementDate":{"description":"Latest date when a direct bill settlement was automatically done using the \"Direct Bill Batch Folios\" option.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_blk_resPreConfiguredRoutingInstrType":{"description":"Instruction to attach Pre-Configured Routing Instructions to a Reservation.","properties":{"authorizerInfo":{"$ref":"#/components/schemas/booking_blk_authorizerInfoType","description":"The authorizer information for Promotion Code with attached Complimentary Routing"},"profileType":{"$ref":"#/components/schemas/booking_blk_resProfileTypeType","description":"Profile Type with attached Routing Instruction."},"promotionCode":{"description":"Promotion Code with attached Complimentary Routing.","maxLength":20,"minLength":0,"type":"string"},"ratePlanCode":{"description":"Rate Code with attached Routing Instruction.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_resProfileTypeType":{"enum":["Guest","Company","Group","TravelAgent","Source","ReservationContact","BillingContact","Addressee"],"type":"string"},"booking_blk_resRevenueBalanceType":{"description":"Revenue and Balance Amount summary for the reservation.","properties":{"balance":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Balance amount on the reservation."},"compBalance":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Comp Balance amount"},"foodAndBevRevenue":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Food and Beverage Revenue generated by the reservation."},"nonRevenue":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Total Non Revenue posted on the reservation."},"otherRevenue":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Other Revenue generated by the reservation."},"roomRevenue":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Room Revenue generated by the reservation."},"totalFixedCharge":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Total Fixed Charges on the reservation."},"totalPayment":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Total payment received for the reservation."},"totalRevenue":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Total Revenue generated by the reservation."}},"type":"object"},"booking_blk_resSharedGuestInfoType":{"description":"Contains information regarding the share reservation.","properties":{"firstName":{"description":"Given name, first name or names","type":"string"},"fullName":{"description":"String representation of the full name","type":"string"},"lastName":{"description":"Family name, last name.","type":"string"},"profileId":{"$ref":"#/components/schemas/booking_blk_profileId"}},"type":"object"},"booking_blk_resSharedGuestListType":{"description":"Collection of shared guest reservations.","items":{"$ref":"#/components/schemas/booking_blk_resSharedGuestInfoType"},"maxItems":4000,"type":"array"},"booking_blk_resStatClassificationType":{"description":"Statistical Classification information for the reservation.","properties":{"rateTier":{"description":"Rate Tier used calculate statistics for export(DRS).","type":"integer"},"roomType":{"description":"Room Type used to calculate statistics for export(DRS).","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_reservationAllowedActionType":{"description":"Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.","enum":["Cancel","Move","PreCharge","PostCharge","FacilitySchedule","Upsell","PreCheckIn","PostToNoShowCancel","NoShow","NameChange","Discount","EnrollToPrimaryMembership","EnrollInProgress"],"type":"string"},"booking_blk_reservationAllowedActionsType":{"description":"Allowed action.","items":{"$ref":"#/components/schemas/booking_blk_reservationAllowedActionType"},"maxItems":11,"type":"array"},"booking_blk_reservationBlockType":{"description":"Key information about the block for a reservation.","properties":{"blockIdList":{"$ref":"#/components/schemas/booking_blk_blockIdList","description":"Collection of unique block identifiers for the reservation."},"blockName":{"description":"The Name of the block that is attached to the reservation.","maxLength":40,"minLength":0,"type":"string"},"hotelId":{"description":"This is the HotelCode of the Block.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_reservationCertificateType":{"description":"Certificate is incentive.","enum":["Reward","Incentive"],"type":"string"},"booking_blk_reservationDepositType":{"description":"Reservation Deposit Type.","properties":{"amountOwed":{"description":"Deposit Amount Owed.","type":"number"},"amountPaid":{"description":"Deposit Amount Paid.","type":"number"},"amountRequired":{"description":"Deposit Amount Required.","type":"number"},"dueDate":{"description":"Deposit Due Date.","format":"date","maxLength":8,"type":"string"},"hasOutstanding":{"description":"Resolves whether reservation has outstanding deposit.","type":"boolean"},"hasPaid":{"description":"Resolves whether reservation has paid deposit.","type":"boolean"},"postingDate":{"description":"Deposit Posting Date.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_blk_reservationECertificateType":{"description":"Reservation ECertificate Type Information.","properties":{"actionType":{"$ref":"#/components/schemas/booking_blk_requestActionType","description":"ECertificate status for the reservation."},"eCertificateNo":{"description":"ECertificate Number for the reservation.","maxLength":40,"minLength":0,"type":"string"},"eCertificateType":{"$ref":"#/components/schemas/booking_blk_eCertificateClassficationType","description":"ECertificate Type where value can be PROMOTION,AWARD,BENEFIT and OTHER"}},"type":"object"},"booking_blk_reservationECertificatesType":{"description":"Collection of ECertificateType object.","items":{"$ref":"#/components/schemas/booking_blk_reservationECertificateType"},"maxItems":4000,"type":"array"},"booking_blk_reservationFolioWindowType":{"description":"Folio window view which holds the set of folios for a reservation.","properties":{"balance":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Running balance of the window."},"folioWindowNo":{"type":"integer"},"payeeInfo":{"$ref":"#/components/schemas/booking_blk_payeeInfoType","description":"The window's configured payee information."},"paymentMethod":{"description":"Payment Method Type","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_reservationFolioWindowsType":{"description":"Collection of reservation folio windows.","items":{"$ref":"#/components/schemas/booking_blk_reservationFolioWindowType"},"maxItems":4000,"type":"array"},"booking_blk_reservationHistoryFutureInfoType":{"description":"Information of History and Future Reservation details attached to Profiles.","properties":{"futureList":{"$ref":"#/components/schemas/booking_blk_futureListType","description":"Refer to Future list type document."},"historyList":{"$ref":"#/components/schemas/booking_blk_historyListType","description":"Refer to History list type document."}},"type":"object"},"booking_blk_reservationId":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_blk_reservationIdList":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type"},"maxItems":4000,"type":"array"},"booking_blk_reservationInfoType":{"description":"The Reservation class contains the current reservation being created or altered.","properties":{"accessRestriction":{"$ref":"#/components/schemas/booking_blk_resAccessRestrictionType","description":"Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both."},"advanceCheckIn":{"$ref":"#/components/schemas/booking_blk_advanceCheckInType","description":"Information relating to Reservation's Advance Checked In state and Expected Time of Return"},"allowMobileCheckout":{"description":"Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false.","type":"boolean"},"allowMobileViewFolio":{"description":"Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.","type":"boolean"},"allowedActions":{"$ref":"#/components/schemas/booking_blk_reservationAllowedActionsType","description":"Collection of reservation allowed actions."},"attachedProfiles":{"$ref":"#/components/schemas/booking_blk_resAttachedProfileListType","description":"List of attached profiles"},"cancellationInfo":{"description":"Information regarding why reservation has been/was cancelled.","properties":{"code":{"maxLength":20,"minLength":0,"type":"string"},"date":{"description":"Date when reservation was last cancelled.","format":"date","maxLength":8,"type":"string"},"description":{"maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"cashiering":{"$ref":"#/components/schemas/booking_blk_resCashieringType","description":"Holds cashiering related information for the reservation."},"commissionPayoutTo":{"$ref":"#/components/schemas/booking_blk_commissionPayoutToType","description":"If not null, reservation is considered to pay out commission to either Travel Agent, Source or both."},"computedReservationStatus":{"$ref":"#/components/schemas/booking_blk_pMS_ResStatusType","description":"Indicates the status of the reservation."},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"deposit":{"$ref":"#/components/schemas/booking_blk_reservationDepositType","description":"Holds reservation deposit information."},"displayColor":{"description":"Color setting of the reservation.","maxLength":20,"minLength":0,"type":"string"},"expectedServiceTime":{"maxLength":20,"minLength":0,"type":"string"},"externalReferences":{"$ref":"#/components/schemas/booking_blk_externalReferencesType","description":"External Reference information for Reservation."},"guestPreferredCurrency":{"description":"Currency code preferred by guest.","maxLength":20,"minLength":0,"type":"string"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"hotelInterfaceStatusList":{"description":"Collection of Hotel Interfaces and rights, this is populated only when fetching interface status for rooms.","items":{"$ref":"#/components/schemas/booking_blk_reservationInterfaceStatusType"},"maxItems":4000,"type":"array"},"hotelName":{"maxLength":80,"minLength":0,"type":"string"},"housekeeping":{"$ref":"#/components/schemas/booking_blk_resHousekeepingType","description":"Information regarding housekeeping for this reservation."},"keyCount":{"description":"Number of keys created for the reservation.","type":"integer"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"lastPrivacyPromptDate":{"description":"Last Privacy Prompt Date","format":"date","maxLength":8,"type":"string"},"mobileNotifications":{"$ref":"#/components/schemas/booking_blk_resMobileNotificationsType","description":"Denotes the status of Room Ready, Key Ready messages."},"openFolio":{"description":"Returns true when reservation has an open folio.","type":"boolean"},"optedForCommunication":{"description":"Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation.","type":"boolean"},"paymentMethod":{"description":"Payment Method.","maxLength":20,"minLength":0,"type":"string"},"preRegistered":{"description":"Defines if the reservation is pre-registered or not.","type":"boolean"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","maxLength":8,"type":"string"},"queue":{"$ref":"#/components/schemas/booking_blk_reservationQueueInformationType","description":"Information about the time and duration this reservation was on Queue for Checkin."},"reservationCommunication":{"$ref":"#/components/schemas/booking_blk_resCommunicationType","description":"Collection of reservation communication details."},"reservationFolioWindows":{"$ref":"#/components/schemas/booking_blk_reservationFolioWindowsType","description":"Collection of reservation folio windows."},"reservationGuest":{"$ref":"#/components/schemas/booking_blk_resGuestInfoType","description":"Collection of guests associated with the reservation."},"reservationIdList":{"$ref":"#/components/schemas/booking_blk_reservationIdList","description":"Unique identifiers for the reservation for both internal and external systems"},"reservationIndicators":{"$ref":"#/components/schemas/booking_blk_indicatorsType","description":"Indicators of additional information attached to the reservation"},"reservationPaymentMethod":{"$ref":"#/components/schemas/booking_blk_reservationPaymentMethodType","description":"Payment method used for this reservation"},"reservationStatus":{"$ref":"#/components/schemas/booking_blk_pMS_ResStatusType","description":"Indicates the status of the reservation."},"revenuesAndBalances":{"$ref":"#/components/schemas/booking_blk_resRevenueBalanceType","description":"Revenues and Balances Amount summary for the reservation."},"roomStatus":{"$ref":"#/components/schemas/booking_blk_housekeepingRoomStatusType","description":"Current room status"},"roomStay":{"$ref":"#/components/schemas/booking_blk_stayInfoType","description":"Collection of room stays."},"roomStayReservation":{"description":"Boolean True if this reservation is reserving rooms. False if it is only reserving services.","type":"boolean"},"searchMatches":{"$ref":"#/components/schemas/booking_blk_searchMatchesType","description":"Super Search matching terms."},"sharedGuests":{"$ref":"#/components/schemas/booking_blk_resSharedGuestListType","description":"Collection of guests who share this reservation."},"sourceOfSale":{"$ref":"#/components/schemas/booking_blk_sourceOfSaleType","description":"Point of Sale of reservation. Identifies the entity/channel who made the reservation."},"specials":{"description":"Set of reservation preferences which belongs to the Specials group.","maxLength":4000,"minLength":0,"type":"string"},"taxType":{"$ref":"#/components/schemas/booking_blk_taxTypeType","description":"This stores the code for the type of tax calculation especially with tax exemption, etc."},"turndownInfo":{"$ref":"#/components/schemas/booking_blk_reservationTurndownInfoType","description":"Currency code preferred by guest."},"waitlist":{"$ref":"#/components/schemas/booking_blk_waitlistResType","description":"Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is not in Waitlist status anymore."},"walkInIndicator":{"description":"When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in.","type":"boolean"},"welcomeOffer":{"description":"This flag will determine wheather the reservation is eligible for Welcome Offer or not.","type":"boolean"}},"type":"object"},"booking_blk_reservationInterfaceStatusType":{"description":"Hotel Interface Type for a reservation and status of the various services","properties":{"hotelInterface":{"$ref":"#/components/schemas/booking_blk_hotelInterfaceType","description":"Hotel interface information for the reservation"},"interfaceRights":{"description":"Contains a list of status/rights for the various services under this interface","items":{"$ref":"#/components/schemas/booking_blk_interfaceRightsStatusType"},"maxItems":4000,"type":"array"},"roomExtension":{"description":"Identifier for the room extension","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_reservationLocatorType":{"description":"Holds the information for a Reservation Guest Locator","properties":{"dateSpan":{"$ref":"#/components/schemas/booking_blk_dateRangeType","description":"Begin and End date range of the Guest Locator."},"locatorBy":{"description":"User that entered this Guest Locator.","type":"string"},"locatorId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Unique Id of the Guest Locator ( Locator Id )"},"locatorOn":{"description":"Date and time of the Guest Locator.","format":"date-time","type":"string"},"locatorText":{"description":"The Locator Text for the guest.","type":"string"},"timeSpan":{"$ref":"#/components/schemas/booking_blk_dateTimeSpanType","description":"Time span for the Guest Locator."}},"type":"object"},"booking_blk_reservationLocatorsType":{"description":"Holds the Locator Information.","items":{"$ref":"#/components/schemas/booking_blk_reservationLocatorType"},"maxItems":4000,"type":"array"},"booking_blk_reservationMembershipType":{"description":"Detailed information of the memberships.","properties":{"benefits":{"$ref":"#/components/schemas/booking_blk_benefitsType","description":"benefits for the membership."},"centralSetup":{"description":"Indicates how the award points for this membership type will be managed.","type":"boolean"},"comment":{"$ref":"#/components/schemas/booking_blk_paragraphType","description":"Additional comments regarding to the membership."},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"currentPoints":{"description":"Profile MemberShip Points.","type":"number"},"downgrade":{"$ref":"#/components/schemas/booking_blk_downgradeType","description":"Defines how downgrading will be handled for this membership."},"downgradeDescription":{"description":"Indicates information regarding the member's possible downgrades.","maxLength":32000,"minLength":0,"type":"string"},"earningPreference":{"$ref":"#/components/schemas/booking_blk_membershipEarningPreferenceType","description":"Earning preference to the membership."},"effectiveDate":{"description":"Indicates the starting date.","format":"date","maxLength":8,"type":"string"},"enrollmentResort":{"description":"Resort/CRO where enrollment is done.","maxLength":20,"minLength":0,"type":"string"},"enrollmentSource":{"description":"Source from where the enrollment is done.","maxLength":20,"minLength":0,"type":"string"},"excludeFromBatch":{"description":"True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false.","type":"boolean"},"expireDate":{"description":"Indicates the ending date.","format":"date","maxLength":8,"type":"string"},"expireDateExclusiveIndicator":{"description":"When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).","type":"boolean"},"inactive":{"description":"Indicates whether membership is active or inactive.","type":"boolean"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"linkMembership":{"type":"boolean"},"memberStatus":{"description":"Indicates where the guest is in the membership enrollment process.","maxLength":20,"minLength":0,"type":"string"},"membershipClass":{"description":"Indicates the membership class.","type":"string"},"membershipEnrollmentCode":{"description":"Indicates how the guest enrolled in the program.","maxLength":20,"minLength":0,"type":"string"},"membershipId":{"description":"Card Number of the membership.","type":"string"},"membershipIdNo":{"description":"Membership ID Number.","type":"integer"},"membershipLevel":{"description":"Indicates the membership level.","type":"string"},"membershipLevelDescription":{"description":"Indicates the membership level description.","maxLength":200,"minLength":0,"type":"string"},"membershipType":{"description":"Type of membership.","type":"string"},"nameOnCard":{"description":"Name to be displayed on the membership card.","type":"string"},"newMembershipNumber":{"description":"Card Number of the membership.","type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"playerRanking":{"description":"Ranking assigned to the Player Profile by the Gaming system.","type":"integer"},"pointsLabel":{"description":"Label used to refer to points for this membership type","maxLength":20,"minLength":0,"type":"string"},"preferredCard":{"description":"Preferred Card.","type":"boolean"},"primary":{"type":"boolean"},"primaryMembership":{"description":"Boolean indicator set to True implies membership is a Primary Membership.","type":"boolean"},"primaryMembershipYn":{"description":"Indicator if Membership is a Primary Membership.","maxLength":1,"minLength":0,"type":"string"},"programDescription":{"description":"Description of the membership program.","type":"string"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","maxLength":8,"type":"string"},"rating":{"description":"Value Rating Type Description for this membership.","type":"string"},"reIssueNewCard":{"$ref":"#/components/schemas/booking_blk_cardReIssueType","description":"The status of issuing new membership card to the member."},"signupDate":{"description":"Indicates when the member signed up for the loyalty program.","format":"date","maxLength":8,"type":"string"},"tierAdministration":{"$ref":"#/components/schemas/booking_blk_tierAdministrationType","description":"Defines the degree of participation for this membership in the tier management portion of the program."},"upgradeDescription":{"description":"Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.","maxLength":32000,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_reservationPackageScheduleType":{"description":"A HotelPackageSchedule type.","properties":{"computedResvPrice":{"description":"Computed Reservation Price of the package. Calculation Will Be Performed Based On Other Parameters.","type":"number"},"consumptionDate":{"description":"The date the package was used or can be used.","format":"date","maxLength":8,"type":"string"},"originalUnitAllowance":{"description":"The original allowance per unit of the package if it has been changed.","type":"number"},"originalUnitPrice":{"description":"The original price per unit of the package if it has been changed.","type":"number"},"reservationDate":{"description":"The date of the Reservation when this package is applicable. This can be different from the date the package will be consumed. Example are next day packages. Reservation date is when the package is applied to the guest and Consumption date is when the guest can consume the package.","format":"date","maxLength":8,"type":"string"},"totalQuantity":{"description":"The total quantity of the package for this date, calculated based on the calculation rule as defined in the PackageHeaderType","type":"integer"},"unitAllowance":{"description":"The allowance per unit of the package.","type":"number"},"unitPrice":{"description":"The price per unit of the package.","type":"number"}},"type":"object"},"booking_blk_reservationPackageType":{"description":"A ReservationPackageType class.","properties":{"awardCode":{"description":"This is the Award code used to redeem the package if the package is a redemption package.","maxLength":20,"minLength":0,"type":"string"},"consumptionDetails":{"$ref":"#/components/schemas/booking_blk_packageConsumptionType","description":"Package consumption details. Includes information for quantity , allowance etc."},"endDate":{"description":"Required value when changing a reservation package. If the original end date was null, then null is required.","format":"date","maxLength":8,"type":"string"},"internalID":{"description":"Reservation Package Opera Internal Unique Id. This is the unique Id used for this reservation package.","type":"number"},"newTimeSpan":{"$ref":"#/components/schemas/booking_blk_timeSpanType","description":"The changed dates(Start and End dates) for this product."},"packageCode":{"description":"Package code. This is the unique code used for the package and is a required element.","maxLength":20,"minLength":0,"type":"string"},"packageGroup":{"description":"Package group code. If this package is part of a package group, the group code is indicated here. This is a required element and is part of the key to fetch the correct package record .","maxLength":20,"minLength":0,"type":"string"},"packageHeaderType":{"$ref":"#/components/schemas/booking_blk_packageCodeHeaderType","description":"Package information from configuration."},"points":{"description":"Indicates the points used to redeem the redemption package.","type":"integer"},"ratePlanCode":{"description":"The rate code which contains this package. If the package is not part of a rate code, this will be empty. Required element and part of the key to fetch the correct package record on the reservation.","maxLength":20,"minLength":0,"type":"string"},"scheduleList":{"description":"A HotelPackageSchedule type.","items":{"$ref":"#/components/schemas/booking_blk_reservationPackageScheduleType"},"maxItems":4000,"type":"array"},"source":{"$ref":"#/components/schemas/booking_blk_productSourceType","description":"Indicates if the source of the product is Rate header, Rate Detail or Reservation. For new development this field is to be used for passing the product scource"},"startDate":{"description":"Required value when changing a reservation package. If the original start date was null, then null is required.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_blk_reservationPaymentMethodType":{"properties":{"authorizationRule":{"$ref":"#/components/schemas/booking_blk_authorizationRuleType"},"balance":{"$ref":"#/components/schemas/booking_blk_currencyAmountType"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"emailFolioInfo":{"description":"Information on an email for the customer.","properties":{"email":{"$ref":"#/components/schemas/booking_blk_emailType","description":"eMail deatils for the profile."},"emailFolio":{"type":"boolean"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"warnings":{"$ref":"#/components/schemas/booking_blk_warningsType"}},"type":"object"},"folioView":{"type":"integer"},"paymentCard":{"$ref":"#/components/schemas/booking_blk_resPaymentCardType"},"paymentMethod":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_reservationPaymentMethodsType":{"description":"Defines reservation payment methods.","items":{"$ref":"#/components/schemas/booking_blk_reservationPaymentMethodType"},"maxItems":4000,"type":"array"},"booking_blk_reservationPoliciesType":{"description":"A collection of reservation deposit and cancellation policies.","properties":{"cancellationPolicies":{"$ref":"#/components/schemas/booking_blk_resCancellationPoliciesType","description":"A collection of reservation cancellation policies.."},"depositPolicies":{"$ref":"#/components/schemas/booking_blk_resDepositPoliciesType","description":"A collection of reservation deposit policies."},"name":{"description":"Name identifier for the reservation.","type":"string"},"reservationIdList":{"$ref":"#/components/schemas/booking_blk_uniqueIDListType","description":"A list of Ids for reservation."}},"type":"object"},"booking_blk_reservationProfileType":{"properties":{"profile":{"$ref":"#/components/schemas/booking_blk_profileType","description":"Provides detailed information regarding either a company or a customer profile."},"profileIdList":{"$ref":"#/components/schemas/booking_blk_profileIdList","description":"Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id."},"reservationProfileType":{"$ref":"#/components/schemas/booking_blk_resProfileTypeType"}},"type":"object"},"booking_blk_reservationQueueInformationType":{"description":"Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.","properties":{"averageQueueTimeCurrentReservations":{"description":"The average time, in seconds, of the reservations currently in queue.","type":"integer"},"averageQueueTimeToCheckIn":{"description":"The average time, in seconds, a reservation was on queue prior to Check-In.","type":"integer"},"guestTextInfo":{"$ref":"#/components/schemas/booking_blk_queueTextInfoType","description":"Information for the message sent to the user"},"priority":{"description":"The Queue Priority given to this reservation.","type":"integer"},"queueDate":{"description":"The Business date on which the reservation was due to arrive and is currently placed on Queue for Check In.","format":"date","maxLength":8,"type":"string"},"timeSpan":{"description":"Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.","properties":{"duration":{"type":"string"},"durationInSeconds":{"description":"The total duration, in seconds, the reservation is on Queue.","type":"integer"},"endDate":{"format":"date","maxLength":8,"type":"string"},"startDate":{"format":"date","maxLength":8,"type":"string"}},"type":"object"}},"type":"object"},"booking_blk_reservationSnapshotType":{"description":"This is used when changing block reservations in bulk.","properties":{"hotelReservation":{"$ref":"#/components/schemas/booking_blk_hotelReservationType","description":"Contains detailed information about the snapshot reservation"},"routingInstructions":{"$ref":"#/components/schemas/booking_blk_routingInfoListType","description":"Contains the routing instructions of the reservation."}},"type":"object"},"booking_blk_reservationSnapshotsType":{"description":"A collection of Reservation snapshot objects.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"reservation":{"description":"A reservation snapshot object.","items":{"$ref":"#/components/schemas/booking_blk_reservationSnapshotType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"booking_blk_reservationStayHistoryFutureInfoType":{"description":"Information of History and Future Reservation details attached to Profiles.","properties":{"futureList":{"$ref":"#/components/schemas/booking_blk_stayFutureListType","description":"Refer to Future list type document."},"historyList":{"$ref":"#/components/schemas/booking_blk_stayHistoryListType","description":"Refer to History list type document."}},"type":"object"},"booking_blk_reservationTaxTypeInfo":{"description":"Provides information about the Tax Type.","properties":{"code":{"description":"Code of the Tax Type.","maxLength":20,"minLength":0,"type":"string"},"collectingAgentTax":{"description":"A boolean flag for Collecting Agent Tax","type":"boolean"},"description":{"description":"Description of the Tax Type.","maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"description":"Code of the Hotel.","maxLength":20,"minLength":0,"type":"string"},"minimumLengthOfStay":{"description":"Minimun Length of Stay.","type":"integer"},"printAutoAdjust":{"description":"Print auto adjust information for this tax type on the tax exempt report.","type":"boolean"},"reportExemptDays":{"description":"Number of days after which the guest will be tax exempt. Only used for tax exempt report.","type":"integer"},"reportTaxPercentage":{"description":"Tax percentage. Only used for tax exempt report.","maximum":100,"minimum":0,"type":"number"},"taxExemptNo":{"description":"Tax exempt number on the profile.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_reservationTransactionDiversionType":{"description":"A Transaction Diversion Rule Type","properties":{"code":{"description":"Transaction Diversion Code","maxLength":20,"minLength":0,"type":"string"},"dailyDetails":{"$ref":"#/components/schemas/booking_blk_transactionDiversionDailyDetailsType","description":"Collection of daily details of a Transaction diversion rule for a particular reservation."},"description":{"description":"User defined message for the Transaction Diversion Rule.","maxLength":2000,"minLength":0,"type":"string"},"displaySequence":{"description":"User configured Sequence number.","type":"number"},"diverted":{"description":"Transaction diversions that are diverted .","type":"integer"},"hotelId":{"description":"Hotel code with which Transaction Diversion Rule is associated.","maxLength":20,"minLength":0,"type":"string"},"inactive":{"description":"Indicator that tells whether the transaction diversion rule is active or not.","type":"boolean"},"level":{"$ref":"#/components/schemas/booking_blk_transactionDiversionRuleLevelType","description":"Level of the Transaction Diversion rule that can be Property or Reservation."},"membership":{"$ref":"#/components/schemas/booking_blk_membershipTypeLevelType","description":"Membership type to consider while applying Diversion Instruction."},"notes":{"$ref":"#/components/schemas/booking_blk_commentInfoType","description":"The Note details related to the Transaction Diversion Rule."},"posted":{"description":"Transaction diversions that are posted.","type":"integer"},"targetRoom":{"description":"Room number to receive all the diverted transactions configured for this instruction.","maxLength":20,"minLength":0,"type":"string"},"thresholds":{"$ref":"#/components/schemas/booking_blk_thresholdDetailsType","description":"Threshold Details related to the Transaction diversion rule."},"transactionCodes":{"description":"Collection of Transaction Code List","items":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType"},"maxItems":4000,"type":"array"},"type":{"$ref":"#/components/schemas/booking_blk_transactionDiversionRuleTypeType","description":"Transaction Diversion Rule Types"},"vipCode":{"description":"VIP code to consider while applying Diversion Instruction.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_reservationTransactionDiversionsType":{"description":"List of Transaction Diversion rules.","items":{"$ref":"#/components/schemas/booking_blk_reservationTransactionDiversionType"},"maxItems":4000,"type":"array"},"booking_blk_reservationTurndownInfoType":{"description":"Turndown information for a reservation","properties":{"allowed":{"description":"Indicates if turndown is allowed or not","type":"boolean"},"status":{"$ref":"#/components/schemas/booking_blk_turndownStatusType","description":"Indicates turndown status, values could be required, not required, completed"}},"type":"object"},"booking_blk_reservationTypeInfoType":{"properties":{"chainCode":{"maxLength":20,"minLength":0,"type":"string"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"reservationType":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_resourceDiscountTypeType":{"description":"Indicates the option to select resources that will be discounted with the Resource Discount Percentage.","enum":["AllDiscountableResources","ResourcesWithSameDiscountPercentage","AllDiscountableItems","ItemsWithSameDiscountPercentage","AllDiscountableMenusAndMenuItems","MenusAndMenuItemsWithSameDiscountPercentage","AllDiscountableSpaces","SpacesWithSameDiscountPercentage","ResourcesAndCateringPackageWithSameDiscountPercentage","AllCateringPackages","AllCateringPackagesWithSameDiscountPercentage","AllDiscountableResourcesAndCateringPackage","None"],"type":"string"},"booking_blk_restrictionStatusType":{"description":"The RestrictionStatusType is used to indicate the type of restriction applied. An enumerated restriction type is defined in the attribute group.","properties":{"code":{"$ref":"#/components/schemas/booking_blk_restrictionStatusesType","description":"Identifies the type of restriction. I.E. Closed, ClosedForArrival, etc."},"lOS1":{"description":"Indicates Length of Stay 1 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.","type":"boolean"},"lOS2":{"description":"Indicates Length of Stay 2 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.","type":"boolean"},"lOS3":{"description":"Indicates Length of Stay 3 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.","type":"boolean"},"lOS4":{"description":"Indicates Length of Stay 4 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.","type":"boolean"},"lOS5":{"description":"Indicates Length of Stay 5 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.","type":"boolean"},"lOS6":{"description":"Indicates Length of Stay 6 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.","type":"boolean"},"lOS7":{"description":"Indicates Length of Stay 7 or more is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.","type":"boolean"},"unit":{"description":"Defines restriction in conjunction with Restriction Code. Value must be specified for Restriction Codes MinimumStayThrough, MaximumStayThrough, MinimumLengthOfStay, MaximumLengthOfStay, MinimumAdvanceBooking, MaximumAdvanceBooking.","type":"integer"}},"type":"object"},"booking_blk_restrictionStatusesType":{"enum":["Closed","ClosedForArrival","ClosedForDeparture","MinimumStayThrough","MaximumStayThrough","MinimumLengthOfStay","MaximumLengthOfStay","LOSNotAvailable","MinimumAdvanceBooking","MaximumAdvanceBooking","Open","OpenForArrival","OpenForDeparture"],"type":"string"},"booking_blk_revenueSummaryType":{"description":"Summary information pertaining to revenue like Room, Food and Beverage, Catering, Other, Catering Other and Total Revenue.","properties":{"cateringOtherRevenue":{"type":"number"},"cateringRevenue":{"type":"number"},"foodAndBeverageRevenue":{"type":"number"},"nonRevenue":{"type":"number"},"otherRevenue":{"type":"number"},"roomRevenue":{"type":"number"},"totalRevenue":{"type":"number"}},"type":"object"},"booking_blk_rewardCertificateType":{"description":"Point Saver reward.","enum":["Regular","StayAnytime","PointSaver"],"type":"string"},"booking_blk_roomAllocationInfoType":{"description":"A collection of Allocation objects for a block that indicate room inventory or rate amounts.","properties":{"availableRoomGridInvSummary":{"description":"Indicates the values of room available room grid inventory's summary.","items":{"$ref":"#/components/schemas/booking_blk_blockGridInvType"},"maxItems":4000,"type":"array"},"extendedStay":{"description":"Indicates if the current date will require automatic block extension.","type":"boolean"},"roomGridDetails":{"description":"Indicates the values of room inventory or rate amounts.","items":{"$ref":"#/components/schemas/booking_blk_roomGridDetailsType"},"maxItems":4000,"type":"array"},"roomGridInvSummary":{"description":"Indicates the values of room inventory's summary.","items":{"$ref":"#/components/schemas/booking_blk_blockGridInvType"},"maxItems":4000,"type":"array"},"stayDate":{"description":"Indicates the date of the room allocation or rate amount.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_blk_roomAllocationMasterInfoType":{"properties":{"genericRoomTypes":{"description":"Detailed information about Room Type in the Hotel.","items":{"$ref":"#/components/schemas/booking_blk_allocationRoomTypeInfoType"},"maxItems":4000,"type":"array"},"roomTypes":{"description":"Detailed information about Room Type in the Hotel.","items":{"$ref":"#/components/schemas/booking_blk_allocationRoomTypeInfoType"},"maxItems":4000,"type":"array"}},"type":"object"},"booking_blk_roomAllocationTypeType":{"description":"A collection of Allocation objects for a block, such as Current Rooms, Original Rooms, Rate Amounts, etc.","properties":{"allocation":{"$ref":"#/components/schemas/booking_blk_allocationType","description":"Indicates the type of the Allocation objects."},"roomAllocationInfo":{"description":"Allocation objects for a block.","items":{"$ref":"#/components/schemas/booking_blk_roomAllocationInfoType"},"maxItems":4000,"type":"array"}},"type":"object"},"booking_blk_roomFeatureType":{"description":"Room Feature Information.","properties":{"code":{"description":"A code representing a room feature.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"A code representing a room feature.","maxLength":2000,"minLength":0,"type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"quantity":{"description":"Indicates quantity.","type":"integer"}},"type":"object"},"booking_blk_roomFeaturesType":{"description":"A recurring element that identifies the room features.","items":{"$ref":"#/components/schemas/booking_blk_roomFeatureType"},"maxItems":4000,"type":"array"},"booking_blk_roomGridDetailsType":{"description":"Indicates the values of room inventory or rate amount per room type.","properties":{"childRate":{"$ref":"#/components/schemas/booking_blk_blockGridChildRatesType","description":"Indicates the child rate amount values per age bucket. This element is reserved for future child rate functionality and is not yet available for use."},"genericRoomType":{"description":"Indicates the Generic Room Type (Room Pool) the Room Type belongs to.","maxLength":20,"minLength":0,"type":"string"},"inventory":{"$ref":"#/components/schemas/booking_blk_blockGridInvType","description":"Indicates the room inventory values per person occupancy."},"rate":{"$ref":"#/components/schemas/booking_blk_blockGridRatesType","description":"Indicates the rate amount values per person occupancy."},"roomType":{"description":"Indicates the room type for which the inventory or rate values are applicable.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_roomOwnershipType":{"description":"Define the search criteria for retrieving room ownership records","properties":{"contractNumber":{"description":"Contract number for room owner.","type":"string"},"endDate":{"description":"End Date of the room ownership record.","format":"date","maxLength":8,"type":"string"},"profileId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Profile ID of the room ownership record."},"roomCategory":{"description":"Room Category of the room ownership record.","type":"string"},"roomId":{"description":"Room Id of room owner.","type":"string"},"roomOwnershipId":{"description":"Unique Id for Room Owner record.","type":"integer"},"roomType":{"description":"Room Type of the room ownership record.","type":"string"},"startDate":{"description":"Start Date of the room ownership record.","format":"date","maxLength":8,"type":"string"},"status":{"description":"Status of the room ownership record.","type":"string"}},"type":"object"},"booking_blk_roomRateAvailReasonType":{"description":"Indicates the Room Rate is not available due to unavailability of enough items for the rate code.","enum":["Available","Restricted","RestrictedDueToInventory","RestrictedDueToOccupancy","RestrictedDueToItemInventory"],"type":"string"},"booking_blk_roomRateType":{"properties":{"availability":{"$ref":"#/components/schemas/booking_blk_roomRateAvailReasonType","description":"Used to specify an availability status for the room rate. When available value could be either not specified or \"Available\"."},"awards":{"$ref":"#/components/schemas/booking_blk_resAwardsType","description":"Membership Awards code applied on the reservation."},"barRanking":{"description":"Best Available rates ranking.","type":"integer"},"bogoDiscount":{"description":"Indicates if the Rate Code has BOGO(Bye one Get one) indicator.","type":"boolean"},"commissionAmount":{"description":"Indicates commission amount used by the rate plan.","type":"integer"},"commissionCode":{"description":"Commission Code applicable for commission calculation for Travel Agent/Company.","maxLength":20,"minLength":0,"type":"string"},"commissionPercentage":{"description":"Indicates commission percentage used by the rate plan.","type":"integer"},"commissionable":{"description":"Indicates Commission is applicable for commission calculation for Travel Agent/Company.","type":"boolean"},"complimentary":{"description":"Indicates this reservation rate is complimentary.","type":"boolean"},"credentialsRequired":{"description":"If true, indicates that credentials is required to sell the rate code.","type":"boolean"},"discountAllowed":{"description":"Indicates if the Rate Code is discountable i.e discounts are allowed on the rate code.","type":"boolean"},"end":{"description":"The ending value of the date range.","format":"date","maxLength":8,"type":"string"},"fixedRate":{"description":"Fixed Rate Indicator.","type":"boolean"},"foreignExchange":{"$ref":"#/components/schemas/booking_blk_foreignExchangeType","description":"Exchange Type information for the postings."},"guestCounts":{"$ref":"#/components/schemas/booking_blk_guestCountsType","description":"A collection of Guest Counts associated with the room rate."},"houseUseOnly":{"description":"Indicates this reservation is for House use.","type":"boolean"},"inventoryLender":{"description":"Indicates whether the room type inventory was taken from the allotment or House availability.","type":"string"},"marketCode":{"description":"The code that relates to the market being sold to (e.g., the corporate market, packages).","maxLength":20,"minLength":0,"type":"string"},"marketCodeDescription":{"description":"Description of the market code.","maxLength":4000,"minLength":0,"type":"string"},"mealPlans":{"$ref":"#/components/schemas/booking_blk_mealPlansType","description":"Meal plan codes for rate plan code."},"numberOfUnits":{"description":"The number of rooms.","type":"integer"},"packages":{"items":{"$ref":"#/components/schemas/booking_blk_packageElementType"},"maxItems":4000,"type":"array"},"promotionCode":{"maxLength":20,"minLength":0,"type":"string"},"pseudoRoom":{"description":"True indicates as pseudo room type. This is usually used for a posting master reservation.","type":"boolean"},"rateDescription":{"description":"Rate code description.","maxLength":4000,"minLength":0,"type":"string"},"rateGroup":{"description":"For RatePlanSet equals BESTAVAILABLERATE, in case Rate Groups are enabled the element provides the rate group for the rate plan code.","maxLength":20,"minLength":0,"type":"string"},"rateLevel":{"description":"Rate plan type like Corporate,Regular,Military,Weekend etc.","maxLength":20,"minLength":0,"type":"string"},"ratePlanCode":{"maxLength":20,"minLength":0,"type":"string"},"rates":{"$ref":"#/components/schemas/booking_blk_ratesType"},"reservationBlock":{"$ref":"#/components/schemas/booking_blk_reservationBlockType","description":"Key information about the block for this reservation."},"roomId":{"description":"A string value representing the unique identification of a room.","maxLength":20,"minLength":0,"type":"string"},"roomRateInfo":{"description":"Information about the Room Rate Combination.","maxLength":2000,"minLength":0,"type":"string"},"roomType":{"maxLength":20,"minLength":0,"type":"string"},"roomTypeCharged":{"description":"Room Type used for the Rate calculation.","maxLength":20,"minLength":0,"type":"string"},"sourceCode":{"description":"To specify where the business came from e.g. radio, newspaper ad, etc.","maxLength":20,"minLength":0,"type":"string"},"sourceCodeDescription":{"description":"Description of the source of business.","maxLength":4000,"minLength":0,"type":"string"},"start":{"description":"The starting value of the date range.","format":"date","maxLength":8,"type":"string"},"stayProfiles":{"description":"Profile associated with the room Stay.","items":{"$ref":"#/components/schemas/booking_blk_reservationProfileType"},"maxItems":4000,"type":"array"},"suppressRate":{"type":"boolean"},"taxFreeGuestCounts":{"$ref":"#/components/schemas/booking_blk_guestCountsType","description":"A collection of Tax Free Guest Counts associated with the room rate. This list does not add to the guest count but just indicates number of tax free guests out of guest counts."},"taxIncluded":{"description":"If true, indicates if tax is included in the rate code.","type":"boolean"},"total":{"$ref":"#/components/schemas/booking_blk_totalType"},"totalPoints":{"$ref":"#/components/schemas/booking_blk_pointsType"}},"type":"object"},"booking_blk_roomStatisticsType":{"properties":{"averageRate":{"description":"The average rate per room.","type":"number"},"roomCount":{"description":"The total number of rooms.","type":"number"},"roomRevenue":{"description":"The total revenue for the rooms.","type":"number"}},"type":"object"},"booking_blk_roomStayType":{"properties":{"arrivalDate":{"format":"date","type":"string"},"availableUpsellOfferCount":{"description":"Number of Upsell Offers Available for this stay. This will only be populated if the Upsell Instruction is included in the Allowed Instruction request","type":"integer"},"bookingMedium":{"description":"Classifies the medium(Channel field on reservation screen) through which the reservation is made.","maxLength":20,"minLength":0,"type":"string"},"bookingMediumDescription":{"description":"Description of the booking medium.","maxLength":2000,"minLength":0,"type":"string"},"currentRoomInfo":{"$ref":"#/components/schemas/booking_blk_currentRoomInfoType","description":"Room information of the reservation for the current day."},"departureDate":{"format":"date","type":"string"},"expectedTimes":{"$ref":"#/components/schemas/booking_blk_resExpectedTimesType","description":"The Expected Arrival and Departure Times."},"guarantee":{"$ref":"#/components/schemas/booking_blk_resGuaranteeType","description":"The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context."},"guestCounts":{"$ref":"#/components/schemas/booking_blk_guestCountsType"},"mobileNotifications":{"$ref":"#/components/schemas/booking_blk_resMobileNotificationsType","description":"Denotes the status of Room Ready and Key Ready messages."},"multiValueAttrs":{"description":"Informative indicators indicating different values of an attribute exists over the stay.","items":{"maxLength":2000,"type":"string"},"maxItems":4000,"type":"array"},"originalTimeSpan":{"$ref":"#/components/schemas/booking_blk_timeSpanType","description":"The Original Time Span(Arrival, Departure) which covers the Room Stay. In case of Rolling No Show TimeSpan's StratDate moves forward but OriginalTimeSpan's StratDate remains the same."},"ownerReservationType":{"$ref":"#/components/schemas/booking_blk_ownerResTypeType","description":"Indicates whether reservation is for Unit/Room Owner or Authorized User. If this attribute is not define it is a regular/rental reservation."},"primaryShareType":{"$ref":"#/components/schemas/booking_blk_primaryShareTypeType","description":"This is populated in case of primary share scenario. This indicates whether this reservation is primary or non primary. Changes or postings to the 'non-primary' share reservation is not allowed."},"printRate":{"description":"This control whether rate info will be printed in confirmation letter.","type":"boolean"},"promotion":{"$ref":"#/components/schemas/booking_blk_promotionType","description":"Promotions applied to the reservation to get the promotional rate."},"registrationNumber":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Registration Number of the reservation for the current day."},"remoteCheckInAllowed":{"description":"Indicates whether the reservation is pre-registered for internet check-in or not.","type":"boolean"},"roomNumberLocked":{"description":"When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.","type":"boolean"},"roomRates":{"description":"A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can have multiple rates. Example King room, Rack rate plan, Monday through Thursday, weekday amount, Friday and Saturday, weekend amount.","items":{"$ref":"#/components/schemas/booking_blk_roomRateType"},"maxItems":4000,"type":"array"},"suiteWith":{"description":"Connecting Rooms.","maxLength":200,"minLength":0,"type":"string"},"total":{"$ref":"#/components/schemas/booking_blk_totalType","description":"The total amount charged for the Room Stay."},"totalPoints":{"$ref":"#/components/schemas/booking_blk_pointsType","description":"The total number of Points charged for the Room Stay."},"upsellInfo":{"$ref":"#/components/schemas/booking_blk_upsellInfoType","description":"Indicates Upsell Information to be applied on Reservation."}},"type":"object"},"booking_blk_roomTypeAttributesType":{"description":"Attributes of property room type.","properties":{"defaultOccupancy":{"description":"Default occupancy of property room type.","type":"integer"},"maximumAdults":{"description":"Maximum adult occupancy of property room type.","type":"integer"},"maximumChildren":{"description":"Maximum children occupancy of property room type.","type":"integer"},"maximumOccupancy":{"description":"Max occupancy of property room type.","type":"integer"},"minimumOccupancy":{"description":"Minimum occupancy of property room type.","type":"integer"},"noOfPhysicalRooms":{"description":"Number of physical rooms of property room type.","type":"integer"}},"type":"object"},"booking_blk_routingInfoListType":{"description":"A routing info object can either be of type Folio OR of type Room with its corresponding instructions.","items":{"$ref":"#/components/schemas/booking_blk_routingInfoType"},"maxItems":4000,"type":"array"},"booking_blk_routingInfoType":{"description":"A routing info object can either be of type Folio OR of type Room with its corresponding object.","properties":{"comp":{"description":"Comp Accounting Routing Info","properties":{"compRequestInfo":{"$ref":"#/components/schemas/booking_blk_compRoutingRequestType"},"folioWindowNo":{"type":"integer"},"instructions":{"description":"Set of routing instructions associated to this routing type.","items":{"$ref":"#/components/schemas/booking_blk_routingInstructionType"},"maxItems":4000,"type":"array"},"payeeInfo":{"$ref":"#/components/schemas/booking_blk_payeeInfoType"}},"type":"object"},"folio":{"description":"Folio routing type.","properties":{"aRNumber":{"description":"Accounts Receivable.","maxLength":20,"minLength":0,"type":"string"},"folioWindowNo":{"type":"integer"},"guestInfo":{"description":"Guest details","properties":{"profileIdList":{"$ref":"#/components/schemas/booking_blk_profileIdList","description":"Unique identifiers for the Profile for both internal and external systems."}},"type":"object"},"instructions":{"description":"Set of routing instructions associated to this routing type.","items":{"$ref":"#/components/schemas/booking_blk_routingInstructionType"},"maxItems":4000,"type":"array"},"payeeInfo":{"$ref":"#/components/schemas/booking_blk_payeeInfoType"},"paymentMethod":{"maxLength":2000,"type":"string"}},"type":"object"},"refreshFolio":{"description":"On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions.","type":"boolean"},"request":{"description":"Comp Accounting Request routing","properties":{"compRequestInfo":{"$ref":"#/components/schemas/booking_blk_compRoutingRequestType"},"instructions":{"description":"Set of routing instructions associated to this routing type.","items":{"$ref":"#/components/schemas/booking_blk_routingInstructionType"},"maxItems":4000,"type":"array"}},"type":"object"},"room":{"description":"Room routing type.","properties":{"guestDisplayName":{"description":"Display Name for the guest.","maxLength":80,"minLength":0,"type":"string"},"guestNameId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Guest unique identifier to which the instruction will be routed."},"instructions":{"description":"Set of routing instructions associated to this routing type.","items":{"$ref":"#/components/schemas/booking_blk_routingInstructionType"},"maxItems":4000,"type":"array"},"reservationNameId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Reservation name id to which the instruction will be routed."},"roomId":{"description":"Room number to route the instructions.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"}},"type":"object"},"booking_blk_routingInstructionType":{"description":"Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit","properties":{"billingInstructions":{"$ref":"#/components/schemas/booking_blk_billingInstructionsType","description":"Set of Billing Instructions configured in this time span."},"covers":{"description":"Number of covers for this routing instruction.","type":"number"},"creditLimit":{"description":"Allowable credit amount for this routing instruction. Null value means no limit, 0 equals zero.","type":"number"},"duration":{"description":"Duration of this instruction.","properties":{"daily":{"description":"Flag to indicate if the routing instruction is a daily instruction.","type":"boolean"},"friday":{"type":"boolean"},"monday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"thursday":{"type":"boolean"},"timeSpan":{"$ref":"#/components/schemas/booking_blk_timeSpanType"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"}},"type":"object"},"limitUsed":{"description":"Amount of Credit used for this routing instruction.","type":"number"},"percentageLimit":{"description":"The routing limit percentage allowed for this routing instruction.","type":"number"},"routingLinkId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Internal Routing Link Id identifier to which limit group the instruction belongs."},"transactionCodes":{"$ref":"#/components/schemas/booking_blk_trxCodesInfoType","description":"Set of Transaction Codes configured in this time span."}},"type":"object"},"booking_blk_scopeType":{"description":"Minimum required and complimentary values are applicable Per Stay.","enum":["PerDay","PerStay"],"type":"string"},"booking_blk_searchMatchType":{"description":"Search match indicating attribute and the matching value.","properties":{"attribute":{"description":"Search match attribute.","maxLength":2000,"minLength":0,"type":"string"},"value":{"description":"Search match value.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_searchMatchesType":{"description":"List of Generic Name-Value-Pair Parameters used for super search matches.","items":{"$ref":"#/components/schemas/booking_blk_searchMatchType"},"maxItems":4000,"type":"array"},"booking_blk_sellMessageConfigType":{"description":"Only one of the following can hold a value: HotelCode, CROCode or ChainCode","properties":{"blockCode":{"description":"Block Code to which the sell message is defined.","maxLength":20,"minLength":0,"type":"string"},"blockId":{"$ref":"#/components/schemas/booking_blk_blockId","description":"Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA."},"chainCode":{"description":"Chain Code for which the sell message is defined.","maxLength":20,"minLength":0,"type":"string"},"croCode":{"description":"CRO Code for which the sell message is defined.","maxLength":20,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel Code for which the sell message is defined.","maxLength":20,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"languageCode":{"description":"Language in which the sell message is defined.","maxLength":20,"minLength":0,"type":"string"},"message":{"description":"Sell message text.","maxLength":2000,"minLength":0,"type":"string"},"ratePlanCode":{"description":"Rate Plan Code for which the sell message is defined.","maxLength":20,"minLength":0,"type":"string"},"roomType":{"description":"Room type for which the sell message is defined.","maxLength":20,"minLength":0,"type":"string"},"sellSequence":{"description":"This number indicates the display order of the sell message.","type":"number"},"stickyFlag":{"description":"Sticky flag is used to define if the sell message should display on the block screen by default.","type":"boolean"},"timespan":{"$ref":"#/components/schemas/booking_blk_timeSpanType","description":"Begin and End date for the sell message."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"usedInModule":{"description":"This represents the moduleType where we want to display this SellMessage.","items":{"$ref":"#/components/schemas/booking_blk_usedInModuleType"},"maxItems":10,"type":"array"}},"type":"object"},"booking_blk_sellMessageConfigsType":{"description":"The SellMessageConfigsType is the list of sell messages, each comprising of all the sell message attributes and other details.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"sellMessageConfig":{"items":{"$ref":"#/components/schemas/booking_blk_sellMessageConfigType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"booking_blk_sentConfirmationStatus":{"enum":["Pending","Succeeded","Failed"],"type":"string"},"booking_blk_serviceRequest":{"description":"Service request.","properties":{"action":{"description":"Description of the action taken to complete the request.","maxLength":200,"minLength":0,"type":"string"},"closeDescription":{"description":"The follow up description.","maxLength":2000,"minLength":0,"type":"string"},"closedBy":{"description":"The user who closed the service request.","maxLength":80,"minLength":0,"type":"string"},"closedDate":{"description":"The date-time in which the service request was closed. Uses the hotel's time zone.","format":"date-time","type":"string"},"code":{"description":"Service request code.","maxLength":20,"minLength":0,"type":"string"},"comment":{"description":"Description of the service request.","maxLength":2000,"minLength":0,"type":"string"},"completionDate":{"description":"The date-time in which the service request was completed. Uses the hotel's time zone.","format":"date-time","type":"string"},"department":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"The department that is associated with the service request code."},"guaranteedBy":{"description":"The user who guaranteed the completion of the service request.","maxLength":100,"minLength":0,"type":"string"},"guestContactMethod":{"description":"Communication method picked from guest profile.","maxLength":100,"minLength":0,"type":"string"},"guestName":{"description":"The guest name.","maxLength":200,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel Code of the service request.","maxLength":20,"minLength":0,"type":"string"},"openDate":{"description":"The date-time in which the service request was opened. Uses the hotel's time zone.","format":"date-time","type":"string"},"priority":{"description":"The priority level of the service request.","maxLength":20,"minLength":0,"type":"string"},"profileId":{"$ref":"#/components/schemas/booking_blk_profileId","description":"Unique identifier of the guest."},"reservationIdList":{"$ref":"#/components/schemas/booking_blk_reservationIdList","description":"Unique identifier of the reservation."},"room":{"description":"The room number in which the service request was created.","maxLength":20,"minLength":0,"type":"string"},"serviceRequestId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Unique identifier of the service request."},"status":{"$ref":"#/components/schemas/booking_blk_serviceRequestStatusType","description":"The status of the service request."}},"type":"object"},"booking_blk_serviceRequestStatusType":{"enum":["Open","PendingFollowUp","Closed","DoNotDisturb","MakeUpRoom"],"type":"string"},"booking_blk_serviceRequests":{"description":"Service request.","items":{"$ref":"#/components/schemas/booking_blk_serviceRequest"},"maxItems":4000,"type":"array"},"booking_blk_shareDistributionInstructionType":{"description":"The type of Rate Amount Change to be done on the Sharer reservation. This can be FULL -\u003e Full Rate for each Sharer. SPLIT-\u003e Split the Rate amount between Sharer Reservations. ENTIRE -\u003e This Sharer will get the total amount of the rate code for all the Sharer Reservations.","enum":["Full","Entire","Split","CustomSplit"],"type":"string"},"booking_blk_sourceCodeInfoType":{"properties":{"description":{"maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"sourceCode":{"maxLength":20,"minLength":0,"type":"string"},"sourceGroup":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_sourceOfSaleType":{"description":"Point of Sale of reservation. Identifies the entity/channel who made the reservation.","properties":{"sourceCode":{"description":"The entity/channel who made the reservation.","maxLength":20,"minLength":0,"type":"string"},"sourceType":{"description":"Type of entity/channel who made the reservation..","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_statisticsSummaryType":{"description":"Type of statistic for which summary information is populated.","enum":["Potential","Actual","Variance"],"type":"string"},"booking_blk_status":{"description":"Response Body.","properties":{"links":{"$ref":"#/components/schemas/booking_blk_links"},"warnings":{"$ref":"#/components/schemas/booking_blk_warningsType"}},"type":"object"},"booking_blk_statusColorType":{"description":"Status code color configuration type.","enum":["White","Red","Blue","Cyan","Magenta","Green","Brown","Black","Yellow","Gray"],"type":"string"},"booking_blk_stayFutureListType":{"description":"A collection of reservation history details attached to Profiles.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"reservationInfo":{"description":"Additional reservation information attached to the profile . Eg : Future reservation details","items":{"$ref":"#/components/schemas/booking_blk_stayReservationInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"booking_blk_stayHistoryListType":{"description":"A collection of reservation history details attached to Profiles.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"reservationInfo":{"description":"Additional reservation information attached to the profile . Eg : History reservation details","items":{"$ref":"#/components/schemas/booking_blk_stayReservationInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"booking_blk_stayInfoType":{"description":"Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties.","properties":{"adultCount":{"description":"A collection of Guest Counts associated with Room Stay.","type":"integer"},"arrivalDate":{"format":"date","type":"string"},"assignedByAI":{"description":"Represents the room was assigned by AI Room Assignment.","type":"boolean"},"balance":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Balance amount"},"bookingChannelCode":{"description":"Booking channel code","maxLength":20,"minLength":0,"type":"string"},"childCount":{"description":"A collection of Child Counts associated with Room Stay.","type":"integer"},"compBalance":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Comp Balance amount"},"componentRoomType":{"description":"True indicates room type is a component type.","type":"boolean"},"departureDate":{"format":"date","type":"string"},"depositPayments":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"A collection of deposit and/or payments for the Room Stay."},"expectedTimes":{"$ref":"#/components/schemas/booking_blk_resExpectedTimesType","description":"The expected arrival, return and departure times of the guest."},"fixedRate":{"description":"True if the rate is a fixed rate, otherwise false","type":"boolean"},"guarantee":{"$ref":"#/components/schemas/booking_blk_resGuaranteeType","description":"The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context."},"guestServiceStatus":{"$ref":"#/components/schemas/booking_blk_guestHousekeepingServiceRequestType","description":"Service Status of In House guest like DND or MUP"},"linkCode":{"description":"Party code","maxLength":2000,"type":"string"},"marketCode":{"description":"Market code","maxLength":20,"minLength":0,"type":"string"},"marketDescription":{"description":"Description of Market code","maxLength":4000,"minLength":0,"type":"string"},"numberOfRooms":{"description":"Room Id","type":"integer"},"originalTimeSpan":{"$ref":"#/components/schemas/booking_blk_timeSpanType","description":"The Original Time Span covers the Room Stay dates of the original reservation."},"points":{"$ref":"#/components/schemas/booking_blk_pointsType","description":"The Points contains the number of points used to book a particular room type."},"promotion":{"$ref":"#/components/schemas/booking_blk_promotionType","description":"Promotion Codes"},"pseudoRoom":{"description":"True indicates as pseudo room type. This is usually used for a posting master reservation.","type":"boolean"},"rateAmount":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Rate amount"},"ratePlanCode":{"description":"Rate plan code","maxLength":20,"minLength":0,"type":"string"},"rateSuppressed":{"description":"Whether this rate should be suppressed from view","type":"boolean"},"reservationBlock":{"$ref":"#/components/schemas/booking_blk_reservationBlockType","description":"Key information about the block for this reservation."},"roomClass":{"description":"Room class code","maxLength":20,"minLength":0,"type":"string"},"roomId":{"description":"Room Id","maxLength":20,"minLength":0,"type":"string"},"roomNumberLocked":{"description":"When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.","type":"boolean"},"roomType":{"description":"Room type code","maxLength":20,"minLength":0,"type":"string"},"roomTypeCharged":{"description":"Room type code that was charged","maxLength":20,"minLength":0,"type":"string"},"scheduledCheckoutTime":{"description":"Indicates that this reservation is scheduled for automated check out.","format":"date","type":"string"},"sourceCode":{"description":"Source of business","maxLength":20,"minLength":0,"type":"string"},"sourceCodeDescription":{"description":"Description of the source of business.","maxLength":4000,"minLength":0,"type":"string"},"totalAmount":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount."},"upgradedByAI":{"description":"Represents the room was assigned by AI Room Assignment.","type":"boolean"}},"type":"object"},"booking_blk_stayReservationInfoType":{"description":"The Reservation class contains the current reservation being created or altered.","properties":{"attachedProfiles":{"$ref":"#/components/schemas/booking_blk_resAttachedProfileListType","description":"List of attached profiles"},"computedReservationStatus":{"$ref":"#/components/schemas/booking_blk_pMS_ResStatusType","description":"Indicates the status of the reservation."},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"reservationIdList":{"$ref":"#/components/schemas/booking_blk_reservationIdList","description":"Unique identifiers for the reservation for both internal and external systems"},"reservationStatus":{"$ref":"#/components/schemas/booking_blk_pMS_ResStatusType","description":"Indicates the status of the reservation."},"roomStay":{"$ref":"#/components/schemas/booking_blk_stayInfoType","description":"Collection of room stays."}},"type":"object"},"booking_blk_subBlockIdList":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type"},"maxItems":4000,"type":"array"},"booking_blk_surnameType":{"description":"Family name, last name.","maxLength":40,"minLength":0,"type":"string"},"booking_blk_taxType":{"description":"Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"code":{"description":"Code identifying the fee (e.g.,agency fee, municipality fee).","maxLength":20,"minLength":0,"type":"string"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"type":{"$ref":"#/components/schemas/booking_blk_amountDeterminationType","description":"Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other)."}},"type":"object"},"booking_blk_taxTypeType":{"description":"Provides information about the Tax Type.","properties":{"code":{"description":"Code of the Tax Type.","maxLength":20,"minLength":0,"type":"string"},"collectingAgentTax":{"description":"A boolean flag for Collecting Agent Tax","type":"boolean"},"description":{"description":"Description of the Tax Type.","maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"description":"Code of the Hotel.","maxLength":20,"minLength":0,"type":"string"},"minimumLengthOfStay":{"description":"Minimun Length of Stay.","type":"integer"},"printAutoAdjust":{"description":"Print auto adjust information for this tax type on the tax exempt report.","type":"boolean"},"reportExemptDays":{"description":"Number of days after which the guest will be tax exempt. Only used for tax exempt report.","type":"integer"},"reportTaxPercentage":{"description":"Tax percentage. Only used for tax exempt report.","maximum":100,"minimum":0,"type":"number"}},"type":"object"},"booking_blk_taxesType":{"description":"A collection of taxes.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"},"tax":{"description":"An individual tax.","items":{"$ref":"#/components/schemas/booking_blk_taxType"},"maxItems":99,"type":"array"}},"type":"object"},"booking_blk_telephoneInfoType":{"description":"Information on a telephone number for the customer.","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"telephone":{"$ref":"#/components/schemas/booking_blk_telephoneType","description":"Phone details for the profile."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"warnings":{"$ref":"#/components/schemas/booking_blk_warningsType"}},"type":"object"},"booking_blk_telephoneType":{"description":"Information on a telephone number for the customer.","properties":{"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"extension":{"description":"Extension to reach a specific party at the phone number.","maxLength":20,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"phoneNumber":{"description":"Telephone number assigned to a single location.","maxLength":40,"minLength":0,"type":"string"},"phoneTechType":{"description":"Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc.","maxLength":20,"minLength":0,"type":"string"},"phoneUseType":{"description":"Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening).","maxLength":20,"minLength":0,"type":"string"},"phoneUseTypeDescription":{"description":"Description of the PhoneUseType code","maxLength":2000,"minLength":0,"type":"string"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"}},"type":"object"},"booking_blk_thresholdDetailsType":{"description":"Type for the threshold elements.","properties":{"complimentary":{"description":"The number of quantities, counts or minutes for which transaction diversion is allowed .","type":"integer"},"entity":{"$ref":"#/components/schemas/booking_blk_entityType","description":"Diversion entity type associated with the charge for the transaction diversion rule ."},"isEditable":{"description":"Configuring this flag to be TRUE will make the thresholds editable.","type":"boolean"},"minRequired":{"description":"Minimum required number of quantities, counts or minutes that must be posted.","type":"integer"},"scope":{"$ref":"#/components/schemas/booking_blk_scopeType","description":"Diversion scope for the transaction diversion rule."}},"type":"object"},"booking_blk_ticketType":{"description":"Reservation Ticket Type Information.","properties":{"consumptionDate":{"description":"Tickets comsumption date.","format":"date","maxLength":8,"type":"string"},"description":{"description":"Package description.","maxLength":2000,"minLength":0,"type":"string"},"issueDate":{"description":"Tickets issue date.","format":"date","maxLength":8,"type":"string"},"packageCode":{"description":"Package Code.","maxLength":20,"minLength":0,"type":"string"},"price":{"description":"Tickets price.","type":"number"},"quantity":{"description":"Number of tickets used to create multiple tickets.","type":"integer"},"rateCode":{"description":"The Rate Code to which tickets belong to.","maxLength":20,"minLength":0,"type":"string"},"reference":{"description":"Free text field for reference information.","maxLength":2000,"minLength":0,"type":"string"},"reservationProductId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Reference to the reservation product."},"status":{"description":"The Status Code for outbound WS call.","maxLength":20,"minLength":0,"type":"string"},"statusDescription":{"description":"The Status Description for outbound WS call.","maxLength":2000,"minLength":0,"type":"string"},"ticketId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Internal Unique ID."},"ticketNumber":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type","description":"Ticket number."}},"type":"object"},"booking_blk_ticketsType":{"description":"Collection of TicketType objects.","items":{"$ref":"#/components/schemas/booking_blk_ticketType"},"maxItems":4000,"type":"array"},"booking_blk_tierAdministrationType":{"description":"Do not upgrade membership. The membership may be downgraded.","enum":["Disabled","NoUpgrade"],"type":"string"},"booking_blk_timeSpanDaysOfWeekType":{"description":"Container for Time span with days of week.","properties":{"friday":{"type":"boolean"},"monday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"thursday":{"type":"boolean"},"timeSpan":{"$ref":"#/components/schemas/booking_blk_timeSpanType"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"}},"type":"object"},"booking_blk_timeSpanType":{"description":"Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.","properties":{"duration":{"type":"string"},"endDate":{"format":"date","maxLength":8,"type":"string"},"startDate":{"format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_blk_timeWindowType":{"description":"Defines a Time period with start time and an end time.","properties":{"endTime":{"description":"End Time of the Time window.","type":"string"},"startTime":{"description":"Start Time of the Time window.","type":"string"}},"type":"object"},"booking_blk_totalType":{"description":"The total amount charged for the service including additional amounts and fees.","properties":{"amountAfterTax":{"description":"The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).","type":"number"},"amountBeforeTax":{"description":"The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).","type":"number"},"code":{"description":"Type of charge.","maxLength":20,"minLength":0,"type":"string"},"currencyCode":{"description":"The code specifying a monetary unit. Use ISO 4217, three alpha code.","maxLength":20,"minLength":0,"type":"string"},"currencySymbol":{"description":"The symbol for the currency, e.g, for currencyCode USD the symbol is $.","maxLength":10,"minLength":0,"type":"string"},"decimalPlaces":{"description":"Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).","type":"integer"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"fees":{"$ref":"#/components/schemas/booking_blk_feesType","description":"A collection of fees or service charges."},"rateOverride":{"description":"When true indicates that the rate amount has been overridden.","type":"boolean"},"taxes":{"$ref":"#/components/schemas/booking_blk_taxesType","description":"A collection of taxes."}},"type":"object"},"booking_blk_traceResolveType":{"properties":{"resolvedBy":{"description":"User that resolved the trace","type":"string"},"resolvedOn":{"description":"Date the trace was resolved","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_blk_traceTimeInfoType":{"properties":{"dateTimeSpan":{"$ref":"#/components/schemas/booking_blk_dateTimeSpanType","description":"Time span for the trace."},"enteredBy":{"description":"User that entered this trace.","type":"string"},"traceOn":{"description":"Date of the trace. Uses the hotel's time zone.","format":"date-time","type":"string"},"traceTime":{"description":"Time of the trace","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_trackItActionType":{"description":"Identifies the response expected from staff or other parties relative to a Track It ticket.","properties":{"status":{"$ref":"#/components/schemas/booking_blk_actionStatusType"},"trackItAction":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType"}},"type":"object"},"booking_blk_trackItGroup":{"description":"Group to which the Track It items belong.","enum":["Parcel","Valet","Baggage","Lost"],"type":"string"},"booking_blk_trackItId":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_blk_trackItItemType":{"description":"Detailed information of a Track It item.","properties":{"action":{"$ref":"#/components/schemas/booking_blk_trackItActionType"},"assignedTo":{"$ref":"#/components/schemas/booking_blk_applicationUserType"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"followUpDate":{"format":"date","maxLength":8,"type":"string"},"group":{"$ref":"#/components/schemas/booking_blk_trackItGroup"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"location":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType"},"quantity":{"type":"integer"},"referenceNumber":{"maxLength":20,"minLength":0,"type":"string"},"reservationInfo":{"$ref":"#/components/schemas/booking_blk_trackItReservationInfoType"},"ticketNumber":{"maxLength":80,"minLength":0,"type":"string"},"trackItId":{"$ref":"#/components/schemas/booking_blk_trackItId"},"trackItLogList":{"$ref":"#/components/schemas/booking_blk_trackItLogListType"},"type":{"$ref":"#/components/schemas/booking_blk_trackItType"}},"type":"object"},"booking_blk_trackItItemsType":{"description":"","items":{"$ref":"#/components/schemas/booking_blk_trackItItemType"},"maxItems":4000,"type":"array"},"booking_blk_trackItLogListType":{"items":{"$ref":"#/components/schemas/booking_blk_trackItLogType"},"maxItems":4000,"type":"array"},"booking_blk_trackItLogType":{"description":"Individual activity log related to the Track It ticket.","properties":{"businessDate":{"format":"date","maxLength":8,"type":"string"},"description":{"maxLength":200,"minLength":0,"type":"string"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"logDate":{"format":"date-time","type":"string"},"logUserId":{"type":"integer"},"logUserName":{"type":"string"},"trackItId":{"$ref":"#/components/schemas/booking_blk_trackItId"},"trackItLogId":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type"},"type":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_trackItReservationInfoType":{"description":"Reservation info associated with a Track It item.","properties":{"computedReservationStatus":{"$ref":"#/components/schemas/booking_blk_pMS_ResStatusType"},"guarantee":{"$ref":"#/components/schemas/booking_blk_resGuaranteeType"},"guestInfo":{"$ref":"#/components/schemas/booking_blk_resGuestInfoType"},"reservationIdList":{"$ref":"#/components/schemas/booking_blk_reservationIdList"},"reservationStatus":{"$ref":"#/components/schemas/booking_blk_pMS_ResStatusType"},"roomId":{"maxLength":20,"minLength":0,"type":"string"},"roomStatus":{"$ref":"#/components/schemas/booking_blk_housekeepingRoomStatusType"},"roomType":{"maxLength":20,"minLength":0,"type":"string"},"timeSpan":{"$ref":"#/components/schemas/booking_blk_timeSpanType"}},"type":"object"},"booking_blk_trackItType":{"description":"Identifies the kind of Parcel, Baggage, or Lost items or Valet-managed vehicles or services.","properties":{"type":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType"},"url":{"$ref":"#/components/schemas/booking_blk_uRLType"}},"type":"object"},"booking_blk_transactionDiversionDailyDetailType":{"description":"List of daily details for Transaction Diversion rule.","properties":{"date":{"description":"Daily details Date about when the rules are posted or diverted.","format":"date","maxLength":8,"type":"string"},"diverted":{"description":"Transaction diversion rules that are diverted .","type":"integer"},"posted":{"description":"Transaction diversion rules that are posted.","type":"integer"}},"type":"object"},"booking_blk_transactionDiversionDailyDetailsType":{"description":"List of daily details for Transaction Diversion rule.","items":{"$ref":"#/components/schemas/booking_blk_transactionDiversionDailyDetailType"},"maxItems":4000,"type":"array"},"booking_blk_transactionDiversionRuleLevelType":{"description":"Reservation level.","enum":["Property","Reservation"],"type":"string"},"booking_blk_transactionDiversionRuleTypeType":{"description":"The rule type on which the Transaction Diversion Rule is based. If a reservation has any of the following code, Transaction Diversion rule gets active for that reservation","enum":["Vip","Membership"],"type":"string"},"booking_blk_translationTextType80":{"description":"Contains Multiple translated texts and language codes.","properties":{"defaultText":{"description":"Default text with Character length from 0 to 80.","maxLength":80,"minLength":0,"type":"string"},"translatedTexts":{"$ref":"#/components/schemas/booking_blk_translationsTextType","description":"List of translated text and language codes."}},"type":"object"},"booking_blk_translationsTextType":{"description":"Language code for the translation.","items":{"description":"Language code for the translation.","properties":{"language":{"description":"Language identification.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Used for Character Strings, length 0 to 2000.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"maxItems":4000,"type":"array"},"booking_blk_transportInfoType":{"properties":{"carrierCode":{"maxLength":20,"minLength":0,"type":"string"},"comments":{"maxLength":2000,"minLength":0,"type":"string"},"dateTime":{"format":"date-time","type":"string"},"stationCode":{"maxLength":20,"minLength":0,"type":"string"},"transportCode":{"maxLength":20,"minLength":0,"type":"string"},"transportationReqd":{"type":"boolean"},"type":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_trxCodesInfoType":{"description":"List of Transaction codes info.","items":{"$ref":"#/components/schemas/booking_blk_trxInfoType"},"maxItems":4000,"type":"array"},"booking_blk_trxInfoType":{"description":"Transaction codes info.","properties":{"articles":{"description":"The List of Articles defined for this transaction code, when using the Articles functionality.","items":{"$ref":"#/components/schemas/booking_blk_articleInfoType"},"maxItems":4000,"type":"array"},"description":{"description":"Transaction codes info.","maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel context of the Transaction code.","maxLength":20,"minLength":0,"type":"string"},"printTrxReceipt":{"description":"Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code.","type":"boolean"},"routingInstructionsId":{"description":"This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer.","type":"number"},"transactionCode":{"description":"Unique identifier for the Transaction code.","maxLength":20,"minLength":0,"type":"string"},"transactionGroup":{"description":"Category of the transaction code.","maxLength":20,"minLength":0,"type":"string"},"transactionSubGroup":{"description":"Sub category of the transaction code.","maxLength":20,"minLength":0,"type":"string"},"trxServiceType":{"description":"Contains service type for transaction code.","maxLength":20,"minLength":0,"type":"string"},"universalProductCode":{"description":"Unique Universal product code of the transaction code.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_turndownStatusType":{"description":"Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Completed.","enum":["Required","NotRequired","Compeleted"],"type":"string"},"booking_blk_typeOfMessageType":{"description":"The type of Message for Guest Messages.","enum":["Tm","Vm"],"type":"string"},"booking_blk_uRLInfoType":{"description":"Web site address.","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"$ref":"#/components/schemas/booking_blk_uRLType","description":"Provides URL information."},"warnings":{"$ref":"#/components/schemas/booking_blk_warningsType"}},"type":"object"},"booking_blk_uRLType":{"description":"Web site address, in IETF(The Internet Engineering Task Force) specified format.","properties":{"orderSequence":{"description":"Display Order sequence.","type":"number"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"},"type":{"description":"Defines the purpose of the URL address, such as personal, business, public, etc.","maxLength":20,"minLength":0,"type":"string"},"typeDescription":{"description":"Describes the Type code","maxLength":2000,"minLength":0,"type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"booking_blk_uniqueIDListType":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/booking_blk_uniqueID_Type"},"maxItems":4000,"type":"array"},"booking_blk_uniqueID_Type":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"warnings":{"$ref":"#/components/schemas/booking_blk_warningsType"}},"type":"object"},"booking_blk_upsellInfoType":{"description":"Information regarding upsell for a reservation.","properties":{"originalInfo":{"description":"Original Values of the reservation prior to upgrade.","properties":{"nights":{"description":"The number of nights of the reservation before being upgraded.","type":"integer"},"rateCode":{"description":"The Rate Code of the Reservation before it was upgraded","maxLength":20,"minLength":0,"type":"string"},"roomType":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Original Reservation Room Type before being upgraded."},"totalAmount":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Total Amount of the reservation before it was upgraded."}},"type":"object"},"upsellInfo":{"description":"Information of a reservation during the process of upgrade.","properties":{"firstNightUpsellAmount":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"First Night Total Amount including Upsell."},"firstNightUpsellCharge":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"First Night Upsell Charges."},"percentageSavings":{"description":"Percentage savings resulting from accepting upsell offer. This will be calculated as the ratio of the amount saved by accepting the upsell offer to the actual room rate (i.e. room rate when upsell is not offered)","maximum":100,"minimum":0,"type":"number"},"roomLongDescription":{"description":"Detail description of the Room Type.","maxLength":2000,"minLength":0,"type":"string"},"roomType":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType","description":"Reservation Room Type for Upsell."},"ruleCode":{"description":"Upsell rule code","maxLength":20,"minLength":0,"type":"string"},"ruleDescription":{"description":"Upsell rule description","maxLength":2000,"minLength":0,"type":"string"},"ruleId":{"description":"Upsell Rule Id.","type":"integer"},"totalActualRateAmount":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Actual Total Room Rate for the Target Upsell Room Type."},"totalUpsellCharge":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Amount that was charged for the upsell."},"totalUpsellMoneyAmount":{"$ref":"#/components/schemas/booking_blk_currencyAmountType","description":"Total Amount that was charged including upsell."},"totalUpsellPoints":{"description":"Total Upsell Points.","type":"integer"},"upsellDate":{"description":"The date on which reservation is upgraded.","format":"date","maxLength":8,"type":"string"},"upsellUser":{"description":"User who upgraded the reservation.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"}},"type":"object"},"booking_blk_usedInModuleType":{"description":"Simple type for indicating the module for which user wants to create the SellMessage. Valid module types are Look To Book Sales,Reservations,Blocks,Function Diary and Group Rooms Control.","enum":["Blocks","Reservations","FunctionDiary","LookToBookSales","GroupRoomsControl"],"type":"string"},"booking_blk_userDefinedFieldsType":{"description":"A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc.","properties":{"characterUDFs":{"$ref":"#/components/schemas/booking_blk_characterUDFsType","description":"Collection of user defined fields of Character/String Type."},"dateUDFs":{"$ref":"#/components/schemas/booking_blk_dateUDFsType","description":"Collection of user defined fields of Date Type."},"numericUDFs":{"$ref":"#/components/schemas/booking_blk_numericUDFsType","description":"Collection of user defined fields of Numeric Type."}},"type":"object"},"booking_blk_userInfoType":{"description":"Opera User Information","properties":{"userId":{"description":"User Id of the Opera User","type":"integer"},"userName":{"description":"Name of the Opera User","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_userSessionDefaultsType":{"properties":{"baseLanguage":{"maxLength":20,"minLength":0,"type":"string"},"currencyCode":{"maxLength":20,"minLength":0,"type":"string"},"currencyFormat":{"type":"string"},"dbDateFormat":{"type":"string"},"defaultLanguage":{"type":"string"},"javaDateFormat":{"type":"string"},"javaTimeFormat":{"type":"string"},"oracleDateFormat":{"type":"string"},"oracleTimeFormat":{"type":"string"}},"type":"object"},"booking_blk_userSessionInfoType":{"properties":{"businessDate":{"format":"date","maxLength":8,"type":"string"},"cROCountryCode":{"maxLength":20,"minLength":0,"type":"string"},"chain":{"maxLength":20,"minLength":0,"type":"string"},"cro":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType"},"hotel":{"$ref":"#/components/schemas/booking_blk_codeDescriptionType"},"parameters":{"$ref":"#/components/schemas/booking_blk_parametersType"},"runningApp":{"type":"string"},"sessionDefaults":{"$ref":"#/components/schemas/booking_blk_userSessionDefaultsType"},"shareProfiles":{"type":"boolean"},"systemDate":{"format":"date","maxLength":8,"type":"string"},"terminal":{"type":"string"}},"type":"object"},"booking_blk_vIPStatusType":{"description":"VIP status of the customer.","properties":{"code":{"description":"VIP status of the customer.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Used for Character Strings, length 0 to 2000.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_vIPType":{"description":"The supplier's ranking of the customer.","properties":{"vipCode":{"description":"VIP Code.","maxLength":20,"minLength":0,"type":"string"},"vipDescription":{"description":"VIP Description.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_visaInfoType":{"properties":{"visaExpiryDate":{"format":"date","maxLength":8,"type":"string"},"visaIssueDate":{"format":"date","maxLength":8,"type":"string"},"visaNumber":{"maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_waitlistResType":{"description":"Information regarding why reservation is being /has been waitlisted.","properties":{"description":{"description":"Description why the reservation is being /has been waitlisted.","maxLength":2000,"minLength":0,"type":"string"},"priorityCode":{"description":"Waitlist Priority Code.","maxLength":20,"minLength":0,"type":"string"},"priorityDescription":{"description":"Waitlist priority Description.","maxLength":2000,"minLength":0,"type":"string"},"reasonCode":{"description":"Waitlist Reason Code.","maxLength":20,"minLength":0,"type":"string"},"reasonDescription":{"description":"Waitlist Reason Description.","maxLength":2000,"minLength":0,"type":"string"},"telephone":{"description":"Guest telephone number.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_blk_warningType":{"description":"Used when a message has been successfully processed to report any warnings or business errors that occurred.","properties":{"code":{"description":"If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.","maxLength":20,"minLength":0,"type":"string"},"docURL":{"description":"If present, this URL refers to an online description of the error that occurred.","maxLength":2000,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"recordId":{"description":"If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.","maxLength":2000,"type":"string"},"rph":{"description":"Reference Place Holder used as an index for this warning.","maxLength":8,"minLength":1,"type":"string"},"shortText":{"description":"An abbreviated version of the error in textual format.","maxLength":2000,"type":"string"},"status":{"description":"If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.","maxLength":2000,"type":"string"},"tag":{"description":"If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].","maxLength":2000,"type":"string"},"type":{"description":"The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"booking_blk_warningsType":{"description":"Used in conjunction with the Success element to define a business error.","items":{"$ref":"#/components/schemas/booking_blk_warningType"},"maxItems":4000,"type":"array"},"booking_blk_welcomeOfferOptionsType":{"description":"None of the Welcome Offer option is selected.","enum":["BonusPoints","Ecoupons","Items","PostIt","NotSelected"],"type":"string"},"booking_blk_welcomeOfferType":{"properties":{"status":{"description":"Determines the status of the welcome offer.","maxLength":20,"minLength":0,"type":"string"},"type":{"$ref":"#/components/schemas/booking_blk_welcomeOfferOptionsType","description":"Determines the welcome offer option selected while availing the welcome offer."}},"type":"object"},"booking_crm_aRAccountShortInfoType":{"description":"Accounts Receivabales Account details type charged for batched posting.","properties":{"accountId":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type","description":"The unique ID for the Account."},"accountName":{"description":"Name of the AR Account.","maxLength":200,"minLength":0,"type":"string"},"accountNo":{"description":"The Account Number for the Account.","maxLength":20,"minLength":0,"type":"string"},"status":{"$ref":"#/components/schemas/booking_crm_aRAccountStatusType","description":"The status of the account."}},"type":"object"},"booking_crm_aRAccountStatusType":{"description":"Type for the Account Status. Status can be restricted and a message/description added to the Account.","properties":{"description":{"description":"User defined status message on the Account.","maxLength":2000,"minLength":0,"type":"string"},"restricted":{"description":"Flag to indicate if the Account is restricted.","type":"boolean"},"restriction":{"description":"The Restriction Code added on the Account. This is available when the functionality for adding restriction codes is ON.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_aRAccountType":{"description":"Accounts Receivabales Account details type.","properties":{"accountId":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type","description":"The unique ID for the Account."},"accountIndicators":{"$ref":"#/components/schemas/booking_crm_indicatorsType","description":"Indicators of additional information attached to the Account."},"accountName":{"description":"Name of the AR Account.","maxLength":200,"minLength":0,"type":"string"},"accountNo":{"description":"The Account Number for the Account.","maxLength":20,"minLength":0,"type":"string"},"accountTypeDescription":{"description":"The description of the Account Type.","maxLength":2000,"minLength":0,"type":"string"},"address":{"$ref":"#/components/schemas/booking_crm_addressInfoType","description":"Address information for the address which is attached to this AR Account."},"agingInfo":{"$ref":"#/components/schemas/booking_crm_aRAgingInfoType","description":"The Aging balance information for this account, by Aging Buckets."},"balance":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Open Balance of the Account for this property."},"batchStatement":{"description":"Include In Batch Statement","type":"boolean"},"contactName":{"description":"The person to contact for this Account.","maxLength":200,"minLength":0,"type":"string"},"creditLimit":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"The maximum credit allowed for the Account."},"email":{"$ref":"#/components/schemas/booking_crm_emailInfoType","description":"Email information for the Account. This is the Email that is attached to this AR Account."},"emailStatementsReminders":{"description":"Indicates if the Account has opted to send the statements and reminders to the Account email address by default.","type":"boolean"},"fixedCharges":{"$ref":"#/components/schemas/booking_crm_fixedChargesType","description":"Fixed charges attached to this AR Account."},"hotelId":{"description":"Property where the AR Account exists.","maxLength":20,"minLength":0,"type":"string"},"invoices":{"$ref":"#/components/schemas/booking_crm_aRInvoicesType","description":"List of all Invoices."},"lastReminderInfo":{"description":"Report History Type used as based type for Remiders and Statements History types.","properties":{"age":{"description":"The minimum age(days) of the invoices to be included in the Reminder","type":"integer"},"dateSent":{"description":"The Reminder Letter name which is to be used for this Reminder based on the setup on the Account Type.","format":"date","maxLength":8,"type":"string"},"historyExists":{"description":"Indicates that reminders history exists.","type":"boolean"},"reportFileName":{"description":"Report file name when exists to allow report re-printing.","maxLength":2000,"minLength":0,"type":"string"},"reportName":{"description":"Report Name.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"lastStatementInfo":{"description":"Report History Type used as based type for Remiders and Statements History types.","properties":{"dateSent":{"description":"The Reminder Letter name which is to be used for this Reminder based on the setup on the Account Type.","format":"date","maxLength":8,"type":"string"},"historyExists":{"description":"Indicates that statement history exists.","type":"boolean"},"reportFileName":{"description":"Report file name when exists to allow report re-printing.","maxLength":2000,"minLength":0,"type":"string"},"reportName":{"description":"Report Name.","maxLength":2000,"minLength":0,"type":"string"},"statementNo":{"description":"When using Statement Numbering, a unique number is associated to the Statement.","type":"integer"}},"type":"object"},"monthEndCalcYN":{"description":"Month End Calculation.","type":"boolean"},"notes":{"description":"The Note details attached to the Account.","items":{"$ref":"#/components/schemas/booking_crm_commentInfoType"},"maxItems":4000,"type":"array"},"paymentDueDays":{"description":"Number of days on which person can make payment.","maxLength":20,"minLength":0,"type":"string"},"payments":{"$ref":"#/components/schemas/booking_crm_aRPaymentsType","description":"List of all Payments made."},"permanent":{"description":"Indicates if this is a Permanent Account. Permanent Accounts cannot be deleted.","type":"boolean"},"primary":{"description":"Indicates if this Account is the Primary Account for this Guest/Company.","type":"boolean"},"printFoliosWithStatement":{"description":"Indicates if associated folios should be printed by default with the statement.","type":"boolean"},"profileId":{"$ref":"#/components/schemas/booking_crm_profileId","description":"Internal Profile ID for the AR Account."},"searchMatches":{"$ref":"#/components/schemas/booking_crm_searchMatchesType","description":"Super Search matching terms."},"status":{"$ref":"#/components/schemas/booking_crm_aRAccountStatusType","description":"The status of the account."},"summary":{"$ref":"#/components/schemas/booking_crm_aRBalanceType","description":"The Summary Information of the Invoices for the Account."},"telephones":{"description":"The Telephone and Fax details attached to the Account.","items":{"$ref":"#/components/schemas/booking_crm_telephoneInfoType"},"maxItems":4000,"type":"array"},"traces":{"description":"The Trace details attached to the Account.","items":{"$ref":"#/components/schemas/booking_crm_traceType"},"maxItems":4000,"type":"array"},"type":{"description":"The type of Account.","maxLength":20,"minLength":0,"type":"string"},"yearViewInfo":{"$ref":"#/components/schemas/booking_crm_aRYearViewInfoType","description":"The Year View balance information for this account."}},"type":"object"},"booking_crm_aRAccountsType":{"description":"Information regarding the AR Account.","items":{"$ref":"#/components/schemas/booking_crm_aRAccountType"},"maxItems":4000,"type":"array"},"booking_crm_aRAgingInfoType":{"description":"Information regarding the aging balances for an account.","properties":{"aging":{"description":"The debit and credit balance per Aging bucket.","items":{"$ref":"#/components/schemas/booking_crm_aRAgingType"},"maxItems":4000,"type":"array"},"totalOutstanding":{"$ref":"#/components/schemas/booking_crm_aRBalanceType","description":"The total debit and credit balance of the account."}},"type":"object"},"booking_crm_aRAgingType":{"description":"Aging information for an Aging Bucket.","properties":{"agingBucketRange":{"description":"The bucket description in terms of days. Example : 0-31 days","maxLength":20,"minLength":0,"type":"string"},"agingDate":{"$ref":"#/components/schemas/booking_crm_dateRangeType","description":"The start date and end date for this Aging bucket."},"agingEndDay":{"description":"The end number of days for this Aging bucket. Example: For the range 31-60 days, this would be 60.","type":"integer"},"agingStartDay":{"description":"The start number of days for this Aging bucket. Example: For the range 31-60 days, this would be 31.","type":"integer"},"balanceInfo":{"$ref":"#/components/schemas/booking_crm_aRBalanceType","description":"The balance amounts for this bucket. Contains the Debit Balance, Credit Balance and the Total Balance."},"sequence":{"description":"The sequence for display.","type":"integer"}},"type":"object"},"booking_crm_aRBalanceType":{"description":"Balance information for AR.","properties":{"credit":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"The credit Balance amount. Any payment that is Unallocated i.e not applied against an invoice, is included in this."},"debit":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Debit Balance amount. The amount owed by the Account."},"total":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"The total balance i.e Debit minus Credit amounts."}},"type":"object"},"booking_crm_aRInvoiceCategory":{"enum":["Normal","Credit","OldBalance","PasserBy"],"type":"string"},"booking_crm_aRInvoiceType":{"description":"Details of an AR Invoice.","properties":{"addresseeInfo":{"$ref":"#/components/schemas/booking_crm_profileInfoType","description":"Addressee Information for the folio. This is available when the Addressee functionality is used and and Addressee is attached to the folio of the Invoice."},"adjusted":{"type":"boolean"},"age":{"description":"The Aging age of the invoice","type":"integer"},"allowPartialTransferYn":{"description":"Flag to check Partail Transfer Allowed.","type":"boolean"},"amount":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Current Amount of the Invoice."},"balance":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Amount still open which has not been paid"},"canBeModified":{"description":"Flag to indicate if postings or adjustments can be made to the invoice.","type":"boolean"},"cashierInfo":{"$ref":"#/components/schemas/booking_crm_cashierInfoType","description":"Cashier information. Contains Id and Name details of the cashier."},"closeDate":{"description":"Close date of the invoice.","format":"date","maxLength":8,"type":"string"},"compressed":{"type":"boolean"},"compressedDate":{"format":"date","maxLength":8,"type":"string"},"fiscalBillNo":{"description":"The Fiscal Bill number of this posting","maxLength":2000,"minLength":0,"type":"string"},"folioDate":{"description":"Date of Folio Generation.","format":"date","maxLength":8,"type":"string"},"folioNo":{"description":"Folio Number.","type":"number"},"folioNoWithPrefix":{"description":"The folio number with prefix value.","maxLength":200,"minLength":0,"type":"string"},"folioSeqNo":{"description":"Unique sequence number. Used to identify the current folio tax record.","type":"number"},"folioStatus":{"$ref":"#/components/schemas/booking_crm_folioStatusType"},"folioTexts":{"$ref":"#/components/schemas/booking_crm_folioTextsType","description":"Additional text fields to display on the folio."},"folioTypeName":{"description":"The name of the Folio Type used for the Folio Number sequence.","maxLength":100,"minLength":0,"type":"string"},"guestName":{"description":"Name of the Guest who consumed these transactions.","maxLength":200,"minLength":0,"type":"string"},"guestProfileId":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type","description":"Guest Profile ID of the invoice."},"hotelId":{"description":"Property where the invoice exists.","maxLength":20,"minLength":0,"type":"string"},"internalFolioWindowID":{"description":"Internal window ID which is unique to the reservation. This ID can only be used for reference.","maxLength":20,"minLength":0,"type":"string"},"invoiceNo":{"description":"Invoice No after the folio is generated. Same invoice number may be referred in multiple folios","type":"number"},"invoiceType":{"$ref":"#/components/schemas/booking_crm_aRInvoiceCategory","description":"Invoice code of the invoice."},"market":{"$ref":"#/components/schemas/booking_crm_marketCodeInfoType","description":"Invoice market code."},"originalAmount":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Original Amount of the Invoice"},"parentInvoiceNo":{"type":"number"},"paymentCard":{"$ref":"#/components/schemas/booking_crm_resPaymentCardType","description":"Payment card details."},"payments":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Total Payments made to this Invoice."},"postingDate":{"description":"Posting date of the invoice.","format":"date","maxLength":8,"type":"string"},"printed":{"description":"Flag to check Invoice Statement is Printed.","type":"boolean"},"printedDate":{"description":"Invoice Statement Printed Date.","format":"date","maxLength":8,"type":"string"},"reference":{"description":"User-defined posting reference.","maxLength":2000,"minLength":0,"type":"string"},"remark":{"description":"User-defined posting remark.","maxLength":2000,"minLength":0,"type":"string"},"reservationId":{"$ref":"#/components/schemas/booking_crm_reservationId","description":"Reservation ID of the invoice."},"reservationInfo":{"$ref":"#/components/schemas/booking_crm_reservationInfoType","description":"Reservation guest details."},"revenueDate":{"description":"Revenue date ID of the invoice.","format":"date","maxLength":8,"type":"string"},"roomClass":{"$ref":"#/components/schemas/booking_crm_roomClassCodeInfoType","description":"Invoice room class code."},"source":{"$ref":"#/components/schemas/booking_crm_sourceCodeInfoType","description":"Invoice source code."},"statementNo":{"description":"Statementno of the invoice.","type":"integer"},"status":{"description":"Status of the invoice.","maxLength":20,"minLength":0,"type":"string"},"storedDebitFolioId":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type","description":"ID of the Stored Debit Folio."},"storedDebitFolioName":{"description":"Name of the Stored Debit Folio.","maxLength":2000,"minLength":0,"type":"string"},"storedFolioId":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type","description":"ID of the Stored Folio."},"storedFolioName":{"description":"Name of the Stored Folio.","maxLength":2000,"minLength":0,"type":"string"},"transactionCode":{"description":"Transaction code of the invoice.","maxLength":20,"minLength":0,"type":"string"},"transactionDate":{"description":"Transaction Date of the invoice.","format":"date","maxLength":8,"type":"string"},"transactionInfo":{"$ref":"#/components/schemas/booking_crm_trxInfoType","description":"Transaction information ."},"transactionNo":{"description":"Unique Transaction Identifier of the Invoice.","type":"number"},"transferDate":{"description":"Transfer date of the invoice.","format":"date","maxLength":8,"type":"string"},"transferredIn":{"type":"boolean"},"transferredOut":{"type":"boolean"}},"type":"object"},"booking_crm_aRInvoicesType":{"description":"A collection of AR Invoices.","items":{"$ref":"#/components/schemas/booking_crm_aRInvoiceType"},"maxItems":4000,"type":"array"},"booking_crm_aRPaymentType":{"description":"Details of an AR Payment.","properties":{"age":{"description":"The Aging age of the payment.","type":"integer"},"amount":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Amount of the Payment."},"amountUsed":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Total amount applied against an invoice."},"balance":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Amount still open which has not been applied against any invoice."},"cashierInfo":{"$ref":"#/components/schemas/booking_crm_cashierInfoType","description":"Cashier information. Contains Id and Name details of the cashier."},"hotelId":{"description":"Property code.","maxLength":20,"minLength":0,"type":"string"},"paymentCard":{"$ref":"#/components/schemas/booking_crm_resPaymentCardType","description":"Payment card details."},"postingDate":{"description":"Posting date of the invoice.","format":"date","maxLength":8,"type":"string"},"reference":{"description":"User-defined posting reference.","maxLength":2000,"minLength":0,"type":"string"},"remark":{"description":"User-defined posting remark.","maxLength":2000,"minLength":0,"type":"string"},"revenueDate":{"description":"Revenue date ID of the invoice.","format":"date","maxLength":8,"type":"string"},"sequenceNo":{"description":"When this PostingType is used to return the postings generated by a batch request, the sequence number is used to relate to the Request's sequence number.","type":"integer"},"transactionCode":{"description":"Transaction code of the Payment.","maxLength":20,"minLength":0,"type":"string"},"transactionDate":{"description":"Date of the Payment.","format":"date","maxLength":8,"type":"string"},"transactionNo":{"description":"Unique Transaction Identifier of the Payment.","type":"number"},"transferDate":{"description":"Transfer of the invoice.","format":"date","maxLength":8,"type":"string"},"transferredIn":{"type":"boolean"},"transferredOut":{"type":"boolean"}},"type":"object"},"booking_crm_aRPaymentsType":{"description":"A collection of AR Payments.","items":{"$ref":"#/components/schemas/booking_crm_aRPaymentType"},"maxItems":4000,"type":"array"},"booking_crm_aRYearViewInfoType":{"description":"Information regarding Year View balances for an account.","properties":{"totalOutstanding":{"$ref":"#/components/schemas/booking_crm_aRBalanceType","description":"The total debit and credit balance of the account."},"yearView":{"description":"The debit and credit balance per account.","items":{"$ref":"#/components/schemas/booking_crm_aRYearViewType"},"maxItems":4000,"type":"array"}},"type":"object"},"booking_crm_aRYearViewType":{"description":"Year information for an Year View.","properties":{"balanceInfo":{"$ref":"#/components/schemas/booking_crm_aRBalanceType","description":"The balance amounts for this date range. Contains the Debit Balance, Credit Balance and the Total Balance."},"dateRange":{"$ref":"#/components/schemas/booking_crm_dateRangeType","description":"The period start and end date."},"runningTotal":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"The running total balance for the date range."}},"type":"object"},"booking_crm_addressInfoType":{"description":"Provides address information.","properties":{"address":{"$ref":"#/components/schemas/booking_crm_addressType","description":"Address details for the profile."},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_addressSearchType":{"description":"Address Details such as city, state, country, postal code etc.","properties":{"cityName":{"description":"City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).","maxLength":40,"minLength":0,"type":"string"},"country":{"$ref":"#/components/schemas/booking_crm_countryNameType","description":"Country name (e.g., Ireland)."},"excludeNoCity":{"description":"When true indicates that only profiles with city will be fetched.","type":"boolean"},"postalCode":{"description":"Post Office Code number.","maxLength":15,"minLength":0,"type":"string"},"state":{"description":"State or Province name (e.g., Texas).","maxLength":20,"minLength":0,"type":"string"},"streetAddress":{"description":"First Line of Street Address. For profile search it matches the first Address line.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_addressType":{"description":"Provides address information.","properties":{"addressLine":{"description":"When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.","items":{"maxLength":80,"minLength":0,"type":"string"},"maxItems":4,"type":"array"},"barCode":{"description":"The postal barcode for the address.","maxLength":100,"minLength":0,"type":"string"},"cityExtension":{"description":"Post Office City Extension Code number. City Extension mainly used for UK addresses.","maxLength":20,"minLength":0,"type":"string"},"cityName":{"description":"City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).","maxLength":40,"minLength":0,"type":"string"},"country":{"$ref":"#/components/schemas/booking_crm_countryNameType","description":"Country name (e.g., Ireland)."},"county":{"description":"County or District Name (e.g., Fairfax). Currently this attribute is not used.","maxLength":20,"minLength":0,"type":"string"},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.","maxLength":200,"minLength":0,"type":"string"},"isValidated":{"description":"Indicator to define if the Address is validated by the Address Validation System.","type":"boolean"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"municipalityCode":{"description":"The Municipality code for the address.","maxLength":40,"minLength":0,"type":"string"},"postalCode":{"description":"Post Office Code number.","maxLength":15,"minLength":0,"type":"string"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"},"state":{"description":"State or Province name (e.g., Texas).","maxLength":20,"minLength":0,"type":"string"},"type":{"description":"Defines the type of address (e.g. home, business, other).","maxLength":20,"minLength":0,"type":"string"},"typeDescription":{"description":"Describes the type code","type":"string"},"updateReservations":{"description":"Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address.","type":"boolean"}},"type":"object"},"booking_crm_advanceCheckInType":{"description":"Information relating to Reservation's Advance Checked In state and Expected Time of Return","properties":{"advanceCheckedIn":{"description":"Indicates if the reservation is marked as Advance Checked In","type":"boolean"},"eTRComments":{"description":"ETR Comments","maxLength":2000,"minLength":0,"type":"string"},"expectedReturnTime":{"description":"Expected Return Time. Uses the hotel's time zone.","format":"date-time","type":"string"}},"type":"object"},"booking_crm_alienInfoType":{"description":"immigration/visa information of a foreign person.","properties":{"alienRegistrationNo":{"description":"Alien Registration Number.","type":"string"},"immigrationStatus":{"description":"Immigration Status on an Alien.","maxLength":40,"minLength":0,"type":"string"},"visaValidityType":{"description":"Visa Type of an Alien.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_anonymizationStatusType":{"description":"Guest has been anonymized.","enum":["Requested","Anonymized"],"type":"string"},"booking_crm_anonymizationType":{"description":"Provides information about guest's anonymization status.","properties":{"anonymizationDate":{"description":"Date and Time when the guest was anonymized.","format":"date-time","type":"string"},"anonymizationStatus":{"$ref":"#/components/schemas/booking_crm_anonymizationStatusType","description":"Status of anonymization such as Requested or Anonymized."}},"type":"object"},"booking_crm_articleInfoType":{"description":"Information regarding an article.","properties":{"articleCode":{"description":"Unique code of the article.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Description of the article.","maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel code to which the article belongs.","maxLength":20,"minLength":0,"type":"string"},"inactive":{"description":"Indicates whether the article is inactive or not.","type":"boolean"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"postIt":{"$ref":"#/components/schemas/booking_crm_articlePostItType","description":"Post it information of the article."},"price":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Default price of the article."},"transactionCode":{"description":"Transaction code to which the article belongs.","maxLength":20,"minLength":0,"type":"string"},"universalProductCode":{"description":"Unique Universal product code of the article.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_articlePostItType":{"description":"Post it information of an article.","properties":{"availableForPostIt":{"description":"Indicates whether the article is available for post it.","type":"boolean"},"color":{"$ref":"#/components/schemas/booking_crm_colorType","description":"Color indicator which is only configurable if article is available for post it."}},"type":"object"},"booking_crm_authorizationRuleType":{"description":"Configured rule for computing the amount to authorize.","properties":{"amount":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"The amount applicable to the authorization rule."},"code":{"description":"The authorization rule code.","pattern":"[0-9]{1,9}","type":"integer"},"percent":{"description":"A percentage value if the authorization rule is percentage based.","type":"number"}},"type":"object"},"booking_crm_awardId":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_basicEmailType":{"description":"Email address","maxLength":2000,"minLength":0,"type":"string"},"booking_crm_bedTaxReportingType":{"description":"This stores the information for Bed Tax Reporting. Mainly used in Maldives.","properties":{"taxRegistrationNo":{"description":"Tax Registration Number for Maldives Bed Tax Reporting.","type":"number"},"taxableDays":{"description":"Number of days for which the Maldives tax is applicable.","type":"integer"},"visaExpiryDate":{"description":"Visa Expiration Date used for Maldives Bed Tax Reporting","format":"date","maxLength":8,"type":"string"},"visaIssueDate":{"description":"Visa Issue Date used for Maldives Bed Tax Reporting.","format":"date","maxLength":8,"type":"string"},"visaNumber":{"description":"Visa number used for Maldives Bed Tax Reporting","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_benefitType":{"description":"Basic information about membership benefit.","properties":{"code":{"description":"Benefit code associated with a membership.","maxLength":20,"minLength":0,"type":"string"},"inactive":{"description":"Indicates whether membership benefit is active or inactive.","type":"boolean"},"message":{"description":"Processing message for membership benefit.","maxLength":4000,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_benefitsType":{"description":"Basic information about membership benefit.","items":{"$ref":"#/components/schemas/booking_crm_benefitType"},"maxItems":4000,"type":"array"},"booking_crm_billingPrivilegesType":{"description":"This stores the information for Bed Tax Reporting. Mainly used in Maldives.","properties":{"allowAutoCheckin":{"description":"Indicated if a new reservation should be created and automatically checked in whenever the room is checked out. Available for pseudo room types only.","type":"boolean"},"autoSettlement":{"description":"Indicates if the is a candidate for auto folio settlement.","type":"boolean"},"autoSettlementFreq":{"description":"The interval of days between each auto folio settlement.","type":"integer"},"autoSettlementType":{"description":"The folio settlement type for auto folio settlement.","maxLength":40,"minLength":0,"type":"string"},"creditLimitAutoPay":{"description":"Indicates if the reservation will be included in the Automatic Credit Limit Overages process and also be listed in the Credit Limit Overages screen results.","type":"boolean"},"directBillAuthorized":{"description":"If Direct bill is authorized this will hold User ID who authorized it.","type":"boolean"},"folioCloseDate":{"description":"Date when folio was closed. This works with PostStayCharging flag.","format":"date","maxLength":8,"type":"string"},"postStayCharging":{"description":"Indicates if the reservation has charging privileges after checkout.","type":"boolean"},"postingRestriction":{"description":"Flag used by interface program during check in.","type":"boolean"},"preStayCharging":{"description":"Indicates if the reservation has charging privileges before arrival.","type":"boolean"},"scheduledCheckout":{"description":"Indicates if the guest is scheduled for automatic check out.","type":"boolean"},"scheduledCheckoutTime":{"description":"Time of automatic check out if guest is schedule for automatic check out.","format":"date","maxLength":8,"type":"string"},"videoCheckout":{"description":"Indicates if the guest can do video checkout","type":"boolean"}},"type":"object"},"booking_crm_blockIdList":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type"},"maxItems":4000,"type":"array"},"booking_crm_cardNumberTypeType":{"description":"Simple type for indicating if credit card number is tokenized.","enum":["CardNumber","Token"],"type":"string"},"booking_crm_cardProcessingType":{"enum":["Eft","Manual"],"type":"string"},"booking_crm_cardReIssueType":{"description":"Request to re issue a new card.","enum":["Pending","NotApplicable","Requested"],"type":"string"},"booking_crm_cardTypeType":{"description":"This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.","enum":["Ab","Am","Ax","Cb","Dc","Ds","Dt","Ec","Er","Jc","Jl","Mc","Nb","So","St","Sw","Va","Xy","Zz","Cp","Cu"],"type":"string"},"booking_crm_cashierInfoType":{"description":"Cashier information. Contains Id and Name details of the cashier.","properties":{"cashierId":{"description":"Cashier Id of the Cashier.","type":"number"},"cashierName":{"description":"Cashier Name.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_changeRelationsType":{"description":"Detailed information regarding the changes made to relationships for the profile.","properties":{"id":{"description":"Relationship identifier.","maxLength":80,"minLength":0,"type":"string"},"relation":{"description":"Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).","maxLength":20,"minLength":0,"type":"string"},"relationDescription":{"description":"Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).","maxLength":200,"minLength":0,"type":"string"},"targetRelation":{"description":"Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).","maxLength":20,"minLength":0,"type":"string"},"targetRelationDescription":{"description":"Displays the description of the target relation(Target Profile).","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_characterUDFType":{"description":"Used to hold user defined field of Character/String Type.","properties":{"alternateName":{"description":"Label of user defined field used by vendors or customers.","maxLength":2000,"minLength":0,"type":"string"},"name":{"description":"Used to hold user defined field of Character Type. It is highly recommended to use UDFC01, UDFC02,...UDFC40 (Total 40) as Character/String UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Value of user defined field.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_characterUDFsType":{"description":"Used to hold collection of user defined fields of Character/String Type.","items":{"$ref":"#/components/schemas/booking_crm_characterUDFType"},"maxItems":4000,"type":"array"},"booking_crm_codeDescriptionType":{"description":"This contains a generic code and description information.","properties":{"code":{"description":"Code.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"description.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_colorType":{"description":"Color configuration type. This color configuration provides a visual category of entities.","enum":["Red","DarkRed","Green","DarkGreen","LightGreen","Orange","White","Yellow","DarkYellow","Purple","Brown","Gray","Aqua","Chocolate","Blue","LightBlue","DarkBlue","Cyan","DarkCyan","Magenta","DarkMagenta","Black"],"type":"string"},"booking_crm_commentInfoType":{"description":"Comment related to the profile/reservation.","properties":{"comment":{"$ref":"#/components/schemas/booking_crm_commentType","description":"Comment details for the comment. It will be empty in case of delete comment."},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.","maxLength":200,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_commentType":{"description":"An indication of a new paragraph for a sub-section of a formatted text message.","properties":{"actionDate":{"description":"Indicates at which date an action described in the comment must be taken.","format":"date","maxLength":8,"type":"string"},"actionType":{"description":"Specifies type of action described in the comments.","maxLength":20,"minLength":0,"type":"string"},"commentTitle":{"description":"Specifies Comment's Title.","maxLength":4000,"minLength":0,"type":"string"},"confidential":{"description":"When true, the comment may be confidential.","type":"boolean"},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.","maxLength":200,"minLength":0,"type":"string"},"hotelId":{"description":"If specified comment belongs to the Hotel, otherwise it is a global comment.","maxLength":20,"minLength":0,"type":"string"},"internal":{"description":"When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer.","type":"boolean"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"notificationLocation":{"description":"Notification Location associated with the Note.","maxLength":20,"minLength":0,"type":"string"},"overrideInternal":{"description":"When true, the note internal could be modified.","type":"boolean"},"protectDescription":{"description":"When true, the note title will be populated from the note type description and couldn't be modified.","type":"boolean"},"text":{"$ref":"#/components/schemas/booking_crm_formattedTextTextType","description":"Formatted text content."},"type":{"description":"Specifies type of the comment.","maxLength":20,"minLength":0,"type":"string"},"typeDescription":{"description":"Comment type Description.","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_commissionPaymentMethods":{"description":"Check","enum":["Cent","Eft","Chk"],"type":"string"},"booking_crm_commissionPayoutToType":{"enum":["TravelAgent","Source","TravelAgentSource","None"],"type":"string"},"booking_crm_communicationStatusType":{"description":"Enum to denote the Status of Readiness messages sent to Guest Devices.","enum":["Pending","Completed","Failed","Sent","Received","Cancelled","PendingAvailability"],"type":"string"},"booking_crm_companyInfoType":{"description":"Company Information of the Profile.","properties":{"department":{"description":"Department of the Profile.","maxLength":20,"minLength":0,"type":"string"},"legalCompany":{"description":"Legal Company.","maxLength":80,"minLength":0,"type":"string"},"position":{"description":"Business Title or Position of the profile.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_companyType":{"properties":{"alternateLanguage":{"description":"Alternate Language of the company.","maxLength":20,"minLength":0,"type":"string"},"alternateName":{"description":"Alternate Name of the Company. Mainly, it's the name of the company written in the Alternate Language.","maxLength":80,"minLength":0,"type":"string"},"blacklist":{"description":"This element tells if profile is blacklisted or not.","type":"boolean"},"businessLocale":{"description":"A jurisdiction(Territory) in which a company is authorized to do business.","maxLength":40,"minLength":0,"type":"string"},"businessTitle":{"description":"Business Title.","maxLength":80,"minLength":0,"type":"string"},"commissionCode":{"description":"Commission code of the company.","maxLength":20,"minLength":0,"type":"string"},"companyName":{"description":"Name of the company.","maxLength":40,"minLength":0,"type":"string"},"companyName2":{"description":"Second Name of the company.","maxLength":40,"minLength":0,"type":"string"},"companyName3":{"description":"Third Name of the company.","maxLength":40,"minLength":0,"type":"string"},"corporateIdType":{"description":"The type of corporate ID","maxLength":20,"minLength":0,"type":"string"},"creditRating":{"description":"Credit Rating of the company.","maxLength":20,"minLength":0,"type":"string"},"currencyCode":{"description":"The code specifying a monetary unit. Use ISO 4217, three alpha code.","maxLength":20,"minLength":0,"type":"string"},"currencySymbol":{"description":"The symbol for the currency, e.g, for currencyCode USD the symbol is $.","maxLength":10,"minLength":0,"type":"string"},"decimalPlaces":{"description":"Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).","type":"integer"},"iATAInfo":{"$ref":"#/components/schemas/booking_crm_iATAInfoType","description":"IATA Information of the profile."},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"longAccountName":{"description":"Large company name to be used in the Invoice/Credit Bill.","maxLength":512,"minLength":0,"type":"string"},"nationality":{"description":"Nationality code identification","maxLength":20,"minLength":0,"type":"string"},"nationalityDescription":{"description":"Nationality code description","maxLength":80,"minLength":0,"type":"string"},"vipDescription":{"description":"Description of the VIP status.","maxLength":2000,"minLength":0,"type":"string"},"vipStatus":{"description":"VIP status of the company.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_countryNameType":{"description":"Code for a country or a nationality.","properties":{"code":{"description":"Code for a country or a nationality.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Used for Character Strings, length 0 to 200.","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_currencyAmountType":{"description":"A monetary value expressed with a currency code.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"}},"type":"object"},"booking_crm_customerType":{"description":"Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.","properties":{"alienInfo":{"$ref":"#/components/schemas/booking_crm_alienInfoType","description":"Immigration/visa information of a foreign person."},"anonymization":{"$ref":"#/components/schemas/booking_crm_anonymizationType","description":"Provides information about the guest's anonymization status"},"birthCountry":{"$ref":"#/components/schemas/booking_crm_countryNameType","description":"Country of birth."},"birthDate":{"description":"Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format. When masked birthdate will be shown as 1800/01/01","format":"date","maxLength":8,"type":"string"},"birthDateMasked":{"description":"Indicates the date of birth as masked.","type":"string"},"birthPlace":{"description":"Place of birth.","maxLength":80,"minLength":0,"type":"string"},"blacklist":{"description":"This element tells if profile is blacklisted or not.","type":"boolean"},"businessTitle":{"description":"Business Title.","maxLength":80,"minLength":0,"type":"string"},"citizenCountry":{"$ref":"#/components/schemas/booking_crm_countryNameType","description":"Name of the (self-professed) country that is claimed for citizenship."},"companyInfo":{"$ref":"#/components/schemas/booking_crm_companyInfoType","description":"Company Information of the Profile."},"creditRating":{"description":"Credit Rating of the customer.","maxLength":20,"minLength":0,"type":"string"},"currencyCode":{"description":"The code specifying a monetary unit. Use ISO 4217, three alpha code.","maxLength":20,"minLength":0,"type":"string"},"currencySymbol":{"description":"The symbol for the currency, e.g, for currencyCode USD the symbol is $.","maxLength":10,"minLength":0,"type":"string"},"customerValue":{"description":"The supplier's ranking of the customer (e.g., VIP, numerical ranking).","maxLength":20,"minLength":0,"type":"string"},"decimalPlaces":{"description":"Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).","type":"integer"},"gender":{"description":"Identifies the profile gender code selected from Gender types List of values. Gender types LOV provides the values configured at gender configuration.","maxLength":20,"minLength":0,"type":"string"},"identifications":{"description":"List of identification of the customer.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"identificationInfo":{"description":"Collection of detailed information on the identification of the customer.","items":{"$ref":"#/components/schemas/booking_crm_identificationInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"legalCompany":{"description":"Name Of the company the individual is associated with.","maxLength":80,"minLength":0,"type":"string"},"nationality":{"description":"Nationality code identification","maxLength":20,"minLength":0,"type":"string"},"nationalityDescription":{"description":"Nationality code description","maxLength":80,"minLength":0,"type":"string"},"personName":{"description":"Detailed name information for the customer.","items":{"$ref":"#/components/schemas/booking_crm_personNameType"},"maxItems":5,"type":"array"},"privateProfile":{"description":"This element tells profile is property exclusive or not.","type":"boolean"},"profession":{"description":"Profession of a person.","maxLength":80,"minLength":0,"type":"string"},"vipDescription":{"description":"Description of the VIP status.","maxLength":2000,"minLength":0,"type":"string"},"vipStatus":{"description":"VIP status of the customer.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_customizedPrivacyCodesType":{"description":"Customized privacy codes and values","properties":{"code":{"description":"Configured and active profile correspondence code","maxLength":20,"minLength":0,"type":"string"},"value":{"default":false,"description":"Indicates code is enabled/disabled for the profile.","type":"boolean"}},"type":"object"},"booking_crm_dateRangeType":{"description":"Date Range with Start and End dates.","properties":{"end":{"description":"The ending value of the date range.","format":"date","maxLength":8,"type":"string"},"start":{"description":"The starting value of the date range.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_crm_dateTimeSpanType":{"description":"Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.","properties":{"endDateTime":{"format":"date-time","type":"string"},"startDateTime":{"format":"date-time","type":"string"}},"type":"object"},"booking_crm_dateUDFType":{"description":"Used to hold user defined field of Date Type.","properties":{"alternateName":{"description":"Label of user defined field used by vendors or customers.","maxLength":2000,"minLength":0,"type":"string"},"name":{"description":"Used to hold user defined field of Date Type. It is highly recommended to use UDFD01, UDFD02,...UDFN20 (Total 20) as Date UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Value of user defined field.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_crm_dateUDFsType":{"description":"Used to hold collection of user defined fields of Date Type.","items":{"$ref":"#/components/schemas/booking_crm_dateUDFType"},"maxItems":4000,"type":"array"},"booking_crm_directBillingType":{"description":"This is the preconfigured routing instruction type.","properties":{"aRNumber":{"description":"Hotel Code for which the details of direct billing is provided for a profile.","maxLength":20,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel Code for which the details of direct billing is provided for a profile.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_downgradeType":{"description":"Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace.","enum":["Grace","Never","Period"],"type":"string"},"booking_crm_eCertificateConsumeSourceType":{"description":"Indicates that OPERA E-Certificate is consumed by hotelPMS.","enum":["Central","Web","Hotel"],"type":"string"},"booking_crm_eCertificateConsumptionType":{"description":"E-Certificates details.","properties":{"authorizationCode":{"description":"Authorization code for consumption.","maxLength":100,"minLength":0,"type":"string"},"date":{"description":"Date the certificate was consumed.","format":"date","maxLength":8,"type":"string"},"email":{"description":"Email of the person who consumed the certificate.","maxLength":2000,"minLength":0,"type":"string"},"firstName":{"description":"First name of the person who consumed the certificate.","maxLength":40,"minLength":0,"type":"string"},"hotelId":{"description":"Property where certificate was consumed for.","maxLength":20,"minLength":0,"type":"string"},"locationType":{"description":"Consumption location type.","maxLength":20,"minLength":0,"type":"string"},"middleName":{"description":"Middle name of the person who consumed the certificate.","maxLength":40,"minLength":0,"type":"string"},"referenceId":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type","description":"Any reference like reservation no etc against which the certificate was consumed."},"serviceDate":{"description":"Date on which the service is due (arrival date in case of reservation).","format":"date","maxLength":8,"type":"string"},"source":{"$ref":"#/components/schemas/booking_crm_eCertificateConsumeSourceType","description":"Source of consumption."},"surname":{"description":"Last name of the person who consumed the certificate..","maxLength":40,"minLength":0,"type":"string"},"userName":{"description":"Application user who created the consumption.","maxLength":2000,"minLength":0,"type":"string"},"userNotes":{"description":"Any notes on the certificate entered at time of consumption.","maxLength":4000,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_eCertificateGenerationType":{"description":"E-Certificates details.","properties":{"generationDetail":{"description":"Reason for which e-certificate was generated.","maxLength":4000,"minLength":0,"type":"string"},"referenceValue":{"description":"Type of value that is in the certificate.valid values are membership_level.","maxLength":20,"minLength":0,"type":"string"},"ruleId":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type","description":"Key to identify the generation rule id."}},"type":"object"},"booking_crm_eCertificateInfoType":{"description":"E-Certificates details.","properties":{"awardCode":{"description":"Award type to which the certificate is linked to.","maxLength":20,"minLength":0,"type":"string"},"benefitSummary":{"description":"Summary of Benefits attached to this ECertificate.","maxLength":4000,"minLength":0,"type":"string"},"certificateType":{"description":"User defined certificate code.","maxLength":20,"minLength":0,"type":"string"},"cost":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Cost of certificate."},"description":{"description":"Description about the certificate.","maxLength":200,"minLength":0,"type":"string"},"hotels":{"description":"Hotel to which certificate is attached to.","properties":{"code":{"items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"scope":{"$ref":"#/components/schemas/booking_crm_eCertificateScopeType","description":"Scope of e-cert: global,single property or multi property."}},"type":"object"},"label":{"description":"Label for the certificate.","maxLength":40,"minLength":0,"type":"string"},"longDescription":{"description":"Detail description about the certificate.","maxLength":4000,"minLength":0,"type":"string"},"maxExtensionAllowed":{"description":"Number of times e-certificate can be extended.","type":"integer"},"membershipType":{"description":"Membership type to which the certificate is linked to.","maxLength":20,"minLength":0,"type":"string"},"promotionCode":{"description":"Promotion code to which certificate is attached to.","maxLength":20,"minLength":0,"type":"string"},"usageCriteria":{"$ref":"#/components/schemas/booking_crm_eCertificateUsageCriteriaType"},"value":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Value of the certificate for the guest."},"voucherBenefitCode":{"description":"Voucher benefit code attached to the certificate.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_eCertificateIssueSourceType":{"description":"Indicates that OPERA E-Certificate is issued by external system.","enum":["Opera","Web","Interface"],"type":"string"},"booking_crm_eCertificateIssueType":{"description":"Indicates that guest purchased OPERA E-Certificate.","enum":["Assigned","OptedIn","Purchased"],"type":"string"},"booking_crm_eCertificateScopeType":{"description":"Indicates that OPERA E-Certificate is available for a specific list of hotels.","enum":["Global","Hotel","MultiHotel"],"type":"string"},"booking_crm_eCertificateStatusType":{"description":"Indicates that OPERA E-Certificate is reserved.","enum":["Cancelled","Consumed","Deleted","Expired","Issued","Reserved"],"type":"string"},"booking_crm_eCertificateType":{"description":"E-Certificates details.","properties":{"awardId":{"$ref":"#/components/schemas/booking_crm_awardId","description":"AwardID."},"awardPoints":{"description":"Award points if any in case of certificate use membership award.","type":"integer"},"cancelRequestDate":{"description":"Date on which the cancellation was requested.","format":"date","maxLength":8,"type":"string"},"certificateId":{"description":"System generated unique certificate id.","type":"integer"},"certificateNo":{"description":"Printed certificate no. This has to be unique.","maxLength":40,"minLength":0,"type":"string"},"consumptionDetail":{"$ref":"#/components/schemas/booking_crm_eCertificateConsumptionType"},"databaseId":{"description":"External reference from which the record is created.","maxLength":20,"minLength":0,"type":"string"},"eCertificateInfo":{"$ref":"#/components/schemas/booking_crm_eCertificateInfoType"},"expiryDate":{"description":"Date of expiry.","format":"date","maxLength":8,"type":"string"},"extensionCount":{"description":"Number of times e-certificate is already extended.","type":"integer"},"generationDetail":{"$ref":"#/components/schemas/booking_crm_eCertificateGenerationType"},"inLieuSequence":{"description":"Seq of the in lieu of certificate. 1..n. original certificate will be treated as null = 0.","type":"integer"},"inactiveDate":{"description":"Date the record was marked as inactive.","format":"date","maxLength":8,"type":"string"},"issueDate":{"description":"Date when certificate was issued.","format":"date","maxLength":8,"type":"string"},"issueType":{"$ref":"#/components/schemas/booking_crm_eCertificateIssueType","description":"Process action issued the certificate. valid values are assigned (a),opt in (o) and purchased (p)."},"newExpiryDate":{"description":"New Date of expiry to extend e-certificate.","format":"date","maxLength":8,"type":"string"},"originalCertificateNo":{"description":"In case of in lieu of certificate this will contain the original certificate no.","maxLength":40,"minLength":0,"type":"string"},"originalVoucherNo":{"description":"In case of in lieu of certificate this will contain the original voucher no.","maxLength":40,"minLength":0,"type":"string"},"printed":{"description":"Print status of the certificate.","type":"boolean"},"profileId":{"$ref":"#/components/schemas/booking_crm_profileId","description":"NameId."},"source":{"$ref":"#/components/schemas/booking_crm_eCertificateIssueSourceType","description":"Source of e-certificate."},"status":{"$ref":"#/components/schemas/booking_crm_eCertificateStatusType","description":"Status of the certificate."},"voucherNo":{"description":"System generated unique voucher number.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_eCertificateUsageCriteriaType":{"description":"E-Certificates details.","properties":{"benefit":{"description":"Indicates to attach a rate code to the e-certificate as a benefit.","type":"boolean"},"cancelAllowed":{"description":"Identify if cancel is allowed or not.","type":"boolean"},"generateInLieuCertificate":{"description":"Identify if in lieu of certificate can be generated or not.","type":"boolean"},"hotel":{"description":"Indicates if web certificate can be consumed in hotel.","type":"boolean"},"reservation":{"description":"Indicates if certificate is to be used against reservation or not.","type":"boolean"},"verifyCertificateNo":{"description":"Specify if the certificate number verification is required at time of consumption or not.","type":"boolean"},"web":{"description":"Indicates if web certificate can be consumed in OWS.","type":"boolean"},"webAllowed":{"description":"Indicates if certificate consumption allowable on the web.","type":"boolean"}},"type":"object"},"booking_crm_eCertificatesType":{"description":"List of e-certificates for the profile.","items":{"$ref":"#/components/schemas/booking_crm_eCertificateType"},"maxItems":4000,"type":"array"},"booking_crm_emailInfoType":{"description":"Information on an email for the customer.","properties":{"email":{"$ref":"#/components/schemas/booking_crm_emailType","description":"eMail deatils for the profile."},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_emailType":{"description":"Information on an email for the customer.","properties":{"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.","maxLength":200,"minLength":0,"type":"string"},"emailAddress":{"description":"Defines the e-mail address.","maxLength":2000,"minLength":0,"type":"string"},"emailFormat":{"description":"Supported Email format.","type":"string"},"isValidated":{"description":"Indicator to define if the Email is validated by the Email Validation System.","type":"boolean"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"},"type":{"description":"Defines the purpose of the e-mail address (e.g. personal, business, listserve).","maxLength":20,"minLength":0,"type":"string"},"typeDescription":{"description":"Describes the Type code","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_facilityCodeType":{"description":"Facility Housekeeping Code, its description and quantity.","properties":{"code":{"description":"Facility code value.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Facility Code.","maxLength":80,"minLength":0,"type":"string"},"quantity":{"description":"Signifies the quantity.","type":"integer"}},"type":"object"},"booking_crm_facilityCodesType":{"description":"List of the facility codes.","items":{"$ref":"#/components/schemas/booking_crm_facilityCodeType"},"maxItems":4000,"type":"array"},"booking_crm_facilityTaskType":{"description":"Information regarding facility task on a reservation.","properties":{"date":{"description":"The Date on which the task is applicable.","format":"date","maxLength":8,"type":"string"},"supplies":{"$ref":"#/components/schemas/booking_crm_facilityCodesType","description":"Supplies associated with the task."},"task":{"$ref":"#/components/schemas/booking_crm_housekeepingTaskCodeType","description":"The Task Code."}},"type":"object"},"booking_crm_fixedChargeDetailType":{"description":"Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.","properties":{"article":{"$ref":"#/components/schemas/booking_crm_codeDescriptionType","description":"Holds related article code and description."},"chargeAmount":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Price of the product."},"percent":{"description":"Percentage of the rate amount.","maximum":100,"minimum":0,"type":"number"},"quantity":{"description":"Quantity of the product.","type":"integer"},"roomNights":{"description":"Holds number of comp or cash room night to allocate.","type":"integer"},"supplement":{"description":"Additional information regarding the fixed charge.","maxLength":2000,"minLength":0,"type":"string"},"transaction":{"$ref":"#/components/schemas/booking_crm_codeDescriptionType","description":"Transaction code and description of a fixed charge."}},"type":"object"},"booking_crm_fixedChargeFrequencyType":{"description":"Yearly.","enum":["O","D","W","M","Q","Y"],"type":"string"},"booking_crm_fixedChargeScheduleType":{"description":"Holds schedule of fixed charge.","properties":{"dateToExecute":{"description":"Date of when to execute yearly fixed charge. Applicable when frequency is Yearly.","format":"date","maxLength":8,"type":"string"},"dayToExecute":{"description":"Day of when to execute fixed charge. Applicable when frequency is Daily or Weekly.","maxLength":3,"minLength":0,"type":"string"},"end":{"description":"The ending value of the date range.","format":"date","maxLength":8,"type":"string"},"frequency":{"$ref":"#/components/schemas/booking_crm_fixedChargeFrequencyType","description":"Frequency of a fixed charge."},"start":{"description":"The starting value of the date range.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_crm_fixedChargeType":{"description":"Holds fixed charge information.","properties":{"charge":{"$ref":"#/components/schemas/booking_crm_fixedChargeDetailType","description":"Holds specific details of fixed charge."},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"schedule":{"$ref":"#/components/schemas/booking_crm_fixedChargeScheduleType","description":"Holds schedule of fixed charge."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_crm_fixedChargesType":{"description":"Holds fixed charge detail.","items":{"$ref":"#/components/schemas/booking_crm_fixedChargeType"},"maxItems":4000,"type":"array"},"booking_crm_folioStatusType":{"description":"The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.","enum":["Deposit","Void","Ok","Zero","Compress","Converted","Internal"],"type":"string"},"booking_crm_folioTextsType":{"description":"This stores the description for the type of tax calculation especially with tax exemption, etc.","items":{"properties":{"row":{"description":"Row number of the additional text.","type":"integer"},"text":{"description":"Additional text field to display on the folio.","maxLength":50,"minLength":0,"type":"string"}},"type":"object"},"maxItems":2,"type":"array"},"booking_crm_formattedTextTextType":{"description":"Provides text and indicates whether it is formatted or not.","properties":{"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"booking_crm_gdsNegotiatedInfoType":{"description":"This provides information for a channel negotiated rate.","properties":{"accessCode":{"description":"The GDS negotiated rate code.","maxLength":20,"minLength":0,"type":"string"},"end":{"description":"The ending value of the date range.","format":"date","maxLength":8,"type":"string"},"inactive":{"description":"The GDS Negotiated Rate is inactive or not","type":"boolean"},"order":{"description":"The sell order.","type":"integer"},"start":{"description":"The starting value of the date range.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_crm_gdsNegotiatedType":{"description":"This holds a list of GdsNegotiatedInfoType.","properties":{"bookingChannelCode":{"description":"Booking Channel Code.","maxLength":20,"minLength":0,"type":"string"},"channelRatePlanCode":{"description":"Channel Room Type.","maxLength":20,"minLength":0,"type":"string"},"gdsNegotiatedInfoList":{"description":"List of channel negotiated rates for the profile.","items":{"$ref":"#/components/schemas/booking_crm_gdsNegotiatedInfoType"},"maxItems":4000,"type":"array"},"hotelId":{"description":"Hotel Code.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_givenNameType":{"description":"Given name, first name or names","maxLength":40,"minLength":0,"type":"string"},"booking_crm_guestHousekeepingServiceRequestType":{"description":"Possible values for the Guest Service Status.","enum":["DoNotDisturb","MakeUpRoom","NoStatusSelected"],"type":"string"},"booking_crm_guestLastStayInfoType":{"description":"Contains last stay related details of the guest.","properties":{"lastStayDate":{"description":"Guest's last stay date.","format":"date","maxLength":8,"type":"string"},"lastStayRate":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"The Rate amount of the guest's last stay."},"lastStayRoom":{"description":"Room Number where the guest stayed.","maxLength":20,"minLength":0,"type":"string"},"totalStay":{"description":"The total number of previous stay of the guest.","type":"integer"}},"type":"object"},"booking_crm_hotelInterfaceStatusType":{"description":"Status of the Hotel Interface either STOPPED or RUNNING.","enum":["Stopped","Running","Waiting","StopInitiated","StartInitiated","RebootInitiated","Other"],"type":"string"},"booking_crm_hotelInterfaceType":{"properties":{"activeFlag":{"description":"Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.","type":"boolean"},"hotelId":{"description":"Hotel Code","maxLength":20,"minLength":0,"type":"string"},"interfaceId":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type","description":"Unique DB internal number of a Hotel Interface record."},"interfaceName":{"description":"Name of the Hotel Interface","maxLength":40,"minLength":0,"type":"string"},"interfaceType":{"$ref":"#/components/schemas/booking_crm_hotelInterfaceTypeType","description":"Three letter code for each interface that identifies the interface."},"logo":{"description":"Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.","maxLength":20,"minLength":0,"type":"string"},"machineName":{"description":"Unique machine name of the running IFC.","maxLength":80,"minLength":0,"type":"string"},"status":{"$ref":"#/components/schemas/booking_crm_hotelInterfaceStatusType","description":"The current status of the IFC."}},"type":"object"},"booking_crm_hotelInterfaceTypeType":{"description":"XML Posting Interface","enum":["Bms","Cas","Ccw","Dls","Eft","Exp","Mak","Mbs","Msc","Pbx","Pos","Svs","Tik","Vid","Vms","Www","Xml"],"type":"string"},"booking_crm_housekeepingRoomStatusType":{"description":"Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.","enum":["Clean","Dirty","Pickup","Inspected","OutOfOrder","OutOfService"],"type":"string"},"booking_crm_housekeepingTaskCodeType":{"description":"Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.","properties":{"code":{"description":"The Code for the task.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Description of the Task Code.","maxLength":80,"minLength":0,"type":"string"},"facilityDepartureTask":{"description":"Indicates if this task code is the default departure task for Facility Tasks. This requires","type":"boolean"},"hotelId":{"description":"Property where this task code is configured.","maxLength":20,"minLength":0,"type":"string"},"instructions":{"description":"Instructions for this Task Code.","maxLength":2000,"minLength":0,"type":"string"},"linenChange":{"description":"Indicates if a linen change is necessary.","type":"boolean"},"sequence":{"description":"Ordering sequence for display.","type":"integer"}},"type":"object"},"booking_crm_iATAInfoType":{"description":"IATA Information of the profile.","properties":{"iATACompany":{"description":"IATA Company Detail.","maxLength":20,"minLength":0,"type":"string"},"iATAConsortia":{"description":"IATA Consortia.","maxLength":40,"minLength":0,"type":"string"},"iATAValidationResult":{"description":"IATA Validation Result.","type":"boolean"}},"type":"object"},"booking_crm_identificationInfoType":{"description":"Information on the identification of the customer.","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"identification":{"$ref":"#/components/schemas/booking_crm_identificationType","description":"Detailed information on the identification of the customer."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_identificationType":{"description":"Identification information of the customer.","properties":{"expirationDate":{"description":"Expiration date of Identification.","format":"date","maxLength":8,"type":"string"},"idNumber":{"description":"Identification Number.","maxLength":80,"minLength":0,"type":"string"},"idNumberMasked":{"description":"Masked Identification Number.","maxLength":80,"minLength":0,"type":"string"},"idType":{"description":"Identification Type. Eg Passport, Driving License etc.","maxLength":40,"minLength":0,"type":"string"},"issuedCountry":{"description":"The country where Identification was issued.","maxLength":20,"minLength":0,"type":"string"},"issuedDate":{"description":"Issued date of Identification.","format":"date","maxLength":8,"type":"string"},"issuedPlace":{"description":"The place where Identification was issued.","maxLength":80,"minLength":0,"type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"},"registeredProperty":{"description":"Property where the identification belongs to.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_imageSetType":{"description":"Represents on image set record.","properties":{"chainCode":{"description":"The image set chain code.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"The image set description.","maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"description":"The image set hotel code.","maxLength":20,"minLength":0,"type":"string"},"imageOrder":{"description":"The image set order.","type":"integer"},"imageSet":{"description":"The image set name.","maxLength":800,"minLength":0,"type":"string"},"imageStyle":{"$ref":"#/components/schemas/booking_crm_imageStyleType","description":"The image set enumerated style."},"imageType":{"description":"The image set type.","maxLength":80,"minLength":0,"type":"string"},"imageURL":{"description":"The image set URL.","maxLength":2000,"minLength":0,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"sequenceId":{"description":"The image set sequence ID.","type":"integer"},"website":{"description":"The image set website.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_imageStyleType":{"description":"An enumeration of image styles.","enum":["Full","Thumbnail","Icon","Square","Banner","Button","Lowres","Highres"],"type":"string"},"booking_crm_indicatorType":{"description":"Lamp indicator Type.","properties":{"count":{"description":"Indicates number of occurrences of the indicator.","type":"integer"},"indicatorName":{"description":"Name of the indicator.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_indicatorsType":{"description":"Collection of lamp indicators.","items":{"$ref":"#/components/schemas/booking_crm_indicatorType"},"maxItems":4000,"type":"array"},"booking_crm_instanceLink":{"description":"Metadata describing link description objects that MAY appear in the JSON instance representation.","properties":{"href":{"description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.","type":"string"},"method":{"description":"HTTP method for requesting the target of the link.","enum":["GET","POST","PUT","DELETE","PATCH","OPTIONS","HEAD"],"type":"string"},"operationId":{"description":"The operationId of the path you can call to follow this link.  This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.","type":"string"},"rel":{"description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.","type":"string"},"targetSchema":{"description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..","type":"string"},"templated":{"default":false,"description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.","type":"boolean"},"title":{"description":"Exact copy of the \"summary\" field on the linked operation.","type":"string"}},"type":"object"},"booking_crm_interfaceRightsStatusType":{"properties":{"category":{"description":"Category code of this interface right.","maxLength":1,"minLength":0,"type":"string"},"description":{"description":"User defined description for an Interface Right.","maxLength":80,"minLength":0,"type":"string"},"right":{"description":"Internal code for each allowed right of a Hotel Interface record.","type":"integer"},"statusCode":{"description":"User defined code for an Interface Right.","maxLength":5,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_keywordDetailType":{"properties":{"newKeyword":{"description":"The new keyword value.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_keywordType":{"properties":{"keyword":{"description":"The keyword value.","maxLength":80,"minLength":0,"type":"string"},"keywordDetail":{"$ref":"#/components/schemas/booking_crm_keywordDetailType","description":"The keyword new value, in case keyword value is modified."},"type":{"description":"The type of keyword","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_lastStayInfoType":{"description":"Contains last stay related details for the profile","properties":{"lastRate":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Used to hold last rate information for the profile."},"lastRoom":{"description":"Used to hold last room information for the profile.","type":"string"},"lastVisit":{"description":"Used to hold last stay information for the profile.","format":"date","maxLength":8,"type":"string"},"totalStay":{"description":"The total number of previous stay of the profile.","type":"integer"}},"type":"object"},"booking_crm_links":{"items":{"$ref":"#/components/schemas/booking_crm_instanceLink"},"type":"array"},"booking_crm_mailingActionsType":{"description":"Defines mailing action list for the profile.","properties":{"active":{"description":"When true indicates that profile has subscribed to the mailing list.","type":"boolean"},"count":{"description":"Total number of rows returned","type":"integer"},"mailingAction":{"description":"Defines mailing action code and description.","items":{"$ref":"#/components/schemas/booking_crm_codeDescriptionType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"booking_crm_marketCodeInfoType":{"properties":{"description":{"maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"marketCode":{"maxLength":20,"minLength":0,"type":"string"},"marketGroup":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_masterAccountInfoType":{"properties":{"masterAccountId":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type","description":"Unique ID of the Master account."},"masterAccountName":{"description":"Name of the Master account.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_membershipEarningPreferenceType":{"description":"The earning preference of a membership, it depends on the type of property. eg. when the property is a airline it should be Miles, other than Points.","enum":["Points","Miles"],"type":"string"},"booking_crm_membershipInfoType":{"description":"The Membership object identifies the frequent customer reward program.","properties":{"accountId":{"description":"The account identification number for this particular member in this particular program.","maxLength":50,"minLength":0,"type":"string"},"bonusCode":{"description":"The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.)","maxLength":20,"minLength":0,"type":"string"},"membershipId":{"description":"Membership ID (Unique ID from the memberships table).","type":"number"},"membershipLevel":{"description":"The code or name of the membership level and indicates the level of membership (Gold Club, Platinum member, etc.). This is same as the BonusCode.","maxLength":20,"minLength":0,"type":"string"},"membershipLevelDesc":{"description":"The description of the Bonus Code.(Platinum for code P)","maxLength":2000,"minLength":0,"type":"string"},"membershipTypeDesc":{"description":"The description of the ProgramCode.(Delta Previlige for code DP)","maxLength":2000,"minLength":0,"type":"string"},"playerRanking":{"description":"Ranking assigned to the Player Profile by the Gaming system.","type":"integer"},"programCode":{"description":"The code or name of the membership program ('Hertz', 'AAdvantage', etc.).","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_namePrefixType":{"description":"Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.). Currently this attribute is not used for PUT and POST operations.","maxLength":40,"minLength":0,"type":"string"},"booking_crm_nameTypeType":{"enum":["Guest","Company","Agent","Contact","Source","Group","Employee","Hotel","Purge"],"type":"string"},"booking_crm_negotiatedInfoType":{"description":"This provides information for a profile negotiated rate.","properties":{"comissionCode":{"description":"Informational purposes only in numeric format.","maxLength":20,"minLength":0,"type":"string"},"corporateAgreementId":{"description":"The master identifier for multiple offices/locations under the same company profile. This is optional","maxLength":80,"minLength":0,"type":"string"},"end":{"description":"The ending value of the date range.","format":"date","maxLength":8,"type":"string"},"inactive":{"description":"Negotiated Rate is inactive or not","type":"boolean"},"order":{"description":"The sell order.","type":"integer"},"start":{"description":"The starting value of the date range.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_crm_negotiatedType":{"description":"This holds a list of NegotiatedInfoType.","properties":{"hotelId":{"description":"Hotel code for the negotiated rate.","maxLength":20,"minLength":0,"type":"string"},"negotiatedInfoList":{"items":{"$ref":"#/components/schemas/booking_crm_negotiatedInfoType"},"maxItems":4000,"type":"array"},"rateCode":{"description":"Rate plan code for the negotiated rate.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_numericUDFType":{"description":"Used to hold user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02,...UDFN40 (Total 40) as Numeric UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.","properties":{"alternateName":{"description":"Label of user defined field used by vendors or customers.","maxLength":2000,"minLength":0,"type":"string"},"name":{"description":"Name of user defined field.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Value of user defined field.","type":"number"}},"type":"object"},"booking_crm_numericUDFsType":{"description":"Used to hold collection of user defined fields of Numeric Type.","items":{"$ref":"#/components/schemas/booking_crm_numericUDFType"},"maxItems":4000,"type":"array"},"booking_crm_ownerType":{"description":"Generic type for information about an owner.","properties":{"department":{"$ref":"#/components/schemas/booking_crm_codeDescriptionType","description":"Department to which the owner belongs to."},"email":{"$ref":"#/components/schemas/booking_crm_emailInfoType","description":"Email information of the owner."},"hotel":{"$ref":"#/components/schemas/booking_crm_codeDescriptionType","description":"Hotel to which the owner belongs to."},"name":{"$ref":"#/components/schemas/booking_crm_personNameType","description":"Provides name information of the owner."},"ownerCode":{"description":"Unique Code to identify the owner.","maxLength":20,"minLength":0,"type":"string"},"phone":{"$ref":"#/components/schemas/booking_crm_telephoneInfoType","description":"Information on the telephone number of the owner."},"primary":{"description":"When true, this is a primary owner.","type":"boolean"},"profileId":{"$ref":"#/components/schemas/booking_crm_profileId","description":"Unique owner profile information."},"relationship":{"$ref":"#/components/schemas/booking_crm_codeDescriptionType","description":"Relationship of the owner within the profile or block."},"userId":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type","description":"Unique application user ID."},"userName":{"description":"Unique application user name of the owner.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_pMS_ResStatusType":{"description":"This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.","enum":["Reserved","Requested","NoShow","Cancelled","InHouse","CheckedOut","Waitlisted","DueIn","DueOut","Walkin","PendingCheckout"],"type":"string"},"booking_crm_paragraphType":{"description":"An indication of a new paragraph for a sub-section of a formatted text message.","properties":{"text":{"$ref":"#/components/schemas/booking_crm_formattedTextTextType","description":"Formatted text content."},"url":{"description":"A URL for this paragraph.","type":"string"}},"type":"object"},"booking_crm_payeeInfoType":{"description":"Payee information.","properties":{"payeeAccountInfo":{"$ref":"#/components/schemas/booking_crm_aRAccountShortInfoType","description":"AR account short info of the payee."},"payeeAddress":{"$ref":"#/components/schemas/booking_crm_addressInfoType","description":"Address of the payee."},"payeeAddressCount":{"description":"Payee multiple address count.","type":"integer"},"payeeId":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type","description":"Opera name id of the payee."},"payeeName":{"description":"Name of the payee.","maxLength":80,"minLength":0,"type":"string"},"payeeReferenceCurrency":{"description":"Reference currency of the payee.","maxLength":20,"minLength":0,"type":"string"},"payeeTaxNumber":{"description":"The tax number of the payee.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_personNameType":{"description":"This provides name information for a person.","properties":{"envelopeGreeting":{"description":"Envelope Greeting of the profile","type":"string"},"givenName":{"description":"Given name, first name or names.","maxLength":40,"minLength":0,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"middleName":{"description":"The middle name of the person name.","maxLength":40,"minLength":0,"type":"string"},"name2":{"description":"Maternal/paternal name of the guest, required only for the SPAIN country mode.","maxLength":40,"minLength":0,"type":"string"},"name3":{"description":"Maternal/paternal name of the guest, required only for the SPAIN country mode.","maxLength":40,"minLength":0,"type":"string"},"namePrefix":{"description":"Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.). Currently this attribute is not used for PUT and POST operations.","maxLength":40,"minLength":0,"type":"string"},"nameSuffix":{"description":"Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.). Currently this attribute is not used for PUT and POST operations.","maxLength":40,"minLength":0,"type":"string"},"nameTitle":{"description":"Degree or honors (e.g., Ph.D., M.D.)","maxLength":80,"minLength":0,"type":"string"},"nameTitleSuffix":{"description":"Title Suffix. Must be populated if ADVANCED_TITLE is on.","type":"integer"},"nameType":{"$ref":"#/components/schemas/booking_crm_personNameTypeType","description":"Type of name of the individual, such as former, nickname, alternate or alias name."},"salutation":{"description":"Salutation of the profile","type":"string"},"surname":{"description":"Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_personNameTypeType":{"description":"Person's name in an external system.","enum":["Primary","Alternate","Incognito","External","Phonetic"],"type":"string"},"booking_crm_phoneNumberType":{"description":"Phone number","maxLength":40,"minLength":0,"type":"string"},"booking_crm_pointsType":{"description":"The Redeem Points contains the number of points required to book a room type.","properties":{"awardsType":{"description":"Awards type for the award type rate code.","type":"string"},"points":{"description":"No of points required to book this Room Stay.","type":"integer"}},"type":"object"},"booking_crm_preferenceType":{"description":"Guest Preference details for the profile.","properties":{"copyToProfile":{"description":"Specifies whether to copy the reservation preference to the profile or not.","type":"boolean"},"description":{"description":"Preference Description for display purposes.","maxLength":2000,"minLength":0,"type":"string"},"excludedPreferencesCount":{"description":"Specifies the count of preferences excluded for the attached reservation preference.","type":"integer"},"global":{"description":"Whether this preference is property specific or not.","type":"boolean"},"hotels":{"description":"If specified preference belongs to the Hotels listed, otherwise it is a global preference.","items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"preferenceCode":{"maxLength":20,"minLength":0,"type":"string"},"preferenceValue":{"description":"Preference value for display purposes.","maxLength":200,"minLength":0,"type":"string"},"source":{"description":"Source of the preference.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_preferenceTypeType":{"description":"Preference details for the profile.","properties":{"availableQuantity":{"description":"Available quantity of preferences (maximum quantity - Existing preferences)per preference group.","type":"integer"},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.","maxLength":200,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"maxQuantity":{"description":"Maximum quantity of preferences allowed per preference group.","type":"integer"},"maxResortUsedQuantity":{"description":"Maximum quantity of preferences used by any resort per preference group.","type":"integer"},"preference":{"description":"Collection of Preferences for the profile.","items":{"$ref":"#/components/schemas/booking_crm_preferenceType"},"maxItems":4000,"type":"array"},"preferenceType":{"description":"Preference group code.","maxLength":20,"minLength":0,"type":"string"},"preferenceTypeDescription":{"description":"Preference group description.","type":"string"},"reservationPreference":{"description":"Whether this preference is reservation preference or not.","type":"boolean"},"sequence":{"description":"Preference Sequence.","type":"string"}},"type":"object"},"booking_crm_privacyInfoType":{"description":"Defines Privacy related information for the profile.","properties":{"allowEmail":{"description":"Indicates if the profile wishes to allow Email.","type":"boolean"},"allowPhone":{"description":"Indicates if the profile wishes to allow phone calls.","type":"boolean"},"allowSMS":{"description":"Indicates if the profile wishes to allow SMS.","type":"boolean"},"autoEnrollLoyaltyProgram":{"description":"Indicates if the profile wishes to be automatically enrolled in the property's loyalty program.","type":"boolean"},"customizedPrivacyCodes":{"description":"Customized privacy codes","items":{"$ref":"#/components/schemas/booking_crm_customizedPrivacyCodesType"},"maxItems":20,"type":"array"},"infoFromThirdParty":{"description":"Indicates if the profile is ok getting info from third parties.","type":"boolean"},"lastPrivacyPromptDate":{"description":"Indicate the last privacy prompt date of the guest.","format":"date","maxLength":8,"type":"string"},"marketResearchParticipation":{"description":"Indicates if the profile participates in market research.","type":"boolean"},"optInAutoEnrollmentMember":{"description":"Indicates if the profile wishes to opt in for Auto Enrolment Member.","type":"boolean"},"optInEmail":{"description":"Indicates if the profile wishes to opt in for Email.","type":"boolean"},"optInMailingList":{"description":"Indicates if the profile wishes to opt in for Mailing List.","type":"boolean"},"optInMarketResearch":{"description":"Indicates if the profile wishes to opt in for Market Research.","type":"boolean"},"optInPhone":{"description":"Indicates if the profile wishes to opt in for Phone.","type":"boolean"},"optInSms":{"description":"Indicates if the profile wishes to opt in for SMS.","type":"boolean"},"optInThirdParty":{"description":"Indicates if the profile wishes to opt in for Third Party.","type":"boolean"}},"type":"object"},"booking_crm_profileAccessType":{"properties":{"chainCode":{"description":"Indicates the Chain code where the profile was created","maxLength":200,"minLength":0,"type":"string"},"croCode":{"description":"Indicates the CRO code where the profile was created","maxLength":200,"minLength":0,"type":"string"},"hotelId":{"description":"Indicates the Hotel code where the profile was created","maxLength":200,"minLength":0,"type":"string"},"sharedLevel":{"$ref":"#/components/schemas/booking_crm_profileSharedLevelType","description":"Indicates whether the profile is shared at the following levels : global/property/CRO"}},"type":"object"},"booking_crm_profileCashieringType":{"description":"Contains cashiering related details for the profile","properties":{"arNoCentral":{"description":"Account Receivables Central Number.","maxLength":20,"minLength":0,"type":"string"},"autoFolioSettlementType":{"description":"Contains the auto folio settlement type for the profile.","maxLength":40,"minLength":0,"type":"string"},"currencyCode":{"description":"The code specifying a monetary unit. Use ISO 4217, three alpha code.","maxLength":20,"minLength":0,"type":"string"},"currencySymbol":{"description":"The symbol for the currency, e.g, for currencyCode USD the symbol is $.","maxLength":10,"minLength":0,"type":"string"},"decimalPlaces":{"description":"Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).","type":"integer"},"directBillingList":{"description":"Contains the direct billing related information for the profile.","items":{"$ref":"#/components/schemas/booking_crm_directBillingType"},"maxItems":4000,"type":"array"},"paymentDueDays":{"description":"Ability to define on the account, the number of days after which the invoice should be paid.","type":"integer"},"referenceCurrency":{"description":"Reference Currency.","maxLength":20,"minLength":0,"type":"string"},"taxPercent1":{"description":"Tax1 Percentage for Collecting Agent.","type":"integer"},"taxPercent2":{"description":"Tax2 Percentage for Collecting Agent.","type":"integer"},"taxPercent3":{"description":"Tax3 Percentage for Collecting Agent.","type":"integer"},"taxPercent4":{"description":"Tax4 Percentage for Collecting Agent.","type":"integer"},"taxPercent5":{"description":"Tax5 Percentage for Collecting Agent.","type":"integer"},"vATOffsetYN":{"description":"VAT Offset Flag.","maxLength":1,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_profileCommissionType":{"description":"This is the preconfigured routing instruction type.","properties":{"bankAccount":{"description":"Bank account used for the commission for a profile.","maxLength":20,"minLength":0,"type":"string"},"commissionCode":{"description":"commission Code for a profile.","maxLength":20,"minLength":0,"type":"string"},"currencyCode":{"description":"The code specifying a monetary unit. Use ISO 4217, three alpha code.","maxLength":20,"minLength":0,"type":"string"},"currencySymbol":{"description":"The symbol for the currency, e.g, for currencyCode USD the symbol is $.","maxLength":10,"minLength":0,"type":"string"},"decimalPlaces":{"description":"Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).","type":"integer"},"hotelId":{"description":"Hotel Code for the commission being used for a profile.","maxLength":20,"minLength":0,"type":"string"},"paymentMethod":{"$ref":"#/components/schemas/booking_crm_commissionPaymentMethods","description":"Type of payment associated with the bank account."}},"type":"object"},"booking_crm_profileDeliveryMethod":{"description":"Delivery Information type to the profile.","properties":{"deliveryId":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type","description":"Delivery ID. It will be empty in case of new delivery method."},"deliveryModule":{"$ref":"#/components/schemas/booking_crm_profileDeliveryModuleType","description":"Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc.."},"deliveryType":{"description":"Delivery type can have a value EMAIL, ELECTRONIC etc and it depends on the parameter set in OPERA Control.","maxLength":20,"minLength":0,"type":"string"},"deliveryValue":{"description":"Delivery value holds the corresponding value of the delivery type..","maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"description":"Property that has delivery methods configured.","maxLength":20,"minLength":0,"type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"}},"type":"object"},"booking_crm_profileDeliveryModuleType":{"description":"Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..","enum":["EfolioExport"],"type":"string"},"booking_crm_profileId":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_profileIdList":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type"},"maxItems":4000,"type":"array"},"booking_crm_profileInfoType":{"description":"Provides information about attached profiles to the block.","properties":{"city":{"description":"City for the profile attached to the block.","maxLength":80,"minLength":0,"type":"string"},"name":{"description":"Name for the profile attached to the block.","maxLength":200,"minLength":0,"type":"string"},"phone":{"description":"Phone for the profile attached to the block.","maxLength":80,"minLength":0,"type":"string"},"profileId":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type","description":"Opera ID for the profile attached to the block."},"type":{"description":"Defines the type of Linked profiles for a block.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_profileMembershipType":{"description":"Detailed information of the memberships.","properties":{"autoPopulateFromName":{"default":"false","description":"Automatically populate membership number based on profile name.","type":"boolean"},"benefits":{"$ref":"#/components/schemas/booking_crm_benefitsType","description":"benefits for the membership."},"centralSetup":{"description":"Indicates how the award points for this membership type will be managed.","type":"boolean"},"comment":{"$ref":"#/components/schemas/booking_crm_paragraphType","description":"Additional comments regarding to the membership."},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.","maxLength":200,"minLength":0,"type":"string"},"currentPoints":{"description":"Profile MemberShip Points.","type":"number"},"downgrade":{"$ref":"#/components/schemas/booking_crm_downgradeType","description":"Defines how downgrading will be handled for this membership."},"downgradeDescription":{"description":"Indicates information regarding the member's possible downgrades.","maxLength":32000,"minLength":0,"type":"string"},"earningPreference":{"$ref":"#/components/schemas/booking_crm_membershipEarningPreferenceType","description":"Earning preference to the membership."},"effectiveDate":{"description":"Indicates the starting date.","format":"date","maxLength":8,"type":"string"},"enrollmentResort":{"description":"Resort/CRO where enrollment is done.","maxLength":20,"minLength":0,"type":"string"},"enrollmentSource":{"description":"The source from which a profile is enrolled. If not specified when adding a membership to a profile, the value defaults to the 'Default Enrollment Source' setting in the OPERA Control.","maxLength":20,"minLength":0,"type":"string"},"excludeFromBatch":{"description":"True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false.","type":"boolean"},"expireDate":{"description":"Indicates the ending date.","format":"date","maxLength":8,"type":"string"},"expireDateExclusiveIndicator":{"description":"When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).","type":"boolean"},"inactive":{"description":"Indicates whether membership is active or inactive.","type":"boolean"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"memberStatus":{"description":"Indicates where the guest is in the membership enrollment process.","maxLength":20,"minLength":0,"type":"string"},"membershipClass":{"description":"Indicates the membership class.","type":"string"},"membershipEnrollmentCode":{"description":"Indicates how the guest enrolled in the program.","maxLength":20,"minLength":0,"type":"string"},"membershipId":{"description":"Card Number of the membership.","type":"string"},"membershipIdNo":{"description":"Membership ID Number.","type":"integer"},"membershipLevel":{"description":"Indicates the membership level.","type":"string"},"membershipLevelDescription":{"description":"Indicates the membership level description.","maxLength":200,"minLength":0,"type":"string"},"membershipType":{"description":"Type of membership.","type":"string"},"nameOnCard":{"description":"Name to be displayed on the membership card.","type":"string"},"newMembershipNumber":{"description":"Card Number of the membership.","type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"playerRanking":{"description":"Ranking assigned to the Player Profile by the Gaming system.","type":"integer"},"pointsLabel":{"description":"Label used to refer to points for this membership type","maxLength":20,"minLength":0,"type":"string"},"preferredCard":{"description":"Preferred Card.","type":"boolean"},"primaryMembership":{"description":"Indicator that implies if membership type is a Primary Membership Type. This attribute is only applicable when fetching information using get operations and not used in post and put operations.","type":"boolean"},"primaryMembershipYn":{"description":"Indicator if Membership is a Primary Membership.","maxLength":1,"minLength":0,"type":"string"},"programDescription":{"description":"Description of the membership program.","type":"string"},"rating":{"description":"Value Rating Type Description for this membership.","type":"string"},"reIssueNewCard":{"$ref":"#/components/schemas/booking_crm_cardReIssueType","description":"The status of issuing new membership card to the member."},"referredByDisplayName":{"description":"Display name this profile was referred by.","maxLength":200,"minLength":0,"type":"string"},"referredByMembershipNameId":{"description":"Name id this profile was referred by.","type":"integer"},"signupDate":{"description":"Indicates when the member signed up for the loyalty program.","format":"date","maxLength":8,"type":"string"},"tierAdministration":{"$ref":"#/components/schemas/booking_crm_tierAdministrationType","description":"Defines the degree of participation for this membership in the tier management portion of the program."},"upgradeDescription":{"description":"Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.","maxLength":32000,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_profileRelationships":{"properties":{"links":{"$ref":"#/components/schemas/booking_crm_links"},"relationships":{"$ref":"#/components/schemas/booking_crm_relationshipsSummary","description":"Contains a collection of profiles that have a relationship with this profile."},"warnings":{"$ref":"#/components/schemas/booking_crm_warningsType"}},"type":"object"},"booking_crm_profileRestrictions":{"properties":{"reason":{"description":"Restriction reason associated with the current profile.","maxLength":20,"minLength":0,"type":"string"},"reasonDescription":{"description":"Description of restriction reason.","maxLength":2000,"minLength":0,"type":"string"},"restricted":{"description":"True indicates there are restrictions associated with the current profile.","type":"boolean"}},"type":"object"},"booking_crm_profileSharedLevelType":{"description":"Simple types for Shared level.","enum":["Global","Property","Cro"],"type":"string"},"booking_crm_profileStatusType":{"enum":["Active","Inactive"],"type":"string"},"booking_crm_profileSubscriptionListType":{"description":"Details of the OPERA Profile subscription to external system","items":{"$ref":"#/components/schemas/booking_crm_profileSubscriptionType"},"maxItems":4000,"type":"array"},"booking_crm_profileSubscriptionType":{"description":"Contains details of the profile subscription. The subscription represents the link between the OPERA profile and the external profile within a particular external system","properties":{"distributed":{"description":"Indicates if the profile was distributed to the external system.","type":"boolean"},"externalProfileId":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type","description":"Profile ID within the external system."},"externalResort":{"description":"This provides external resort for external profiles","maxLength":20,"minLength":0,"type":"string"},"force":{"description":"Indicates if the profile information should be overwritten by the external system.","type":"boolean"},"inactive":{"description":"Indicates whether this subscription is active or inactive.","type":"boolean"},"lastDistributionDate":{"description":"Timestamp of the most recent distribution of this profile to the external system.","format":"date-time","type":"string"},"lastExternalUpdateDate":{"description":"Timestamp of the most recent update of the subscription information by the external system.","format":"date-time","type":"string"},"profileId":{"$ref":"#/components/schemas/booking_crm_profileId","description":"OPERA Profile ID that this subscription record corresponds to."},"profileInfo":{"description":"This provides name information for a person.","properties":{"fullName":{"description":"Full display Name.","maxLength":200,"minLength":0,"type":"string"},"givenName":{"description":"Given name, first name or names.","maxLength":40,"minLength":0,"type":"string"},"middleName":{"description":"The middle name of the person name.","maxLength":40,"minLength":0,"type":"string"},"name":{"description":"Family name, last name or Company Name.","maxLength":40,"minLength":0,"type":"string"},"namePrefix":{"description":"Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.). Currently this attribute is not used for PUT and POST operations.","maxLength":40,"minLength":0,"type":"string"},"nameSuffix":{"description":"Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.). Currently this attribute is not used for PUT and POST operations.","maxLength":40,"minLength":0,"type":"string"},"nameTitle":{"description":"Degree or honors (e.g., Ph.D., M.D.)","maxLength":80,"minLength":0,"type":"string"},"nameType":{"$ref":"#/components/schemas/booking_crm_personNameTypeType","description":"Type of name of the individual, such as former, nickname, alternate or alias name."},"profileType":{"$ref":"#/components/schemas/booking_crm_profileTypeType","description":"OPERA profile type such as Individual or Company"}},"type":"object"},"subscriptionDate":{"description":"Timestamp when the profile was subscribed to.","format":"date-time","type":"string"},"systemCode":{"description":"Code of system where profile is subscribed to.","maxLength":40,"minLength":0,"type":"string"},"systemType":{"description":"Type of system where profile is subscribed to.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_profileTaxInfoType":{"description":"Profile information related to tax.","properties":{"businessId":{"description":"Business ID. The maximum length of this element should not exceed 120 characters.","maxLength":128,"minLength":0,"type":"string"},"businessRegistration":{"description":"Business Registration Code. The maximum length of this element should not exceed 120 characters.","maxLength":128,"minLength":0,"type":"string"},"tax1No":{"description":"The tax id of this profile. Usually issued by a government agency. Used by 1099 printing.","maxLength":40,"minLength":0,"type":"string"},"tax2No":{"description":"Tax 2 id of this profile.","maxLength":40,"minLength":0,"type":"string"},"taxCategory":{"description":"Tax Category to be changed.","maxLength":20,"minLength":0,"type":"string"},"taxOffice":{"description":"Tax Office to be changed.","maxLength":30,"minLength":0,"type":"string"},"taxType":{"description":"Tax type to be changed.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_profileType":{"description":"Type provides the detailed information about the profile and its children.","properties":{"addresses":{"description":"List of customer addresses.","properties":{"addressInfo":{"description":"Collection of Detailed information on an address for the customer.","items":{"$ref":"#/components/schemas/booking_crm_addressInfoType"},"maxItems":4000,"type":"array"},"count":{"description":"Total number of rows returned","type":"integer"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"businessSegments":{"description":"Business/Market Segment associated to the profile.","items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"cashiering":{"$ref":"#/components/schemas/booking_crm_profileCashieringType","description":"Contains cashiering related details for the profile"},"comments":{"description":"List of Notes for the customer.","properties":{"commentInfo":{"description":"Collection of Detailed information on comments for the customer.","items":{"$ref":"#/components/schemas/booking_crm_commentInfoType"},"maxItems":4000,"type":"array"},"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"commissionInfoList":{"description":"Contains commission related details for the profile.","items":{"$ref":"#/components/schemas/booking_crm_profileCommissionType"},"maxItems":4000,"type":"array"},"company":{"$ref":"#/components/schemas/booking_crm_companyType","description":"Detailed company information for this profile."},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.","maxLength":200,"minLength":0,"type":"string"},"customer":{"$ref":"#/components/schemas/booking_crm_customerType","description":"Detailed customer information for this profile."},"eCertificates":{"$ref":"#/components/schemas/booking_crm_eCertificatesType","description":"E-Certificate assosiated with the profile."},"eligibleForFiscalFolio":{"description":"Eligible for Fiscal Folio/Payload generation.","maxLength":20,"minLength":0,"type":"string"},"emails":{"description":"List of email address for the customer.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"emailInfo":{"description":"Collection of Detailed information on an eMail address for the customer.","items":{"$ref":"#/components/schemas/booking_crm_emailInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"fiscalGuestType":{"description":"Fiscal Guest Type is used for Fiscal Folio funcionality","maxLength":20,"minLength":0,"type":"string"},"flexFieldExternalProfileId":{"description":"Unique Identifier of the Profile on the External System that would be fetched against flexFieldExternalProfileId. (For internal use only).","maxLength":80,"minLength":0,"type":"string"},"gdsNegotiatedRates":{"description":"List of channel negotiated rates that this profile has been assigned to.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"gdsNegotiatedRate":{"description":"Collection of Detailed information on channel negotiated rates for the profile.","items":{"$ref":"#/components/schemas/booking_crm_gdsNegotiatedType"},"maxItems":4000,"type":"array"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"hasCommission":{"description":"Populates true if the profile has commission configured false otherwise.","type":"boolean"},"inactiveReason":{"description":"Inactive reason associated with the current profile.","maxLength":20,"minLength":0,"type":"string"},"influenceCode":{"description":"Influence Code associated to the profile.","maxLength":40,"minLength":0,"type":"string"},"inheritedNegRates":{"description":"Flag to indicate if the negotiated rates are inherited from master profile. Flag is available only when the profile is linked to master profile and master profile has negotiated rate codes attached.","type":"boolean"},"internalFolio":{"description":"Flag considered during folio settlement, to select the corresponding Folio Type when the value is true. Only used in Poland country mode.","type":"boolean"},"keywords":{"description":"List of customer keywords.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"keyword":{"description":"Collection of keywords attached to the profile.","items":{"$ref":"#/components/schemas/booking_crm_keywordType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"lastStayInfo":{"$ref":"#/components/schemas/booking_crm_lastStayInfoType","description":"Information on last stay of the profile."},"localizationGuestType":{"description":"Localization Guest Type assocaited to the profile.","maxLength":20,"minLength":0,"type":"string"},"mailingActions":{"$ref":"#/components/schemas/booking_crm_mailingActionsType","description":"Contains collection of mailing action list associated with the profile"},"markAsRecentlyAccessed":{"description":"Mark this profile as recently accessed.","type":"boolean"},"markForHistory":{"description":"\"true\" setting marks the profile to be kept from being purged, once the profile is marked inactive.","type":"boolean"},"negotiatedRates":{"description":"List of profile negotiated rates.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"negotiatedRate":{"description":"Collection of Detailed information on profile negotiated rates.","items":{"$ref":"#/components/schemas/booking_crm_negotiatedType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"ownerCode":{"description":"Owner Code associated to the profile.","maxLength":40,"minLength":0,"type":"string"},"preferenceCollection":{"description":"List of customer preferences.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"preferenceType":{"description":"Collection of Detailed information on preferences of the customer.","items":{"$ref":"#/components/schemas/booking_crm_preferenceTypeType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"privacyInfo":{"$ref":"#/components/schemas/booking_crm_privacyInfoType","description":"Contains privacy related information associated with the profile"},"profileAccessType":{"$ref":"#/components/schemas/booking_crm_profileAccessType","description":"Detailed information on access type associated with the profile."},"profileAccounts":{"$ref":"#/components/schemas/booking_crm_aRAccountsType","description":"Response of profile accounts."},"profileDeliveryMethods":{"description":"List of Delivery methods configured against a Property for this Profile.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"profileDeliveryMethod":{"description":"Collection of delivery methods for this Profile.","items":{"$ref":"#/components/schemas/booking_crm_profileDeliveryMethod"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"profileImage":{"$ref":"#/components/schemas/booking_crm_imageSetType","description":"The profile image."},"profileIndicators":{"$ref":"#/components/schemas/booking_crm_indicatorsType","description":"Indicators of additional information attached to the profile"},"profileMemberships":{"description":"List of loyalty program(s) the profile is subscribed to.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"profileMembership":{"description":"Collection of Detailed information on memberships for the customer.","items":{"$ref":"#/components/schemas/booking_crm_profileMembershipType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"profileRestrictions":{"$ref":"#/components/schemas/booking_crm_profileRestrictions","description":"Detailed information on restrictions associated with the profile."},"profileType":{"$ref":"#/components/schemas/booking_crm_profileTypeType","description":"Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact."},"protectedBy":{"description":"What level this profile is protected.","maxLength":40,"minLength":0,"type":"string"},"registeredProperty":{"description":"Hotel which this profile is registered with. This attribute is not used for configuration.","maxLength":20,"minLength":0,"type":"string"},"relationships":{"description":"Contains a collection of profiles that have a relationship with this profile.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"relationship":{"description":"A collection of the profiles that have a relationship with this profile.","items":{"$ref":"#/components/schemas/booking_crm_relationshipInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"relationshipsSummary":{"description":"Contains a collection of profiles that have a relationship with this profile.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"relationship":{"description":"A collection of the profiles summary that have a relationship with this profile.","items":{"$ref":"#/components/schemas/booking_crm_relationshipInfoSummaryType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"requestForHotel":{"description":"Hotel which this profile is to be registered. This attribute is only used during creation of profile.","maxLength":20,"minLength":0,"type":"string"},"roomOwnershipsList":{"description":"Room Ownership records.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"roomOwnershipInfo":{"description":"Collection of Detailed information on Room Ownership records.","items":{"$ref":"#/components/schemas/booking_crm_roomOwnershipType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"salesInfo":{"$ref":"#/components/schemas/booking_crm_salesInfoType","description":"Sales information of the profiles."},"showInactiveRoomOwners":{"description":"Flag to show inactive Room Owners.","type":"boolean"},"statusCode":{"$ref":"#/components/schemas/booking_crm_profileStatusType","description":"Status of the profile. Active/Inactive"},"stayReservationInfoList":{"$ref":"#/components/schemas/booking_crm_reservationStayHistoryFutureInfoType","description":"Collection of Detailed information on history and future reservations associated with the profile."},"subscriptions":{"$ref":"#/components/schemas/booking_crm_profileSubscriptionListType","description":"List of profile subscriptions."},"taxInfo":{"$ref":"#/components/schemas/booking_crm_profileTaxInfoType","description":"Profile information about tax."},"telephones":{"description":"List of Telephone Number Information","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"telephoneInfo":{"description":"Collection of Detailed information on telephone/fax for the customer.","items":{"$ref":"#/components/schemas/booking_crm_telephoneInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"territory":{"description":"Territory associated to the profile.","maxLength":40,"minLength":0,"type":"string"},"traceCode":{"description":"Trace Code associated to the profile.","maxLength":40,"minLength":0,"type":"string"},"uRLs":{"description":"List of Information on a URL for the customer.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"totalResults":{"description":"Total number of rows queried","type":"integer"},"uRLInfo":{"description":"Collection of Detailed information on web url/address for the customer.","items":{"$ref":"#/components/schemas/booking_crm_uRLInfoType"},"maxItems":4000,"type":"array"}},"type":"object"},"userDefinedFields":{"$ref":"#/components/schemas/booking_crm_userDefinedFieldsType","description":"Collections of user defined fields."},"webUserAccounts":{"$ref":"#/components/schemas/booking_crm_webUserAccountsType","description":"List of Web User Accounts of the profile."}},"type":"object"},"booking_crm_profileTypeType":{"description":"The types of Profile handled by the web service.","enum":["Guest","Agent","Company","Group","Source","Employee","Hotel","Vendor","Contact","Purge","BusinessHeader","BillingAccount","Activity","Potential","Account"],"type":"string"},"booking_crm_promotionType":{"description":"Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.","properties":{"couponCode":{"description":"Promotion Coupon Code when promotion is setup to have a valid coupon code.","maxLength":40,"minLength":0,"type":"string"},"promotionCode":{"description":"Promotion code associated with the rate plan.","maxLength":20,"minLength":0,"type":"string"},"promotionName":{"description":"Promotion code Name associated with the rate plan.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_queueTextInfoType":{"description":"Information regarding the message sent to guest.","properties":{"sentBy":{"description":"User name of the user who sent message.","maxLength":40,"minLength":0,"type":"string"},"sentTime":{"description":"Time the text was last sent to the user. Uses database time zone.","format":"date-time","type":"string"}},"type":"object"},"booking_crm_relationshipAddressType":{"description":"Provides address information for a Relationship.","properties":{"addressLine":{"description":"When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.","items":{"maxLength":80,"minLength":0,"type":"string"},"maxItems":4,"type":"array"},"city":{"description":"City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).","maxLength":40,"minLength":0,"type":"string"},"country":{"description":"Country name (e.g., Ireland).","maxLength":200,"minLength":0,"type":"string"},"postalCode":{"description":"Post Office Code number.","maxLength":15,"minLength":0,"type":"string"},"state":{"description":"State or Province name (e.g., Texas).","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_relationshipInfoSummaryType":{"description":"RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.","properties":{"masterAccountDetails":{"$ref":"#/components/schemas/booking_crm_masterAccountInfoType","description":"Refer to Master Profile type document."},"relationshipID":{"description":"Relationship identifier.","maxLength":80,"minLength":0,"type":"string"},"relationshipProfile":{"$ref":"#/components/schemas/booking_crm_relationshipProfileSummaryType","description":"Refer to Relationship Profile Summary type document."},"sourceRelation":{"description":"Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).","maxLength":20,"minLength":0,"type":"string"},"sourceRelationDescription":{"description":"Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).","maxLength":200,"minLength":0,"type":"string"},"targetRelation":{"description":"Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).","maxLength":20,"minLength":0,"type":"string"},"targetRelationDescription":{"description":"Displays the description of the target relation(Target Profile).","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_relationshipInfoType":{"description":"Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.","properties":{"changeRelationship":{"$ref":"#/components/schemas/booking_crm_changeRelationsType","description":"Information about the changes in relationship for the profile"},"id":{"description":"Relationship identifier.","maxLength":80,"minLength":0,"type":"string"},"masterAccountInfo":{"$ref":"#/components/schemas/booking_crm_masterAccountInfoType","description":"Refer to Master Profile type document."},"relation":{"description":"Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).","maxLength":20,"minLength":0,"type":"string"},"relationDescription":{"description":"Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).","maxLength":200,"minLength":0,"type":"string"},"relationshipProfile":{"$ref":"#/components/schemas/booking_crm_relationshipProfileType","description":"Refer to Relationship Profile type document."},"targetRelation":{"description":"Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).","maxLength":20,"minLength":0,"type":"string"},"targetRelationDescription":{"description":"Displays the description of the target relation(Target Profile).","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_relationshipProfileSummaryType":{"properties":{"address":{"$ref":"#/components/schemas/booking_crm_relationshipAddressType","description":"Information on address details for the customer/company"},"companyName":{"description":"Name of the company.","maxLength":40,"minLength":0,"type":"string"},"customerName":{"description":"Name of the customer","maxLength":40,"minLength":0,"type":"string"},"emailAddress":{"description":"Defines the e-mail address.","maxLength":2000,"minLength":0,"type":"string"},"ownerCode":{"description":"Unique Code to identify the owner.","maxLength":20,"minLength":0,"type":"string"},"primary":{"description":"Indicates if this relationship is the primary relationship.","type":"boolean"},"primaryOwnerCode":{"description":"When true, this is a primary owner.","type":"boolean"},"profileIdList":{"$ref":"#/components/schemas/booking_crm_uniqueIDListType","description":"Original profile details for which the relationships was created"},"profileStatus":{"$ref":"#/components/schemas/booking_crm_profileStatusType","description":"Status of the profile. Active/Inactive"},"profileType":{"$ref":"#/components/schemas/booking_crm_profileTypeType","description":"Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact."},"telephoneNumber":{"description":"Telephone number assigned to a single location","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_relationshipProfileType":{"properties":{"address":{"$ref":"#/components/schemas/booking_crm_addressInfoType","description":"Information on address details for the customer/company"},"changeProfileIdList":{"$ref":"#/components/schemas/booking_crm_uniqueIDListType","description":"Updated/changed profile details for the relationships created"},"company":{"$ref":"#/components/schemas/booking_crm_companyType","description":"Detailed information of the Company."},"customer":{"$ref":"#/components/schemas/booking_crm_customerType","description":"Detailed information of the customer"},"email":{"$ref":"#/components/schemas/booking_crm_emailInfoType","description":"Information on email address for the customer/company"},"id":{"description":"Relationship identifier.","maxLength":80,"minLength":0,"type":"string"},"primary":{"description":"Indicates if this relationship is the primary relationship.","maxLength":20,"minLength":0,"type":"string"},"primaryOwner":{"$ref":"#/components/schemas/booking_crm_ownerType","description":"Primary Owner of the profile"},"profileIdList":{"$ref":"#/components/schemas/booking_crm_uniqueIDListType","description":"Original profile details for which the relationships was created"},"profileType":{"$ref":"#/components/schemas/booking_crm_profileTypeType","description":"Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact."},"statusCode":{"$ref":"#/components/schemas/booking_crm_profileStatusType","description":"Status of the profile. Active/Inactive"},"telephone":{"$ref":"#/components/schemas/booking_crm_telephoneInfoType","description":"Information on telephone details for the customer/company"},"uRLs":{"$ref":"#/components/schemas/booking_crm_uRLInfoType","description":"Information on web url/address for the customer/company"}},"type":"object"},"booking_crm_relationshipsSummary":{"description":"Contains details relationships related to a profile.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"relationship":{"description":"A collection of the profiles summary that have a relationship with this profile.","items":{"$ref":"#/components/schemas/booking_crm_relationshipInfoSummaryType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"booking_crm_resAccessRestrictionType":{"description":"Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.","enum":["Change","Cancel","ChangeOrCancel"],"type":"string"},"booking_crm_resAccompanyGuestInfoType":{"properties":{"firstName":{"description":"Given name, first name or names","type":"string"},"fullName":{"description":"String representation of the full name","type":"string"},"lastName":{"description":"Family name, last name.","type":"string"},"profileIdList":{"$ref":"#/components/schemas/booking_crm_profileIdList","description":"Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id."},"registrationCardNo":{"description":"Unique identifier of the police registration card number.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_resAccompanyGuestListType":{"description":"Collection of accompany guests","items":{"$ref":"#/components/schemas/booking_crm_resAccompanyGuestInfoType"},"maxItems":4000,"type":"array"},"booking_crm_resAttachedProfileListType":{"items":{"$ref":"#/components/schemas/booking_crm_resAttachedProfileType"},"maxItems":4000,"type":"array"},"booking_crm_resAttachedProfileType":{"properties":{"name":{"description":"Attached profile name","type":"string"},"profileIdList":{"$ref":"#/components/schemas/booking_crm_profileIdList","description":"Collection of unique profile identifiers"},"reservationProfileType":{"$ref":"#/components/schemas/booking_crm_resProfileTypeType"}},"type":"object"},"booking_crm_resCashieringType":{"description":"Cashiering Information for the reservation.","properties":{"bedTaxReporting":{"$ref":"#/components/schemas/booking_crm_bedTaxReportingType","description":"This stores the information for Bed Tax Reporting. Mainly used in Maldives."},"billingPrivileges":{"$ref":"#/components/schemas/booking_crm_billingPrivilegesType","description":"Billing privileges set on the reservation."},"compAccounting":{"$ref":"#/components/schemas/booking_crm_resCompAccountingType","description":"Information regarding comp accounting on the reservation."},"financiallyResponsible":{"description":"The guest from whom payment has to be recovered (direct guest).","type":"boolean"},"folioTexts":{"$ref":"#/components/schemas/booking_crm_folioTextsType","description":"Additional text fields to display on the folio."},"lastRoomAndTaxPostedDate":{"description":"Date of the last Room And Tax posting. Used primarily to know the date in case of Advance Billing.","format":"date","maxLength":8,"type":"string"},"periodicFolio":{"$ref":"#/components/schemas/booking_crm_resPeriodicFolioType","description":"Information regarding periodic folios set on the reservation."},"proratedBilling":{"description":"In case of Appartment style billing indicates whether a prorated amount should be used for an Apartment Style Billing rate.","type":"boolean"},"reservationPreConfiguredRoutingInstruction":{"$ref":"#/components/schemas/booking_crm_resPreConfiguredRoutingInstrType","description":"Information regarding the selected preconfigured routing instruction on the reservation."},"revenuesAndBalances":{"$ref":"#/components/schemas/booking_crm_resRevenueBalanceType","description":"Revenues and Balances Amount summary for the reservation."},"reverseAdvanceCheckInAllowed":{"description":"This attribute is to verify if reverse advance check-in is allowed for the reservation.","type":"boolean"},"reverseCheckInAllowed":{"description":"This attribute is to verify if reverse check-in is allowed for the reservation.","type":"boolean"},"taxType":{"$ref":"#/components/schemas/booking_crm_reservationTaxTypeInfo","description":"This stores the code for the type of tax calculation especially with tax exemption, etc."},"transactionsPosted":{"description":"Specifies whether reservation has a financial transaction associated with it.","type":"boolean"}},"type":"object"},"booking_crm_resCommunicationType":{"description":"Communication details for a reservation.","properties":{"emails":{"description":"List of email address for the customer.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"emailInfo":{"description":"Collection of Detailed information on an eMail address for the customer.","items":{"$ref":"#/components/schemas/booking_crm_emailInfoType"},"maxItems":4000,"type":"array"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"telephones":{"description":"List of Telephone Number Information","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"telephoneInfo":{"description":"Collection of Detailed information on telephone/fax for the customer.","items":{"$ref":"#/components/schemas/booking_crm_telephoneInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"}},"type":"object"},"booking_crm_resCompAccountingType":{"description":"Information regarding comp accounting on the reservation.","properties":{"authorizer":{"description":"ID of the employee who will act as the host for this guest.","maxLength":40,"minLength":0,"type":"string"},"compPostings":{"description":"Indicates if the Comp Billing/posting Exist","maxLength":5,"minLength":0,"type":"string"},"compType":{"description":"Code used to identify the casino comp type and ranking of a guest.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_resExpectedTimesType":{"description":"Holds the Arrival and Departure Time Information","properties":{"reservationExpectedArrivalTime":{"description":"Arrival Time. Uses the hotel's local time zone.","format":"date-time","type":"string"},"reservationExpectedDepartureTime":{"description":"Departure Time. Uses the hotel's local time zone.","format":"date-time","type":"string"}},"type":"object"},"booking_crm_resGuaranteeType":{"description":"Validations type record returned after Validations are done.","properties":{"guaranteeCode":{"description":"Guarantee Code.","maxLength":20,"minLength":0,"type":"string"},"onHold":{"description":"Guarantee Code.","type":"boolean"},"shortDescription":{"description":"Guarantee Code.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_resGuestExternalInfoType":{"description":"Specifies Company or Travel Agent profile using IATA or Corp. No.","properties":{"givenName":{"$ref":"#/components/schemas/booking_crm_givenNameType","description":"Given name, first name or names"},"surname":{"$ref":"#/components/schemas/booking_crm_surnameType","description":"Family name, last name."}},"type":"object"},"booking_crm_resGuestInfoType":{"description":"Specifies Company or Travel Agent profile using IATA or Corp. No.","properties":{"accompanyGuests":{"$ref":"#/components/schemas/booking_crm_resAccompanyGuestListType","description":"List of guest names that are accompanying the reservation guest"},"address":{"$ref":"#/components/schemas/booking_crm_addressSearchType","description":"Address information that is attached to the reservation guest"},"alternateFullName":{"description":"Altername full display name","type":"string"},"alternateGivenName":{"description":"Alternate given name, first name or names","maxLength":40,"minLength":0,"type":"string"},"alternateSurname":{"description":"Alternate family name, last name.","maxLength":40,"minLength":0,"type":"string"},"anonymization":{"$ref":"#/components/schemas/booking_crm_anonymizationType","description":"Provides information about the guest's anonymization status"},"birthDate":{"description":"Date of birth","format":"date","maxLength":8,"type":"string"},"email":{"$ref":"#/components/schemas/booking_crm_basicEmailType","description":"Email address"},"externalInfo":{"$ref":"#/components/schemas/booking_crm_resGuestExternalInfoType","description":"External information about the guest associated with the reservation."},"fullName":{"description":"Full display name","type":"string"},"givenName":{"$ref":"#/components/schemas/booking_crm_givenNameType","description":"Given name, first name or names"},"guestLastStayInfo":{"$ref":"#/components/schemas/booking_crm_guestLastStayInfoType","description":"Contains information regarding the last stay of this guest."},"guestRestricted":{"description":"True indicates there are restrictions associated with the current profile.","type":"boolean"},"guestRestrictedCode":{"description":"Guest profile restricted reason code","type":"string"},"guestRestrictedReasonDesc":{"description":"Guest profile restricted reason description","type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"membership":{"$ref":"#/components/schemas/booking_crm_membershipInfoType","description":"The Membership object identifying the frequent customer reward program."},"middleName":{"description":"The middle name of the person name","maxLength":40,"minLength":0,"type":"string"},"namePrefix":{"$ref":"#/components/schemas/booking_crm_namePrefixType","description":"Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.). Currently this attribute is not used for PUT and POST operations."},"nameSuffix":{"description":"Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.). Currently this attribute is not used for PUT and POST operations.","maxLength":20,"minLength":0,"type":"string"},"nameTitle":{"description":"Degree or honors (e.g., Ph.D., M.D.)","maxLength":20,"minLength":0,"type":"string"},"nameType":{"$ref":"#/components/schemas/booking_crm_nameTypeType"},"nationality":{"$ref":"#/components/schemas/booking_crm_countryNameType","description":"Affiliation or ethnicity to a particular country."},"phoneNumber":{"$ref":"#/components/schemas/booking_crm_phoneNumberType","description":"Phone number"},"registrationCardNo":{"description":"Unique identifier of the police registration card number.","maxLength":40,"minLength":0,"type":"string"},"surname":{"$ref":"#/components/schemas/booking_crm_surnameType","description":"Family name, last name."},"surnamePrefix":{"description":"e.g \"van der\", \"von\", \"de\"","maxLength":20,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"},"vip":{"$ref":"#/components/schemas/booking_crm_vIPType","description":"The supplier's ranking of the customer (e.g., VIP, numerical ranking)."}},"type":"object"},"booking_crm_resHousekeepingType":{"description":"Holds housekeeping turndown service information for the room.","properties":{"expectedServiceTime":{"description":"Expected Start Time for housekeeping task(s).","type":"string"},"facilityTaskInfo":{"$ref":"#/components/schemas/booking_crm_facilityTaskType","description":"The facility task applicable for the current day. This will be information only and not used for any updates."},"instructions":{"description":"Turndown instructions for the room.","type":"string"},"linenChange":{"description":"Indicates if a linen change is necessary.","type":"boolean"},"roomStatus":{"$ref":"#/components/schemas/booking_crm_housekeepingRoomStatusType","description":"Current room status. Current room status is populated only if room is assigned to the reservation and reservation is due in or in house."},"serviceTime":{"description":"This is the Turndown room service time.","format":"date","maxLength":8,"type":"string"},"turndownRequested":{"description":"Indicates whether guest wants turndown facility or not.","type":"boolean"}},"type":"object"},"booking_crm_resMobileNotificationsType":{"description":"Contains the status of Room Ready and Key Ready messages.","properties":{"checkoutMessageReceived":{"description":"Indicates if the Mobile checkout message is received.","type":"boolean"},"errorMessage":{"description":"Error message when Mobile Notification has failed.","type":"string"},"keyReady":{"$ref":"#/components/schemas/booking_crm_communicationStatusType","description":"Denotes the status of Key Ready message. It can have one of the values:PENDING, COMPLETED or FAILED"},"requiresAction":{"description":"Indicates if user action is required. The action could be for sending Room Ready or Key Ready Notification. It could also be for initiating Checkout","type":"boolean"},"roomReady":{"$ref":"#/components/schemas/booking_crm_communicationStatusType","description":"Denotes the status of Room Ready message. It can have one of the values:PENDING, COMPLETED or FAILED"}},"type":"object"},"booking_crm_resPaymentCardType":{"description":"Information on a credit card for the customer.","properties":{"approvalAmountNeeded":{"$ref":"#/components/schemas/booking_crm_currencyAmountType"},"approvalCode":{"description":"Approval code sent by the credit card company on a successful authorization.","maxLength":20,"minLength":0,"type":"string"},"attachCreditCardToProfile":{"description":"Attach the credit card to profile.","type":"boolean"},"cardHolderName":{"maxLength":200,"minLength":0,"type":"string"},"cardId":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type","description":"credit card id"},"cardNumber":{"maxLength":80,"minLength":0,"type":"string"},"cardNumberLast4Digits":{"maxLength":80,"minLength":0,"type":"string"},"cardNumberMasked":{"maxLength":80,"minLength":0,"type":"string"},"cardOrToken":{"$ref":"#/components/schemas/booking_crm_cardNumberTypeType","description":"This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates credit card is token enabled and 'CardNumber' indicates non token environment for this payment card type."},"cardPresent":{"description":"Flag to determine if the credit card was swiped/manually entered , This element is only used when PAYMENT SERVICE DIRECTIVE(PSD) Opera Control is active.","type":"boolean"},"cardType":{"$ref":"#/components/schemas/booking_crm_cardTypeType","description":"Indicates the type of credit card from a defined list"},"citId":{"description":"Customer Initiated Transaction(CIT) Id for Credit Cards. This is only used when PAYMENT SERVICES DIRECTIVE (PSD2) Opera Control is active.","maxLength":30,"minLength":0,"type":"string"},"currentAuthorizedAmount":{"$ref":"#/components/schemas/booking_crm_currencyAmountType"},"expirationDate":{"description":"Expiration date of the credit card","format":"date","maxLength":8,"type":"string"},"expirationDateExpired":{"type":"boolean"},"expirationDateMasked":{"description":"Masked Expiration date of the credit card","maxLength":20,"minLength":0,"type":"string"},"processing":{"$ref":"#/components/schemas/booking_crm_cardProcessingType","description":"This contains information on whether EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type."},"swiped":{"type":"boolean"},"userDefinedCardType":{"description":"Indicates the user defined credit card type if credit card type from a defined list is not provided","maxLength":2,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_resPeriodicFolioType":{"description":"Information regarding periodic folios set on the reservation.","properties":{"frequency":{"description":"Frequency in number of days when folios should be printed for this reservation.","type":"integer"},"lastFolioDate":{"description":"Latest date when a folio was printed using the \"Periodic Batch Folios\" option","format":"date","maxLength":8,"type":"string"},"lastSettlementDate":{"description":"Latest date when a direct bill settlement was automatically done using the \"Direct Bill Batch Folios\" option.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_crm_resPreConfiguredRoutingInstrType":{"description":"Instruction to attach Pre-Configured Routing Instructions to a Reservation.","properties":{"profileType":{"$ref":"#/components/schemas/booking_crm_resProfileTypeType","description":"Profile Type with attached Routing Instruction."},"promotionCode":{"description":"Promotion Code with attached Complimentary Routing.","maxLength":20,"minLength":0,"type":"string"},"ratePlanCode":{"description":"Rate Code with attached Routing Instruction.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_resProfileTypeType":{"enum":["Guest","Company","Group","TravelAgent","Source","ReservationContact","BillingContact","Addressee"],"type":"string"},"booking_crm_resRevenueBalanceType":{"description":"Revenue and Balance Amount summary for the reservation.","properties":{"balance":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Balance amount on the reservation."},"compBalance":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Comp Balance amount"},"foodAndBevRevenue":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Food and Beverage Revenue generated by the reservation."},"nonRevenue":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Total Non Revenue posted on the reservation."},"otherRevenue":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Other Revenue generated by the reservation."},"roomRevenue":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Room Revenue generated by the reservation."},"totalFixedCharge":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Total Fixed Charges on the reservation."},"totalPayment":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Total payment received for the reservation."},"totalRevenue":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Total Revenue generated by the reservation."}},"type":"object"},"booking_crm_resSharedGuestInfoType":{"description":"Contains information regarding the share reservation.","properties":{"firstName":{"description":"Given name, first name or names","type":"string"},"fullName":{"description":"String representation of the full name","type":"string"},"lastName":{"description":"Family name, last name.","type":"string"},"profileId":{"$ref":"#/components/schemas/booking_crm_profileId"}},"type":"object"},"booking_crm_resSharedGuestListType":{"description":"Collection of shared guest reservations.","items":{"$ref":"#/components/schemas/booking_crm_resSharedGuestInfoType"},"maxItems":4000,"type":"array"},"booking_crm_reservationAllowedActionType":{"description":"Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.","enum":["Cancel","Move","PreCharge","PostCharge","FacilitySchedule","Upsell","PreCheckIn","PostToNoShowCancel","NoShow","NameChange","Discount","EnrollToPrimaryMembership","EnrollInProgress"],"type":"string"},"booking_crm_reservationAllowedActionsType":{"description":"Allowed action.","items":{"$ref":"#/components/schemas/booking_crm_reservationAllowedActionType"},"maxItems":11,"type":"array"},"booking_crm_reservationBlockType":{"description":"Key information about the block for a reservation.","properties":{"blockIdList":{"$ref":"#/components/schemas/booking_crm_blockIdList","description":"Collection of unique block identifiers for the reservation."},"blockName":{"description":"The Name of the block that is attached to the reservation.","maxLength":40,"minLength":0,"type":"string"},"hotelId":{"description":"This is the HotelCode of the Block.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_reservationDepositType":{"description":"Reservation Deposit Type.","properties":{"amountOwed":{"description":"Deposit Amount Owed.","type":"number"},"amountPaid":{"description":"Deposit Amount Paid.","type":"number"},"amountRequired":{"description":"Deposit Amount Required.","type":"number"},"dueDate":{"description":"Deposit Due Date.","format":"date","maxLength":8,"type":"string"},"hasOutstanding":{"description":"Resolves whether reservation has outstanding deposit.","type":"boolean"},"hasPaid":{"description":"Resolves whether reservation has paid deposit.","type":"boolean"},"postingDate":{"description":"Deposit Posting Date.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_crm_reservationFolioWindowType":{"description":"Folio window view which holds the set of folios for a reservation.","properties":{"balance":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Running balance of the window."},"folioWindowNo":{"type":"integer"},"payeeInfo":{"$ref":"#/components/schemas/booking_crm_payeeInfoType","description":"The window's configured payee information."},"paymentMethod":{"description":"Payment Method Type","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_reservationFolioWindowsType":{"description":"Collection of reservation folio windows.","items":{"$ref":"#/components/schemas/booking_crm_reservationFolioWindowType"},"maxItems":4000,"type":"array"},"booking_crm_reservationId":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_crm_reservationIdList":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type"},"maxItems":4000,"type":"array"},"booking_crm_reservationInfoType":{"description":"The Reservation class contains the current reservation being created or altered.","properties":{"accessRestriction":{"$ref":"#/components/schemas/booking_crm_resAccessRestrictionType","description":"Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both."},"advanceCheckIn":{"$ref":"#/components/schemas/booking_crm_advanceCheckInType","description":"Information relating to Reservation's Advance Checked In state and Expected Time of Return"},"allowMobileCheckout":{"description":"Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false.","type":"boolean"},"allowMobileViewFolio":{"description":"Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.","type":"boolean"},"allowedActions":{"$ref":"#/components/schemas/booking_crm_reservationAllowedActionsType","description":"Collection of reservation allowed actions."},"attachedProfiles":{"$ref":"#/components/schemas/booking_crm_resAttachedProfileListType","description":"List of attached profiles"},"cancellationInfo":{"description":"Information regarding why reservation has been/was cancelled.","properties":{"code":{"maxLength":20,"minLength":0,"type":"string"},"date":{"description":"Date when reservation was last cancelled.","format":"date","maxLength":8,"type":"string"},"description":{"maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"cashiering":{"$ref":"#/components/schemas/booking_crm_resCashieringType","description":"Holds cashiering related information for the reservation."},"commissionPayoutTo":{"$ref":"#/components/schemas/booking_crm_commissionPayoutToType","description":"If not null, reservation is considered to pay out commission to either Travel Agent, Source or both."},"computedReservationStatus":{"$ref":"#/components/schemas/booking_crm_pMS_ResStatusType","description":"Indicates the status of the reservation."},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.","maxLength":200,"minLength":0,"type":"string"},"deposit":{"$ref":"#/components/schemas/booking_crm_reservationDepositType","description":"Holds reservation deposit information."},"displayColor":{"description":"Color setting of the reservation.","maxLength":20,"minLength":0,"type":"string"},"expectedServiceTime":{"maxLength":20,"minLength":0,"type":"string"},"guestPreferredCurrency":{"description":"Currency code preferred by guest.","maxLength":20,"minLength":0,"type":"string"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"hotelInterfaceStatusList":{"description":"Collection of Hotel Interfaces and rights, this is populated only when fetching interface status for rooms.","items":{"$ref":"#/components/schemas/booking_crm_reservationInterfaceStatusType"},"maxItems":4000,"type":"array"},"hotelName":{"maxLength":80,"minLength":0,"type":"string"},"housekeeping":{"$ref":"#/components/schemas/booking_crm_resHousekeepingType","description":"Information regarding housekeeping for this reservation."},"keyCount":{"description":"Number of keys created for the reservation.","type":"integer"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"lastPrivacyPromptDate":{"description":"Last Privacy Prompt Date","format":"date","maxLength":8,"type":"string"},"mobileNotifications":{"$ref":"#/components/schemas/booking_crm_resMobileNotificationsType","description":"Denotes the status of Room Ready, Key Ready messages."},"openFolio":{"description":"Returns true when reservation has an open folio.","type":"boolean"},"optedForCommunication":{"description":"Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation.","type":"boolean"},"parentReservationId":{"$ref":"#/components/schemas/booking_crm_reservationId","description":"Reservation ID of the parent reservation."},"paymentMethod":{"description":"Payment Method.","maxLength":20,"minLength":0,"type":"string"},"preRegistered":{"description":"Defines if the reservation is pre-registered or not.","type":"boolean"},"queue":{"$ref":"#/components/schemas/booking_crm_reservationQueueInformationType","description":"Information about the time and duration this reservation was on Queue for Checkin."},"reservationCommunication":{"$ref":"#/components/schemas/booking_crm_resCommunicationType","description":"Collection of reservation communication details."},"reservationFolioWindows":{"$ref":"#/components/schemas/booking_crm_reservationFolioWindowsType","description":"Collection of reservation folio windows."},"reservationGuest":{"$ref":"#/components/schemas/booking_crm_resGuestInfoType","description":"Collection of guests associated with the reservation."},"reservationIdList":{"$ref":"#/components/schemas/booking_crm_reservationIdList","description":"Unique identifiers for the reservation for both internal and external systems"},"reservationIndicators":{"$ref":"#/components/schemas/booking_crm_indicatorsType","description":"Indicators of additional information attached to the reservation"},"reservationPaymentMethod":{"$ref":"#/components/schemas/booking_crm_reservationPaymentMethodType","description":"Payment method used for this reservation"},"reservationStatus":{"$ref":"#/components/schemas/booking_crm_pMS_ResStatusType","description":"Indicates the status of the reservation."},"revenuesAndBalances":{"$ref":"#/components/schemas/booking_crm_resRevenueBalanceType","description":"Revenues and Balances Amount summary for the reservation."},"roomStatus":{"$ref":"#/components/schemas/booking_crm_housekeepingRoomStatusType","description":"Current room status"},"roomStay":{"$ref":"#/components/schemas/booking_crm_stayInfoType","description":"Collection of room stays."},"roomStayReservation":{"description":"Boolean True if this reservation is reserving rooms. False if it is only reserving services.","type":"boolean"},"searchMatches":{"$ref":"#/components/schemas/booking_crm_searchMatchesType","description":"Super Search matching terms."},"sharedGuests":{"$ref":"#/components/schemas/booking_crm_resSharedGuestListType","description":"Collection of guests who share this reservation."},"sourceOfSale":{"$ref":"#/components/schemas/booking_crm_sourceOfSaleType","description":"Point of Sale of reservation. Identifies the entity/channel who made the reservation."},"specials":{"description":"Set of reservation preferences which belongs to the Specials group.","maxLength":4000,"minLength":0,"type":"string"},"taxType":{"$ref":"#/components/schemas/booking_crm_taxTypeType","description":"This stores the code for the type of tax calculation especially with tax exemption, etc."},"turndownInfo":{"$ref":"#/components/schemas/booking_crm_reservationTurndownInfoType","description":"Currency code preferred by guest."},"waitlist":{"$ref":"#/components/schemas/booking_crm_waitlistResType","description":"Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is not in Waitlist status anymore."},"walkInIndicator":{"description":"When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in.","type":"boolean"},"welcomeOffer":{"description":"This flag will determine wheather the reservation is eligible for Welcome Offer or not.","type":"boolean"}},"type":"object"},"booking_crm_reservationInterfaceStatusType":{"description":"Hotel Interface Type for a reservation and status of the various services","properties":{"hotelInterface":{"$ref":"#/components/schemas/booking_crm_hotelInterfaceType","description":"Hotel interface information for the reservation"},"interfaceRights":{"description":"Contains a list of status/rights for the various services under this interface","items":{"$ref":"#/components/schemas/booking_crm_interfaceRightsStatusType"},"maxItems":4000,"type":"array"},"roomExtension":{"description":"Identifier for the room extension","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_reservationPaymentMethodType":{"properties":{"authorizationRule":{"$ref":"#/components/schemas/booking_crm_authorizationRuleType"},"balance":{"$ref":"#/components/schemas/booking_crm_currencyAmountType"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"emailFolioInfo":{"description":"Information on an email for the customer.","properties":{"email":{"$ref":"#/components/schemas/booking_crm_emailType","description":"eMail deatils for the profile."},"emailFolio":{"type":"boolean"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"folioView":{"type":"integer"},"paymentCard":{"$ref":"#/components/schemas/booking_crm_resPaymentCardType"},"paymentMethod":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_reservationQueueInformationType":{"description":"Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.","properties":{"averageQueueTimeCurrentReservations":{"description":"The average time, in seconds, of the reservations currently in queue.","type":"integer"},"averageQueueTimeToCheckIn":{"description":"The average time, in seconds, a reservation was on queue prior to Check-In.","type":"integer"},"guestTextInfo":{"$ref":"#/components/schemas/booking_crm_queueTextInfoType","description":"Information for the message sent to the user"},"priority":{"description":"The Queue Priority given to this reservation.","type":"integer"},"queueDate":{"description":"The Business date on which the reservation was due to arrive and is currently placed on Queue for Check In.","format":"date","maxLength":8,"type":"string"},"timeSpan":{"description":"Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.","properties":{"duration":{"type":"string"},"durationInSeconds":{"description":"The total duration, in seconds, the reservation is on Queue.","type":"integer"},"endDate":{"format":"date","maxLength":8,"type":"string"},"startDate":{"format":"date","maxLength":8,"type":"string"}},"type":"object"}},"type":"object"},"booking_crm_reservationStayHistoryFutureInfoType":{"description":"Information of History and Future Reservation details attached to Profiles.","properties":{"futureList":{"$ref":"#/components/schemas/booking_crm_stayFutureListType","description":"Refer to Future list type document."},"historyList":{"$ref":"#/components/schemas/booking_crm_stayHistoryListType","description":"Refer to History list type document."}},"type":"object"},"booking_crm_reservationTaxTypeInfo":{"description":"Provides information about the Tax Type.","properties":{"code":{"description":"Code of the Tax Type.","maxLength":20,"minLength":0,"type":"string"},"collectingAgentTax":{"description":"A boolean flag for Collecting Agent Tax","type":"boolean"},"description":{"description":"Description of the Tax Type.","maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"description":"Code of the Hotel.","maxLength":20,"minLength":0,"type":"string"},"minimumLengthOfStay":{"description":"Minimun Length of Stay.","type":"integer"},"printAutoAdjust":{"description":"Print auto adjust information for this tax type on the tax exempt report.","type":"boolean"},"reportExemptDays":{"description":"Number of days after which the guest will be tax exempt. Only used for tax exempt report.","type":"integer"},"reportTaxPercentage":{"description":"Tax percentage. Only used for tax exempt report.","maximum":100,"minimum":0,"type":"number"},"taxExemptNo":{"description":"Tax exempt number on the profile.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_reservationTurndownInfoType":{"description":"Turndown information for a reservation","properties":{"allowed":{"description":"Indicates if turndown is allowed or not","type":"boolean"},"status":{"$ref":"#/components/schemas/booking_crm_turndownStatusType","description":"Indicates turndown status, values could be required, not required, completed"}},"type":"object"},"booking_crm_roomClassCodeInfoType":{"description":"Code of the room class type.","properties":{"description":{"maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"roomClassCode":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_roomOwnershipType":{"description":"Define the search criteria for retrieving room ownership records","properties":{"contractNumber":{"description":"Contract number for room owner.","type":"string"},"endDate":{"description":"End Date of the room ownership record.","format":"date","maxLength":8,"type":"string"},"profileId":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type","description":"Profile ID of the room ownership record."},"roomCategory":{"description":"Room Category of the room ownership record.","type":"string"},"roomId":{"description":"Room Id of room owner.","type":"string"},"roomOwnershipId":{"description":"Unique Id for Room Owner record.","type":"integer"},"roomType":{"description":"Room Type of the room ownership record.","type":"string"},"startDate":{"description":"Start Date of the room ownership record.","format":"date","maxLength":8,"type":"string"},"status":{"description":"Status of the room ownership record.","type":"string"}},"type":"object"},"booking_crm_salesInfoType":{"description":"Provides sales information about the profiles of type company, travel agent, source and contact.","properties":{"accountSource":{"description":"Defines the account source.","maxLength":2000,"minLength":0,"type":"string"},"accountType":{"description":"Defines the account type.","maxLength":20,"minLength":0,"type":"string"},"actionCode":{"description":"Defines the action code.","maxLength":4000,"minLength":0,"type":"string"},"businessSegments":{"description":"Defines the Business segments.","maxLength":2000,"minLength":0,"type":"string"},"competitionCode":{"description":"Defines the competition code.","maxLength":4000,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel Code used to filter the sales information.","maxLength":20,"minLength":0,"type":"string"},"industryCode":{"description":"Defines the industry code.","maxLength":2000,"minLength":0,"type":"string"},"influence":{"description":"Defines the influence for the contact profile.","maxLength":2000,"minLength":0,"type":"string"},"preferredRoom":{"description":"Defines the Preferred Room for profile.","maxLength":20,"minLength":0,"type":"string"},"priority":{"description":"Defines the priority.","maxLength":4000,"minLength":0,"type":"string"},"roomsPotential":{"description":"Defines the rooms potential.","maxLength":4000,"minLength":0,"type":"string"},"scope":{"description":"Defines the scope.","maxLength":2000,"minLength":0,"type":"string"},"scopeCity":{"description":"Defines the scope city.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_searchMatchType":{"description":"Search match indicating attribute and the matching value.","properties":{"attribute":{"description":"Search match attribute.","maxLength":2000,"minLength":0,"type":"string"},"value":{"description":"Search match value.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_searchMatchesType":{"description":"List of Generic Name-Value-Pair Parameters used for super search matches.","items":{"$ref":"#/components/schemas/booking_crm_searchMatchType"},"maxItems":4000,"type":"array"},"booking_crm_sourceCodeInfoType":{"properties":{"description":{"maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"sourceCode":{"maxLength":20,"minLength":0,"type":"string"},"sourceGroup":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_sourceOfSaleType":{"description":"Point of Sale of reservation. Identifies the entity/channel who made the reservation.","properties":{"sourceCode":{"description":"The entity/channel who made the reservation.","maxLength":20,"minLength":0,"type":"string"},"sourceType":{"description":"Type of entity/channel who made the reservation..","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_status":{"description":"Response Body.","properties":{"links":{"$ref":"#/components/schemas/booking_crm_links"},"warnings":{"$ref":"#/components/schemas/booking_crm_warningsType"}},"type":"object"},"booking_crm_stayFutureListType":{"description":"A collection of reservation history details attached to Profiles.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"reservationInfo":{"description":"Additional reservation information attached to the profile . Eg : Future reservation details","items":{"$ref":"#/components/schemas/booking_crm_stayReservationInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"booking_crm_stayHistoryListType":{"description":"A collection of reservation history details attached to Profiles.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"reservationInfo":{"description":"Additional reservation information attached to the profile . Eg : History reservation details","items":{"$ref":"#/components/schemas/booking_crm_stayReservationInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"booking_crm_stayInfoType":{"description":"Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties.","properties":{"adultCount":{"description":"A collection of Guest Counts associated with Room Stay.","type":"integer"},"arrivalDate":{"format":"date","type":"string"},"assignedByAI":{"description":"Represents the room was assigned by AI Room Assignment.","type":"boolean"},"balance":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Balance amount"},"bookingChannelCode":{"description":"Booking channel code","maxLength":20,"minLength":0,"type":"string"},"childCount":{"description":"A collection of Child Counts associated with Room Stay.","type":"integer"},"compBalance":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Comp Balance amount"},"componentRoomType":{"description":"True indicates room type is a component type.","type":"boolean"},"departureDate":{"format":"date","type":"string"},"depositPayments":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"A collection of deposit and/or payments for the Room Stay."},"expectedTimes":{"$ref":"#/components/schemas/booking_crm_resExpectedTimesType","description":"The expected arrival, return and departure times of the guest."},"fixedRate":{"description":"True if the rate is a fixed rate, otherwise false","type":"boolean"},"guarantee":{"$ref":"#/components/schemas/booking_crm_resGuaranteeType","description":"The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context."},"guestServiceStatus":{"$ref":"#/components/schemas/booking_crm_guestHousekeepingServiceRequestType","description":"Service Status of In House guest like DND or MUP"},"linkCode":{"description":"Party code","maxLength":2000,"type":"string"},"marketCode":{"description":"Market code","maxLength":20,"minLength":0,"type":"string"},"marketDescription":{"description":"Description of Market code","maxLength":4000,"minLength":0,"type":"string"},"numberOfRooms":{"description":"Room Id","type":"integer"},"originalTimeSpan":{"$ref":"#/components/schemas/booking_crm_timeSpanType","description":"The Original Time Span covers the Room Stay dates of the original reservation."},"points":{"$ref":"#/components/schemas/booking_crm_pointsType","description":"The Points contains the number of points used to book a particular room type."},"promotion":{"$ref":"#/components/schemas/booking_crm_promotionType","description":"Promotion Codes"},"pseudoRoom":{"description":"True indicates as pseudo room type. This is usually used for a posting master reservation.","type":"boolean"},"rateAmount":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"Rate amount"},"ratePlanCode":{"description":"Rate plan code","maxLength":20,"minLength":0,"type":"string"},"rateSuppressed":{"description":"Whether this rate should be suppressed from view","type":"boolean"},"reservationBlock":{"$ref":"#/components/schemas/booking_crm_reservationBlockType","description":"Key information about the block for this reservation."},"roomClass":{"description":"Room class code","maxLength":20,"minLength":0,"type":"string"},"roomId":{"description":"Room Id","maxLength":20,"minLength":0,"type":"string"},"roomNumberLocked":{"description":"When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.","type":"boolean"},"roomType":{"description":"Room type code","maxLength":20,"minLength":0,"type":"string"},"roomTypeCharged":{"description":"Room type code that was charged","maxLength":20,"minLength":0,"type":"string"},"scheduledCheckoutTime":{"description":"Indicates that this reservation is scheduled for automated check out.","format":"date","type":"string"},"sourceCode":{"description":"Source of business","maxLength":20,"minLength":0,"type":"string"},"sourceCodeDescription":{"description":"Description of the source of business.","maxLength":4000,"minLength":0,"type":"string"},"totalAmount":{"$ref":"#/components/schemas/booking_crm_currencyAmountType","description":"The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount."},"upgradedByAI":{"description":"Represents the room was assigned by AI Room Assignment.","type":"boolean"}},"type":"object"},"booking_crm_stayReservationInfoType":{"description":"The Reservation class contains the current reservation being created or altered.","properties":{"attachedProfiles":{"$ref":"#/components/schemas/booking_crm_resAttachedProfileListType","description":"List of attached profiles"},"computedReservationStatus":{"$ref":"#/components/schemas/booking_crm_pMS_ResStatusType","description":"Indicates the status of the reservation."},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"parentReservationId":{"$ref":"#/components/schemas/booking_crm_reservationId","description":"Reservation ID of the parent reservation."},"reservationIdList":{"$ref":"#/components/schemas/booking_crm_reservationIdList","description":"Unique identifiers for the reservation for both internal and external systems"},"reservationStatus":{"$ref":"#/components/schemas/booking_crm_pMS_ResStatusType","description":"Indicates the status of the reservation."},"roomStay":{"$ref":"#/components/schemas/booking_crm_stayInfoType","description":"Collection of room stays."}},"type":"object"},"booking_crm_surnameType":{"description":"Family name, last name.","maxLength":80,"minLength":0,"type":"string"},"booking_crm_taxTypeType":{"description":"Provides information about the Tax Type.","properties":{"code":{"description":"Code of the Tax Type.","maxLength":20,"minLength":0,"type":"string"},"collectingAgentTax":{"description":"A boolean flag for Collecting Agent Tax","type":"boolean"},"description":{"description":"Description of the Tax Type.","maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"description":"Code of the Hotel.","maxLength":20,"minLength":0,"type":"string"},"minimumLengthOfStay":{"description":"Minimun Length of Stay.","type":"integer"},"printAutoAdjust":{"description":"Print auto adjust information for this tax type on the tax exempt report.","type":"boolean"},"reportExemptDays":{"description":"Number of days after which the guest will be tax exempt. Only used for tax exempt report.","type":"integer"},"reportTaxPercentage":{"description":"Tax percentage. Only used for tax exempt report.","maximum":100,"minimum":0,"type":"number"}},"type":"object"},"booking_crm_telephoneInfoType":{"description":"Information on a telephone number for the customer.","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"telephone":{"$ref":"#/components/schemas/booking_crm_telephoneType","description":"Phone details for the profile."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_telephoneType":{"description":"Information on a telephone number for the customer.","properties":{"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.","maxLength":200,"minLength":0,"type":"string"},"extension":{"description":"Extension to reach a specific party at the phone number.","maxLength":20,"minLength":0,"type":"string"},"isValidated":{"description":"Indicator to define if the Phone number is validated by the Phone Validation System.","type":"boolean"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"phoneNumber":{"description":"Telephone number assigned to a single location.","maxLength":40,"minLength":0,"type":"string"},"phoneTechType":{"description":"Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc.","maxLength":20,"minLength":0,"type":"string"},"phoneUseType":{"description":"Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening).","maxLength":20,"minLength":0,"type":"string"},"phoneUseTypeDescription":{"description":"Description of the PhoneUseType code","maxLength":2000,"minLength":0,"type":"string"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"}},"type":"object"},"booking_crm_tierAdministrationType":{"description":"Do not upgrade membership. The membership may be downgraded.","enum":["Disabled","NoUpgrade"],"type":"string"},"booking_crm_timeSpanType":{"description":"Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.","properties":{"duration":{"type":"string"},"endDate":{"format":"date","maxLength":8,"type":"string"},"startDate":{"format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_crm_traceResolveType":{"properties":{"resolvedBy":{"description":"User that resolved the trace","type":"string"},"resolvedOn":{"description":"Date the trace was resolved","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_crm_traceTimeInfoType":{"properties":{"dateTimeSpan":{"$ref":"#/components/schemas/booking_crm_dateTimeSpanType","description":"Time span for the trace."},"enteredBy":{"description":"User that entered this trace.","type":"string"},"traceOn":{"description":"Date of the trace. Uses the hotel's time zone.","format":"date-time","type":"string"},"traceTime":{"description":"Time of the trace","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_traceType":{"properties":{"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.","maxLength":200,"minLength":0,"type":"string"},"departmentId":{"description":"Indicates the Department code.","maxLength":20,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"reservationId":{"$ref":"#/components/schemas/booking_crm_reservationId","description":"Reservation ID of the reservation for which the traces are to be retrieved."},"resolveInfo":{"$ref":"#/components/schemas/booking_crm_traceResolveType","description":"Information regarding the status of the trace"},"timeInfo":{"$ref":"#/components/schemas/booking_crm_traceTimeInfoType","description":"Date of the trace."},"traceText":{"description":"The information this trace contains.","type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_crm_trxInfoType":{"description":"Transaction codes info.","properties":{"articles":{"description":"The List of Articles defined for this transaction code, when using the Articles functionality.","items":{"$ref":"#/components/schemas/booking_crm_articleInfoType"},"maxItems":4000,"type":"array"},"description":{"description":"Transaction codes info.","maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel context of the Transaction code.","maxLength":20,"minLength":0,"type":"string"},"printTrxReceipt":{"description":"Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code.","type":"boolean"},"routingInstructionsId":{"description":"This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer.","type":"number"},"transactionCode":{"description":"Unique identifier for the Transaction code.","maxLength":20,"minLength":0,"type":"string"},"transactionGroup":{"description":"Category of the transaction code.","maxLength":20,"minLength":0,"type":"string"},"transactionSubGroup":{"description":"Sub category of the transaction code.","maxLength":20,"minLength":0,"type":"string"},"trxServiceType":{"description":"Contains service type for transaction code.","maxLength":20,"minLength":0,"type":"string"},"universalProductCode":{"description":"Unique Universal product code of the transaction code.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_turndownStatusType":{"description":"Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Completed.","enum":["Required","NotRequired","Compeleted"],"type":"string"},"booking_crm_uRLInfoType":{"description":"Web site address.","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"},"url":{"$ref":"#/components/schemas/booking_crm_uRLType","description":"Provides URL information."}},"type":"object"},"booking_crm_uRLType":{"description":"Web site address, in IETF(The Internet Engineering Task Force) specified format.","properties":{"orderSequence":{"description":"Display Order sequence.","type":"number"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"},"type":{"description":"Defines the purpose of the URL address, such as personal, business, public, etc.","maxLength":20,"minLength":0,"type":"string"},"typeDescription":{"description":"Describes the Type code","maxLength":2000,"minLength":0,"type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"booking_crm_uniqueIDListType":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/booking_crm_uniqueID_Type"},"maxItems":4000,"type":"array"},"booking_crm_uniqueID_Type":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_userDefinedFieldsType":{"description":"A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc.","properties":{"characterUDFs":{"$ref":"#/components/schemas/booking_crm_characterUDFsType","description":"Collection of user defined fields of Character/String Type."},"dateUDFs":{"$ref":"#/components/schemas/booking_crm_dateUDFsType","description":"Collection of user defined fields of Date Type."},"numericUDFs":{"$ref":"#/components/schemas/booking_crm_numericUDFsType","description":"Collection of user defined fields of Numeric Type."}},"type":"object"},"booking_crm_vIPType":{"description":"The supplier's ranking of the customer.","properties":{"vipCode":{"description":"VIP Code.","maxLength":20,"minLength":0,"type":"string"},"vipDescription":{"description":"VIP Description.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_waitlistResType":{"description":"Information regarding why reservation is being /has been waitlisted.","properties":{"description":{"description":"Description why the reservation is being /has been waitlisted.","maxLength":2000,"minLength":0,"type":"string"},"priorityCode":{"description":"Waitlist Priority Code.","maxLength":20,"minLength":0,"type":"string"},"priorityDescription":{"description":"Waitlist priority Description.","maxLength":2000,"minLength":0,"type":"string"},"reasonCode":{"description":"Waitlist Reason Code.","maxLength":20,"minLength":0,"type":"string"},"reasonDescription":{"description":"Waitlist Reason Description.","maxLength":2000,"minLength":0,"type":"string"},"telephone":{"description":"Guest telephone number.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_crm_warningType":{"description":"Used when a message has been successfully processed to report any warnings or business errors that occurred.","properties":{"code":{"description":"If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.","maxLength":20,"minLength":0,"type":"string"},"docURL":{"description":"If present, this URL refers to an online description of the error that occurred.","maxLength":2000,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"recordId":{"description":"If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.","maxLength":2000,"type":"string"},"rph":{"description":"Reference Place Holder used as an index for this warning.","maxLength":8,"minLength":1,"type":"string"},"shortText":{"description":"An abbreviated version of the error in textual format.","maxLength":2000,"type":"string"},"status":{"description":"If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.","maxLength":2000,"type":"string"},"tag":{"description":"If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].","maxLength":2000,"type":"string"},"type":{"description":"The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"booking_crm_warningsType":{"description":"Used in conjunction with the Success element to define a business error.","items":{"$ref":"#/components/schemas/booking_crm_warningType"},"maxItems":4000,"type":"array"},"booking_crm_webUserAccountType":{"description":"Web User Account of the guest.","properties":{"autoGeneratePassword":{"description":"A flag which determines if the password is auto generated.","type":"boolean"},"comments":{"description":"Comments.","maxLength":4000,"minLength":0,"type":"string"},"domainCode":{"description":"Domain code.","maxLength":20,"minLength":0,"type":"string"},"history":{"$ref":"#/components/schemas/booking_crm_webUserHistoryType","description":"Web User Account History."},"inactive":{"description":"Boolean flag that indicates whether the web account is inactive or not.","type":"boolean"},"locked":{"description":"Boolean flag that indicates whether the web account is locked or not.","type":"boolean"},"loginName":{"description":"Login Name of the guest.","maxLength":80,"minLength":0,"type":"string"},"newLoginName":{"description":"New Login Name of the guest.","maxLength":80,"minLength":0,"type":"string"},"newPassword":{"description":"Login Password.","maxLength":2000,"minLength":0,"type":"string"},"securityAnswer":{"description":"Answer to the Security Question.","maxLength":4000,"minLength":0,"type":"string"},"securityQuestion":{"$ref":"#/components/schemas/booking_crm_codeDescriptionType","description":"Security Question and its Code associated with the account to verify the user."}},"type":"object"},"booking_crm_webUserAccountsType":{"description":"Web User Accounts List.","items":{"$ref":"#/components/schemas/booking_crm_webUserAccountType"},"maxItems":4000,"type":"array"},"booking_crm_webUserHistoryType":{"description":"Creation date time, Creator Id, last modification date time and last Modifier Id.","properties":{"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.","maxLength":200,"minLength":0,"type":"string"},"inactiveDate":{"description":"Inactive date.","format":"date","maxLength":8,"type":"string"},"lastLogin":{"description":"Last login date.","format":"date","maxLength":8,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"lastPasswordChange":{"description":"Last Password change date.","format":"date","maxLength":8,"type":"string"}},"type":"object"},"booking_entcfg_applicationSettingConversionType":{"enum":["Default","Parameter"],"type":"string"},"booking_entcfg_applicationSettingGroupType":{"description":"This element simply groups the different Application Functions.","properties":{"appSettings":{"items":{"$ref":"#/components/schemas/booking_entcfg_applicationSettingType"},"maxItems":4000,"type":"array"},"groupDisplayName":{"maxLength":80,"minLength":0,"type":"string"},"groupName":{"maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"booking_entcfg_applicationSettingLevelType":{"enum":["Global","Hotel","Cro"],"type":"string"},"booking_entcfg_applicationSettingType":{"description":"Internal settings that can be of a certain valueType.","properties":{"conversionType":{"$ref":"#/components/schemas/booking_entcfg_applicationSettingConversionType","description":"Represents whether the value is OXI Parameter or Conversion code default."},"description":{"maxLength":2000,"minLength":0,"type":"string"},"displayName":{"maxLength":80,"minLength":0,"type":"string"},"editAllowed":{"type":"boolean"},"hotelId":{"description":"Each configuration item will come with a HotelCode which will help the configuration to specify what context the update has to be. Eg. _Global,ORS,'CRO', etc.","maxLength":20,"minLength":0,"type":"string"},"levelCode":{"maxLength":20,"minLength":0,"type":"string"},"levelType":{"$ref":"#/components/schemas/booking_entcfg_applicationSettingLevelType"},"name":{"maxLength":80,"minLength":0,"type":"string"},"scope":{"enum":["P","G","Ch","C"],"type":"string"},"sequence":{"type":"number"},"settings":{"items":{"$ref":"#/components/schemas/booking_entcfg_baseApplicationSettingType"},"maxItems":4000,"type":"array"},"shortDescription":{"maxLength":2000,"minLength":0,"type":"string"},"subscriptionCountEligible":{"description":"Indicates if this OPERA Setting is part of subscription count.","type":"boolean"},"type":{"$ref":"#/components/schemas/booking_entcfg_applicationSettingTypeType"},"value":{"maxLength":2000,"minLength":0,"type":"string"},"valueType":{"enum":["Yn","Integer","String","SingleSelectLov","MultiSelectLov","ShuttleLov","Custom","Double","Secure"],"type":"string"},"wildCardMatch":{"description":"A flag which indicate whether a wild card search should be made.","type":"boolean"}},"type":"object"},"booking_entcfg_applicationSettingTypeType":{"enum":["Function","Parameter","Setting"],"type":"string"},"booking_entcfg_baseApplicationSettingType":{"description":"Internal settings that can be of a certain valueType.","properties":{"conversionType":{"$ref":"#/components/schemas/booking_entcfg_applicationSettingConversionType","description":"Represents whether the value is OXI Parameter or Conversion code default."},"description":{"maxLength":2000,"minLength":0,"type":"string"},"displayName":{"maxLength":80,"minLength":0,"type":"string"},"editAllowed":{"type":"boolean"},"hotelId":{"description":"Each configuration item will come with a HotelCode which will help the configuration to specify what context the update has to be. Eg. _Global,ORS,'CRO', etc.","maxLength":20,"minLength":0,"type":"string"},"name":{"maxLength":80,"minLength":0,"type":"string"},"scope":{"enum":["P","G","Ch","C"],"type":"string"},"sequence":{"type":"number"},"shortDescription":{"maxLength":2000,"minLength":0,"type":"string"},"subscriptionCountEligible":{"description":"Indicator if the function does not count against the OPERA Control function count limit or not.","type":"boolean"},"type":{"$ref":"#/components/schemas/booking_entcfg_applicationSettingTypeType"},"value":{"maxLength":2000,"minLength":0,"type":"string"},"valueType":{"enum":["Yn","Integer","String","SingleSelectLov","MultiSelectLov","ShuttleLov","Custom","Double","Secure"],"type":"string"},"wildCardMatch":{"description":"A flag which indicate whether a wild card search should be made.","type":"boolean"}},"type":"object"},"booking_entcfg_instanceLink":{"description":"Metadata describing link description objects that MAY appear in the JSON instance representation.","properties":{"href":{"description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.","type":"string"},"method":{"description":"HTTP method for requesting the target of the link.","enum":["GET","POST","PUT","DELETE","PATCH","OPTIONS","HEAD"],"type":"string"},"operationId":{"description":"The operationId of the path you can call to follow this link.  This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.","type":"string"},"rel":{"description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.","type":"string"},"targetSchema":{"description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..","type":"string"},"templated":{"default":false,"description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.","type":"boolean"},"title":{"description":"Exact copy of the \"summary\" field on the linked operation.","type":"string"}},"type":"object"},"booking_entcfg_links":{"items":{"$ref":"#/components/schemas/booking_entcfg_instanceLink"},"type":"array"},"booking_entcfg_operaSettingsDetails":{"description":"The result element containing the requested application settings.","properties":{"activeFunctions":{"description":"Count of active property services functions.","type":"integer"},"groups":{"description":"Contains a collection of application settings for a particular group.","items":{"$ref":"#/components/schemas/booking_entcfg_applicationSettingGroupType"},"type":"array"},"links":{"$ref":"#/components/schemas/booking_entcfg_links"},"warnings":{"$ref":"#/components/schemas/booking_entcfg_warningsType"}},"type":"object"},"booking_entcfg_warningType":{"description":"Used when a message has been successfully processed to report any warnings or business errors that occurred.","properties":{"code":{"description":"If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.","maxLength":20,"minLength":0,"type":"string"},"docURL":{"description":"If present, this URL refers to an online description of the error that occurred.","maxLength":2000,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"recordId":{"description":"If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.","maxLength":2000,"type":"string"},"rph":{"description":"Reference Place Holder used as an index for this warning.","maxLength":8,"minLength":1,"type":"string"},"shortText":{"description":"An abbreviated version of the error in textual format.","maxLength":2000,"type":"string"},"status":{"description":"If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.","maxLength":2000,"type":"string"},"tag":{"description":"If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].","maxLength":2000,"type":"string"},"type":{"description":"The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"booking_entcfg_warningsType":{"description":"Used in conjunction with the Success element to define a business error.","items":{"$ref":"#/components/schemas/booking_entcfg_warningType"},"maxItems":4000,"type":"array"},"booking_rsv_addressInfoType":{"description":"Provides address information.","properties":{"address":{"$ref":"#/components/schemas/booking_rsv_addressType","description":"Address details for the profile."},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_addressSearchType":{"description":"Address Details such as city, state, country, postal code etc.","properties":{"cityName":{"description":"City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).","maxLength":40,"minLength":0,"type":"string"},"country":{"$ref":"#/components/schemas/booking_rsv_countryNameType","description":"Country name (e.g., Ireland)."},"excludeNoCity":{"description":"When true indicates that only profiles with city will be fetched.","type":"boolean"},"postalCode":{"description":"Post Office Code number.","maxLength":15,"minLength":0,"type":"string"},"state":{"description":"State or Province name (e.g., Texas).","maxLength":20,"minLength":0,"type":"string"},"streetAddress":{"description":"First Line of Street Address. For profile search it matches the first Address line.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_addressType":{"description":"Provides address information.","properties":{"addressLine":{"description":"When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.","items":{"maxLength":80,"minLength":0,"type":"string"},"maxItems":4,"type":"array"},"barCode":{"description":"The postal barcode for the address.","maxLength":100,"minLength":0,"type":"string"},"cityExtension":{"description":"Post Office City Extension Code number. City Extension mainly used for UK addresses.","maxLength":20,"minLength":0,"type":"string"},"cityName":{"description":"City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).","maxLength":40,"minLength":0,"type":"string"},"country":{"$ref":"#/components/schemas/booking_rsv_countryNameType","description":"Country name (e.g., Ireland)."},"county":{"description":"County or District Name (e.g., Fairfax). This is read only.","maxLength":20,"minLength":0,"type":"string"},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"isValidated":{"description":"Indicator to define if the Address is validated by the Address Validation System.","type":"boolean"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"postalCode":{"description":"Post Office Code number.","maxLength":15,"minLength":0,"type":"string"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"},"state":{"description":"State or Province name (e.g., Texas).","maxLength":20,"minLength":0,"type":"string"},"type":{"description":"Defines the type of address (e.g. home, business, other).","maxLength":20,"minLength":0,"type":"string"},"typeDescription":{"description":"Describes the type code","type":"string"},"updateReservations":{"description":"Indicates whether all future reservations for this profile should be updated with the primary address. When set to true, and the address is being updated to primary, any active reservations where this profile is the primary profile will automatically update to use the new primary address.","type":"boolean"}},"type":"object"},"booking_rsv_advanceCheckInType":{"description":"Information relating to Reservation's Advance Checked In state and Expected Time of Return","properties":{"advanceCheckInTime":{"description":"Time in the property's timezone the reservation is advance checked in, returned only with operation getReservation when a reservation is advance checked in. Uses the hotel's time zone.","format":"date-time","type":"string"},"advanceCheckedIn":{"description":"Indicates if the reservation is marked as Advance Checked In","type":"boolean"},"eTRComments":{"description":"ETR Comments","maxLength":2000,"minLength":0,"type":"string"},"expectedReturnTime":{"description":"Expected Return Time in the property's timezone. Uses the hotel's time zone.","format":"date-time","type":"string"}},"type":"object"},"booking_rsv_amountDeterminationType":{"description":"Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.","enum":["Inclusive","Exclusive"],"type":"string"},"booking_rsv_anonymizationStatusType":{"description":"Guest has been anonymized.","enum":["Requested","Anonymized"],"type":"string"},"booking_rsv_anonymizationType":{"description":"Provides information about guest's anonymization status.","properties":{"anonymizationStatus":{"$ref":"#/components/schemas/booking_rsv_anonymizationStatusType","description":"Status of anonymization such as Requested or Anonymized."}},"type":"object"},"booking_rsv_authorizationRuleType":{"description":"Configured rule for computing the amount to authorize.","properties":{"amount":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"The amount applicable to the authorization rule."},"code":{"description":"The authorization rule code.","pattern":"[0-9]{1,9}","type":"integer"},"percent":{"description":"A percentage value if the authorization rule is percentage based.","type":"number"}},"type":"object"},"booking_rsv_authorizerInfoType":{"description":"Authorizer Information","properties":{"authorizerId":{"$ref":"#/components/schemas/booking_rsv_uniqueID_Type"},"authorizerName":{"description":"Full name of the authorizer.","maxLength":100,"minLength":0,"type":"string"},"authorizerRateCode":{"description":"Rate code of the authorizer.","maxLength":20,"minLength":0,"type":"string"},"authorizerUserName":{"description":"Application user name of the authorizer","maxLength":40,"minLength":0,"type":"string"},"inheritAuthorizerRateCode":{"description":"Indicates whether user has the choice to have reservation inherit rate code from the authorizer.","type":"boolean"}},"type":"object"},"booking_rsv_backToBackResSequenceType":{"description":"Type object represents Back To Back Sequence Position and Total Count of Linked Back To Back Reservations ordered by consecutive Stay Dates.","properties":{"position":{"description":"Indicates the Sequence position of Back to Back Reservation.","type":"integer"},"totalCount":{"description":"Indicates the total count of Back To Back Reservations in the group of Linked Reservations.","type":"integer"}},"type":"object"},"booking_rsv_basicEmailType":{"description":"Email address","maxLength":2000,"minLength":0,"type":"string"},"booking_rsv_bedTaxReportingType":{"description":"This stores the information for Bed Tax Reporting. Mainly used in Maldives.","properties":{"taxRegistrationNo":{"description":"Tax Registration Number for Maldives Bed Tax Reporting.","type":"number"}},"type":"object"},"booking_rsv_billingPrivilegesType":{"description":"This stores the information for Bed Tax Reporting. Mainly used in Maldives.","properties":{"allowAutoCheckin":{"description":"Indicated if a new reservation should be created and automatically checked in whenever the room is checked out. Available for pseudo room types only.","type":"boolean"},"autoSettlement":{"description":"Indicates if the is a candidate for auto folio settlement.","type":"boolean"},"autoSettlementFreq":{"description":"The interval of days between each auto folio settlement.","type":"integer"},"autoSettlementType":{"description":"The folio settlement type for auto folio settlement.","maxLength":40,"minLength":0,"type":"string"},"creditLimitAutoPay":{"description":"Indicates if the reservation will be included in the Automatic Credit Limit Overages process and also be listed in the Credit Limit Overages screen results.","type":"boolean"},"excludeFromAutoAuthorization":{"description":"Indicates if the reseravtion will be excluded from auto athorization of Credit Cards.","type":"boolean"},"postStayCharging":{"description":"Indicates if the reservation has charging privileges after checkout.","type":"boolean"},"postingRestriction":{"description":"Flag used by interface program during check in.","type":"boolean"},"preStayCharging":{"description":"Indicates if the reservation has charging privileges before arrival.","type":"boolean"},"videoCheckout":{"description":"Indicates if the guest can do video checkout","type":"boolean"}},"type":"object"},"booking_rsv_blockIdList":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/booking_rsv_uniqueID_Type"},"maxItems":4000,"type":"array"},"booking_rsv_bookingChannelType":{"properties":{"channelCode":{"maxLength":20,"minLength":0,"type":"string"},"channelName":{"maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_bookingTimeSpanType":{"description":"The booking time span of the reservation, only applicable when time increments are being used.","properties":{"endDateTime":{"description":"The end time of the reservation booking. Uses the hotel's time zone.","format":"date-time","type":"string"},"startDateTime":{"description":"The start time of the reservation booking. Uses the hotel's time zone.","format":"date-time","type":"string"}},"type":"object"},"booking_rsv_cancelReservationDetails":{"description":"Response object for the request to cancel reservations. Response contains the reservations which were successfully canceled.","properties":{"channelInformation":{"$ref":"#/components/schemas/booking_rsv_channelResvRSInfoType","description":"Information to be returned, if the request is received through a channel"},"comments":{"description":"List of Notes for the Guest related to the reservation.","items":{"$ref":"#/components/schemas/booking_rsv_commentInfoType"},"maxItems":4000,"type":"array"},"cxlActivityLog":{"description":"Cancellation information includes information regarding Reason, Date of Cancellation etc..","items":{"$ref":"#/components/schemas/booking_rsv_cancellationActivityType"},"maxItems":4000,"type":"array"},"links":{"$ref":"#/components/schemas/booking_rsv_links"},"newRates":{"$ref":"#/components/schemas/booking_rsv_dailyRatesType","description":"Collection of new room rate information on a daily basis for the new remaining guest count in case of sharing reservations."},"oldRates":{"$ref":"#/components/schemas/booking_rsv_dailyRatesType","description":"Collection of old room rate information on a daily basis for the old guest count in case of sharing reservations."},"reservationPolicies":{"$ref":"#/components/schemas/booking_rsv_reservationPoliciesType","description":"Contains deposit and cancellation policies attached with the reservation."},"reservations":{"description":"Information regarding the reservation which was canceled.","items":{"$ref":"#/components/schemas/booking_rsv_cancelReservationType"},"maxItems":4000,"type":"array"},"warnings":{"$ref":"#/components/schemas/booking_rsv_warningsType"}},"type":"object"},"booking_rsv_cancelReservationType":{"description":"The Reservation class contains the current reservation being created or altered.","properties":{"accessRestriction":{"$ref":"#/components/schemas/booking_rsv_resAccessRestrictionType","description":"Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both."},"advanceCheckIn":{"$ref":"#/components/schemas/booking_rsv_advanceCheckInType","description":"Information relating to Reservation's Advance Checked In state and Expected Time of Return"},"allowMobileCheckout":{"description":"Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false.","type":"boolean"},"allowMobileViewFolio":{"description":"Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.","type":"boolean"},"allowedActions":{"$ref":"#/components/schemas/booking_rsv_reservationAllowedActionsType","description":"Collection of reservation allowed actions."},"attachedProfiles":{"$ref":"#/components/schemas/booking_rsv_resAttachedProfileListType","description":"List of attached profiles"},"cancellationInfo":{"description":"Information regarding why reservation has been/was cancelled.","properties":{"code":{"maxLength":20,"minLength":0,"type":"string"},"date":{"description":"Date when reservation was last cancelled.","format":"date","type":"string"},"description":{"maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"cashiering":{"$ref":"#/components/schemas/booking_rsv_resCashieringType","description":"Holds cashiering related information for the reservation."},"commissionPayoutTo":{"$ref":"#/components/schemas/booking_rsv_commissionPayoutToType","description":"If not null, reservation is considered to pay out commission to either Travel Agent, Source or both."},"computedReservationStatus":{"$ref":"#/components/schemas/booking_rsv_pMS_ResStatusType","description":"Indicates the status of the reservation."},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"cxlInstr":{"$ref":"#/components/schemas/booking_rsv_cancellationInstructionsType"},"deposit":{"$ref":"#/components/schemas/booking_rsv_reservationDepositType","description":"Holds reservation deposit information."},"displayColor":{"description":"Color setting of the reservation.","maxLength":20,"minLength":0,"type":"string"},"expectedServiceTime":{"maxLength":20,"minLength":0,"type":"string"},"externalCancellationId":{"description":"External cancellation number to be stored as cancellation number of the reservation. This is supported by postCancelShareReservation and postCancelReservation only.","maxLength":50,"minLength":1,"type":"string"},"externalReferences":{"$ref":"#/components/schemas/booking_rsv_externalReferencesType","description":"External Reference information for Reservation."},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"hotelInterfaceStatusList":{"description":"Collection of Hotel Interfaces and rights, this is populated only when fetching interface status for rooms.","items":{"$ref":"#/components/schemas/booking_rsv_reservationInterfaceStatusType"},"maxItems":4000,"type":"array"},"hotelName":{"maxLength":80,"minLength":0,"type":"string"},"housekeeping":{"$ref":"#/components/schemas/booking_rsv_resHousekeepingType","description":"Information regarding housekeeping for this reservation."},"keyCount":{"description":"Number of keys created for the reservation.","type":"integer"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"lastPrivacyPromptDate":{"description":"Last Privacy Prompt Date","format":"date","type":"string"},"mobileNotifications":{"$ref":"#/components/schemas/booking_rsv_resMobileNotificationsType","description":"Denotes the status of Room Ready, Key Ready messages."},"openFolio":{"description":"Returns true when reservation has an open folio.","type":"boolean"},"optedForCommunication":{"description":"Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation.","type":"boolean"},"overrideExternalChecks":{"description":"This forcefully overrides the cancel operation on Reservation. For real-time CRS interface, it is used as cancellation override flag.","type":"boolean"},"paymentMethod":{"description":"Payment Method.","maxLength":20,"minLength":0,"type":"string"},"preRegistered":{"description":"Defines if the reservation is pre-registered or not.","type":"boolean"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","type":"string"},"queue":{"$ref":"#/components/schemas/booking_rsv_reservationQueueInformationType","description":"Information about the time and duration this reservation was on Queue for Checkin."},"refResId":{"$ref":"#/components/schemas/booking_rsv_uniqueID_Type"},"reservationCommunication":{"$ref":"#/components/schemas/booking_rsv_resCommunicationType","description":"Collection of reservation communication details."},"reservationFolioWindows":{"$ref":"#/components/schemas/booking_rsv_reservationFolioWindowsType","description":"Collection of reservation folio windows."},"reservationGuest":{"$ref":"#/components/schemas/booking_rsv_resGuestInfoType","description":"Collection of guests associated with the reservation."},"reservationIdList":{"$ref":"#/components/schemas/booking_rsv_reservationIdList","description":"Unique identifiers for the reservation for both internal and external systems"},"reservationIndicators":{"$ref":"#/components/schemas/booking_rsv_indicatorsType","description":"Indicators of additional information attached to the reservation"},"reservationLockHandle":{"type":"number"},"reservationPaymentMethod":{"$ref":"#/components/schemas/booking_rsv_reservationPaymentMethodType","description":"Payment method used for this reservation"},"reservationStatus":{"$ref":"#/components/schemas/booking_rsv_pMS_ResStatusType","description":"Indicates the status of the reservation."},"revenuesAndBalances":{"$ref":"#/components/schemas/booking_rsv_resRevenueBalanceType","description":"Revenues and Balances Amount summary for the reservation."},"roomStatus":{"$ref":"#/components/schemas/booking_rsv_housekeepingRoomStatusType","description":"Current room status"},"roomStay":{"$ref":"#/components/schemas/booking_rsv_stayInfoType","description":"Collection of room stays."},"roomStayReservation":{"description":"Boolean True if this reservation is reserving rooms. False if it is only reserving services.","type":"boolean"},"searchMatches":{"$ref":"#/components/schemas/booking_rsv_searchMatchesType","description":"Super Search matching terms."},"sharedGuests":{"$ref":"#/components/schemas/booking_rsv_resSharedGuestListType","description":"Collection of guests who share this reservation."},"sourceOfSale":{"$ref":"#/components/schemas/booking_rsv_sourceOfSaleType","description":"Point of Sale of reservation. Identifies the entity/channel who made the reservation."},"specials":{"description":"Set of reservation preferences which belongs to the Specials group.","maxLength":4000,"minLength":0,"type":"string"},"taxType":{"$ref":"#/components/schemas/booking_rsv_taxTypeType","description":"This stores the code for the type of tax calculation especially with tax exemption, etc."},"turndownInfo":{"$ref":"#/components/schemas/booking_rsv_reservationTurndownInfoType","description":"Currency code preferred by guest."},"waitlist":{"$ref":"#/components/schemas/booking_rsv_waitlistResType","description":"Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is not in Waitlist status anymore."},"walkInIndicator":{"description":"When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in.","type":"boolean"},"welcomeOffer":{"description":"This flag will determine wheather the reservation is eligible for Welcome Offer or not.","type":"boolean"}},"type":"object"},"booking_rsv_cancellationActivityType":{"properties":{"cancellationIdList":{"$ref":"#/components/schemas/booking_rsv_uniqueIDListType","description":"Cancellation IDs"},"cxlDate":{"format":"date","type":"string"},"reason":{"$ref":"#/components/schemas/booking_rsv_cancellationReasonType"},"userId":{"type":"number"},"userName":{"type":"string"}},"type":"object"},"booking_rsv_cancellationInstructionsType":{"properties":{"deleteResTraces":{"type":"boolean"},"description":{"description":"Detailed description such as why reservation cannot be cancelled.","maxLength":4000,"minLength":0,"type":"string"},"status":{"maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_cancellationReasonType":{"properties":{"code":{"maxLength":20,"minLength":0,"type":"string"},"description":{"maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_cardNumberTypeType":{"description":"Simple type for indicating if credit card number is tokenized.","enum":["CardNumber","Token"],"type":"string"},"booking_rsv_cardProcessingType":{"enum":["Eft","Manual"],"type":"string"},"booking_rsv_cardTypeType":{"description":"This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.","enum":["Ab","Am","Ax","Cb","Dc","Ds","Dt","Ec","Er","Jc","Jl","Mc","Nb","So","St","Sw","Va","Xy","Zz","Cp","Cu"],"type":"string"},"booking_rsv_channelMarketingInfoType":{"description":"Marketing Text like cancel policy, deposit policy etc.","items":{"properties":{"description":{"description":"Marketing Text like cancel policy, deposit policy etc.","maxLength":4000,"minLength":0,"type":"string"},"policyType":{"$ref":"#/components/schemas/booking_rsv_marketingPolicyType","description":"Indicates the policy type like cancel,deposit etc."},"ratePlanCode":{"description":"Indicates the rate code for which the policy is associated with.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"maxItems":4000,"type":"array"},"booking_rsv_channelResvRSInfoType":{"description":"Holds all the channel reservation specific information.","properties":{"channelMarketingInfo":{"$ref":"#/components/schemas/booking_rsv_channelMarketingInfoType","description":"Channel Marketing Text like cancel,deposit,tax,commission policy etc."},"channelResvStatus":{"$ref":"#/components/schemas/booking_rsv_channelResvStatusType","description":"Holds the reservation status to be returned to channel."},"channelSummaryInfo":{"$ref":"#/components/schemas/booking_rsv_channelSummaryInfoType","description":"Holds channel details such as type, code"},"inSessionReservationId":{"$ref":"#/components/schemas/booking_rsv_uniqueID_Type","description":"Holds the internal reservationId for in session reservation."},"lastCommittedResv":{"$ref":"#/components/schemas/booking_rsv_lastCommittedResvType","description":"Holds the last committed reservation to be returned to channel."}},"type":"object"},"booking_rsv_channelResvStatusType":{"description":"Depicts that the operation was failed.","enum":["Pending","Cancelled","Modified","Committed","Ignored","Unsuccessful","Pending Cancellation"],"type":"string"},"booking_rsv_channelSummaryInfoType":{"description":"Depicts channel information such as the type and code.","properties":{"bookingChannel":{"$ref":"#/components/schemas/booking_rsv_bookingChannelType"}},"type":"object"},"booking_rsv_childAgeType":{"description":"Defines Child's Age.","properties":{"age":{"description":"Age of a child in years.","type":"integer"}},"type":"object"},"booking_rsv_childAgesType":{"description":"Age of a child in years.","items":{"$ref":"#/components/schemas/booking_rsv_childAgeType"},"maxItems":4000,"type":"array"},"booking_rsv_childBucketsType":{"description":"Defines children counts with Age Qualifying Group(Child Bucket) classification.","properties":{"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"}},"type":"object"},"booking_rsv_commentInfoType":{"description":"Comment related to the profile/reservation.","properties":{"comment":{"$ref":"#/components/schemas/booking_rsv_commentType","description":"Comment details for the comment. It will be empty in case of delete comment."},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_commentType":{"description":"An indication of a new paragraph for a sub-section of a formatted text message.","properties":{"commentTitle":{"description":"Specifies Comment's Title.","maxLength":4000,"minLength":0,"type":"string"},"confidential":{"description":"When true, the comment may be confidential.","type":"boolean"},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"hotelId":{"description":"If specified comment belongs to the Hotel, otherwise it is a global comment.","maxLength":20,"minLength":0,"type":"string"},"internal":{"description":"When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer.","type":"boolean"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"notificationLocation":{"description":"Notification Location associated with the Note.","maxLength":20,"minLength":0,"type":"string"},"overrideInternal":{"description":"When true, the note internal could be modified.","type":"boolean"},"text":{"$ref":"#/components/schemas/booking_rsv_formattedTextTextType","description":"Formatted text content."},"type":{"description":"Specifies type of the comment.","maxLength":20,"minLength":0,"type":"string"},"typeDescription":{"description":"Comment type Description.","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_commissionPayoutToType":{"enum":["TravelAgent","Source","TravelAgentSource","None"],"type":"string"},"booking_rsv_communicationStatusType":{"description":"Enum to denote the Status of Readiness messages sent to Guest Devices.","enum":["Pending","Completed","Failed","Sent","Received","Cancelled","PendingAvailability"],"type":"string"},"booking_rsv_countryNameType":{"description":"Used for Character Strings, length 0 to 200 - It indicates country/nationality description.","properties":{"code":{"description":"Code for a country or a nationality.","maxLength":20,"minLength":0,"type":"string"},"displayCountryFlag":{"description":"Setting this to true will display the guest profile's country flag in the OPERA Cloud user interface, if it is configured.","type":"boolean"},"isoCode":{"description":"ISO standard code for country.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Used for Character Strings, length 0 to 200.","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_currencyAmountType":{"description":"A monetary value expressed with a currency code.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"}},"type":"object"},"booking_rsv_dailyRateType":{"description":"The total amount charged for the service including additional amounts and fees.","properties":{"amountAfterTax":{"description":"The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).","type":"number"},"amountBeforeTax":{"description":"The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).","type":"number"},"baseAmount":{"description":"The rate's base price. Amount excluding price for any add to rate combine line package attached to the rate.Also excludes any discounts","type":"number"},"code":{"description":"Type of charge.","maxLength":20,"minLength":0,"type":"string"},"currencyCode":{"description":"The code specifying a monetary unit. Use ISO 4217, three alpha code.","maxLength":20,"minLength":0,"type":"string"},"currencySymbol":{"description":"The symbol for the currency, e.g, for currencyCode USD the symbol is $.","maxLength":10,"minLength":0,"type":"string"},"decimalPlaces":{"description":"Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).","type":"integer"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"discount":{"$ref":"#/components/schemas/booking_rsv_discountType","description":"Room rate discount percentage or amount, code and textual reason for discount."},"end":{"description":"The ending value of the date range.","format":"date","type":"string"},"rateOverride":{"description":"When true indicates that the rate amount has been overridden.","type":"boolean"},"start":{"description":"The starting value of the date range.","format":"date","type":"string"},"taxes":{"$ref":"#/components/schemas/booking_rsv_taxesType","description":"A collection of taxes."}},"type":"object"},"booking_rsv_dailyRatesType":{"description":"Defines room rate information on a daily basis.","items":{"$ref":"#/components/schemas/booking_rsv_dailyRateType"},"maxItems":4000,"type":"array"},"booking_rsv_depositCancelRevenueType":{"description":"The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.","enum":["Rooms","Catering","All"],"type":"string"},"booking_rsv_depositPolicyType":{"description":"Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.","properties":{"amountPercent":{"$ref":"#/components/schemas/booking_rsv_policyAmountPercentType","description":"Payment expressed as a fixed amount, or a percentage of/or room nights."},"deadline":{"$ref":"#/components/schemas/booking_rsv_policyDeadlineType","description":"Payment deadline, absolute or relative."},"depositReceiptNo":{"description":"Receipt number associated with the deposit policy","type":"integer"},"depositReqReversed":{"description":"Flag to indicate if deposit policy is reversed","type":"boolean"},"description":{"description":"Text description of the Payment in a given language.","maxLength":2000,"minLength":0,"type":"string"},"formattedRule":{"description":"Formatted Text Rule of the deposit policy.","maxLength":2000,"minLength":0,"type":"string"},"manual":{"description":"Flag to indicate if the cancellation policy is manual.","type":"boolean"},"policyCode":{"description":"Deposit Policy Code","maxLength":20,"minLength":0,"type":"string"},"transactionDate":{"description":"Transaction Date associated with the deposit policy","format":"date","type":"string"},"typeOfCharges":{"$ref":"#/components/schemas/booking_rsv_depositCancelRevenueType","description":"Defines if the deposit amount is calculated based on Room Charges, Catering Charges or both"}},"type":"object"},"booking_rsv_discountType":{"description":"Identifies and provides details about the discount. This allows for both percentages and flat amounts. If one field is used, the other should be zero/not specified since logically.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"},"discountCode":{"description":"Specifies the type of discount (e.g., No condition, LOS, Deposit or Total amount spent).","maxLength":20,"minLength":0,"type":"string"},"discountReason":{"maxLength":2000,"minLength":0,"type":"string"},"percent":{"description":"Percentage discount.","type":"number"}},"type":"object"},"booking_rsv_emailInfoType":{"description":"Information on an email for the customer.","properties":{"email":{"$ref":"#/components/schemas/booking_rsv_emailType","description":"eMail deatils for the profile."},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_emailType":{"description":"Information on an email for the customer.","properties":{"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"emailAddress":{"description":"Defines the e-mail address.","maxLength":2000,"minLength":0,"type":"string"},"emailFormat":{"description":"Supported Email format.","enum":["Html","Text"],"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"},"type":{"description":"Defines the purpose of the e-mail address (e.g. personal, business, listserve).","maxLength":20,"minLength":0,"type":"string"},"typeDescription":{"description":"Describes the Type code","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_externalReferenceType":{"description":"This type contains unique information of external reference.","properties":{"id":{"description":"Unique ID of external reference.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"ID context for external reference.","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system for the external reference number. It is only applicable to reservation external references.","type":"integer"}},"type":"object"},"booking_rsv_externalReferencesType":{"description":"This type contains unique information of external reference.","items":{"$ref":"#/components/schemas/booking_rsv_externalReferenceType"},"maxItems":4000,"type":"array"},"booking_rsv_folioTextsType":{"description":"This stores the description for the type of tax calculation especially with tax exemption, etc.","items":{"properties":{"row":{"description":"Row number of the additional text.","type":"integer"},"text":{"description":"Additional text field to display on the folio.","maxLength":50,"minLength":0,"type":"string"}},"type":"object"},"maxItems":2,"type":"array"},"booking_rsv_formattedTextTextType":{"description":"Provides text and indicates whether it is formatted or not.","properties":{"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"booking_rsv_frontOfficeRoomStatusType":{"description":"Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.","enum":["Vacant","Occupied"],"type":"string"},"booking_rsv_givenNameType":{"description":"Given name, first name or names","maxLength":40,"minLength":0,"type":"string"},"booking_rsv_guestHousekeepingServiceRequestType":{"description":"Possible values for the Guest Service Status.","enum":["DoNotDisturb","MakeUpRoom","NoStatusSelected","ServiceDeclined"],"type":"string"},"booking_rsv_guestLastStayInfoType":{"description":"Contains last stay related details of the guest.","properties":{"lastStayDate":{"description":"Guest's last stay date.","format":"date","type":"string"},"lastStayRate":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"The Rate amount of the guest's last stay."},"lastStayRoom":{"description":"Room Number where the guest stayed.","maxLength":20,"minLength":0,"type":"string"},"totalStay":{"description":"The total number of previous stay of the guest.","type":"integer"}},"type":"object"},"booking_rsv_hotelInterfaceStatusType":{"description":"Status of the Hotel Interface either STOPPED or RUNNING.","enum":["Stopped","Running","Waiting","StopInitiated","StartInitiated","RebootInitiated","Other"],"type":"string"},"booking_rsv_hotelInterfaceType":{"properties":{"activeFlag":{"description":"Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.","type":"boolean"},"hotelId":{"description":"Hotel Code","maxLength":20,"minLength":0,"type":"string"},"interfaceId":{"$ref":"#/components/schemas/booking_rsv_uniqueID_Type","description":"Unique DB internal number of a Hotel Interface record."},"interfaceName":{"description":"Name of the Hotel Interface","maxLength":40,"minLength":0,"type":"string"},"interfaceType":{"$ref":"#/components/schemas/booking_rsv_hotelInterfaceTypeType","description":"Three letter code for each interface that identifies the interface."},"logo":{"description":"Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.","maxLength":20,"minLength":0,"type":"string"},"machineName":{"description":"Unique machine name of the running IFC.","maxLength":80,"minLength":0,"type":"string"},"status":{"$ref":"#/components/schemas/booking_rsv_hotelInterfaceStatusType","description":"The current status of the IFC."}},"type":"object"},"booking_rsv_hotelInterfaceTypeType":{"description":"XML Posting Interface","enum":["Bms","Cas","Ccw","Dls","Eft","Exp","Mak","Mbs","Msc","Pbx","Pos","Svs","Tik","Vid","Vms","Www","Xml"],"type":"string"},"booking_rsv_housekeepingRoomStatusType":{"description":"Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.","enum":["Clean","Dirty","Pickup","Inspected","OutOfOrder","OutOfService"],"type":"string"},"booking_rsv_indicatorType":{"description":"Lamp indicator Type.","properties":{"count":{"description":"Indicates number of occurrences of the indicator.","type":"integer"},"indicatorName":{"description":"Name of the indicator.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_indicatorsType":{"description":"Collection of lamp indicators.","items":{"$ref":"#/components/schemas/booking_rsv_indicatorType"},"maxItems":4000,"type":"array"},"booking_rsv_instanceLink":{"description":"Metadata describing link description objects that MAY appear in the JSON instance representation.","properties":{"href":{"description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.","type":"string"},"method":{"description":"HTTP method for requesting the target of the link.","enum":["GET","POST","PUT","DELETE","PATCH","OPTIONS","HEAD"],"type":"string"},"operationId":{"description":"The operationId of the path you can call to follow this link.  This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.","type":"string"},"rel":{"description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.","type":"string"},"targetSchema":{"description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..","type":"string"},"templated":{"default":false,"description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.","type":"boolean"},"title":{"description":"Exact copy of the \"summary\" field on the linked operation.","type":"string"}},"type":"object"},"booking_rsv_interfaceRightsStatusType":{"properties":{"category":{"description":"Category code of this interface right.","maxLength":1,"minLength":0,"type":"string"},"description":{"description":"User defined description for an Interface Right.","maxLength":80,"minLength":0,"type":"string"},"right":{"description":"Internal code for each allowed right of a Hotel Interface record.","type":"integer"},"statusCode":{"description":"User defined code for an Interface Right.","maxLength":5,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_lastCommittedResvType":{"properties":{"arrivalDate":{"format":"date","type":"string"},"departureDate":{"format":"date","type":"string"},"numberOfRooms":{"description":"Number of rooms","type":"integer"},"reservationStatus":{"$ref":"#/components/schemas/booking_rsv_pMS_ResStatusType","description":"Indicates the Actual status of the reservation."},"roomType":{"description":"Current room type.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_links":{"items":{"$ref":"#/components/schemas/booking_rsv_instanceLink"},"type":"array"},"booking_rsv_marketingPolicyType":{"description":"Indicates the channel policy type like deposit,cancel etc.","enum":["Deposit","Commission","Cancel","Guarantee","General","Penalty","Tax","Promotion"],"type":"string"},"booking_rsv_membershipInfoType":{"description":"The Membership object identifies the frequent customer reward program.","properties":{"accountId":{"description":"The account identification or membership card number for this particular member in this particular program.","maxLength":50,"minLength":0,"type":"string"},"bonusCode":{"description":"The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.)","maxLength":20,"minLength":0,"type":"string"},"membershipId":{"description":"Membership ID Number(Unique ID from the memberships table).","type":"number"},"membershipLevel":{"description":"The code or name of the membership level and indicates the level of membership (Gold Club, Platinum member, etc.). This is same as the BonusCode.","maxLength":20,"minLength":0,"type":"string"},"membershipLevelDesc":{"description":"The description of the Bonus Code.(Platinum for code P)","maxLength":2000,"minLength":0,"type":"string"},"membershipTypeDesc":{"description":"The description of the ProgramCode.(Delta Previlige for code DP)","maxLength":2000,"minLength":0,"type":"string"},"playerRanking":{"description":"Ranking assigned to the Player Profile by the Gaming system.","type":"integer"},"programCode":{"description":"The code or name of the membership program ('Hertz', 'AAdvantage', etc.).","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_namePrefixType":{"description":"Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)","maxLength":40,"minLength":0,"type":"string"},"booking_rsv_nameTypeType":{"enum":["Guest","Company","Agent","Contact","Source","Group","Employee","Hotel","Purge"],"type":"string"},"booking_rsv_offsetUnitType":{"description":"Indicates deadline offset unit type.","enum":["Year","Month","Day","Hour"],"type":"string"},"booking_rsv_offshoreRateType":{"description":"Defines Offshore rate information.","properties":{"offshoreRateAmount":{"description":"Offshore Rate Amount","type":"number"},"offshoreRateCode":{"description":"Offshore Rate Code","maxLength":20,"minLength":0,"type":"string"},"offshoreRateCurrency":{"description":"Offshore Rate Currency specifying the monetary unit for the Offshore Rate. Use ISO 4217, three alpha code","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_pMS_ResStatusType":{"description":"This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.","enum":["Reserved","Requested","NoShow","Cancelled","InHouse","CheckedOut","Waitlisted","DueIn","DueOut","Walkin","PendingCheckout"],"type":"string"},"booking_rsv_payeeInfoType":{"description":"Payee information.","properties":{"payeeAddress":{"$ref":"#/components/schemas/booking_rsv_addressInfoType","description":"Address of the payee."},"payeeId":{"$ref":"#/components/schemas/booking_rsv_uniqueID_Type","description":"Opera name id of the payee."},"payeeName":{"description":"Name of the payee.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_phoneNumberType":{"description":"Phone number","maxLength":40,"minLength":0,"type":"string"},"booking_rsv_pointsType":{"description":"The Redeem Points contains the number of points required to book a room type.","properties":{"awardsType":{"description":"Awards type for the award type rate code.","type":"string"},"points":{"description":"No of points required to book this Room Stay.","type":"integer"}},"type":"object"},"booking_rsv_policyAmountPercentType":{"description":"Defines the percentage basis for calculating the fee amount or the amount.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"basisType":{"$ref":"#/components/schemas/booking_rsv_policyBasisTypeType","description":"Provides the basis for how the amount of the guarantee is calculated."},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"},"nights":{"description":"The number of nights of the hotel stay that are used to calculate the fee amount.","type":"integer"},"percent":{"description":"The percentage used to calculate the amount.","maximum":100,"minimum":0,"type":"number"}},"type":"object"},"booking_rsv_policyBasisTypeType":{"description":"Full Amount.","enum":["FlatAmount","Percentage","Nights","NightPercentage","FullAmount"],"type":"string"},"booking_rsv_policyDeadlineType":{"description":"Cancellation deadline, absolute or relative.","properties":{"absoluteDeadline":{"description":"Defines the absolute deadline in Property TimeZone. Either this or the offset attributes may be used. Uses the hotel's time zone.","format":"date-time","type":"string"},"offsetDropTime":{"description":"Time on offset day the cancellation penalties applies. Uses the hotel's time zone.","format":"date-time","type":"string"},"offsetFromArrival":{"description":"The number of days before arrival that allows cancellation without penalties.","type":"integer"},"offsetFromBookingDate":{"description":"The number of days after booking deposit must be paid.","type":"integer"}},"type":"object"},"booking_rsv_postingIntervalFrequency":{"description":"Specifies the frequency at which charges are posted for the rate plan on the reservation.","enum":["Nightly","Weekly","Monthly"],"type":"string"},"booking_rsv_postingIntervalType":{"description":"Posting Interval details for the reservation including begin/end dates, amount and frequency for each posting interval cycle on the reservation. Only available to be returned for extended stay reservations with at least 1 rate code with either a weekly or monthly posting interval.","properties":{"beginDate":{"description":"Begin Date of the Posting Interval.","format":"date","type":"string"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","type":"string"},"endDate":{"description":"End Date of the Posting Interval.","format":"date","type":"string"},"frequency":{"$ref":"#/components/schemas/booking_rsv_postingIntervalFrequency","description":"Specifies the frequency at which charges are posted for the rate plan on the reservation."},"postingAmount":{"description":"The amount to be posted for the rate plan on the begin date of the posting interval.","type":"number"},"rateCode":{"description":"Rate code used for the reservation.","type":"string"}},"type":"object"},"booking_rsv_profileId":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_profileIdList":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/booking_rsv_uniqueID_Type"},"maxItems":4000,"type":"array"},"booking_rsv_promotionType":{"description":"Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation. \u003cp\u003eNote: For putReservation when promotion type element is sent with no value, existing promotion codes on the reservation will be removed.\u003c/p\u003e","properties":{"couponCode":{"description":"Promotion Coupon Code when promotion is setup to have a valid coupon code.","maxLength":40,"minLength":0,"type":"string"},"promotionCode":{"description":"Promotion code associated with the rate plan.","maxLength":20,"minLength":0,"type":"string"},"promotionName":{"description":"Promotion code Name associated with the rate plan.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_queueTextInfoType":{"description":"Information regarding the message sent to guest.","properties":{"sentBy":{"description":"User name of the user who sent message.","maxLength":40,"minLength":0,"type":"string"},"sentTime":{"description":"Time the text was last sent to the user. Uses the hotel's time zone.","format":"date-time","type":"string"}},"type":"object"},"booking_rsv_resAccessRestrictionType":{"description":"Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.","enum":["Change","Cancel","ChangeOrCancel"],"type":"string"},"booking_rsv_resAccompanyGuestInfoType":{"properties":{"alternateFirstName":{"description":"Alternate first name","type":"string"},"alternateFullName":{"description":"Alternate full name","type":"string"},"alternateLastName":{"description":"Alternate last name.","type":"string"},"externalReferences":{"$ref":"#/components/schemas/booking_rsv_externalReferencesType","description":"External References information for this Profile. Will be returned in getReservations and getHotelReservations when the 'profileExternalReferencesToFetch' query parameter is sent."},"firstName":{"description":"Given name, first name or names","type":"string"},"fullName":{"description":"String representation of the full name","type":"string"},"lastName":{"description":"Family name, last name.","type":"string"},"profileIdList":{"$ref":"#/components/schemas/booking_rsv_profileIdList","description":"Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id."},"registrationCardNo":{"description":"Unique identifier of the police registration card number.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_resAccompanyGuestListType":{"description":"Collection of accompany guests","items":{"$ref":"#/components/schemas/booking_rsv_resAccompanyGuestInfoType"},"maxItems":4000,"type":"array"},"booking_rsv_resAttachedProfileListType":{"items":{"$ref":"#/components/schemas/booking_rsv_resAttachedProfileType"},"maxItems":4000,"type":"array"},"booking_rsv_resAttachedProfileType":{"properties":{"externalReferences":{"$ref":"#/components/schemas/booking_rsv_externalReferencesType","description":"External References information for this Profile. Will be returned in getReservations and getHotelReservations when the 'profileExternalReferencesToFetch' query parameter is sent."},"name":{"description":"Attached profile name","type":"string"},"profileIdList":{"$ref":"#/components/schemas/booking_rsv_profileIdList","description":"Collection of unique profile identifiers"},"reservationProfileType":{"$ref":"#/components/schemas/booking_rsv_resProfileTypeType"}},"type":"object"},"booking_rsv_resCancelPenaltyType":{"description":"The CancelPenalty class defines the cancellation policy of the hotel facility.","properties":{"amountPercent":{"$ref":"#/components/schemas/booking_rsv_policyAmountPercentType","description":"Cancellation fee expressed as a fixed amount, or percentage of/or room nights."},"deadline":{"$ref":"#/components/schemas/booking_rsv_policyDeadlineType","description":"Cancellation deadline, absolute or relative."},"effective":{"description":"Indicator if Cancellation Penalty is currently applicable or not.","type":"boolean"},"formattedRule":{"description":"Formatted Text Rule of the Cancellation Penalty.","maxLength":2000,"minLength":0,"type":"string"},"manual":{"description":"Flag to indicate if the cancellation policy is manual.","type":"boolean"},"nonRefundable":{"description":"Indicates if the amount is refundable if booking is canceled.","type":"boolean"},"offsetUnit":{"$ref":"#/components/schemas/booking_rsv_offsetUnitType"},"penaltyDescription":{"description":"Text description of the Penalty in a given language.","maxLength":2000,"minLength":0,"type":"string"},"policyCode":{"description":"Policy Code.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_resCancellationPoliciesType":{"description":"A list of reservation cancellation policies.","items":{"$ref":"#/components/schemas/booking_rsv_resCancellationPolicyType"},"maxItems":4000,"type":"array"},"booking_rsv_resCancellationPolicyType":{"description":"A cancellation policy attached with the reservation.","properties":{"comments":{"description":"Comments attached with the reservation cancellation.","maxLength":2000,"minLength":0,"type":"string"},"percentageDue":{"description":"The percentage amount due for reservation cancellation.","maximum":100,"minimum":0,"type":"number"},"policy":{"$ref":"#/components/schemas/booking_rsv_resCancelPenaltyType","description":"Cancellation policy details."},"policyId":{"$ref":"#/components/schemas/booking_rsv_uniqueID_Type","description":"Unique ID of the Reservation Policy."},"revenueType":{"$ref":"#/components/schemas/booking_rsv_depositCancelRevenueType","description":"Type of reservation."}},"type":"object"},"booking_rsv_resCashieringType":{"description":"Cashiering Information for the reservation.","properties":{"bedTaxReporting":{"$ref":"#/components/schemas/booking_rsv_bedTaxReportingType","description":"This stores the information for Bed Tax Reporting. Mainly used in Maldives."},"billingPrivileges":{"$ref":"#/components/schemas/booking_rsv_billingPrivilegesType","description":"Billing privileges set on the reservation."},"compAccounting":{"$ref":"#/components/schemas/booking_rsv_resCompAccountingType","description":"Information regarding comp accounting on the reservation."},"folioTexts":{"$ref":"#/components/schemas/booking_rsv_folioTextsType","description":"Additional text fields to display on the folio."},"lastRoomAndTaxPostedDate":{"description":"Date of the last Room And Tax posting. Used primarily to know the date in case of Advance Billing.","format":"date","type":"string"},"reservationPreConfiguredRoutingInstruction":{"$ref":"#/components/schemas/booking_rsv_resPreConfiguredRoutingInstrType","description":"Information regarding the selected preconfigured routing instruction on the reservation. This will be used when Multiple Promotion Code Comp Routings is inactive."},"reservationPreConfiguredRoutingInstructions":{"$ref":"#/components/schemas/booking_rsv_reservationPreConfiguredRoutingInstructionsType","description":"Information regarding the selected preconfigured routing instructions on the reservation. This will be used when Multiple Promotion Code Comp Routings is active."},"revenuesAndBalances":{"$ref":"#/components/schemas/booking_rsv_resRevenueBalanceType","description":"Revenues and Balances Amount summary for the reservation."},"reverseAdvanceCheckInAllowed":{"description":"This attribute is to verify if reverse advance check-in is allowed for the reservation.","type":"boolean"},"reverseCheckInAllowed":{"description":"This attribute is to verify if reverse check-in is allowed for the reservation.","type":"boolean"},"taxType":{"$ref":"#/components/schemas/booking_rsv_reservationTaxTypeInfo"},"transactionsPosted":{"description":"Specifies whether reservation has a financial transaction associated with it.","type":"boolean"}},"type":"object"},"booking_rsv_resCommunicationType":{"description":"Communication details for a reservation.","properties":{"emails":{"description":"List of email address for the customer.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"emailInfo":{"description":"Collection of Detailed information on an eMail address for the customer.","items":{"$ref":"#/components/schemas/booking_rsv_emailInfoType"},"maxItems":4000,"type":"array"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"telephones":{"description":"List of Telephone Number Information","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"telephoneInfo":{"description":"Collection of Detailed information on telephone/fax for the customer.","items":{"$ref":"#/components/schemas/booking_rsv_telephoneInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"}},"type":"object"},"booking_rsv_resCompAccountingType":{"description":"Information regarding comp accounting on the reservation.","properties":{"authorizer":{"description":"ID of the employee who will act as the host for this guest.","maxLength":40,"minLength":0,"type":"string"},"compPostings":{"description":"Indicates if the Comp Billing/posting Exist","maxLength":5,"minLength":0,"type":"string"},"compType":{"description":"Code used to identify the casino comp type and ranking of a guest.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_resDepositPoliciesType":{"description":"A list of deposit policies attached with the reservation.","items":{"$ref":"#/components/schemas/booking_rsv_resDepositPolicyType"},"maxItems":4000,"type":"array"},"booking_rsv_resDepositPolicyType":{"description":"A deposit policy attached with the reservation.","properties":{"amountDue":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"Total amount due against the reservation deposit."},"amountPaid":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"Total amount paid against the reservation deposit."},"comments":{"description":"Comments attached with a deposit.","maxLength":2000,"minLength":0,"type":"string"},"policy":{"$ref":"#/components/schemas/booking_rsv_depositPolicyType","description":"Reservation deposit policy details."},"policyId":{"$ref":"#/components/schemas/booking_rsv_uniqueID_Type","description":"Unique ID of the Reservation Policy."},"revenueType":{"$ref":"#/components/schemas/booking_rsv_depositCancelRevenueType","description":"Type of reservation."}},"type":"object"},"booking_rsv_resExpectedTimesType":{"description":"Holds the Arrival and Departure Time Information","properties":{"reservationExpectedArrivalTime":{"description":"Arrival Time. Uses the hotel's time zone.","format":"date-time","type":"string"},"reservationExpectedDepartureTime":{"description":"Departure Time. Uses the hotel's time zone.","format":"date-time","type":"string"}},"type":"object"},"booking_rsv_resGuaranteeType":{"description":"Validations type record returned after Validations are done.","properties":{"guaranteeCode":{"description":"Guarantee Code.","maxLength":20,"minLength":0,"type":"string"},"onHold":{"description":"Guarantee Code.","type":"boolean"},"shortDescription":{"description":"Guarantee Code.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_resGuestInfoType":{"description":"Specifies Company or Travel Agent profile using IATA or Corp. No.","properties":{"accompanyGuests":{"$ref":"#/components/schemas/booking_rsv_resAccompanyGuestListType","description":"List of guest names that are accompanying the reservation guest"},"address":{"$ref":"#/components/schemas/booking_rsv_addressSearchType","description":"Address information that is attached to the reservation guest"},"alternateFullName":{"description":"Alternate full name","type":"string"},"alternateGivenName":{"description":"Alternate given name, first name or names","maxLength":40,"minLength":0,"type":"string"},"alternateSurname":{"description":"Alternate family name, last name.","maxLength":40,"minLength":0,"type":"string"},"anonymization":{"$ref":"#/components/schemas/booking_rsv_anonymizationType","description":"Provides information about the guest's anonymization status"},"birthDate":{"description":"Date of birth","format":"date","type":"string"},"email":{"$ref":"#/components/schemas/booking_rsv_basicEmailType","description":"Email address"},"externalReferences":{"$ref":"#/components/schemas/booking_rsv_externalReferencesType","description":"External References information for this Profile. Will be returned in getReservations and getHotelReservations when the 'profileExternalReferencesToFetch' query parameter is sent."},"fullName":{"description":"Full display name","type":"string"},"givenName":{"$ref":"#/components/schemas/booking_rsv_givenNameType","description":"Given name, first name or names"},"guestLastStayInformation":{"$ref":"#/components/schemas/booking_rsv_guestLastStayInfoType","description":"Contains information regarding the last stay of this guest."},"guestRestricted":{"description":"True indicates there are restrictions associated with the current profile.","type":"boolean"},"guestRestrictedCode":{"description":"Guest profile restricted reason code","type":"string"},"guestRestrictedReasonDesc":{"description":"Guest profile restricted reason description","type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"membership":{"$ref":"#/components/schemas/booking_rsv_membershipInfoType","description":"The Membership object identifying the frequent customer reward program."},"middleName":{"description":"The middle name of the person name","maxLength":40,"minLength":0,"type":"string"},"namePrefix":{"$ref":"#/components/schemas/booking_rsv_namePrefixType","description":"Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)"},"nameTitle":{"description":"Degree or honors (e.g., Ph.D., M.D.)","maxLength":20,"minLength":0,"type":"string"},"nameType":{"$ref":"#/components/schemas/booking_rsv_nameTypeType"},"nationality":{"$ref":"#/components/schemas/booking_rsv_countryNameType","description":"Affiliation or ethnicity to a particular country."},"phoneNumber":{"$ref":"#/components/schemas/booking_rsv_phoneNumberType","description":"Phone number"},"registrationCardNo":{"description":"Unique identifier of the police registration card number.","maxLength":40,"minLength":0,"type":"string"},"surname":{"$ref":"#/components/schemas/booking_rsv_surnameType","description":"Family name, last name."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"},"vip":{"$ref":"#/components/schemas/booking_rsv_vIPType","description":"The supplier's ranking of the customer (e.g., VIP, numerical ranking)."}},"type":"object"},"booking_rsv_resHousekeepingType":{"description":"Holds housekeeping turndown service information for the room.","properties":{"expectedServiceTime":{"description":"Expected Start Time for housekeeping task(s).","type":"string"},"frontOfficeStatus":{"$ref":"#/components/schemas/booking_rsv_frontOfficeRoomStatusType","description":"Front office status ( Occupied/Vacant )."},"housekeepingStatus":{"$ref":"#/components/schemas/booking_rsv_frontOfficeRoomStatusType","description":"Housekeeping status ( Occupied/Vacant )."},"instructions":{"description":"Turndown instructions for the room.","type":"string"},"roomStatus":{"$ref":"#/components/schemas/booking_rsv_housekeepingRoomStatusType","description":"Current room status. Current room status is populated only if room is assigned to the reservation and reservation is due in or in house."},"turndownRequested":{"description":"Indicates whether guest wants turndown facility or not.","type":"boolean"}},"type":"object"},"booking_rsv_resMobileNotificationsType":{"description":"Contains the status of Room Ready and Key Ready messages.","properties":{"checkoutMessageReceived":{"description":"Indicates if the Mobile checkout message is received.","type":"boolean"},"errorMessage":{"description":"Error message when Mobile Notification has failed.","type":"string"},"keyReady":{"$ref":"#/components/schemas/booking_rsv_communicationStatusType","description":"Denotes the status of Key Ready message. It can have one of the values:PENDING, COMPLETED or FAILED"},"requiresAction":{"description":"Indicates if user action is required. The action could be for sending Room Ready or Key Ready Notification. It could also be for initiating Checkout","type":"boolean"},"roomReady":{"$ref":"#/components/schemas/booking_rsv_communicationStatusType","description":"Denotes the status of Room Ready message. It can have one of the values:PENDING, COMPLETED or FAILED"}},"type":"object"},"booking_rsv_resPaymentCardType":{"description":"Information on a credit card for the customer.","properties":{"approvalAmountNeeded":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType"},"approvalCode":{"description":"Approval code sent by the credit card company on a successful authorization.","maxLength":20,"minLength":0,"type":"string"},"cardHolderName":{"maxLength":200,"minLength":0,"type":"string"},"cardId":{"$ref":"#/components/schemas/booking_rsv_uniqueID_Type","description":"credit card id"},"cardNumber":{"maxLength":80,"minLength":0,"type":"string"},"cardNumberLast4Digits":{"maxLength":80,"minLength":0,"type":"string"},"cardNumberMasked":{"maxLength":80,"minLength":0,"type":"string"},"cardOrToken":{"$ref":"#/components/schemas/booking_rsv_cardNumberTypeType","description":"This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates credit card is token enabled and 'CardNumber' indicates non token environment for this payment card type."},"cardPresent":{"description":"Flag to determine if the credit card was swiped/manually entered , This element is only used when PAYMENT SERVICE DIRECTIVE(PSD) Opera Control is active.","type":"boolean"},"cardType":{"$ref":"#/components/schemas/booking_rsv_cardTypeType","description":"Indicates the type of credit card from a defined list"},"citId":{"description":"Customer Initiated Transaction(CIT) Id for Credit Cards. This is only used when PAYMENT SERVICES DIRECTIVE (PSD2) Opera Control is active.","maxLength":30,"minLength":0,"type":"string"},"currentAuthorizedAmount":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType"},"expirationDate":{"description":"Expiration date of the credit card","format":"date","type":"string"},"expirationDateExpired":{"type":"boolean"},"expirationDateMasked":{"description":"Masked Expiration date of the credit card","maxLength":20,"minLength":0,"type":"string"},"processing":{"$ref":"#/components/schemas/booking_rsv_cardProcessingType","description":"This contains information on whether EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type."},"storeToCreditCardWallet":{"description":"Indicate whether the credit card will be stored to the credit card wallet or not.","type":"boolean"},"swiped":{"type":"boolean"},"userDefinedCardType":{"description":"Indicates the user defined credit card type if credit card type from a defined list is not provided","maxLength":2,"minLength":0,"type":"string"},"vcc":{"description":"Flag to determine if the credit card is a Virtual Credit Card.","type":"boolean"}},"type":"object"},"booking_rsv_resPreConfiguredRoutingInstrType":{"description":"Instruction to attach Pre-Configured Routing Instructions to a Reservation.","properties":{"authorizerInfo":{"$ref":"#/components/schemas/booking_rsv_authorizerInfoType","description":"The authorizer information for Promotion Code with attached Complimentary Routing"},"beginDate":{"description":"Begin Date for attached Routing Instruction.","format":"date","type":"string"},"endDate":{"description":"End Date for attached Routing Instruction.","format":"date","type":"string"},"folioView":{"description":"Folio Window.","type":"integer"},"profileId":{"$ref":"#/components/schemas/booking_rsv_profileId","description":"Profile Id with attached Routing Instruction."},"profileType":{"$ref":"#/components/schemas/booking_rsv_resProfileTypeType","description":"Profile Type with attached Routing Instruction."},"promotionCode":{"description":"Promotion Code with attached Complimentary Routing.","maxLength":20,"minLength":0,"type":"string"},"ratePlanCode":{"description":"Rate Code with attached Routing Instruction.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_resProfileTypeType":{"enum":["Guest","Company","Group","TravelAgent","Source","ReservationContact","BillingContact","Addressee"],"type":"string"},"booking_rsv_resRevenueBalanceType":{"description":"Revenue and Balance Amount summary for the reservation.","properties":{"balance":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"Balance amount on the reservation."},"compBalance":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"Comp Balance amount"},"foodAndBevRevenue":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"Food and Beverage Revenue generated by the reservation."},"nonRevenue":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"Total Non Revenue posted on the reservation."},"otherRevenue":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"Other Revenue generated by the reservation."},"roomRevenue":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"Room Revenue generated by the reservation."},"totalDepositPaid":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"Total of all deposit payment posted to the reservation."},"totalFixedCharge":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"Total Fixed Charges on the reservation."},"totalPayment":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"Total of all payments on the guest ledger for the reservation."},"totalRevenue":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"Total Revenue generated by the reservation."}},"type":"object"},"booking_rsv_resSharedGuestInfoType":{"description":"Contains information regarding the share reservation.","properties":{"firstName":{"description":"Given name, first name or names","type":"string"},"fullName":{"description":"String representation of the full name","type":"string"},"lastName":{"description":"Family name, last name.","type":"string"},"profileId":{"$ref":"#/components/schemas/booking_rsv_profileId"},"reservationId":{"$ref":"#/components/schemas/booking_rsv_reservationId"}},"type":"object"},"booking_rsv_resSharedGuestListType":{"description":"Collection of shared guest reservations.","items":{"$ref":"#/components/schemas/booking_rsv_resSharedGuestInfoType"},"maxItems":4000,"type":"array"},"booking_rsv_reservationAllowedActionType":{"description":"Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.","enum":["Cancel","Move","PreCharge","PostCharge","FacilitySchedule","Upsell","PreCheckIn","PostToNoShowCancel","NoShow","NameChange","Discount","HouseKeeping","EnrollToPrimaryMembership","EnrollInProgress","MemberAwardAttached","UpgradeAwardAttached","DiscountAwardAttached"],"type":"string"},"booking_rsv_reservationAllowedActionsType":{"description":"Allowed action.","items":{"$ref":"#/components/schemas/booking_rsv_reservationAllowedActionType"},"maxItems":11,"type":"array"},"booking_rsv_reservationBlockType":{"description":"Key information about the block for a reservation.","properties":{"blockIdList":{"$ref":"#/components/schemas/booking_rsv_blockIdList","description":"Collection of unique block identifiers for the reservation."},"blockName":{"description":"The Name of the block that is attached to the reservation.","maxLength":40,"minLength":0,"type":"string"},"hotelId":{"description":"This is the HotelCode of the Block.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_reservationDepositType":{"description":"Reservation Deposit Type.","properties":{"amountOwed":{"description":"Deposit Amount Oustanding.","maxLength":40,"minLength":0,"type":"number"},"amountPaid":{"description":"Deposit Amount Paid.","type":"number"},"amountRequired":{"description":"Deposit Amount Required.","maxLength":40,"minLength":0,"type":"number"},"dueDate":{"description":"Deposit Due Date.","format":"date","type":"string"},"hasOutstanding":{"description":"Resolves whether reservation has outstanding deposit.","type":"boolean"},"hasPaid":{"description":"Resolves whether reservation has paid deposit.","type":"boolean"},"hasPayByLinks":{"description":"Resolves whether reservation has Pay By Links.","type":"boolean"},"postingDate":{"description":"Deposit Posting Date.","format":"date","type":"string"}},"type":"object"},"booking_rsv_reservationFolioWindowType":{"description":"Folio window view which holds the set of folios for a reservation.","properties":{"balance":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"Running balance of the window."},"folioWindowNo":{"type":"integer"},"payeeInfo":{"$ref":"#/components/schemas/booking_rsv_payeeInfoType","description":"The window's configured payee information."},"paymentMethod":{"description":"Payment Method Type","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_reservationFolioWindowsType":{"description":"Collection of reservation folio windows.","items":{"$ref":"#/components/schemas/booking_rsv_reservationFolioWindowType"},"maxItems":4000,"type":"array"},"booking_rsv_reservationId":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"booking_rsv_reservationIdList":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/booking_rsv_uniqueID_Type"},"maxItems":4000,"type":"array"},"booking_rsv_reservationInterfaceStatusType":{"description":"Hotel Interface Type for a reservation and status of the various services","properties":{"hotelInterface":{"$ref":"#/components/schemas/booking_rsv_hotelInterfaceType","description":"Hotel interface information for the reservation"},"interfaceRights":{"description":"Contains a list of status/rights for the various services under this interface","items":{"$ref":"#/components/schemas/booking_rsv_interfaceRightsStatusType"},"maxItems":4000,"type":"array"},"roomExtension":{"description":"Identifier for the room extension","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_reservationPaymentMethodType":{"properties":{"authorizationRule":{"$ref":"#/components/schemas/booking_rsv_authorizationRuleType"},"balance":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType"},"confidential":{"description":"Flag indicating a billing window (2-8) as confidential. Applied only when Confidential Billing Window Opera Control is active.","type":"boolean"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"emailFolioInfo":{"description":"Information on an email for the customer.","properties":{"email":{"$ref":"#/components/schemas/booking_rsv_emailType","description":"eMail deatils for the profile."},"emailFolio":{"type":"boolean"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"folioView":{"type":"integer"},"paymentCard":{"$ref":"#/components/schemas/booking_rsv_resPaymentCardType"},"paymentMethod":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_reservationPoliciesType":{"description":"A collection of reservation deposit and cancellation policies.","properties":{"cancellationPolicies":{"$ref":"#/components/schemas/booking_rsv_resCancellationPoliciesType","description":"A collection of reservation cancellation policies.."},"depositPolicies":{"$ref":"#/components/schemas/booking_rsv_resDepositPoliciesType","description":"A collection of reservation deposit policies."},"name":{"description":"Name identifier for the reservation.","type":"string"},"reservationIdList":{"$ref":"#/components/schemas/booking_rsv_uniqueIDListType","description":"A list of Ids for reservation."}},"type":"object"},"booking_rsv_reservationPreConfiguredRoutingInstructionsType":{"properties":{"consumableInventory":{"description":"List of default routing instructions.","items":{"$ref":"#/components/schemas/booking_rsv_resPreConfiguredRoutingInstrType"},"maxItems":4000,"type":"array"}},"type":"object"},"booking_rsv_reservationQueueInformationType":{"description":"Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.","properties":{"averageQueueTimeCurrentReservations":{"description":"The average time, in seconds, of the reservations currently in queue.","type":"integer"},"averageQueueTimeToCheckIn":{"description":"The average time, in seconds, a reservation was on queue prior to Check-In.","type":"integer"},"guestTextInfo":{"$ref":"#/components/schemas/booking_rsv_queueTextInfoType","description":"Information for the message sent to the user"},"priority":{"description":"The Queue Priority given to this reservation.","type":"integer"},"queueDate":{"description":"The Business date on which the reservation was due to arrive and is currently placed on Queue for Check In.","format":"date","type":"string"},"timeSpan":{"description":"Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.","properties":{"duration":{"type":"string"},"durationInSeconds":{"description":"The total duration, in seconds, the reservation is on Queue.","type":"integer"},"endDate":{"format":"date","type":"string"},"startDate":{"format":"date","type":"string"}},"type":"object"}},"type":"object"},"booking_rsv_reservationRoomOwnershipType":{"description":"Indicates if the assigned reservation room is an Owner/Referral or Regular room.","enum":["Owner","Referral","Regular"],"type":"string"},"booking_rsv_reservationTaxTypeInfo":{"description":"Provides information about the Tax Type.","properties":{"code":{"description":"Code of the Tax Type.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Description of the Tax Type.","maxLength":2000,"minLength":0,"type":"string"},"taxExemptNo":{"description":"Tax exempt number on the profile.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_reservationTurndownInfoType":{"description":"Turndown information for a reservation","properties":{"allowed":{"description":"Indicates if turndown is allowed or not","type":"boolean"},"status":{"$ref":"#/components/schemas/booking_rsv_turndownStatusType","description":"Indicates turndown status, values could be required, not required, completed"}},"type":"object"},"booking_rsv_roomOccupancyType":{"description":"Room Occupancy information.","properties":{"estimatedDepartureTime":{"description":"Estimated Time of Departure of reservation when room status is occupied.","format":"date-time","type":"string"},"guestFirstName":{"description":"Guest First/Given Name on reservation when room status is occupied.","maxLength":40,"minLength":0,"type":"string"},"guestLastName":{"description":"Guest Last Name /Surname on reservation when room status is occupied.","maxLength":40,"minLength":0,"type":"string"},"reservationIdList":{"$ref":"#/components/schemas/booking_rsv_uniqueIDListType","description":"A list of Ids for reservation( ResvNameId and ConfirmationNumber)."},"roomId":{"description":"Room Id.","maxLength":20,"minLength":0,"type":"string"},"roomIsOccupied":{"description":"Indicates if the Room is currently occupied.","type":"boolean"},"roomNumberLocked":{"description":"This attribute is to verify if room number is locked for the reservation. When true the room number cannot be changed. This is supported when OPERA Control Do Not Move is active.","type":"boolean"},"roomStatus":{"$ref":"#/components/schemas/booking_rsv_housekeepingRoomStatusType","description":"Room status"},"roomType":{"description":"Room Type.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_scheduledRoomMoveResponseType":{"description":"Scheduled Room Move information.","properties":{"estimatedMoveTime":{"description":"Estimated Move Time in 24Hour Format. Uses the hotel's time zone.","format":"date-time","type":"string"},"moveComments":{"description":"Comments about scheduled move.","maxLength":200,"minLength":0,"type":"string"},"moveInRoomOccupancyInfo":{"$ref":"#/components/schemas/booking_rsv_roomOccupancyType","description":"Scheduled Move In Room Occupancy Information."}},"type":"object"},"booking_rsv_searchMatchType":{"description":"Search match indicating attribute and the matching value.","properties":{"attribute":{"description":"Search match attribute.","maxLength":2000,"minLength":0,"type":"string"},"value":{"description":"Search match value.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_searchMatchesType":{"description":"List of Generic Name-Value-Pair Parameters used for super search matches.","items":{"$ref":"#/components/schemas/booking_rsv_searchMatchType"},"maxItems":4000,"type":"array"},"booking_rsv_sourceOfSaleType":{"description":"Point of Sale of reservation. Identifies the entity/channel who made the reservation.","properties":{"sourceCode":{"description":"The entity/channel who made the reservation.","maxLength":20,"minLength":0,"type":"string"},"sourceType":{"description":"Type of entity/channel who made the reservation..","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_stayInfoType":{"description":"Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties.","properties":{"adultCount":{"description":"A collection of Guest Counts associated with Room Stay.","type":"integer"},"arrivalDate":{"format":"date","type":"string"},"assignedByAI":{"description":"Represents the room was assigned by AI Room Assignment.","type":"boolean"},"backToBack":{"description":"This attribute indicates if the linked reservation is marked as Back to Back or not.","type":"boolean"},"backToBackGroupId":{"description":"This attribute represents a common identifier for a subgroup of linked reservations marked as Back to Back in a group of linked reservations.","maxLength":80,"minLength":0,"type":"string"},"backToBackSequence":{"$ref":"#/components/schemas/booking_rsv_backToBackResSequenceType","description":"This attribute represents Back To Back Sequence of Linked Reservations(e.g. '1 of 2' i.e, 1 indicates Sequence Position of total count 2). This is applicable when OPERA control Back to Back Handling for Linked Reservations is active."},"balance":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"Balance amount"},"bookingChannelCode":{"description":"Classifies the medium(Channel field on reservation screen) through which the reservation is made.","maxLength":40,"minLength":0,"type":"string"},"bookingTimeSpan":{"$ref":"#/components/schemas/booking_rsv_bookingTimeSpanType","description":"The booking time span of the reservation, only applicable when time increments are being used."},"childAges":{"$ref":"#/components/schemas/booking_rsv_childAgesType","description":"Defines Children's Ages. Number of children ages mentioned may mot match with children counts."},"childBuckets":{"$ref":"#/components/schemas/booking_rsv_childBucketsType","description":"Defines children counts with Age Qualifying Group(Child Bucket#1) classification."},"childCount":{"description":"A collection of Child Counts associated with Room Stay.","type":"integer"},"compBalance":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"Comp Balance amount"},"departureDate":{"format":"date","type":"string"},"depositPayments":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"A collection of deposit and/or payments for the Room Stay."},"expectedTimes":{"$ref":"#/components/schemas/booking_rsv_resExpectedTimesType","description":"The expected arrival, return and departure times of the guest."},"fixedRate":{"description":"True if the rate is a fixed rate, otherwise false","type":"boolean"},"guarantee":{"$ref":"#/components/schemas/booking_rsv_resGuaranteeType","description":"The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context."},"guestServiceStatus":{"$ref":"#/components/schemas/booking_rsv_guestHousekeepingServiceRequestType","description":"Service Status of In House guest like DND or MUP"},"linkCode":{"description":"Party code","maxLength":2000,"type":"string"},"marketCode":{"description":"Market code","maxLength":20,"minLength":0,"type":"string"},"numberOfRooms":{"description":"Room Id","type":"integer"},"offshoreRateInformation":{"$ref":"#/components/schemas/booking_rsv_offshoreRateType"},"originalTimeSpan":{"$ref":"#/components/schemas/booking_rsv_timeSpanType","description":"The Original Time Span covers the Room Stay dates of the original reservation."},"points":{"$ref":"#/components/schemas/booking_rsv_pointsType","description":"The Points contains the number of points used to book a particular room type."},"postingInterval":{"$ref":"#/components/schemas/booking_rsv_postingIntervalType","description":"Specifies the frequency at which charges are posted for the rate plan on the reservation."},"promotion":{"$ref":"#/components/schemas/booking_rsv_promotionType","description":"Promotion Codes"},"pseudoRoom":{"description":"True indicates as pseudo room type. This is usually used for a posting master reservation.","type":"boolean"},"rateAmount":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"Rate amount"},"ratePlanCode":{"description":"Rate plan code","maxLength":20,"minLength":0,"type":"string"},"rateSuppressed":{"description":"Whether this rate should be suppressed from view","type":"boolean"},"reservationBlock":{"$ref":"#/components/schemas/booking_rsv_reservationBlockType","description":"Key information about the block for this reservation."},"roomAvailableNights":{"description":"Number of nights this room is avaiable if room is assigned to reservation","type":"integer"},"roomClass":{"description":"Room class code","maxLength":20,"minLength":0,"type":"string"},"roomId":{"description":"Room Id","maxLength":20,"minLength":0,"type":"string"},"roomNumberLocked":{"description":"When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.","type":"boolean"},"roomOwnershipType":{"$ref":"#/components/schemas/booking_rsv_reservationRoomOwnershipType","description":"Provides the information of the assigned reservation room is an Owner, Referral or regular room.This value is returned when Room Rotation OPERA Control is active and room number is assigned to a reservation."},"roomType":{"description":"Room type code","maxLength":20,"minLength":0,"type":"string"},"roomTypeCharged":{"description":"Room type code that was charged","maxLength":20,"minLength":0,"type":"string"},"scheduledCheckoutTime":{"description":"Indicates that this reservation is scheduled for automated check out.","format":"date","type":"string"},"scheduledRoomMoveResponseType":{"$ref":"#/components/schemas/booking_rsv_scheduledRoomMoveResponseType","description":"Scheduled Room Move Response Information."},"scheduledRoomMoveRoomPending":{"description":"Pending Scheduled Move Room.","type":"boolean"},"sourceCode":{"description":"Source of business","maxLength":20,"minLength":0,"type":"string"},"sourceCodeDescription":{"description":"Description of the source of business.","maxLength":4000,"minLength":0,"type":"string"},"totalAmount":{"$ref":"#/components/schemas/booking_rsv_currencyAmountType","description":"The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount."},"upgradedByAI":{"description":"Represents the room was assigned by AI Room Assignment.","type":"boolean"}},"type":"object"},"booking_rsv_surnameType":{"description":"Family name, last name.","maxLength":80,"minLength":0,"type":"string"},"booking_rsv_taxType":{"description":"Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"code":{"description":"Code identifying the fee (e.g.,agency fee, municipality fee).","maxLength":20,"minLength":0,"type":"string"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"generateTransactionCode":{"description":"Unique identifier for Generate Tax Transaction code.","maxLength":20,"minLength":0,"type":"string"},"type":{"$ref":"#/components/schemas/booking_rsv_amountDeterminationType","description":"Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other)."}},"type":"object"},"booking_rsv_taxTypeType":{"description":"Provides information about the Tax Type.","properties":{"code":{"description":"Code of the Tax Type.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Description of the Tax Type.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_taxesType":{"description":"A collection of taxes.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"},"tax":{"description":"An individual tax.","items":{"$ref":"#/components/schemas/booking_rsv_taxType"},"maxItems":99,"type":"array"},"totalTax":{"description":"A sum of the taxes which are related to Rate Info.","type":"number"}},"type":"object"},"booking_rsv_telephoneInfoType":{"description":"Information on a telephone number for the customer.","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"telephone":{"$ref":"#/components/schemas/booking_rsv_telephoneType","description":"Phone details for the profile."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_telephoneType":{"description":"Information on a telephone number for the customer.","properties":{"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"extension":{"description":"Extension to reach a specific party at the phone number.","maxLength":20,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"phoneNumber":{"description":"Telephone number assigned to a single location.","maxLength":40,"minLength":0,"type":"string"},"phoneTechType":{"description":"Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc.","maxLength":20,"minLength":0,"type":"string"},"phoneUseType":{"description":"Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening).","maxLength":20,"minLength":0,"type":"string"},"phoneUseTypeDescription":{"description":"Description of the PhoneUseType code","maxLength":2000,"minLength":0,"type":"string"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"}},"type":"object"},"booking_rsv_timeSpanType":{"description":"Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.","properties":{"duration":{"type":"string"},"endDate":{"format":"date","type":"string"},"startDate":{"format":"date","type":"string"}},"type":"object"},"booking_rsv_turndownStatusType":{"description":"Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Completed.","enum":["Required","NotRequired","Compeleted"],"type":"string"},"booking_rsv_uniqueIDListType":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/booking_rsv_uniqueID_Type"},"maxItems":4000,"type":"array"},"booking_rsv_uniqueID_Type":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system. Eg: ConfirmationLegNumber, ExternalLegNumber","type":"integer"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_vIPType":{"description":"The supplier's ranking of the customer.","properties":{"vipCode":{"description":"VIP Code.","maxLength":20,"minLength":0,"type":"string"},"vipDescription":{"description":"VIP Description.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_waitlistResType":{"description":"Information regarding why reservation is being /has been waitlisted.","properties":{"description":{"description":"Description why the reservation is being /has been waitlisted.","maxLength":2000,"minLength":0,"type":"string"},"priorityCode":{"description":"Waitlist Priority Code.","maxLength":20,"minLength":0,"type":"string"},"priorityDescription":{"description":"Waitlist priority Description.","maxLength":2000,"minLength":0,"type":"string"},"reasonCode":{"description":"Waitlist Reason Code.","maxLength":20,"minLength":0,"type":"string"},"reasonDescription":{"description":"Waitlist Reason Description.","maxLength":2000,"minLength":0,"type":"string"},"telephone":{"description":"Guest telephone number.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"booking_rsv_warningType":{"description":"Used when a message has been successfully processed to report any warnings or business errors that occurred.","properties":{"code":{"description":"If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.","maxLength":20,"minLength":0,"type":"string"},"docURL":{"description":"If present, this URL refers to an online description of the error that occurred.","maxLength":2000,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"recordId":{"description":"If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.","maxLength":2000,"type":"string"},"rph":{"description":"Reference Place Holder used as an index for this warning.","maxLength":8,"minLength":1,"type":"string"},"shortText":{"description":"An abbreviated version of the error in textual format.","maxLength":2000,"type":"string"},"status":{"description":"If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.","maxLength":2000,"type":"string"},"tag":{"description":"If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].","maxLength":2000,"type":"string"},"type":{"description":"The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"booking_rsv_warningsType":{"description":"Used in conjunction with the Success element to define a business error.","items":{"$ref":"#/components/schemas/booking_rsv_warningType"},"maxItems":4000,"type":"array"},"rate_par_availRatePlanInfoType":{"description":"The rate plan element is used to contain all the rate information for a single Rate Plan","properties":{"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"ratePlan":{"description":"Rate plan information","items":{"properties":{"bookingChannelMappings":{"description":"Booking Channel mapping for the Rate Plan Code.","items":{"$ref":"#/components/schemas/rate_par_bookingChannelMappingType"},"maxItems":4000,"type":"array"},"cancelPenalty":{"$ref":"#/components/schemas/rate_par_cancelPenaltyType","description":"Cancellation details for rate plan code."},"credentialsRequired":{"description":"If true, indicates that credentials is required to sell the rate code.","type":"boolean"},"currencyCode":{"description":"Currency Code of the rate code.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Description of the Rate Code.","maxLength":2000,"minLength":0,"type":"string"},"discountAllowed":{"description":"If true, indicates additional discount could be applied on the Rate.","type":"boolean"},"guarantee":{"$ref":"#/components/schemas/rate_par_guaranteeType","description":"Guarantee details for rate plan code."},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"hotelUseOnly":{"description":"If true, indicates this rates is not allowed to be sold by CRO. For CRO this is information only.","type":"boolean"},"longInfo":{"description":"Detail Information of the Rate Code.","maxLength":2000,"minLength":0,"type":"string"},"marketCode":{"description":"Holds the market code.","maxLength":20,"minLength":0,"type":"string"},"mealPlans":{"$ref":"#/components/schemas/rate_par_mealPlansType","description":"Meal plan codes for rate plan code."},"negotiatedBy":{"$ref":"#/components/schemas/rate_par_profileTypeType","description":"If Rate plane is negotiated by Guest or any attached profiles, this indicates how negotiated it. Applicable values are Guest, Company, Agent and Source."},"postingInterval":{"description":"Specifies the frequency at which charges are posted for this rate plan.","maxLength":20,"minLength":0,"type":"string"},"rateCommission":{"$ref":"#/components/schemas/rate_par_ratePlanCommissionType","description":"Commission details for Rate plan code."},"ratePlanCategory":{"maxLength":20,"minLength":0,"type":"string"},"ratePlanChannelInfo":{"$ref":"#/components/schemas/rate_par_ratePlanChannelInfoType","description":"To populate RatePlanLevel, RatePlanWebName, and RatePlanID according to the setup made under channel."},"ratePlanCode":{"maxLength":20,"minLength":0,"type":"string"},"ratePlanLevel":{"description":"All rate codes are associated with rate plan level ( or rate category )for Channels. So if rate plans are given in the request, get all rate codes associated with the rate plan level.","maxLength":20,"minLength":0,"type":"string"},"resGuarantees":{"$ref":"#/components/schemas/rate_par_guaranteePoliciesType","description":"A collection of Guarantee Codes information with cancellation penalty and deposit policy information."},"serviceFeeInclusive":{"description":"Indicates if service fee is included in the rate code amount.","type":"boolean"},"shortInfo":{"description":"Brief Information of the Rate Code.","maxLength":2000,"minLength":0,"type":"string"},"sourceCode":{"description":"Holds the source code.","maxLength":20,"minLength":0,"type":"string"},"taxInclusive":{"description":"Indicates if tax is included in the rate code amount.","type":"boolean"},"webPage":{"description":"URL providing more information about the Rate Code.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"maxItems":4000,"type":"array"}},"type":"object"},"rate_par_availabilityRatePlanInfo":{"description":"Response object for fetching rate plans.","properties":{"availRatePlanInfoType":{"$ref":"#/components/schemas/rate_par_availRatePlanInfoType","description":"Rate plan info based on the search criteria."},"links":{"$ref":"#/components/schemas/rate_par_links"},"warnings":{"$ref":"#/components/schemas/rate_par_warningsType"}},"type":"object"},"rate_par_bookingChannelMappingType":{"properties":{"bookingChannelCode":{"maxLength":20,"minLength":0,"type":"string"},"code":{"maxLength":20,"minLength":0,"type":"string"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"name":{"maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rate_par_cancelPenaltyType":{"description":"The CancelPenalty class defines the cancellation policy of the hotel facility.","properties":{"amountPercent":{"$ref":"#/components/schemas/rate_par_policyAmountPercentType","description":"Cancellation fee expressed as a fixed amount, or percentage of/or room nights."},"deadline":{"$ref":"#/components/schemas/rate_par_policyDeadlineType","description":"Cancellation deadline, absolute or relative."},"formattedRule":{"description":"Formatted Text Rule of the Cancellation Penalty.","maxLength":2000,"minLength":0,"type":"string"},"manual":{"description":"Flag to indicate if the cancellation policy is manual.","type":"boolean"},"nonRefundable":{"description":"Indicates if the amount is refundable if booking is canceled.","type":"boolean"},"offsetUnit":{"$ref":"#/components/schemas/rate_par_offsetUnitType"},"penaltyDescription":{"description":"Text description of the Penalty in a given language.","maxLength":2000,"minLength":0,"type":"string"},"policyCode":{"description":"Policy Code.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rate_par_currencyAmountType":{"description":"A monetary value expressed with a currency code.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"}},"type":"object"},"rate_par_depositCancelRevenueType":{"description":"The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.","enum":["Rooms","Catering","All"],"type":"string"},"rate_par_depositPolicyType":{"description":"Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.","properties":{"amountPercent":{"$ref":"#/components/schemas/rate_par_policyAmountPercentType","description":"Payment expressed as a fixed amount, or a percentage of/or room nights."},"deadline":{"$ref":"#/components/schemas/rate_par_policyDeadlineType","description":"Payment deadline, absolute or relative."},"depositReceiptNo":{"description":"Receipt number associated with the deposit policy","type":"integer"},"depositReqReversed":{"description":"Flag to indicate if deposit policy is reversed","type":"boolean"},"description":{"description":"Text description of the Payment in a given language.","maxLength":2000,"minLength":0,"type":"string"},"formattedRule":{"description":"Formatted Text Rule of the deposit policy.","maxLength":2000,"minLength":0,"type":"string"},"manual":{"description":"Flag to indicate if the cancellation policy is manual.","type":"boolean"},"policyCode":{"description":"Deposit Policy Code","maxLength":20,"minLength":0,"type":"string"},"transactionDate":{"description":"Transaction Date associated with the deposit policy","format":"date","maxLength":8,"type":"string"},"typeOfCharges":{"$ref":"#/components/schemas/rate_par_depositCancelRevenueType","description":"Defines if the deposit amount is calculated based on Room Charges, Catering Charges or both"}},"type":"object"},"rate_par_guaranteePoliciesType":{"description":"Guarantee Code information with cancellation penalty and deposit policy information.","items":{"$ref":"#/components/schemas/rate_par_guaranteePolicyType"},"maxItems":4000,"type":"array"},"rate_par_guaranteePolicyType":{"description":"Specifies Guarantee Code attributes.","properties":{"cancelPenalty":{"description":"The CancelPenalty class defines the cancellation policy of the hotel facility.","properties":{"amountPercent":{"$ref":"#/components/schemas/rate_par_policyAmountPercentType","description":"Cancellation fee expressed as a fixed amount, or percentage of/or room nights."},"deadline":{"$ref":"#/components/schemas/rate_par_policyDeadlineType","description":"Cancellation deadline, absolute or relative."},"effective":{"description":"Indicator if Cancellation Penalty is currently applicable or not.","type":"boolean"},"estimatedAmount":{"description":"Message.","type":"number"},"formattedRule":{"description":"Formatted Text Rule of the Cancellation Penalty.","maxLength":2000,"minLength":0,"type":"string"},"manual":{"description":"Flag to indicate if the cancellation policy is manual.","type":"boolean"},"nonRefundable":{"description":"Indicates if the amount is refundable if booking is canceled.","type":"boolean"},"offsetUnit":{"$ref":"#/components/schemas/rate_par_offsetUnitType"},"penaltyDescription":{"description":"Text description of the Penalty in a given language.","maxLength":2000,"minLength":0,"type":"string"},"policyCode":{"description":"Policy Code.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"defaultGuarantee":{"description":"If true indicates this can be the default guarantee type to be selected for a reservation.","type":"boolean"},"depositPolicy":{"description":"A deposit policy attached with the reservation.","properties":{"amountDue":{"$ref":"#/components/schemas/rate_par_currencyAmountType","description":"Total amount due against the reservation deposit."},"amountPaid":{"$ref":"#/components/schemas/rate_par_currencyAmountType","description":"Total amount paid against the reservation deposit."},"comments":{"description":"Comments attached with a deposit.","maxLength":2000,"minLength":0,"type":"string"},"estimatedAmount":{"description":"Message.","type":"number"},"policy":{"$ref":"#/components/schemas/rate_par_depositPolicyType","description":"Reservation deposit policy details."},"policyId":{"$ref":"#/components/schemas/rate_par_uniqueID_Type","description":"Unique ID of the Reservation Policy."},"revenueType":{"$ref":"#/components/schemas/rate_par_depositCancelRevenueType","description":"Type of reservation."}},"type":"object"},"description":{"description":"Description of the Guarantee Code.","maxLength":2000,"minLength":0,"type":"string"},"guaranteeCode":{"description":"Code assigned to the Guarantee.","maxLength":20,"minLength":0,"type":"string"},"lateArrival":{"description":"Represents the late arrival time.","maxLength":2000,"type":"string"},"onHold":{"description":"If true indicates this Guarantee Code is used only to hold the inventory during reservation process.","type":"boolean"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"paymentTypes":{"$ref":"#/components/schemas/rate_par_paymentTypesType","description":"Specifies various payment types for the guarantee code."},"policyRequirements":{"$ref":"#/components/schemas/rate_par_guaranteeRequirementsType","description":"Specifies various policyRequirements for the guarantee code."},"reserveInventory":{"description":"If true indicates inventory will be reserved/deducted when reservation uses this Guarantee Code.","type":"boolean"},"shortDescription":{"$ref":"#/components/schemas/rate_par_translationTextType80","description":"Brief description of the Guarantee Code."},"warnings":{"$ref":"#/components/schemas/rate_par_warningsType"}},"type":"object"},"rate_par_guaranteeRequirementsType":{"description":"Specifies various requirement for the guarantee code.","properties":{"address":{"description":"When true indicates address on the reservation is required for this guarantee code.","type":"boolean"},"arrivalTime":{"description":"When true indicates arrival Time on the reservation is required for this guarantee code.","type":"boolean"},"cancellation":{"description":"When true indicates cancellation on the reservation is required for this guarantee code.","type":"boolean"},"creditCard":{"description":"When true indicates Credit Card on the reservation is required for this guarantee code.","type":"boolean"},"deposit":{"description":"When true indicates deposit is required for this guarantee code.","type":"boolean"},"phoneNumber":{"description":"When true indicates phone number on the reservation is required for this guarantee code.","type":"boolean"},"requirementCode":{"description":"Requirement Code.","type":"string"}},"type":"object"},"rate_par_guaranteeType":{"description":"Specifies Guarantee Code attributes.","properties":{"description":{"description":"Description of the Guarantee Code.","maxLength":2000,"minLength":0,"type":"string"},"guaranteeCode":{"description":"Code assigned to the Guarantee.","maxLength":20,"minLength":0,"type":"string"},"lateArrival":{"description":"Represents the late arrival time.","type":"string"},"onHold":{"description":"If true indicates this Guarantee Code is used only to hold the inventory during reservation process.","type":"boolean"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"paymentTypes":{"$ref":"#/components/schemas/rate_par_paymentTypesType","description":"Specifies various payment types for the guarantee code."},"policyRequirements":{"$ref":"#/components/schemas/rate_par_guaranteeRequirementsType","description":"Specifies various policyRequirements for the guarantee code."},"reserveInventory":{"description":"If true indicates inventory will be reserved/deducted when reservation uses this Guarantee Code.","type":"boolean"},"shortDescription":{"$ref":"#/components/schemas/rate_par_translationTextType80","description":"Brief description of the Guarantee Code."}},"type":"object"},"rate_par_instanceLink":{"description":"Metadata describing link description objects that MAY appear in the JSON instance representation.","properties":{"href":{"description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.","type":"string"},"method":{"description":"HTTP method for requesting the target of the link.","enum":["GET","POST","PUT","DELETE","PATCH","OPTIONS","HEAD"],"type":"string"},"operationId":{"description":"The operationId of the path you can call to follow this link.  This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.","type":"string"},"rel":{"description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.","type":"string"},"targetSchema":{"description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..","type":"string"},"templated":{"default":false,"description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.","type":"boolean"},"title":{"description":"Exact copy of the \"summary\" field on the linked operation.","type":"string"}},"type":"object"},"rate_par_links":{"items":{"$ref":"#/components/schemas/rate_par_instanceLink"},"type":"array"},"rate_par_mealPlanCodeType":{"description":"Meal plan codes associated with the rate codes.","properties":{"breakfastIncluded":{"description":"Represents if the meal plan code is available for breakfast or not.","type":"boolean"},"code":{"description":"Meal plan code.","maxLength":40,"minLength":0,"type":"string"},"dinnerIncluded":{"description":"Represents if the meal plan code is available for dinner or not.","type":"boolean"},"included":{"description":"Represents if the meal plan code is included in rate code or not.","type":"boolean"},"lunchIncluded":{"description":"Represents if the meal plan code is available for lunch or not.","type":"boolean"}},"type":"object"},"rate_par_mealPlansType":{"description":"Meal plan codes associated with the rate codes.","items":{"$ref":"#/components/schemas/rate_par_mealPlanCodeType"},"maxItems":4000,"type":"array"},"rate_par_offsetUnitType":{"description":"Indicates deadline offset unit type.","enum":["Year","Month","Day","Hour"],"type":"string"},"rate_par_paymentTypesType":{"description":"Payment card code like AX,VI etc.","items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"rate_par_policyAmountPercentType":{"description":"Defines the percentage basis for calculating the fee amount or the amount.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"basisType":{"$ref":"#/components/schemas/rate_par_policyBasisTypeType","description":"Provides the basis for how the amount of the guarantee is calculated."},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"},"nights":{"description":"The number of nights of the hotel stay that are used to calculate the fee amount.","type":"integer"},"percent":{"description":"The percentage used to calculate the amount.","maximum":100,"minimum":0,"type":"number"}},"type":"object"},"rate_par_policyBasisTypeType":{"description":"Full Amount.","enum":["FlatAmount","Percentage","Nights","NightPercentage","FullAmount"],"type":"string"},"rate_par_policyDeadlineType":{"description":"Cancellation deadline, absolute or relative.","properties":{"absoluteDeadline":{"description":"Defines the absolute deadline. Either this or the offset attributes may be used.","format":"date-time","type":"string"},"offsetDropTime":{"description":"Time on offset day the cancellation penalties applies.","format":"date-time","type":"string"},"offsetFromArrival":{"description":"The number of days before arrival that allows cancellation without penalties.","type":"integer"},"offsetFromBookingDate":{"description":"The number of days after booking deposit must be paid.","type":"integer"}},"type":"object"},"rate_par_profileTypeType":{"description":"The types of Profile handled by the web service.","enum":["Guest","Agent","Company","Group","Source","Employee","Hotel","Vendor","Contact","Purge","BusinessHeader","BillingAccount","Activity","Potential","Account"],"type":"string"},"rate_par_ratePlanChannelInfoType":{"properties":{"ratePlanId":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"ratePlanLevel":{"description":"All rate codes are associated with rate plan level ( or rate category )for Channels. So if rate plans are given in the request, get all rate codes associated with the rate plan level.","maxLength":20,"minLength":0,"type":"string"},"ratePlanWebName":{"description":"To populate the RatePlanName, setup for the channel.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"rate_par_ratePlanCommissionType":{"properties":{"commissionAmount":{"description":"commission amount used by the rate plan.","type":"number"},"commissionCode":{"description":"commission code used by the rate plan.","maxLength":20,"minLength":0,"type":"string"},"commissionPercentage":{"description":"commission percentage used by the rate plan.","type":"number"}},"type":"object"},"rate_par_translationTextType80":{"description":"Contains Multiple translated texts and language codes.","properties":{"defaultText":{"description":"Default text with Character length from 0 to 80.","maxLength":80,"minLength":0,"type":"string"},"translatedTexts":{"$ref":"#/components/schemas/rate_par_translationsTextType","description":"List of translated text and language codes."}},"type":"object"},"rate_par_translationsTextType":{"description":"Language code for the translation.","items":{"description":"Language code for the translation.","properties":{"language":{"description":"Language identification.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Used for Character Strings, length 0 to 2000.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"maxItems":4000,"type":"array"},"rate_par_uniqueID_Type":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rate_par_warningType":{"description":"Used when a message has been successfully processed to report any warnings or business errors that occurred.","properties":{"code":{"description":"If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.","maxLength":20,"minLength":0,"type":"string"},"docURL":{"description":"If present, this URL refers to an online description of the error that occurred.","maxLength":2000,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"recordId":{"description":"If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.","maxLength":2000,"type":"string"},"rph":{"description":"Reference Place Holder used as an index for this warning.","maxLength":8,"minLength":1,"type":"string"},"shortText":{"description":"An abbreviated version of the error in textual format.","maxLength":2000,"type":"string"},"status":{"description":"If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.","maxLength":2000,"type":"string"},"tag":{"description":"If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].","maxLength":2000,"type":"string"},"type":{"description":"The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"rate_par_warningsType":{"description":"Used in conjunction with the Success element to define a business error.","items":{"$ref":"#/components/schemas/rate_par_warningType"},"maxItems":4000,"type":"array"},"rate_rsv_amountDeterminationType":{"description":"Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.","enum":["Inclusive","Exclusive"],"type":"string"},"rate_rsv_instanceLink":{"description":"Metadata describing link description objects that MAY appear in the JSON instance representation.","properties":{"href":{"description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.","type":"string"},"method":{"description":"HTTP method for requesting the target of the link.","enum":["GET","POST","PUT","DELETE","PATCH","OPTIONS","HEAD"],"type":"string"},"operationId":{"description":"The operationId of the path you can call to follow this link.  This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.","type":"string"},"rel":{"description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.","type":"string"},"targetSchema":{"description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..","type":"string"},"templated":{"default":false,"description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.","type":"boolean"},"title":{"description":"Exact copy of the \"summary\" field on the linked operation.","type":"string"}},"type":"object"},"rate_rsv_links":{"items":{"$ref":"#/components/schemas/rate_rsv_instanceLink"},"type":"array"},"rate_rsv_rateInfo":{"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"},"rate_rsv_reservationRateSummaryDetailType":{"properties":{"currencyCode":{"description":"Currency revenue calculation is based on.","maxLength":3,"minLength":3,"type":"string"},"gross":{"description":"Amount of revenue and package excluding tax.","type":"number"},"isCycleStartDate":{"description":"Indicates whether the current date marks the start of a new posting cycle","type":"boolean"},"net":{"description":"Amount of revenue and package including tax.","type":"number"},"package":{"description":"Amount of an additional product or service that is sold as part of the rate or in addition to the rate.","type":"number"},"postingInterval":{"description":"Posting Interval of the rate plan code","maxLength":20,"minLength":0,"type":"string"},"ratePlanCode":{"description":"Rate code calculation is based on.","maxLength":20,"minLength":0,"type":"string"},"rateSuppressed":{"description":"Indicates if the rate is to be hidden.","type":"boolean"},"revenue":{"description":"Base Amount of rate.","type":"number"},"revenueSimulationDate":{"description":"Date revenue calculation is based on.","format":"date","type":"string"},"summaryDate":{"description":"Stay date for which revenue calculation is done.","format":"date","type":"string"},"tax":{"description":"Amount of tax generated separately on the revenue and package.","type":"number"}},"type":"object"},"rate_rsv_reservationRateSummaryType":{"properties":{"currencyCode":{"description":"Currency revenue calculation is based on.","maxLength":3,"minLength":3,"type":"string"},"deposit":{"description":"Amount paid prior to the stay.","type":"number"},"details":{"items":{"$ref":"#/components/schemas/rate_rsv_reservationRateSummaryDetailType"},"maxItems":4000,"type":"array"},"end":{"description":"The ending value of the date range.","format":"date","type":"string"},"fixedCharges":{"description":"Amount of automatically posted charges along with room and taxes.","type":"number"},"gross":{"description":"Amount of revenue and package excluding tax.","type":"number"},"guestPay":{"description":"Amount to be paid by Guest.","type":"number"},"hasSuppressedRate":{"description":"Whether suppressed rate is present or not.","type":"boolean"},"net":{"description":"Amount of revenue and package including tax.","type":"number"},"outStandingCostOfStay":{"description":"Remaining amount to be paid.","type":"number"},"routing":{"description":"Amount of automatically forwarded charges for specific transaction codes.","type":"number"},"start":{"description":"The starting value of the date range.","format":"date","type":"string"},"totalCostOfStay":{"description":"Amount of total cost of stay.","type":"number"}},"type":"object"},"rate_rsv_searchRateInfoRequest":{"additionalProperties":false,"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"}},"type":"object"},"rate_rsv_taxType":{"description":"Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"code":{"description":"Code identifying the fee (e.g.,agency fee, municipality fee).","maxLength":20,"minLength":0,"type":"string"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"generateTransactionCode":{"description":"Unique identifier for Generate Tax Transaction code.","maxLength":20,"minLength":0,"type":"string"},"type":{"$ref":"#/components/schemas/rate_rsv_amountDeterminationType","description":"Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other)."}},"type":"object"},"rate_rsv_taxesType":{"description":"A collection of taxes.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"},"tax":{"description":"An individual tax.","items":{"$ref":"#/components/schemas/rate_rsv_taxType"},"maxItems":99,"type":"array"},"totalTax":{"description":"A sum of the taxes which are related to Rate Info.","type":"number"}},"type":"object"},"rate_rsv_totalType":{"description":"The total amount charged for the service including additional amounts and fees.","properties":{"amountAfterTax":{"description":"The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).","type":"number"},"amountAfterTaxPerRoom":{"description":"The total amount per room including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).","type":"number"},"amountBeforeAnyTax":{"description":"The total amount per room does not include any associated tax (e.g., sales tax, VAT, GST or any associated tax), for both Tax Exclusive/Inclusive.","type":"number"},"amountBeforeTax":{"description":"The total amount not including any exclusive associated tax ( e.g., sales tax, VT, GST, or any associated tax configured as an exclusive generate ). Taxes marked as Tax Inclusive are included in this amount.","type":"number"},"amountBeforeTaxPerRoom":{"description":"The total amount per room not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).","type":"number"},"baseAmount":{"description":"The rate's base price. Amount excluding price for any add to rate combine line package attached to the rate.Also excludes any discounts","type":"number"},"code":{"description":"Type of charge.","maxLength":20,"minLength":0,"type":"string"},"currencyCode":{"description":"The code specifying a monetary unit. Use ISO 4217, three alpha code.","maxLength":20,"minLength":0,"type":"string"},"currencySymbol":{"description":"The symbol for the currency, e.g, for currencyCode USD the symbol is $.","maxLength":10,"minLength":0,"type":"string"},"decimalPlaces":{"description":"Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).","type":"integer"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"rateOverride":{"description":"When true indicates that the rate amount has been overridden.","type":"boolean"},"taxes":{"$ref":"#/components/schemas/rate_rsv_taxesType","description":"A collection of taxes."}},"type":"object"},"rate_rsv_warningType":{"description":"Used when a message has been successfully processed to report any warnings or business errors that occurred.","properties":{"code":{"description":"If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.","maxLength":20,"minLength":0,"type":"string"},"docURL":{"description":"If present, this URL refers to an online description of the error that occurred.","maxLength":2000,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"recordId":{"description":"If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.","maxLength":2000,"type":"string"},"rph":{"description":"Reference Place Holder used as an index for this warning.","maxLength":8,"minLength":1,"type":"string"},"shortText":{"description":"An abbreviated version of the error in textual format.","maxLength":2000,"type":"string"},"status":{"description":"If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.","maxLength":2000,"type":"string"},"tag":{"description":"If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].","maxLength":2000,"type":"string"},"type":{"description":"The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"rate_rsv_warningsType":{"description":"Used in conjunction with the Success element to define a business error.","items":{"$ref":"#/components/schemas/rate_rsv_warningType"},"maxItems":4000,"type":"array"},"report_lov_itemType":{"properties":{"active":{"type":"boolean"},"code":{"maxLength":2000,"minLength":0,"type":"string"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"flexfields":{"$ref":"#/components/schemas/report_lov_parametersType","description":"Flexfields returning list of name value pairs."},"name":{"maxLength":2000,"minLength":0,"type":"string"},"shortDescription":{"maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"report_lov_listOfValues":{"properties":{"listOfValues":{"$ref":"#/components/schemas/report_lov_listOfValuesType","description":"Collection of List of Value items."},"warnings":{"$ref":"#/components/schemas/report_lov_warningsType"}},"type":"object"},"report_lov_listOfValuesType":{"properties":{"description":{"maxLength":20,"minLength":0,"type":"string"},"itemCount":{"type":"integer"},"items":{"items":{"$ref":"#/components/schemas/report_lov_itemType"},"maxItems":4000,"type":"array"},"lovName":{"description":"List of Values name.","maxLength":100,"minLength":0,"type":"string"}},"type":"object"},"report_lov_parameterType":{"description":"Name value pair type that will hold generic parameter information. Only use this type when the parameters being passed are too dynamic to be defined.","properties":{"parameterName":{"description":"Name of the parameter.","type":"string"},"parameterValue":{"description":"Value of the parameter.","type":"string"}},"type":"object"},"report_lov_parametersType":{"description":"Collection of generic Name-Value-Pair parameters.","items":{"$ref":"#/components/schemas/report_lov_parameterType"},"maxItems":4000,"type":"array"},"report_lov_warningType":{"description":"Used when a message has been successfully processed to report any warnings or business errors that occurred.","properties":{"code":{"description":"If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.","maxLength":20,"minLength":0,"type":"string"},"docURL":{"description":"If present, this URL refers to an online description of the error that occurred.","maxLength":2000,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"recordId":{"description":"If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.","maxLength":2000,"type":"string"},"rph":{"description":"Reference Place Holder used as an index for this warning.","maxLength":8,"minLength":1,"type":"string"},"shortText":{"description":"An abbreviated version of the error in textual format.","maxLength":2000,"type":"string"},"status":{"description":"If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.","maxLength":2000,"type":"string"},"tag":{"description":"If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].","maxLength":2000,"type":"string"},"type":{"description":"The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"report_lov_warningsType":{"description":"Used in conjunction with the Success element to define a business error.","items":{"$ref":"#/components/schemas/report_lov_warningType"},"maxItems":4000,"type":"array"},"report_repcfg_configReportGroupType":{"description":"Contains details about the report group module from the DB.","properties":{"allowDelete":{"description":"This flag is set to N if a report group cannot be deleted, e.g. mandatory N/A procedures.","type":"boolean"},"defaultModuleType":{"$ref":"#/components/schemas/report_repcfg_defaultModuleType","description":"The module types that are saved under this report group."},"description":{"description":"Report group description.","maxLength":1000,"minLength":0,"type":"string"},"hasShiftReports":{"description":"This flag indicates that the group has reports used in shift reports.","type":"boolean"},"managedBy":{"$ref":"#/components/schemas/report_repcfg_managedByOptions"},"moduleId":{"$ref":"#/components/schemas/report_repcfg_uniqueID_Type","description":"Report group module ID (table key)."},"name":{"description":"Report group name which is recommended to be unique for a given property.","maxLength":80,"minLength":0,"type":"string"},"runSeparately":{"description":"This flag indicates that the group can be attached to reports.","type":"boolean"},"translatableDescription":{"$ref":"#/components/schemas/report_repcfg_translationTextType1000","description":"Translatable Name of the Report Group Description."},"usedInApp":{"description":"A comma separated list of Opera V5 application in which group is available.","maxLength":20,"minLength":0,"type":"string"},"watermarkDetails":{"$ref":"#/components/schemas/report_repcfg_watermarkType","description":"Has the watermark information attached to the report group."}},"type":"object"},"report_repcfg_configReportGroupsType":{"description":"It contains collection of reports.","properties":{"chainCode":{"description":"Chain code in which reports to be set up belong to.","maxLength":20,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel code in which reports to be set up belong to.","maxLength":20,"minLength":0,"type":"string"},"reportCount":{"type":"integer"},"reportGroup":{"description":"A generic report.","items":{"$ref":"#/components/schemas/report_repcfg_configReportGroupType"},"maxItems":4000,"type":"array"}},"type":"object"},"report_repcfg_defaultModuleType":{"description":"Identifies the data type of the report parameter.","enum":["Label","Report","Procedure"],"type":"string"},"report_repcfg_externalUrlInfoType":{"description":"Contains all the information of External Urls.","properties":{"externalReportUrl":{"description":"Report Url from external source.","maxLength":2000,"minLength":0,"type":"string"},"isUrlDynamic":{"description":"Indicates if the Url is dynamic","type":"boolean"}},"type":"object"},"report_repcfg_instanceLink":{"description":"Metadata describing link description objects that MAY appear in the JSON instance representation.","properties":{"href":{"description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.","type":"string"},"method":{"description":"HTTP method for requesting the target of the link.","enum":["GET","POST","PUT","DELETE","PATCH","OPTIONS","HEAD"],"type":"string"},"operationId":{"description":"The operationId of the path you can call to follow this link.  This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.","type":"string"},"rel":{"description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.","type":"string"},"targetSchema":{"description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..","type":"string"},"templated":{"default":false,"description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.","type":"boolean"},"title":{"description":"Exact copy of the \"summary\" field on the linked operation.","type":"string"}},"required":["href","rel","method","operationId"],"type":"object"},"report_repcfg_links":{"items":{"$ref":"#/components/schemas/report_repcfg_instanceLink"},"type":"array"},"report_repcfg_lovParamDetailsType":{"description":"Identifies a destination record for the report.","properties":{"lOVs":{"$ref":"#/components/schemas/report_repcfg_paramLOVsType","description":"Report parameter LOV details."},"lovMultiSelect":{"description":"This attribute is used to indicate if an LOV defined is multi-select. This is particularly useful for simple reports.","type":"boolean"},"lovSql":{"description":"Query statement for LOV based report parameters.","maxLength":2000,"minLength":0,"type":"string"},"lovValidate":{"description":"Flag to indicate that input should be validated against LOV.","type":"boolean"}},"type":"object"},"report_repcfg_managedByOptions":{"description":"Describes of the Configuration is Managed by Enterprise or Property.","enum":["EnterpriseManaged","PropertyManaged","EnterpriseEnforced","PropertyOverridden"],"type":"string"},"report_repcfg_operaVersion":{"description":"Response for Ping operation.","properties":{"links":{"$ref":"#/components/schemas/report_repcfg_links"},"operaVersion":{"$ref":"#/components/schemas/report_repcfg_operaVersionNumberType","description":"Opera version number."},"warnings":{"$ref":"#/components/schemas/report_repcfg_warningsType"}},"type":"object"},"report_repcfg_operaVersionNumberType":{"description":"Current Opera Version Number","maxLength":40,"minLength":0,"type":"string"},"report_repcfg_paramDataType":{"description":"Identifies the data type of the report parameter.","enum":["DateAsChar","Date","Number","CheckBox","DateTime","Char","Money","Integer"],"type":"string"},"report_repcfg_paramFormatMaskType":{"description":"Specifies the format mask for the parameter.","enum":["None","Upper","Lower"],"type":"string"},"report_repcfg_paramLOVType":{"description":"Represents an individual LOV item for a report parameter.","properties":{"code":{"description":"Report parameter LOV code.","type":"string"},"description":{"description":"Report parameter LOV label.","type":"string"},"string":{"description":"Report parameter LOV string (third attribute returned for some queries).","type":"string"}},"type":"object"},"report_repcfg_paramLOVsType":{"description":"List of values for report parameter.","items":{"$ref":"#/components/schemas/report_repcfg_paramLOVType"},"maxItems":4000,"type":"array"},"report_repcfg_reportModuleTypeType":{"description":"Procedure Report","enum":["Rtf","Cus","Rep","Sft","Grp","Url","Lbl","Pcd","Rna"],"type":"string"},"report_repcfg_reportParameterType":{"description":"Defines an individual report parameter.","properties":{"buildStringForDateOffset":{"maxLength":32000,"minLength":0,"type":"string"},"calculatedDateValue":{"description":"Date value from offset.","format":"date","maxLength":8,"type":"string"},"dataType":{"$ref":"#/components/schemas/report_repcfg_paramDataType","description":"Report parameter data type used to determine kind of UI control to display."},"dateFormatMask":{"description":"Format mask for date report parameters.","maxLength":40,"minLength":0,"type":"string"},"dateOffset":{"description":"Number of days to offset from current business date for date report parameter.","type":"integer"},"formatMask":{"$ref":"#/components/schemas/report_repcfg_paramFormatMaskType"},"label":{"description":"Display label for report parameter.","maxLength":80,"minLength":0,"type":"string"},"lovParam":{"$ref":"#/components/schemas/report_repcfg_lovParamDetailsType"},"name":{"description":"Individual report parameter details.","maxLength":400,"minLength":0,"type":"string"},"orderBy":{"description":"Report parameter display order.","type":"integer"},"value":{"description":"Initial report parameter value.","maxLength":4000,"minLength":0,"type":"string"}},"type":"object"},"report_repcfg_reportParameters":{"description":"The Fetch Report Parameters result object contains a collection of report parameters which allow/require user input prior to running the report.","properties":{"links":{"$ref":"#/components/schemas/report_repcfg_links"},"reportParameters":{"$ref":"#/components/schemas/report_repcfg_reportParametersType","description":"This element holds the collection of report parameters for user input."},"warnings":{"$ref":"#/components/schemas/report_repcfg_warningsType"}},"type":"object"},"report_repcfg_reportParametersType":{"description":"List of parameters required to run report.","items":{"$ref":"#/components/schemas/report_repcfg_reportParameterType"},"maxItems":4000,"type":"array"},"report_repcfg_reportType":{"description":"Contains details about the report application module from the DB.","properties":{"attachedReports":{"$ref":"#/components/schemas/report_repcfg_uniqueIDListType","description":"List of Reports attached with the Shift Report group."},"canRunSeperate":{"description":"Flag which indicates if the report can be run separately.","type":"boolean"},"columnsPerPage":{"description":"Columns for Key Packet report group.","type":"integer"},"copies":{"description":"Number of copies configured for report.","type":"integer"},"customized":{"description":"Flag which indicates whether the report is customized by the user.","type":"boolean"},"customizedRtfAttachId":{"$ref":"#/components/schemas/report_repcfg_uniqueID_Type","description":"Customized RTF file's Attach ID in the database."},"dataSource":{"description":"Data source for BI Publisher reports.","maxLength":255,"minLength":0,"type":"string"},"dataSourceType":{"description":"Set to ODT for BI Publisher reports.","maxLength":10,"minLength":0,"type":"string"},"defaultPrinterName":{"description":"Default printer name.","maxLength":20,"minLength":0,"type":"string"},"destination":{"description":"Report default destination.","maxLength":20,"minLength":0,"type":"string"},"excelOutput":{"description":"Flag to indicate whether the report can be exported to Excel.","type":"boolean"},"externalReportUrl":{"$ref":"#/components/schemas/report_repcfg_externalUrlInfoType","description":"Information regarding Report Url from external source."},"formToRun":{"description":"Form which is run to collect parameter information to generate the report.","maxLength":80,"minLength":0,"type":"string"},"hasParameters":{"description":"Flag which indicates whether the report requires parameters.","type":"boolean"},"hotel":{"description":"The hotel code that the report is associated with.","maxLength":20,"minLength":0,"type":"string"},"languageCode":{"description":"Report language code.","maxLength":20,"minLength":0,"type":"string"},"moduleId":{"$ref":"#/components/schemas/report_repcfg_uniqueID_Type","description":"Report module ID (table key)."},"moduleType":{"$ref":"#/components/schemas/report_repcfg_reportModuleTypeType","description":"Module type either RTF,GRP,SFT,URL,RNA or REP."},"multiPropertyReport":{"description":"Flag which indicates if the report can be run for multiple properties.","type":"boolean"},"opera9Certified":{"description":"A flag indicating that the report has been certified for use with Opera 9.","type":"boolean"},"procedureRequired":{"description":"Flag which indicates whether the report requires a procedure.","type":"boolean"},"protectedReport":{"description":"Flag which indicates whether the report is protected.","type":"boolean"},"reportDescription":{"$ref":"#/components/schemas/report_repcfg_translationTextType1000","description":"Report description."},"reportGroup":{"description":"Report group.","maxLength":1000,"minLength":0,"type":"string"},"reportGroupDescription":{"maxLength":1000,"minLength":0,"type":"string"},"reportGroupId":{"$ref":"#/components/schemas/report_repcfg_uniqueID_Type","description":"Report group module ID."},"reportName":{"description":"Report name.","maxLength":80,"minLength":0,"type":"string"},"rowsPerPage":{"description":"Rows for Key Packet report group.","type":"integer"},"sample":{"description":"Flag which indicates whether the report is a sample provided in the application.","type":"boolean"},"shiftReport":{"description":"Flag to indicate whether this is a shift report.","type":"boolean"},"systemReport":{"description":"Flag to indicate whether this is a system report.","type":"boolean"},"translatableReportGroupDescription":{"$ref":"#/components/schemas/report_repcfg_translationTextType1000","description":"Translatable Name of the Report Group Description."},"usedInApp":{"description":"A comma separated list of Opera V5 application indicators for which the report is enabled.","maxLength":20,"minLength":0,"type":"string"},"userDefinedReport":{"description":"Flag which indicates whether the report is user defined.","type":"boolean"},"watermarkDetails":{"$ref":"#/components/schemas/report_repcfg_watermarkType","description":"The watermark details of the report being retrieved."}},"type":"object"},"report_repcfg_reports":{"description":"This type contains a collection of report modules which match the requested criteria. The object also may include a standard SUCCESS element or a WARNINGS or ERRORS collection.","properties":{"links":{"$ref":"#/components/schemas/report_repcfg_links"},"reports":{"$ref":"#/components/schemas/report_repcfg_reportsType","description":"The collection of reports that matches the requested criteria."},"warnings":{"$ref":"#/components/schemas/report_repcfg_warningsType"}},"type":"object"},"report_repcfg_reportsType":{"description":"Contains a collection of reports matching the requested criteria.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"reports":{"description":"List of reports matching search criteria.","items":{"$ref":"#/components/schemas/report_repcfg_reportType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"report_repcfg_retrievedReportGroups":{"description":"This response provides the result of fetching report groups.","properties":{"links":{"$ref":"#/components/schemas/report_repcfg_links"},"reportGroups":{"$ref":"#/components/schemas/report_repcfg_configReportGroupsType"},"warnings":{"$ref":"#/components/schemas/report_repcfg_warningsType"}},"type":"object"},"report_repcfg_translationTextType1000":{"description":"Contains Multiple translated texts and language codes.","properties":{"defaultText":{"description":"Default text with Character length from 0 to 1000.","maxLength":1000,"minLength":0,"type":"string"},"translatedTexts":{"$ref":"#/components/schemas/report_repcfg_translationsTextType","description":"List of translated text and language codes."}},"type":"object"},"report_repcfg_translationsTextType":{"description":"Language code for the translation.","items":{"description":"Language code for the translation.","properties":{"language":{"description":"Language identification.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Used for Character Strings, length 0 to 2000.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"maxItems":4000,"type":"array"},"report_repcfg_uniqueIDListType":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/report_repcfg_uniqueID_Type"},"maxItems":4000,"type":"array"},"report_repcfg_uniqueID_Type":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"report_repcfg_warningType":{"description":"Used when a message has been successfully processed to report any warnings or business errors that occurred.","properties":{"code":{"description":"If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.","maxLength":20,"minLength":0,"type":"string"},"docURL":{"description":"If present, this URL refers to an online description of the error that occurred.","maxLength":2000,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"recordId":{"description":"If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.","maxLength":2000,"type":"string"},"rph":{"description":"Reference Place Holder used as an index for this warning.","maxLength":8,"minLength":1,"type":"string"},"shortText":{"description":"An abbreviated version of the error in textual format.","maxLength":2000,"type":"string"},"status":{"description":"If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.","maxLength":2000,"type":"string"},"tag":{"description":"If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].","maxLength":2000,"type":"string"},"type":{"description":"The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"report_repcfg_warningsType":{"description":"Used in conjunction with the Success element to define a business error.","items":{"$ref":"#/components/schemas/report_repcfg_warningType"},"maxItems":4000,"type":"array"},"report_repcfg_watermarkModeType":{"description":"Identifies the data type of the report parameter.","enum":["Simple","Enhanced","NoWatermark","GroupSettings"],"type":"string"},"report_repcfg_watermarkType":{"description":"Details of the watermark to be used at the time of report generation.","properties":{"angle":{"description":"Watermark angle in degrees.","type":"integer"},"blue":{"description":"Watermark color (blue), value ranges from 0.0 to 1.0 ( Java API values ).","type":"number"},"font":{"description":"Watermark font name.","maxLength":100,"minLength":0,"type":"string"},"fontSize":{"description":"Watermark font name.","type":"number"},"green":{"description":"Watermark color (green), value ranges from 0.0 to 1.0 ( Java API values ).","type":"number"},"mode":{"$ref":"#/components/schemas/report_repcfg_watermarkModeType","description":"Watermark for PDF files"},"red":{"description":"Watermark color (red), value ranges from 0.0 to 1.0 ( Java API values ).","type":"number"},"text":{"description":"Watermark Text.","maxLength":200,"minLength":0,"type":"string"},"xPosition":{"description":"X position of watermark on page starting in lower left corner.","type":"integer"},"yPosition":{"description":"Y position of watermark on page starting in lower left corner.","type":"integer"}},"type":"object"},"rmcfg_codeType":{"description":"Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.","maxLength":20,"minLength":0,"type":"string"},"rmcfg_instanceLink":{"description":"Metadata describing link description objects that MAY appear in the JSON instance representation.","properties":{"href":{"description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.","type":"string"},"method":{"description":"HTTP method for requesting the target of the link.","enum":["GET","POST","PUT","DELETE","PATCH","OPTIONS","HEAD"],"type":"string"},"operationId":{"description":"The operationId of the path you can call to follow this link.  This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.","type":"string"},"rel":{"description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.","type":"string"},"targetSchema":{"description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..","type":"string"},"templated":{"default":false,"description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.","type":"boolean"},"title":{"description":"Exact copy of the \"summary\" field on the linked operation.","type":"string"}},"type":"object"},"rmcfg_links":{"items":{"$ref":"#/components/schemas/rmcfg_instanceLink"},"type":"array"},"rmcfg_managedByOptions":{"description":"Describes of the Configuration is Managed by Enterprise or Property.","enum":["EnterpriseManaged","PropertyManaged","EnterpriseEnforced","PropertyOverridden"],"type":"string"},"rmcfg_roomClassCriteria":{"description":"Request object for creating a new hotel level room class.","properties":{"links":{"$ref":"#/components/schemas/rmcfg_links"},"roomClass":{"$ref":"#/components/schemas/rmcfg_roomClassType","description":"Room class details to be created."},"warnings":{"$ref":"#/components/schemas/rmcfg_warningsType"}},"type":"object"},"rmcfg_roomClassToBeChanged":{"description":"Request object for changing an existing hotel level room class.","properties":{"links":{"$ref":"#/components/schemas/rmcfg_links"},"roomClass":{"$ref":"#/components/schemas/rmcfg_roomClassType","description":"Room class details to be changed."},"warnings":{"$ref":"#/components/schemas/rmcfg_warningsType"}},"type":"object"},"rmcfg_roomClassType":{"description":"Common code type for code, description, seq and inactive","properties":{"code":{"description":"Code for the code type.","maxLength":20,"minLength":0,"type":"string"},"description":{"$ref":"#/components/schemas/rmcfg_translationTextType50","description":"Description for the code type."},"hotelId":{"description":"Hotel code for the code type.","maxLength":20,"minLength":0,"type":"string"},"inactive":{"description":"Indicates the code type is inactive or not.","type":"boolean"},"managedBy":{"$ref":"#/components/schemas/rmcfg_managedByOptions"},"roomTypes":{"$ref":"#/components/schemas/rmcfg_roomTypesSummaryType","description":"Room types of a room class."},"sequence":{"description":"Display sequence for the code type.","type":"integer"}},"type":"object"},"rmcfg_roomFeatureType":{"description":"Room Feature Information.","properties":{"code":{"description":"A code representing a room feature.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"A code representing a room feature.","maxLength":2000,"minLength":0,"type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"quantity":{"description":"Indicates quantity.","type":"integer"}},"type":"object"},"rmcfg_roomFeaturesType":{"description":"A recurring element that identifies the room features.","items":{"$ref":"#/components/schemas/rmcfg_roomFeatureType"},"maxItems":4000,"type":"array"},"rmcfg_roomTypeComponentType":{"description":"Room component and its quantity for the component room type.","properties":{"description":{"description":"Description of room component.","maxLength":2000,"minLength":0,"type":"string"},"qty":{"description":"Quantity of room component for the component room type.","type":"integer"},"roomType":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rmcfg_roomTypeComponentsType":{"description":"Contains room components of a component room type.","items":{"$ref":"#/components/schemas/rmcfg_roomTypeComponentType"},"maxItems":4000,"type":"array"},"rmcfg_roomTypeSummaryType":{"description":"This type represents the summary of room type attributes.","properties":{"accessible":{"description":"Indicates if room type is accessible.","type":"boolean"},"activeDate":{"description":"Active date of the room type.","format":"date","maxLength":8,"type":"string"},"inactive":{"description":"Indicates the room type is inactive or not.","type":"boolean"},"managedBy":{"$ref":"#/components/schemas/rmcfg_managedByOptions"},"meetingRoom":{"description":"Indicates room type is meeting room. This Can be Meeting room flag cannot be unmarked at the property level. Can only be marked for non pseudo room types.","type":"boolean"},"numberOfRooms":{"description":"Number of rooms for this room type.","type":"integer"},"pseudo":{"description":"Indicates if room type is pseudo.","type":"boolean"},"roomClass":{"description":"Room class for the room type code.","maxLength":20,"minLength":0,"type":"string"},"roomType":{"maxLength":20,"minLength":0,"type":"string"},"sellSequence":{"description":"Indicates room types sell sequence.","type":"number"},"sendToInterface":{"description":"Indicates if room type is sent to interface.","type":"boolean"},"shortDescription":{"description":"Short Description of room type.","maxLength":200,"minLength":0,"type":"string"},"suite":{"description":"Indicates room type is a suite.","type":"boolean"}},"type":"object"},"rmcfg_roomTypeType":{"description":"This type represents the room type attributes.","properties":{"accessible":{"description":"Indicates if room type is accessible.","type":"boolean"},"activeDate":{"description":"Active date of the room type.","format":"date","maxLength":8,"type":"string"},"autoCheckin":{"description":"Creates a new linked Reservation, and proceeds within check-in of the new reservation.","type":"boolean"},"autoPopulate":{"description":"Room type is automatically attached when new rate codes are created.","type":"boolean"},"autoRoomAssign":{"description":"The Room is automatically assigned when a reservation is made for this Room Type. This element is available when the Room Type Auto Room Assign OPERA Control is on.","type":"boolean"},"bedType":{"description":"Bed type of room type.","maxLength":20,"minLength":0,"type":"string"},"components":{"$ref":"#/components/schemas/rmcfg_roomTypeComponentsType","description":"Room type component details."},"defaultOccupancy":{"description":"Default occupancy for the room type.","type":"number"},"description":{"$ref":"#/components/schemas/rmcfg_translationTextType2000","description":"Long Description of room type."},"features":{"$ref":"#/components/schemas/rmcfg_roomFeaturesType","description":"Room type feature details."},"generic":{"description":"Indicates room type is generic.","type":"boolean"},"houseKeeping":{"description":"Indicates if the Room Type shows in the Housekeeping components like the Housekeeping Board.","type":"boolean"},"inactive":{"description":"Is Room type inactive?","type":"boolean"},"infoURL":{"description":"Room type info URL.","maxLength":200,"minLength":0,"type":"string"},"maintenance":{"description":"Indicates if the room type is available for maintenance requests. This element is available when the Maintenance OPERA Control is active.","type":"boolean"},"managedBy":{"$ref":"#/components/schemas/rmcfg_managedByOptions"},"maxAdults":{"description":"Maximum Adults for the room type.","type":"integer"},"maxChildren":{"description":"Maximum Children for the room type.","type":"integer"},"maximumOccupancy":{"description":"Maximum occupancy for the room type.","type":"integer"},"meetingRoom":{"description":"Indicates if the Room Type is configured as a meeting room (function space). This element is available when Type = Pseudo or the Guest Room As Meeting Room OPERA Control is active.","type":"boolean"},"minimumOccupancy":{"description":"Minimum occupancy for the room type.","type":"integer"},"newRoomType":{"description":"New Room type code. (Used in change template room type operation)","maxLength":20,"minLength":0,"type":"string"},"numberOfRooms":{"description":"Number of rooms for this room type.","type":"integer"},"pseudo":{"description":"Indicates if room type is pseudo.","type":"boolean"},"rateFloor":{"description":"This value will control the minimum amount that the selected room type can be sold","type":"number"},"roomClass":{"description":"Room class for the room type code.","maxLength":20,"minLength":0,"type":"string"},"roomType":{"maxLength":20,"minLength":0,"type":"string"},"sellSequence":{"description":"Indicates room types sell sequence.","type":"number"},"sendToInterface":{"description":"Indicates room type is sent to interface.","type":"boolean"},"shortDescription":{"$ref":"#/components/schemas/rmcfg_translationTextType2000","description":"Short Description of room type."},"smokingPreference":{"description":"Specifies the smoking preference for this room type. I.E. SM, NS.","maxLength":20,"minLength":0,"type":"string"},"suite":{"description":"Indicates room type is a suite.","properties":{"editable":{"description":"Indicates if room type Room Components may be changed.","type":"boolean"},"value":{"description":"Property Value","type":"boolean"}},"type":"object"},"yieldCategory":{"description":"Yield category for this room type (Available when a yield integration add-on license is active and when room type is Yieldable.)","maxLength":20,"minLength":0,"type":"string"},"yieldStatus":{"$ref":"#/components/schemas/rmcfg_roomTypeYieldableType","description":"Specify whether the room type is yieldable or non-yieldable (Available when a yield integration add-on license is active.)"}},"type":"object"},"rmcfg_roomTypeYieldableType":{"description":"Simple type for Yieldable or Non Yieldable","enum":["Yieldable","NonYieldable"],"type":"string"},"rmcfg_roomTypesCriteria":{"description":"Request object for Creating a new Room Type.","properties":{"links":{"$ref":"#/components/schemas/rmcfg_links"},"roomType":{"description":"Room Type details to be created.","properties":{"hotelId":{"$ref":"#/components/schemas/rmcfg_codeType"},"roomTypeDetails":{"$ref":"#/components/schemas/rmcfg_roomTypeType","description":"Room Type details to be created."}},"type":"object"},"warnings":{"$ref":"#/components/schemas/rmcfg_warningsType"}},"type":"object"},"rmcfg_roomTypesSummaryType":{"description":"This type holds collection of room type.","properties":{"hotelId":{"description":"Hotel Code.","maxLength":20,"minLength":0,"type":"string"},"roomTypeSummary":{"items":{"$ref":"#/components/schemas/rmcfg_roomTypeSummaryType"},"maxItems":4000,"type":"array"}},"type":"object"},"rmcfg_roomTypesToBeChanged":{"description":"Request object for Modifying Room Type.","properties":{"links":{"$ref":"#/components/schemas/rmcfg_links"},"roomType":{"description":"Room Type details to be changed.","properties":{"hotelId":{"$ref":"#/components/schemas/rmcfg_codeType"},"roomTypeDetails":{"$ref":"#/components/schemas/rmcfg_roomTypeType","description":"Room Type details to be changed."}},"type":"object"},"warnings":{"$ref":"#/components/schemas/rmcfg_warningsType"}},"type":"object"},"rmcfg_translationTextType2000":{"description":"Contains Multiple translated texts and language codes.","properties":{"defaultText":{"description":"Default text with Character length from 0 to 2000.","maxLength":2000,"minLength":0,"type":"string"},"translatedTexts":{"$ref":"#/components/schemas/rmcfg_translationsTextType","description":"List of translated text and language codes."}},"type":"object"},"rmcfg_translationTextType50":{"description":"Contains Multiple translated texts and language codes.","properties":{"defaultText":{"description":"Default text with Character length from 0 to 50.","maxLength":50,"minLength":0,"type":"string"},"translatedTexts":{"$ref":"#/components/schemas/rmcfg_translationsTextType","description":"List of translated text and language codes."}},"type":"object"},"rmcfg_translationsTextType":{"description":"Language code for the translation.","items":{"description":"Language code for the translation.","properties":{"language":{"description":"Language identification.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Used for Character Strings, length 0 to 2000.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"maxItems":4000,"type":"array"},"rmcfg_warningType":{"description":"Used when a message has been successfully processed to report any warnings or business errors that occurred.","properties":{"code":{"description":"If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.","maxLength":20,"minLength":0,"type":"string"},"docURL":{"description":"If present, this URL refers to an online description of the error that occurred.","maxLength":2000,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"recordId":{"description":"If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.","maxLength":2000,"type":"string"},"rph":{"description":"Reference Place Holder used as an index for this warning.","maxLength":8,"minLength":1,"type":"string"},"shortText":{"description":"An abbreviated version of the error in textual format.","maxLength":2000,"type":"string"},"status":{"description":"If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.","maxLength":2000,"type":"string"},"tag":{"description":"If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].","maxLength":2000,"type":"string"},"type":{"description":"The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"rmcfg_warningsType":{"description":"Used in conjunction with the Success element to define a business error.","items":{"$ref":"#/components/schemas/rmcfg_warningType"},"maxItems":4000,"type":"array"},"room_calendar_advanceCheckInType":{"description":"Information relating to Reservation's Advance Checked In state and Expected Time of Return","properties":{"advanceCheckInTime":{"description":"Time in the property's timezone the reservation is advance checked in, returned only with operation getReservation when a reservation is advance checked in. Uses the hotel's time zone.","format":"date-time","type":"string"},"advanceCheckedIn":{"description":"Indicates if the reservation is marked as Advance Checked In","type":"boolean"},"eTRComments":{"description":"ETR Comments","maxLength":2000,"minLength":0,"type":"string"},"expectedReturnTime":{"description":"Expected Return Time in the property's timezone. Uses the hotel's time zone.","format":"date-time","type":"string"}},"type":"object"},"room_calendar_componentBlockOutDates":{"properties":{"dateTimeSpan":{"$ref":"#/components/schemas/room_calendar_dateTimeSpanType"},"reservationIdList":{"$ref":"#/components/schemas/room_calendar_reservationIdList"}},"type":"object"},"room_calendar_dateTimeSpanType":{"description":"Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.","properties":{"endDateTime":{"description":"Uses the hotel's time zone.","format":"date-time","type":"string"},"startDateTime":{"description":"Uses the hotel's time zone.","format":"date-time","type":"string"}},"type":"object"},"room_calendar_housekeepingRoomStatusType":{"description":"Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.","enum":["Clean","Dirty","Pickup","Inspected","OutOfOrder","OutOfService"],"type":"string"},"room_calendar_instanceLink":{"description":"Metadata describing link description objects that MAY appear in the JSON instance representation.","properties":{"href":{"description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.","type":"string"},"method":{"description":"HTTP method for requesting the target of the link.","enum":["GET","POST","PUT","DELETE","PATCH","OPTIONS","HEAD"],"type":"string"},"operationId":{"description":"The operationId of the path you can call to follow this link.  This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.","type":"string"},"rel":{"description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.","type":"string"},"targetSchema":{"description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..","type":"string"},"templated":{"default":false,"description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.","type":"boolean"},"title":{"description":"Exact copy of the \"summary\" field on the linked operation.","type":"string"}},"type":"object"},"room_calendar_linkedReservationType":{"description":"Enumeration of the different Linked Reservation Types.","enum":["Linked","Shared","Default"],"type":"string"},"room_calendar_links":{"items":{"$ref":"#/components/schemas/room_calendar_instanceLink"},"type":"array"},"room_calendar_pMS_ResStatusType":{"description":"This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.","enum":["Reserved","Requested","NoShow","Cancelled","InHouse","CheckedOut","Waitlisted","DueIn","DueOut","Walkin","PendingCheckout"],"type":"string"},"room_calendar_resGuaranteeType":{"description":"Validations type record returned after Validations are done.","properties":{"guaranteeCode":{"description":"Guarantee Code.","maxLength":20,"minLength":0,"type":"string"},"onHold":{"description":"Guarantee Code.","type":"boolean"},"shortDescription":{"description":"Guarantee Code.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"room_calendar_reservationId":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"room_calendar_reservationIdList":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/room_calendar_uniqueID_Type"},"maxItems":4000,"type":"array"},"room_calendar_reservationRoomOwnershipType":{"description":"Indicates if the assigned reservation room is an Owner/Referral or Regular room.","enum":["Owner","Referral","Regular"],"type":"string"},"room_calendar_roomCalendar":{"properties":{"links":{"$ref":"#/components/schemas/room_calendar_links"},"roomCalendar":{"$ref":"#/components/schemas/room_calendar_roomCalendarType","description":"Room Calendar Information."},"warnings":{"$ref":"#/components/schemas/room_calendar_warningsType"}},"type":"object"},"room_calendar_roomCalendarDisplayType":{"description":"Display Information for the Room Calendar.","properties":{"displayColor":{"maxLength":10,"minLength":0,"type":"string"},"displayLabel":{"maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"room_calendar_roomCalendarInfoType":{"description":"Holds hotel Room and Reservation Information.","properties":{"componentRoomReservationsForSuite":{"description":"If room is a component suite , holds information about component room reservations","items":{"$ref":"#/components/schemas/room_calendar_componentBlockOutDates"},"maxItems":4000,"type":"array"},"componentSuite":{"description":"Indicates if a room is a Component Suite or not.","type":"boolean"},"houseKeeping":{"description":"Indicates true/false. When this flag is set to true indicates room type of the room is flagged as housekeeping.","type":"boolean"},"pseudo":{"description":"Indicates if a room is a Pseudo room or not.","type":"boolean"},"roomId":{"description":"Room Number.","maxLength":20,"minLength":0,"type":"string"},"roomInfo":{"$ref":"#/components/schemas/room_calendar_roomInfo","description":"Holds the Schedule and Reservations."},"roomOrder":{"description":"Order the Room is displayed based on the Room Display Room settings.","type":"integer"},"roomOwnerStatus":{"$ref":"#/components/schemas/room_calendar_roomOwnerStatusType","description":"Flag used to indicate if a room is configured as an owner exclusive room or an owner room or a regular room. This value is returned when Room Rotation OPERA Control is active. "},"roomSchedule":{"description":"Holds the Schedule and Reservations.","items":{"$ref":"#/components/schemas/room_calendar_roomScheduleType"},"maxItems":4000,"type":"array"}},"type":"object"},"room_calendar_roomCalendarResType":{"description":"Reservation Information for a Reservation Item in the Calendar.","properties":{"advanceCheckIn":{"$ref":"#/components/schemas/room_calendar_advanceCheckInType","description":"Information relating to Reservation's Advance Checked In state and Expected Time of Return"},"assignedByAI":{"description":"Indicates whether the room was assigned by AI Room Assignment.","type":"boolean"},"backToBackReservation":{"description":"This attribute indicates if the linked reservation is marked as Back to Back or not.","type":"boolean"},"dateTimeSpan":{"$ref":"#/components/schemas/room_calendar_dateTimeSpanType"},"givenName":{"maxLength":40,"minLength":0,"type":"string"},"guarantee":{"$ref":"#/components/schemas/room_calendar_resGuaranteeType"},"hasLinkedReservations":{"$ref":"#/components/schemas/room_calendar_linkedReservationType","description":"Indicates whether the reservation has any linked reservation."},"noOfRooms":{"type":"integer"},"reservationIdList":{"$ref":"#/components/schemas/room_calendar_reservationIdList"},"reservationStatus":{"$ref":"#/components/schemas/room_calendar_pMS_ResStatusType","description":"Indicates the Actual status of the reservation."},"roomMoveHistory":{"$ref":"#/components/schemas/room_calendar_roomMoveDetailsType","description":"Room Move History for the reservation."},"roomNumberLocked":{"description":"Verify if the room number is locked for the reservation. When true the room number cannot be changed.","type":"boolean"},"roomOwnershipType":{"$ref":"#/components/schemas/room_calendar_reservationRoomOwnershipType","description":"Provides the information of the assigned reservation room is an Owner, Referral or regular room.This value is returned when Room Rotation OPERA Control is active and room number is assigned to a reservation."},"roomScheduleDisplay":{"$ref":"#/components/schemas/room_calendar_roomCalendarDisplayType","description":"Display configuration for this reservation."},"roomTypeToCharge":{"description":"The Room Type on which the rate is based on. The reservation may use a different room type but is charged based on a different room type. This value is returned when Advance Daily Detail OPERA Control is active.","maxLength":20,"minLength":0,"type":"string"},"scheduledRoomMove":{"$ref":"#/components/schemas/room_calendar_scheduledRoomMoveDetailType","description":"Information related to the room moves scheduled  for a reservation ."},"scheduledRoomMoveRoomPending":{"description":"This attribute indicates if there is a  Scheduled Move Room pending.","type":"boolean"},"segmentEndDateTime":{"description":"End date-time of the reservation segment currently displayed in the room calendar timeline. This value is returned when Advance Daily Detail OPERA Control is active.","format":"date-time","type":"string"},"segmentStartDateTime":{"description":"Start date-time of the reservation segment currently displayed in the room calendar timeline. This value is returned when Advance Daily Detail OPERA Control is active.","format":"date-time","type":"string"},"surname":{"maxLength":40,"minLength":0,"type":"string"},"title":{"maxLength":20,"minLength":0,"type":"string"},"upgradedByAI":{"description":"Indicates whether the room assigned by AI Room Assignment was an upgrade.","type":"boolean"},"vipStatus":{"$ref":"#/components/schemas/room_calendar_vIPStatusType","description":"VIP status of the guest."}},"type":"object"},"room_calendar_roomCalendarType":{"description":"Room Calendar entry that holds Room and Reservation Information.","properties":{"hotelId":{"description":"The resort of the Room Calendar.","maxLength":20,"minLength":0,"type":"string"},"pageIndex":{"description":"Current Page the group of Rooms is included in.","type":"integer"},"recordsPerPage":{"description":"Number of records per page.","type":"integer"},"room":{"description":"Holds the Room Information.","items":{"$ref":"#/components/schemas/room_calendar_roomCalendarInfoType"},"maxItems":4000,"type":"array"},"totalRooms":{"description":"Total Numebr of Rooms.","type":"integer"}},"type":"object"},"room_calendar_roomInfo":{"description":"Room details","properties":{"componentRoomNumber":{"description":"Component Room Number.","maxLength":4000,"minLength":0,"type":"string"},"componentSuiteRoomNumbers":{"description":"Component Suite Room Numbers.","items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"connectingRooms":{"description":"Room number.","items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"roomCondition":{"description":"Room Condition information if the room has an associated Room Condition.","maxLength":20,"minLength":0,"type":"string"},"roomStatus":{"$ref":"#/components/schemas/room_calendar_housekeepingRoomStatusType","description":"Status of the room (Dirty/Clean/Inspected/Pickup)."},"roomType":{"description":"Room Type of the Room.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"room_calendar_roomMoveDetailType":{"description":"Room move history information.","properties":{"date":{"description":"Business date on which room is moved. Uses database time zone.","format":"date-time","type":"string"},"description":{"description":"Description of why room is moved.","maxLength":2000,"minLength":0,"type":"string"},"fromRoom":{"description":"Room from which guest is moved.","maxLength":20,"minLength":0,"type":"string"},"hotelId":{"description":"Identifies the hotel code under which room is moved.","maxLength":20,"minLength":0,"type":"string"},"movedBy":{"description":"The user who moved the guest.","maxLength":100,"minLength":0,"type":"string"},"reasonCode":{"description":"Identifies the room move reason code.","maxLength":20,"minLength":0,"type":"string"},"reservationId":{"$ref":"#/components/schemas/room_calendar_reservationId","description":"Unique identifier of the reservation."},"toRoom":{"description":"Room to which guest is moved.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"room_calendar_roomMoveDetailsType":{"description":"List of room move details","items":{"$ref":"#/components/schemas/room_calendar_roomMoveDetailType"},"maxItems":4000,"type":"array"},"room_calendar_roomOwnerStatusType":{"description":"Enumeration of different ownership statuses of room","enum":["OwnerRoom","Exclusive","Regular"],"type":"string"},"room_calendar_roomScheduleCategoryType":{"description":"Enumeration of the different Room Schedule Types.","enum":["Reservation","Ooo","Oos","Default"],"type":"string"},"room_calendar_roomScheduleType":{"description":"Holds TimeSpan and Reservation Information.","properties":{"description":{"description":"Description for the the Room Schedule.","maxLength":2000,"minLength":0,"type":"string"},"end":{"description":"The ending value of the time span. Uses the hotel's time zone.","format":"date-time","type":"string"},"roomCalendarResList":{"description":"List of Reservations under this schedule.","items":{"$ref":"#/components/schemas/room_calendar_roomCalendarResType"},"maxItems":4000,"type":"array"},"roomScheduleCategory":{"$ref":"#/components/schemas/room_calendar_roomScheduleCategoryType","description":"Tells the type of Schedule Item this record is."},"roomScheduleDisplay":{"$ref":"#/components/schemas/room_calendar_roomCalendarDisplayType","description":"Display configuration for this schedule."},"start":{"description":"The starting value of the time span. Uses the hotel's time zone.","format":"date-time","type":"string"}},"type":"object"},"room_calendar_scheduleRoomMoveType":{"description":"Type of room move scheduled either from or to information","properties":{"scheduleMoveRoomNumber":{"description":"Room to which guest is scheduled to be moved.","maxLength":20,"minLength":0,"type":"string"},"scheduleRoomMoveDate":{"description":"Business date on which room is scheduled to be moved from or to another room.","format":"date","type":"string"},"scheduleRoomMoveStatus":{"$ref":"#/components/schemas/room_calendar_scheduledRoomMoveStatusType","description":"Indicates if the reservation is scheduled to be moved from or to a room."},"scheduledMoveTime":{"description":"The scheduled time of room move. Uses the hotel's time zone.","format":"date-time","type":"string"}},"type":"object"},"room_calendar_scheduledRoomMoveDetailType":{"description":"Scheduled room move information.","properties":{"scheduledRoomMoveFrom":{"$ref":"#/components/schemas/room_calendar_scheduleRoomMoveType","description":"Indicates if the reservation is scheduled to be moved from a room"},"scheduledRoomMoveTo":{"$ref":"#/components/schemas/room_calendar_scheduleRoomMoveType","description":"Indicates if the reservation is scheduled to be moved to a room"}},"type":"object"},"room_calendar_scheduledRoomMoveStatusType":{"description":"Flag indicating scheduled room move status.","enum":["Completed","Pending"],"type":"string"},"room_calendar_uniqueID_Type":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system. Eg: ConfirmationLegNumber, ExternalLegNumber","type":"integer"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"room_calendar_vIPStatusType":{"description":"VIP status of the customer.","properties":{"code":{"description":"VIP status of the customer.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Used for Character Strings, length 0 to 2000.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"room_calendar_warningType":{"description":"Used when a message has been successfully processed to report any warnings or business errors that occurred.","properties":{"code":{"description":"If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.","maxLength":20,"minLength":0,"type":"string"},"docURL":{"description":"If present, this URL refers to an online description of the error that occurred.","maxLength":2000,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"recordId":{"description":"If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.","maxLength":2000,"type":"string"},"rph":{"description":"Reference Place Holder used as an index for this warning.","maxLength":8,"minLength":1,"type":"string"},"shortText":{"description":"An abbreviated version of the error in textual format.","maxLength":2000,"type":"string"},"status":{"description":"If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.","maxLength":2000,"type":"string"},"tag":{"description":"If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].","maxLength":2000,"type":"string"},"type":{"description":"The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"room_calendar_warningsType":{"description":"Used in conjunction with the Success element to define a business error.","items":{"$ref":"#/components/schemas/room_calendar_warningType"},"maxItems":4000,"type":"array"},"rsv_read_actionStatusType":{"description":"Action status of the Track It item(Open, Closed).","enum":["Open","Closed"],"type":"string"},"rsv_read_activityList":{"description":"A collection of Activity objects.","items":{"description":"Represents a single instance of a scheduled activity.","properties":{"activityIds":{"$ref":"#/components/schemas/rsv_read_uniqueIDListType","description":"A collection of reference ID values that identify this uniquely scheduled activity instance. May contain one ID per external system plus an internal identifier."},"amount":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"The amount charged for the activity."},"deposit":{"description":"A monetary value expressed with a currency code.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"collectedBy":{"enum":["Vendor","Agent","Other"],"type":"string"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"}},"type":"object"},"description":{"description":"Description of the activity","items":{"maxLength":2000,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"duration":{"$ref":"#/components/schemas/rsv_read_dateTimeSpanType","description":"The time span of the activity falls"},"extensions":{"description":"Vendor extensions to the activity record.","items":{"type":"string"},"maxItems":4000,"type":"array"},"groupCode":{"description":"Any Block code associated with the activity if its a Group booking.","type":"string"},"inactiveDate":{"description":"The Date by which the activity is deemed Cancelled/Deleted. Uses the hotel's time zone.","format":"date-time","type":"string"},"link":{"description":"When true indicates that activity link only needs to be inserted or deleted for this record.","type":"boolean"},"location":{"description":"The Location where the activity takes place. Eg: Salon","type":"string"},"name":{"description":"Name of the people for whom the activity is scheduled. Can be more than one but should be equal to the number of persons","items":{"maxLength":200,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"note":{"description":"Any additional notes or comments regarding the scheduled activity.","items":{"maxLength":2000,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"numberOfPersons":{"description":"The total number of the people for whom the activity is scheduled. Can be more than one but should be equal to the number of persons","type":"integer"},"participants":{"description":"The names of the participants.","items":{"$ref":"#/components/schemas/rsv_read_personNameType"},"maxItems":4000,"type":"array"},"status":{"description":"Activity reservation status. Typical examples are RESERVED, BOOKED, CANCELLED, and TENTATIVE.","type":"string"},"statusDescription":{"description":"Activity reservation status description. Typical examples are RESERVED, BOOKED, CANCELLED, and TENTATIVE.","type":"string"},"timeSpan":{"$ref":"#/components/schemas/rsv_read_dateTimeSpanType","description":"The time with-in which an activity falls (Starts/Ends/Spans)"},"type":{"description":"The Type of the activity. Eg: SPA, Golf etc.","type":"string"},"uRLLink":{"description":"The URL link to launch the Activity Reservation System to view or edit full details of this activity.","type":"string"}},"type":"object"},"maxItems":4000,"type":"array"},"rsv_read_activityLog":{"description":"Response object for the request for the reservation user activity log.","properties":{"activityLog":{"$ref":"#/components/schemas/rsv_read_activityLogListType","description":"Collection of the list of Activities(Log) requested."},"links":{"$ref":"#/components/schemas/rsv_read_links"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_activityLogListType":{"properties":{"activityLog":{"items":{"$ref":"#/components/schemas/rsv_read_activityLogType"},"maxItems":4000,"type":"array"},"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"limit":{"description":"Indicates maximum number of records a Web Service should return.","type":"integer"},"offset":{"description":"Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.","type":"integer"},"totalPages":{"description":"Evaluated total page count based on the requested max fetch count.","type":"integer"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"rsv_read_activityLogType":{"properties":{"actionDescription":{"maxLength":2000,"minLength":0,"type":"string"},"actionType":{"maxLength":100,"minLength":0,"type":"string"},"croCode":{"maxLength":20,"minLength":0,"type":"string"},"deviceCode":{"description":"The selected device code","maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"iPAddress":{"description":"The IP Address of the machine that performed the activity","maxLength":2000,"minLength":0,"type":"string"},"logDate":{"description":"Uses the hotel's time zone.","format":"date-time","type":"string"},"logUserId":{"type":"integer"},"logUserName":{"type":"string"},"machineStation":{"type":"string"},"module":{"type":"string"},"refActionId":{"type":"number"}},"type":"object"},"rsv_read_activityLookUpList":{"description":"Criteria for fetching Activity Bookings.","items":{"$ref":"#/components/schemas/rsv_read_fetchActivityBookingsType"},"maxItems":4000,"type":"array"},"rsv_read_addressInfoType":{"description":"Provides address information.","properties":{"address":{"$ref":"#/components/schemas/rsv_read_addressType","description":"Address details for the profile."},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_addressSearchType":{"description":"Address Details such as city, state, country, postal code etc.","properties":{"cityName":{"description":"City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).","maxLength":40,"minLength":0,"type":"string"},"country":{"$ref":"#/components/schemas/rsv_read_countryNameType","description":"Country name (e.g., Ireland)."},"excludeNoCity":{"description":"When true indicates that only profiles with city will be fetched.","type":"boolean"},"postalCode":{"description":"Post Office Code number.","maxLength":15,"minLength":0,"type":"string"},"state":{"description":"State or Province name (e.g., Texas).","maxLength":20,"minLength":0,"type":"string"},"streetAddress":{"description":"First Line of Street Address. For profile search it matches the first Address line.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_addressType":{"description":"Provides address information.","properties":{"addressLine":{"description":"When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.","items":{"maxLength":80,"minLength":0,"type":"string"},"maxItems":4,"type":"array"},"barCode":{"description":"The postal barcode for the address.","maxLength":100,"minLength":0,"type":"string"},"cityExtension":{"description":"Post Office City Extension Code number. City Extension mainly used for UK addresses.","maxLength":20,"minLength":0,"type":"string"},"cityName":{"description":"City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).","maxLength":40,"minLength":0,"type":"string"},"country":{"$ref":"#/components/schemas/rsv_read_countryNameType","description":"Country name (e.g., Ireland)."},"county":{"description":"County or District Name (e.g., Fairfax). This is read only.","maxLength":20,"minLength":0,"type":"string"},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"isValidated":{"description":"Indicator to define if the Address is validated by the Address Validation System.","type":"boolean"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"postalCode":{"description":"Post Office Code number.","maxLength":15,"minLength":0,"type":"string"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"},"state":{"description":"State or Province name (e.g., Texas).","maxLength":20,"minLength":0,"type":"string"},"type":{"description":"Defines the type of address (e.g. home, business, other).","maxLength":20,"minLength":0,"type":"string"},"typeDescription":{"description":"Describes the type code","type":"string"},"updateReservations":{"description":"Indicates whether all future reservations for this profile should be updated with the primary address. When set to true, and the address is being updated to primary, any active reservations where this profile is the primary profile will automatically update to use the new primary address.","type":"boolean"}},"type":"object"},"rsv_read_advanceCheckInType":{"description":"Information relating to Reservation's Advance Checked In state and Expected Time of Return","properties":{"advanceCheckInTime":{"description":"Time in the property's timezone the reservation is advance checked in, returned only with operation getReservation when a reservation is advance checked in. Uses the hotel's time zone.","format":"date-time","type":"string"},"advanceCheckedIn":{"description":"Indicates if the reservation is marked as Advance Checked In","type":"boolean"},"eTRComments":{"description":"ETR Comments","maxLength":2000,"minLength":0,"type":"string"},"expectedReturnTime":{"description":"Expected Return Time in the property's timezone. Uses the hotel's time zone.","format":"date-time","type":"string"}},"type":"object"},"rsv_read_alertAreaType":{"enum":["CheckIn","CheckOut","Reservation","Billing","InHouse"],"type":"string"},"rsv_read_alertGuestInfoType":{"properties":{"birthDate":{"description":"Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.","format":"date","type":"string"},"birthDateMasked":{"description":"Indicates the date of birth as masked.","type":"string"},"comments":{"description":"Additional alert information regarding the membership of the guest.","type":"string"},"guestName":{"description":"Guest Name.","maxLength":200,"minLength":0,"type":"string"},"guestPreferredLanguage":{"$ref":"#/components/schemas/rsv_read_languageType","description":"Holds the language preferred by the guest."},"lastHotelCode":{"description":"Hotel code of the last stay location of the guest.","maxLength":20,"minLength":0,"type":"string"},"lastStayDate":{"description":"Last stay date at the property.","format":"date","type":"string"},"membership":{"$ref":"#/components/schemas/rsv_read_membershipType","description":"Membership information of the guest."},"preference":{"description":"Additional alert information regarding the guest.","type":"string"},"preference2":{"description":"Additional mandatory alert information regarding the guest preferences.","type":"string"},"totalBrandStay":{"description":"Holds total number of days that the guest have stayed in the properties for the same brand.","type":"integer"},"totalStay":{"description":"Holds total number of days that the guest have stayed in the property.","type":"integer"},"vipStatus":{"$ref":"#/components/schemas/rsv_read_vIPStatusType","description":"VIP status of the guest."}},"type":"object"},"rsv_read_alertType":{"properties":{"area":{"$ref":"#/components/schemas/rsv_read_alertAreaType","description":"The Area where the alert will be attached and shown."},"code":{"description":"Code identifying the type of alert.","maxLength":20,"minLength":0,"type":"string"},"createDateTime":{"description":"Time stamp of the creation. Uses database time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"description":{"description":"The alert message.","type":"string"},"global":{"description":"Indicate whether the alert is a global that is automatically and dynamically attached to all reservations that meet the alert criteria.","type":"boolean"},"guestInfo":{"$ref":"#/components/schemas/rsv_read_alertGuestInfoType","description":"Contains information regarding the guest."},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"image":{"$ref":"#/components/schemas/rsv_read_imageSetType","description":"The Alert image."},"isAdvancedAlert":{"description":"Indicates whether the Alert is an Advanced Alert with script.","type":"boolean"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses database time zone.","format":"date-time","type":"string"},"printerName":{"description":"Printer used to print the alert notification.","type":"string"},"printerNotification":{"description":"Notify by sending the message to the printer.","type":"boolean"},"reportDescription":{"description":"Report description. Mainly used for as a parameter for printing the alerts.","maxLength":1000,"minLength":0,"type":"string"},"reportId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"The module id of the report. This is used to printer the alert."},"reportName":{"description":"Report name of the report type.","type":"string"},"screenNotification":{"description":"Notify by showing the alert on the screen","type":"boolean"},"script":{"description":"Script associated with Alert.","format":"byte","type":"string"},"stopCheckInCheckOut":{"description":"Indicates the Reservation Stop Check In/Check Out Global Alert.","type":"boolean"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"userDefinedFields":{"$ref":"#/components/schemas/rsv_read_userDefinedFieldsType","description":"Collections of user defined fields."},"welcomeOffer":{"$ref":"#/components/schemas/rsv_read_welcomeOfferType","description":"Contains information regarding welcome offer."}},"type":"object"},"rsv_read_alerts":{"description":"Response with the fetched alerts, includes global alerts, notes and undelivered guest messages.","properties":{"alerts":{"$ref":"#/components/schemas/rsv_read_alertsType","description":"The Alert information returned as per the request."},"comments":{"description":"List of Notes for the Guest related to the reservation.","items":{"$ref":"#/components/schemas/rsv_read_commentInfoType"},"type":"array"},"guestMessages":{"$ref":"#/components/schemas/rsv_read_resvGuestMessagesType","description":"List of undelivered Messages for the Guest related to the requested Reservation. Refer to Generic common types document."},"links":{"$ref":"#/components/schemas/rsv_read_links"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_alertsType":{"description":"List of alerts.","items":{"$ref":"#/components/schemas/rsv_read_alertType"},"maxItems":4000,"type":"array"},"rsv_read_amountDeterminationType":{"description":"Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.","enum":["Inclusive","Exclusive"],"type":"string"},"rsv_read_amountType":{"description":"Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentages, total amount, and the rate description.","properties":{"base":{"$ref":"#/components/schemas/rsv_read_totalType","description":"The base amount charged for the accommodation or service per unit of time (ex: Nightly, Weekly, etc). If TaxInclusive is set to True, then taxes are included in the base amount. Note that any additional charges should itemized in the other elements."},"discount":{"$ref":"#/components/schemas/rsv_read_discountType","description":"Discount percentage and/or Amount, code and textual reason for discount"},"effectiveRate":{"$ref":"#/components/schemas/rsv_read_totalType","description":"The reservation effective amount charged for the accommodation or service (i.e. base amount + amount for Add to Rate Combine Line packages) per unit of time"},"end":{"description":"The ending value of the date range.","format":"date","type":"string"},"requiredPoints":{"$ref":"#/components/schemas/rsv_read_pointsType","description":"The Points contains the number of points required to book a particular room type."},"shareDistributionInstruction":{"$ref":"#/components/schemas/rsv_read_shareDistributionInstructionType","description":"Last rate share distribution instruction applied on share reservation daily rate segment."},"shareRatePercentage":{"description":"Indicates the share rate percentage for the reservation if set to CUSTOMSPLIT.","maximum":100,"minimum":0,"type":"number"},"start":{"description":"The starting value of the date range.","format":"date","type":"string"},"total":{"$ref":"#/components/schemas/rsv_read_totalType","description":"The total amount charged for this rate including additional occupant amounts and fees."}},"type":"object"},"rsv_read_anonymizationStatusType":{"description":"Guest has been anonymized.","enum":["Requested","Anonymized"],"type":"string"},"rsv_read_anonymizationType":{"description":"Provides information about guest's anonymization status.","properties":{"anonymizationStatus":{"$ref":"#/components/schemas/rsv_read_anonymizationStatusType","description":"Status of anonymization such as Requested or Anonymized."}},"type":"object"},"rsv_read_applicationUserType":{"properties":{"actAs":{"maxLength":20,"minLength":0,"type":"string"},"actAt":{"maxLength":20,"minLength":0,"type":"string"},"appUser":{"maxLength":250,"minLength":0,"type":"string"},"appUserId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type"},"attendantInfo":{"$ref":"#/components/schemas/rsv_read_attendantType"},"cashierId":{"type":"integer"},"cashierTitle":{"description":"Cashier title.","maxLength":2000,"minLength":0,"type":"string"},"department":{"maxLength":60,"minLength":0,"type":"string"},"departmentLocation":{"maxLength":60,"minLength":0,"type":"string"},"disabledUntil":{"format":"date","type":"string"},"expiryDate":{"format":"date","type":"string"},"hotel":{"$ref":"#/components/schemas/rsv_read_codeDescriptionType","description":"Hotel where user belongs."},"lDAPUser":{"maxLength":250,"minLength":0,"type":"string"},"passwordChangeDate":{"format":"date","type":"string"},"salesRepCode":{"maxLength":20,"minLength":0,"type":"string"},"userDefaultLanguage":{"maxLength":20,"minLength":0,"type":"string"},"userInfo":{"$ref":"#/components/schemas/rsv_read_employeeInfoType"},"userSessionInfo":{"$ref":"#/components/schemas/rsv_read_userSessionInfoType","description":"This is only used during log-in."}},"type":"object"},"rsv_read_associatedResType":{"description":"Information regarding associated reservations to the reservation.","properties":{},"type":"object"},"rsv_read_attachDetachType":{"description":"This type contains attach and detach information for accompanying guest profile.","properties":{"attachDateTime":{"description":"Time stamp the accompanying guest was last attached. Uses the hotel's time zone.","format":"date-time","type":"string"},"detachDateTime":{"description":"Time stamp the accompanying guest was last detached. Uses the hotel's time zone.","format":"date-time","type":"string"},"detached":{"description":"This attribute indicates if the accompanying guest is marked as detached or attached.","type":"boolean"}},"type":"object"},"rsv_read_attachmentType":{"description":"Attached files.","properties":{"description":{"description":"Description for the file.","maxLength":4000,"minLength":0,"type":"string"},"fileName":{"description":"Name of the file.","maxLength":2000,"minLength":0,"type":"string"},"fileSize":{"description":"Size of the file.","type":"integer"},"global":{"description":"Flag to say if attachment is available across properties.","type":"boolean"},"history":{"$ref":"#/components/schemas/rsv_read_dateTimeStampGroupType","description":"History data associated with Attachment."},"hotelId":{"description":"Hotel Code.","maxLength":20,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"rsv_read_attachmentsType":{"description":"Attachment List.","items":{"$ref":"#/components/schemas/rsv_read_attachmentType"},"maxItems":4000,"type":"array"},"rsv_read_attendantType":{"properties":{"attendantId":{"maxLength":20,"minLength":0,"type":"string"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_authorizationInfoType":{"properties":{"alternateTransRef":{"description":"Alternate vendor transaction id for the authorization.","maxLength":64,"minLength":0,"type":"string"},"approvalAmount":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Approved amount."},"approvalCode":{"description":"The approval code authenticates the authorization.","maxLength":20,"minLength":0,"type":"string"},"originalAuthSequence":{"description":"Unique Authorization Sequence for the authorization and settlement.","type":"integer"},"vendorTranId":{"description":"Vendor transaction id for the authorization.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_authorizationRuleType":{"description":"Configured rule for computing the amount to authorize.","properties":{"amount":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"The amount applicable to the authorization rule."},"code":{"description":"The authorization rule code.","pattern":"[0-9]{1,9}","type":"integer"},"percent":{"description":"A percentage value if the authorization rule is percentage based.","type":"number"}},"type":"object"},"rsv_read_authorizerInfoType":{"description":"Authorizer Information","properties":{"authorizerId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type"},"authorizerName":{"description":"Full name of the authorizer.","maxLength":100,"minLength":0,"type":"string"},"authorizerRateCode":{"description":"Rate code of the authorizer.","maxLength":20,"minLength":0,"type":"string"},"authorizerUserName":{"description":"Application user name of the authorizer","maxLength":40,"minLength":0,"type":"string"},"inheritAuthorizerRateCode":{"description":"Indicates whether user has the choice to have reservation inherit rate code from the authorizer.","type":"boolean"}},"type":"object"},"rsv_read_awardKindType":{"description":"Indicates that this is electronic certificate.","enum":["Paper","ECertificate"],"type":"string"},"rsv_read_awardStatusType":{"description":"Indicates that certificate is in use.","enum":["Available","NotAvailable","InUse"],"type":"string"},"rsv_read_awardType":{"description":"Detailed information of the awards.","properties":{"awardCode":{"description":"Award category.","maxLength":20,"minLength":0,"type":"string"},"awardType":{"$ref":"#/components/schemas/rsv_read_awardKindType","description":"Can be P (Paper) or E (E-Certificate)."},"categoryValid":{"description":"Indicates whether the category of certificate is valid or not for this resort.","type":"boolean"},"certificateNo":{"description":"Certificate No.","maxLength":20,"minLength":0,"type":"string"},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"description":{"description":"Description of the award/certificate.","type":"string"},"detailedCertificate":{"description":"Indicates if this certificate is detailed or not.","type":"boolean"},"displaySequence":{"description":"Indicates the order in which the certificates received from MRW.","type":"number"},"expirationDate":{"description":"Expiration Date.","format":"date","type":"string"},"externalConfirmationNo":{"description":"Confirmation Number given by a CRS application for this reservation.","maxLength":20,"minLength":0,"type":"string"},"externalHotelCode":{"description":"Hotel Code of the CRS application that this certificate belongs to.","maxLength":20,"minLength":0,"type":"string"},"gift":{"description":"Signifies whether award is gift or not.","type":"boolean"},"hotelCategory":{"description":"Indicates the lowest hotel category for which the certificate is valid.","maxLength":20,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel Code for which the routing instructions are provided for a profile.","maxLength":20,"minLength":0,"type":"string"},"instantlyRedeemable":{"description":"Indicates if the award is an Instant Redemption award.","type":"boolean"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"membershipNo":{"description":"Membership No.","type":"string"},"nights":{"description":"Award Nights.","type":"integer"},"package":{"description":"Signifies whether upgrade is package or not.","type":"boolean"},"paidUpgrade":{"description":"Indicates if this certificate was ordered using the \"Paid Upgrade\" option in the E-Certs screen.","type":"boolean"},"points":{"description":"No. of points used to order this award.","type":"number"},"profileId":{"$ref":"#/components/schemas/rsv_read_profileId","description":"Unique profile identifier requested to be fetched."},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","type":"string"},"quantity":{"description":"Quantity of such awards needed to be ordered.","type":"integer"},"reservationCertificateType":{"$ref":"#/components/schemas/rsv_read_reservationCertificateType","description":"[R]=Reward, [I]=Incentive."},"reservationId":{"$ref":"#/components/schemas/rsv_read_reservationId","description":"Reservation IDs will be empty if award is not attached."},"rewardCertificateType":{"$ref":"#/components/schemas/rsv_read_rewardCertificateType","description":"[RE]=Regular Certificate, [SA]=Stay Anytime Certificate, [PS]=Point Saver Certificate."},"sourceType":{"description":"MRW : From MRW MAN:Entered manually.","type":"string"},"status":{"$ref":"#/components/schemas/rsv_read_awardStatusType","description":"Status of the award aka available."},"upgrade":{"description":"Signifies whether upgrade award or not.","type":"boolean"}},"type":"object"},"rsv_read_awardUpgradeDetailType":{"properties":{"date":{"description":"Date on which the award details like points required and penalty points are applicable.","format":"date","type":"string"},"penaltyPoints":{"description":"Penalty Points applicable for the award detail date.","type":"integer"},"pointsRequired":{"description":"Points required for the award detail date.","type":"integer"}},"type":"object"},"rsv_read_awardUpgradeDetailsType":{"description":"Daily Details related to award upgrade.","items":{"$ref":"#/components/schemas/rsv_read_awardUpgradeDetailType"},"maxItems":4000,"type":"array"},"rsv_read_awardUpgradeInfoType":{"properties":{"awardUpgradeSummaries":{"$ref":"#/components/schemas/rsv_read_awardUpgradeSummariesType","description":"Summary information related to award upgrade."},"fromRoomType":{"description":"From Room type associated with the award.","maxLength":20,"minLength":0,"type":"string"},"hotelId":{"description":"Property associated with the award upgrade.","maxLength":20,"minLength":0,"type":"string"},"membershipCardNo":{"description":"The card number associated with this membership.","maxLength":50,"minLength":0,"type":"string"},"membershipLevel":{"description":"The current level of the membership.","maxLength":20,"minLength":0,"type":"string"},"membershipPoints":{"description":"Current membership points available for this guest.","type":"integer"},"membershipType":{"description":"The type of the membership.","maxLength":20,"minLength":0,"type":"string"},"reservationTimeSpan":{"$ref":"#/components/schemas/rsv_read_timeSpanType","description":"Arrival and Departure dates of the reservation."}},"type":"object"},"rsv_read_awardUpgradeSummariesType":{"description":"Summary information related to award upgrade.","items":{"$ref":"#/components/schemas/rsv_read_awardUpgradeSummaryType"},"maxItems":4000,"type":"array"},"rsv_read_awardUpgradeSummaryType":{"properties":{"awardCode":{"description":"User configured award code.","maxLength":40,"minLength":0,"type":"string"},"awardUpgradeDetails":{"$ref":"#/components/schemas/rsv_read_awardUpgradeDetailsType","description":"Daily Details related to award upgrade."},"fromRoomType":{"description":"From Room type associated with the award.","maxLength":20,"minLength":0,"type":"string"},"penaltyCharge":{"description":"Number points deducted if award is cancelled.","type":"integer"},"penaltyDays":{"description":"Number days before arrival to apply penalty for cancellation.","type":"integer"},"penaltyPoints":{"description":"Total Number of penalty points if cancelled.","type":"integer"},"penaltyType":{"description":"Type of cancel penalty like Points, etc.","maxLength":20,"minLength":0,"type":"string"},"pointsRequired":{"description":"Total Number of points required for the award.","type":"integer"},"toRoomType":{"description":"To Room type associated with the award.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_awardUpgrades":{"description":"Response object for available award upgrades.","properties":{"awardUpgradeInfo":{"$ref":"#/components/schemas/rsv_read_awardUpgradeInfoType"},"links":{"$ref":"#/components/schemas/rsv_read_links"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_awardsType":{"description":"List of awards.","items":{"$ref":"#/components/schemas/rsv_read_awardType"},"maxItems":4000,"type":"array"},"rsv_read_backToBackResSequenceType":{"description":"Type object represents Back To Back Sequence Position and Total Count of Linked Back To Back Reservations ordered by consecutive Stay Dates.","properties":{"position":{"description":"Indicates the Sequence position of Back to Back Reservation.","type":"integer"},"totalCount":{"description":"Indicates the total count of Back To Back Reservations in the group of Linked Reservations.","type":"integer"}},"type":"object"},"rsv_read_basicEmailType":{"description":"Email address","maxLength":2000,"minLength":0,"type":"string"},"rsv_read_bedTaxReportingType":{"description":"This stores the information for Bed Tax Reporting. Mainly used in Maldives.","properties":{"taxRegistrationNo":{"description":"Tax Registration Number for Maldives Bed Tax Reporting.","type":"number"}},"type":"object"},"rsv_read_benefitType":{"description":"Basic information about membership benefit.","properties":{"code":{"description":"Benefit code associated with a membership.","maxLength":20,"minLength":0,"type":"string"},"inactive":{"description":"Indicates whether membership benefit is active or inactive.","type":"boolean"},"message":{"description":"Processing message for membership benefit.","maxLength":4000,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_benefitsType":{"description":"Basic information about membership benefit.","items":{"$ref":"#/components/schemas/rsv_read_benefitType"},"maxItems":4000,"type":"array"},"rsv_read_billingInstructionType":{"description":"Configured Billing Instruction which represents a set of Transaction Codes.","properties":{"billingCode":{"description":"Unique identifier for the Billing Instruction.","maxLength":20,"minLength":0,"type":"string"},"desc":{"description":"Billing Instruction code description.","maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel context of the Billing Instruction.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_billingInstructionsType":{"description":"Set of Billing Instruction codes.","items":{"$ref":"#/components/schemas/rsv_read_billingInstructionType"},"maxItems":4000,"type":"array"},"rsv_read_billingPrivilegesType":{"description":"This stores the information for Bed Tax Reporting. Mainly used in Maldives.","properties":{"allowAutoCheckin":{"description":"Indicated if a new reservation should be created and automatically checked in whenever the room is checked out. Available for pseudo room types only.","type":"boolean"},"autoSettlement":{"description":"Indicates if the is a candidate for auto folio settlement.","type":"boolean"},"autoSettlementFreq":{"description":"The interval of days between each auto folio settlement.","type":"integer"},"autoSettlementType":{"description":"The folio settlement type for auto folio settlement.","maxLength":40,"minLength":0,"type":"string"},"creditLimitAutoPay":{"description":"Indicates if the reservation will be included in the Automatic Credit Limit Overages process and also be listed in the Credit Limit Overages screen results.","type":"boolean"},"excludeFromAutoAuthorization":{"description":"Indicates if the reseravtion will be excluded from auto athorization of Credit Cards.","type":"boolean"},"postStayCharging":{"description":"Indicates if the reservation has charging privileges after checkout.","type":"boolean"},"postingRestriction":{"description":"Flag used by interface program during check in.","type":"boolean"},"preStayCharging":{"description":"Indicates if the reservation has charging privileges before arrival.","type":"boolean"},"videoCheckout":{"description":"Indicates if the guest can do video checkout","type":"boolean"}},"type":"object"},"rsv_read_blockId":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"rsv_read_blockIdList":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type"},"maxItems":4000,"type":"array"},"rsv_read_bookingChannelType":{"properties":{"channelCode":{"maxLength":20,"minLength":0,"type":"string"},"channelName":{"maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_bookingTimeSpanType":{"description":"The booking time span of the reservation, only applicable when time increments are being used.","properties":{"endDateTime":{"description":"The end time of the reservation booking. Uses the hotel's time zone.","format":"date-time","type":"string"},"startDateTime":{"description":"The start time of the reservation booking. Uses the hotel's time zone.","format":"date-time","type":"string"}},"type":"object"},"rsv_read_callHistory":{"description":"Response that contains either the fetched call history if was successful or error(s) if not.","properties":{"callHistory":{"$ref":"#/components/schemas/rsv_read_callHistoryType","description":"History of Calls made. Contains information on Caller Info, Reservation info and comments. Refer to the Generic Common Types document for information on the Call History Type"},"links":{"$ref":"#/components/schemas/rsv_read_links"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_callHistoryType":{"description":"Holds call information.","items":{"$ref":"#/components/schemas/rsv_read_callType"},"maxItems":4000,"type":"array"},"rsv_read_callType":{"description":"Holds call information.","properties":{"caller":{"$ref":"#/components/schemas/rsv_read_callerType","description":"Holds caller information."},"comments":{"description":"Call comments.","maxLength":200,"minLength":0,"type":"string"},"dateTimeSpan":{"$ref":"#/components/schemas/rsv_read_dateTimeSpanType","description":"Call Time Span. Start Date and End Date is used for the Call duration."},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"reservation":{"description":"Holds Reservation Id and Hotel Code.","properties":{"hotelId":{"description":"Holds Hotel Code.","maxLength":20,"minLength":0,"type":"string"},"reservationIdList":{"$ref":"#/components/schemas/rsv_read_reservationIdList","description":"Holds Reservation related Ids."}},"type":"object"},"turnawayCode":{"description":"Call turn away code.","maxLength":20,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"rsv_read_callerType":{"description":"Holds caller information.","properties":{"email":{"description":"Caller Email.","maxLength":80,"minLength":0,"type":"string"},"fax":{"description":"Caller Fax Number.","maxLength":80,"minLength":0,"type":"string"},"givenName":{"description":"Caller First Name.","maxLength":280,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"phone":{"description":"Caller Phone Number.","maxLength":80,"minLength":0,"type":"string"},"surname":{"description":"Caller Last Name.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"rsv_read_cancellationActivityType":{"properties":{"cancellationIdList":{"$ref":"#/components/schemas/rsv_read_uniqueIDListType","description":"Cancellation IDs"},"cxlDate":{"format":"date","type":"string"},"reason":{"$ref":"#/components/schemas/rsv_read_cancellationReasonType"},"userId":{"type":"number"},"userName":{"type":"string"}},"type":"object"},"rsv_read_cancellationHistory":{"description":"Response object to the request to retrieve cancellation history for a reservation.","properties":{"cxlActivityLog":{"description":"Cancellation Activity information. Refer to Generic common types document.","items":{"$ref":"#/components/schemas/rsv_read_cancellationActivityType"},"type":"array"},"links":{"$ref":"#/components/schemas/rsv_read_links"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_cancellationReasonType":{"properties":{"code":{"maxLength":20,"minLength":0,"type":"string"},"description":{"maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_cardNumberTypeType":{"description":"Simple type for indicating if credit card number is tokenized.","enum":["CardNumber","Token"],"type":"string"},"rsv_read_cardProcessingType":{"enum":["Eft","Manual"],"type":"string"},"rsv_read_cardReIssueType":{"description":"Request to re issue a new card.","enum":["Pending","NotApplicable","Requested"],"type":"string"},"rsv_read_cardTypeType":{"description":"This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.","enum":["Ab","Am","Ax","Cb","Dc","Ds","Dt","Ec","Er","Jc","Jl","Mc","Nb","So","St","Sw","Va","Xy","Zz","Cp","Cu"],"type":"string"},"rsv_read_cashieringPaymentMethodType":{"properties":{"authorizationApproval":{"$ref":"#/components/schemas/rsv_read_authorizationInfoType","description":"Authorization approval record."},"paymentCard":{"$ref":"#/components/schemas/rsv_read_resPaymentCardType"},"paymentMethod":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_cateringResInfoType":{"description":"Information regarding catering event and catering revenue type associated to the reservation.","properties":{"eventId":{"$ref":"#/components/schemas/rsv_read_eventId","description":"Unique ID on a catering event associated to the reservation."},"revenueType":{"description":"Catering revenue type associated to the reservation.","type":"string"}},"type":"object"},"rsv_read_certainNightsOfTheWeek":{"description":"Supports the 'Certain Nights Of The Week' trace frequency option by indicating on which days traces should be generated.","properties":{"friday":{"description":"If true, a trace will be created for every Friday on the reservation.","type":"boolean"},"monday":{"description":"If true, a trace will be created for every Monday on the reservation.","type":"boolean"},"saturday":{"description":"If true, a trace will be created for every Saturday on the reservation.","type":"boolean"},"sunday":{"description":"If true, a trace will be created for every Sunday on the reservation.","type":"boolean"},"thursday":{"description":"If true, a trace will be created for every Thursday on the reservation.","type":"boolean"},"tuesday":{"description":"If true, a trace will be created for every Tuesday on the reservation.","type":"boolean"},"wednesday":{"description":"If true, a trace will be created for every Wednesday on the reservation.","type":"boolean"}},"type":"object"},"rsv_read_channelResvStatusType":{"description":"Depicts that the operation was failed.","enum":["Pending","Cancelled","Modified","Committed","Ignored","Unsuccessful","Pending Cancellation"],"type":"string"},"rsv_read_channelSummaryInfoType":{"description":"Depicts channel information such as the type and code.","properties":{"bookingChannel":{"$ref":"#/components/schemas/rsv_read_bookingChannelType"}},"type":"object"},"rsv_read_characterUDFType":{"description":"Used to hold user defined field of Character/String Type.","properties":{"alternateName":{"description":"Label of user defined field used by vendors or customers.","maxLength":2000,"minLength":0,"type":"string"},"name":{"description":"Used to hold user defined field of Character Type. It is highly recommended to use UDFC01, UDFC02,...UDFC40 (Total 40) as Character/String UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Value of user defined field.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_characterUDFsType":{"description":"Used to hold collection of user defined fields of Character/String Type.","items":{"$ref":"#/components/schemas/rsv_read_characterUDFType"},"maxItems":4000,"type":"array"},"rsv_read_checkDistributionReservationsSummary":{"description":"Response for checking allowed actions, existence of attached records, or count of reservations.","properties":{"checkReservations":{"description":"Collection of reservations Count and the status of its allowed actions, attached records.","items":{"$ref":"#/components/schemas/rsv_read_checkDistributionReservationsSummaryType"},"maxItems":4000,"type":"array"},"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"links":{"$ref":"#/components/schemas/rsv_read_links"},"totalResults":{"description":"Total number of rows queried","type":"integer"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_checkDistributionReservationsSummaryType":{"description":"Reservation Statistics and the status of its allowed actions, attached records.","properties":{"arrivalDate":{"description":"Arrival Date.","format":"date","type":"string"},"cancellationDate":{"description":"Cancellation Date. Uses the hotel's time zone.","format":"date-time","type":"string"},"channelCode":{"description":"Channel code.","maxLength":20,"minLength":0,"type":"string"},"confirmationId":{"description":"ConfirmationId of Reservation.","maxLength":20,"minLength":0,"type":"string"},"creationDate":{"description":"Creation Date. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"departureDate":{"description":"Departure Date.","format":"date","type":"string"},"enterpriseId":{"description":"EnterpriseId of Property.","maxLength":20,"minLength":0,"type":"string"},"guestName":{"description":"GuestName.","maxLength":20,"minLength":0,"type":"string"},"hotelId":{"description":"Property code of the reservation.","maxLength":20,"minLength":0,"type":"string"},"lastUpdateDate":{"description":"LastUpdate Date. Uses the hotel's time zone.","format":"date-time","type":"string"},"legNumber":{"description":"ConfirmationLeg Number of Reservation.","maxLength":20,"minLength":0,"type":"string"},"numberOfRooms":{"description":"number of Rooms Booked.","type":"integer"},"reservationId":{"description":"ReservationId of Reservation.","maxLength":20,"minLength":0,"type":"string"},"reservationStatus":{"description":"Status of Reservation.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_childAgeType":{"description":"Defines Child's Age.","properties":{"age":{"description":"Age of a child in years.","type":"integer"}},"type":"object"},"rsv_read_childAgesType":{"description":"Age of a child in years.","items":{"$ref":"#/components/schemas/rsv_read_childAgeType"},"maxItems":4000,"type":"array"},"rsv_read_childBucketsType":{"description":"Defines children counts with Age Qualifying Group(Child Bucket) classification.","properties":{"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"}},"type":"object"},"rsv_read_codeDescriptionType":{"description":"This contains a generic code and description information.","properties":{"code":{"description":"Code.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"description.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_codeInfoType":{"description":"","properties":{"code":{"maxLength":20,"minLength":0,"type":"string"},"description":{"maxLength":80,"minLength":0,"type":"string"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_codeListType":{"items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"rsv_read_codeType":{"description":"Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.","maxLength":20,"minLength":0,"type":"string"},"rsv_read_colorDefinitionType":{"description":"Color definition type. This color definition type is used to determine the defintion of color ","enum":["RESERVATION","MARKET_CODE","VIP_LEVEL","MEMBERSHIP_LEVEL"],"type":"string"},"rsv_read_colorType":{"description":"Color configuration type. This color configuration provides a visual category of entities.","enum":["Red","DarkRed","Green","DarkGreen","LightGreen","Orange","White","Yellow","DarkYellow","Purple","Brown","Gray","Aqua","Chocolate","Blue","LightBlue","DarkBlue","Cyan","DarkCyan","Magenta","DarkMagenta","Black","Deepteal","Sunsetorange","Aquasky","Mochabrown","Mossgreen","Rosewood","Claybrown","Softlavender","Olivegold","Plumpurple","Mistblue","Forestgreen","Dustyviolet","Oceanblue","Copper"],"type":"string"},"rsv_read_commentInfoType":{"description":"Comment related to the profile/reservation.","properties":{"comment":{"$ref":"#/components/schemas/rsv_read_commentType","description":"Comment details for the comment. It will be empty in case of delete comment."},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_commentType":{"description":"An indication of a new paragraph for a sub-section of a formatted text message.","properties":{"commentTitle":{"description":"Specifies Comment's Title.","maxLength":4000,"minLength":0,"type":"string"},"confidential":{"description":"When true, the comment may be confidential.","type":"boolean"},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"hotelId":{"description":"If specified comment belongs to the Hotel, otherwise it is a global comment.","maxLength":20,"minLength":0,"type":"string"},"internal":{"description":"When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer.","type":"boolean"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"notificationLocation":{"description":"Notification Location associated with the Note.","maxLength":20,"minLength":0,"type":"string"},"overrideInternal":{"description":"When true, the note internal could be modified.","type":"boolean"},"text":{"$ref":"#/components/schemas/rsv_read_formattedTextTextType","description":"Formatted text content."},"type":{"description":"Specifies type of the comment.","maxLength":20,"minLength":0,"type":"string"},"typeDescription":{"description":"Comment type Description.","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_commissionPaymentMethods":{"description":"Check","enum":["Cent","Eft","Chk"],"type":"string"},"rsv_read_commissionPayoutToType":{"enum":["TravelAgent","Source","TravelAgentSource","None"],"type":"string"},"rsv_read_communicationStatusType":{"description":"Enum to denote the Status of Readiness messages sent to Guest Devices.","enum":["Pending","Completed","Failed","Sent","Received","Cancelled","PendingAvailability"],"type":"string"},"rsv_read_compAccountingType":{"description":"Authorizer Information","properties":{"aRNumber":{"description":"AR Account Number of the authorizer","maxLength":20,"minLength":0,"type":"string"},"authorizerId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type"},"authorizerName":{"description":"Full name of the authorizer.","maxLength":100,"minLength":0,"type":"string"},"authorizerRateCode":{"description":"Rate code of the authorizer.","maxLength":20,"minLength":0,"type":"string"},"authorizerUserName":{"description":"Application user name of the authorizer","maxLength":40,"minLength":0,"type":"string"},"compTypeCode":{"description":"The Comp Type for this Account. Used when using the Comp types functionality","maxLength":20,"minLength":0,"type":"string"},"compVoucherNo":{"description":"The coupon or voucher number used by the external gaming system to track postings made to this routing.","maxLength":30,"minLength":0,"type":"string"},"dateRange":{"$ref":"#/components/schemas/rsv_read_dateRangeType","description":"Arrival date range for comp routing"},"inheritAuthorizerRateCode":{"description":"Indicates whether user has the choice to have reservation inherit rate code from the authorizer.","type":"boolean"},"membershipId":{"description":"Membership number","maxLength":100,"minLength":0,"type":"string"},"membershipIdNo":{"description":"Unique Id of membership","type":"integer"},"membershipNameOnCard":{"description":"Name displayed on the membership card","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_compAuthorizerInfoType":{"description":"Authorizer Information","properties":{"authorizerId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type"},"authorizerName":{"description":"Full name of the authorizer.","maxLength":100,"minLength":0,"type":"string"},"authorizerUserName":{"description":"Application user name of the authorizer","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_compRoutingRequestType":{"description":"Type for the details of a Comp Routing Request","properties":{"comments":{"maxLength":2000,"minLength":0,"type":"string"},"declinedBy":{"$ref":"#/components/schemas/rsv_read_userInfoType","description":"User information of user who declined comp routing request"},"requestedBy":{"$ref":"#/components/schemas/rsv_read_userInfoType","description":"User who requested the Comp Routing"},"status":{"$ref":"#/components/schemas/rsv_read_compRoutingStatusType","description":"Comp routing status"}},"type":"object"},"rsv_read_compRoutingStatusType":{"description":"Status which indicates that the Request of Comp Routing was declined","enum":["Request","Comp","Declined"],"type":"string"},"rsv_read_companyDetails":{"description":"Company Details","properties":{"companyId":{"description":"ID of the company for the reservation.","maxLength":20,"minLength":0,"type":"string"},"companyName":{"description":"Name of the company for the reservation.","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_companyType":{"properties":{"alternateName":{"description":"Alternate Name of the Company. Mainly, it's the name of the company written in the Alternate Language.","maxLength":80,"minLength":0,"type":"string"},"blacklist":{"description":"This element tells if profile is blacklisted or not.","type":"boolean"},"commissionCode":{"description":"Commission code of the company.","maxLength":20,"minLength":0,"type":"string"},"companyName":{"description":"Name of the company.","maxLength":40,"minLength":0,"type":"string"},"corporateIdType":{"description":"The type of corporate ID","maxLength":20,"minLength":0,"type":"string"},"creditRating":{"description":"Credit Rating of the company.","maxLength":20,"minLength":0,"type":"string"},"currencyCode":{"description":"The code specifying a monetary unit. Use ISO 4217, three alpha code.","maxLength":20,"minLength":0,"type":"string"},"currencySymbol":{"description":"The symbol for the currency, e.g, for currencyCode USD the symbol is $.","maxLength":10,"minLength":0,"type":"string"},"decimalPlaces":{"description":"Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).","type":"integer"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"nationality":{"description":"Nationality code identification","maxLength":20,"minLength":0,"type":"string"},"nationalityDescription":{"description":"Nationality code description","maxLength":80,"minLength":0,"type":"string"},"vipDescription":{"description":"Description of the VIP status.","maxLength":2000,"minLength":0,"type":"string"},"vipStatus":{"description":"VIP status of the company.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_confDeliveryInfoType":{"properties":{"communicationType":{"$ref":"#/components/schemas/rsv_read_confDeliveryMethod","description":"CommunicationType through which the confirmation letter was sent."},"lastAttempted":{"description":"Date of last attempt to send confirmation letter. Uses the hotel's time zone.","format":"date-time","type":"string"},"lastStatus":{"$ref":"#/components/schemas/rsv_read_sentConfirmationStatus","description":"Status of last sent confirmation."},"successfulTries":{"description":"Number of success letter sent.","type":"integer"}},"type":"object"},"rsv_read_confDeliveryInfoTypes":{"description":"List of confirmation letter delivery methods and their status","items":{"$ref":"#/components/schemas/rsv_read_confDeliveryInfoType"},"maxItems":4,"type":"array"},"rsv_read_confDeliveryMethod":{"enum":["Print","Email","Fax","Text","NotConfigured"],"type":"string"},"rsv_read_confRecipientInfoType":{"properties":{"addressInfo":{"$ref":"#/components/schemas/rsv_read_addressInfoType","description":"id of the address where to send confirmation letter."},"emailInfo":{"$ref":"#/components/schemas/rsv_read_emailInfoType","description":"id of the Email where to send confirmation letter."},"faxInfo":{"$ref":"#/components/schemas/rsv_read_telephoneInfoType","description":"id of the Fax where to send confirmation letter."},"formerName":{"$ref":"#/components/schemas/rsv_read_profileNameType","description":"Last Name of recipient."},"optionalEmail":{"description":"Email address to which the confirmation letter will be sent. This field is mutually exclusive with emailInfo; providing both will result in an error. Use either emailInfo or optionalEmail, but not both.","maxLength":2000,"minLength":0,"type":"string"},"profileId":{"$ref":"#/components/schemas/rsv_read_profileId","description":"name id of the recipient."},"recipientType":{"$ref":"#/components/schemas/rsv_read_profileTypeType"},"telephoneInfo":{"$ref":"#/components/schemas/rsv_read_telephoneInfoType","description":"id of the Mobile where to send confirmation letter."}},"type":"object"},"rsv_read_configPackagePrimaryDetailsType":{"description":"A Config Package Info type.","properties":{"arrangementCode":{"description":"Arrangement Code.","maxLength":20,"minLength":0,"type":"string"},"beginSellDate":{"description":"Indicates the begin sell date of the package.","format":"date","type":"string"},"description":{"description":"The description of the package.","maxLength":2000,"minLength":0,"type":"string"},"endSellDate":{"description":"Indicates the end sell date of the package.","format":"date","type":"string"},"externallyExcluded":{"description":"Flag to indicate if a package is configured as Externally Excluded.","type":"boolean"},"forecastGroup":{"description":"The Forecast group package belongs to.","maxLength":20,"minLength":0,"type":"string"},"packageCategory":{"description":"Package Category.","maxLength":20,"minLength":0,"type":"string"},"shortDescription":{"description":"The short description of the package.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_configPackageTransactionType":{"description":"A HotelPackageTransaction type.","properties":{"allowance":{"description":"Package is marked as an allowance, in case charge is expected back to the guest account from external interface eg. POS. which need to be offset against a consumption allowance.","type":"boolean"},"calculationRule":{"description":"The price calculation rule for this package.","maxLength":80,"minLength":0,"type":"string"},"currency":{"description":"The currency code for this package.","maxLength":20,"minLength":0,"type":"string"},"postingType":{"description":"The posting frequency for this package, e.g., daily, arrival, departure, etc.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_configPostingAttributesType":{"description":"A config Package posting attributes type.","properties":{"addToRate":{"description":"The package price is added to the room rate.","type":"boolean"},"calculatedPrice":{"description":"Calculated Package Price based from Number of Adults, Children and Calculation Rule.","type":"number"},"catering":{"description":"Is package used for catering?","type":"boolean"},"endTime":{"description":"End time the package is valid.","type":"string"},"forecastNextDay":{"description":"Package will be forecasted for consumption the next business day.","type":"boolean"},"formula":{"description":"The custom formula used for this package, if any.","maxLength":2000,"minLength":0,"type":"string"},"inventoryItems":{"description":"Package Code Inventory Items type.","items":{"$ref":"#/components/schemas/rsv_read_pkgInventoryItemType"},"maxItems":4000,"type":"array"},"postNextDay":{"description":"package charges will be posted next business day.","type":"boolean"},"postingRhythm":{"$ref":"#/components/schemas/rsv_read_packagePostingRhythmType","description":"The posting rhythm for this package."},"priceCalculationRule":{"$ref":"#/components/schemas/rsv_read_packageCalculationRuleType","description":"The price calculation rule for this package."},"printSeparateLine":{"description":"The package price is printed on separate line of the folio.","type":"boolean"},"sellSeparate":{"description":"Can the package be sold separate from rate plan code?","type":"boolean"},"startTime":{"description":"Start time the package is valid.","type":"string"},"ticket":{"description":"Indicates whether a package is configured as a ticket or not.","type":"boolean"}},"type":"object"},"rsv_read_confirmationStyle":{"properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"style":{"description":"Name of the confirmation letter style.","type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"rsv_read_confirmationType":{"properties":{"confirmationStyleInfo":{"$ref":"#/components/schemas/rsv_read_confirmationStyle","description":"Confirmation style."},"deliveryInfo":{"$ref":"#/components/schemas/rsv_read_confDeliveryInfoTypes","description":"The status of the confirmation letter sent via the specified CommunicationType."},"fromEmail":{"description":"Senders Email address.","maxLength":2000,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"recipientInfo":{"$ref":"#/components/schemas/rsv_read_confRecipientInfoType","description":"Receipient's information."},"sendTextMessage":{"description":"Flag to indicate sending confirmation letter as text message.","type":"boolean"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"rsv_read_confirmationsType":{"description":"List of confirmation letters.","items":{"$ref":"#/components/schemas/rsv_read_confirmationType"},"maxItems":4000,"type":"array"},"rsv_read_countryNameType":{"description":"Used for Character Strings, length 0 to 200 - It indicates country/nationality description.","properties":{"code":{"description":"Code for a country or a nationality.","maxLength":20,"minLength":0,"type":"string"},"displayCountryFlag":{"description":"Setting this to true will display the guest profile's country flag in the OPERA Cloud user interface, if it is configured.","type":"boolean"},"isoCode":{"description":"ISO standard code for country.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Used for Character Strings, length 0 to 200.","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_currencyAmountType":{"description":"A monetary value expressed with a currency code.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"}},"type":"object"},"rsv_read_currentRoomInfoType":{"description":"Room information of the reservation for the current day.","properties":{"assignedByAI":{"description":"Represents the room was assigned by AI Room Assignment.","type":"boolean"},"roomDescription":{"description":"Current room description.","maxLength":2000,"minLength":0,"type":"string"},"roomId":{"description":"Current room number.","maxLength":20,"minLength":0,"type":"string"},"roomOwnershipType":{"$ref":"#/components/schemas/rsv_read_reservationRoomOwnershipType","description":"Provides the information of the assigned reservation room is an Owner/Referral or Regular room.This value is returned when Room Rotation OPERA Control is active and room number is assigned to a reservation."},"roomType":{"description":"Current room type.","maxLength":20,"minLength":0,"type":"string"},"roomViewCode":{"description":"Represents the room view code like City view, River view, Ocean view etc.","maxLength":40,"minLength":0,"type":"string"},"suggestedRoomNumbers":{"$ref":"#/components/schemas/rsv_read_codeListType","description":"Suggested room numbers."},"upgradedByAI":{"description":"Represents the room was upgraded by AI Room Assignment.","type":"boolean"}},"type":"object"},"rsv_read_customChargeExemptionDateType":{"description":"Contains Custom Charge Exemption information for a day.","properties":{"date":{"description":"Contains Custom Charge Exemption date.","format":"date","type":"string"},"guests":{"description":"List of guests.","items":{"$ref":"#/components/schemas/rsv_read_customChargeGuestInfoType"},"type":"array"},"quantity":{"description":"Contains number of Custom Charge Exemption for a day.","type":"integer"}},"type":"object"},"rsv_read_customChargeExemptionDatesType":{"description":"Contains List of Custom Charge Exemption information for a day.","items":{"$ref":"#/components/schemas/rsv_read_customChargeExemptionDateType"},"maxItems":4000,"type":"array"},"rsv_read_customChargeExemptionType":{"description":"Contains custom charges exemption information.","properties":{"customChargeDates":{"$ref":"#/components/schemas/rsv_read_customChargeExemptionDatesType","description":"Contains exemption detail information for each date."},"customChargeQuantity":{"$ref":"#/components/schemas/rsv_read_customChargeQuantityType","description":"Contains exemption quantity for the stay. When this value is configured, daily exemption quantities are not permitted."},"customChargesExemption":{"$ref":"#/components/schemas/rsv_read_codeDescriptionType","description":"Contains exemption code and description."},"excludedDates":{"$ref":"#/components/schemas/rsv_read_excludedDatesType","description":"Contains list of dates which are not valid for custom charge exemptions."},"percentage":{"description":"Exemption Percentage","maximum":100,"minimum":0,"type":"number"},"propertyExemption":{"description":"Flag specifying if custom charge exemptions is property level or not.","type":"boolean"}},"type":"object"},"rsv_read_customChargeExemptionsType":{"description":"List of Custom Charge Exemptions.","items":{"$ref":"#/components/schemas/rsv_read_customChargeExemptionType"},"maxItems":4000,"type":"array"},"rsv_read_customChargeGuestInfoType":{"properties":{"firstName":{"description":"Given name, first name or names","type":"string"},"fullName":{"description":"String representation of the full name","type":"string"},"lastName":{"description":"Family name, last name.","type":"string"},"profileId":{"$ref":"#/components/schemas/rsv_read_profileId","description":"Unique profile identifier."}},"type":"object"},"rsv_read_customChargeQuantityType":{"description":"Contains quantity of custom charge exemptions.","properties":{"available":{"description":"Indicates if Custom Charges Exemption information is editable.","type":"boolean"},"guests":{"description":"List of guests.","items":{"$ref":"#/components/schemas/rsv_read_customChargeGuestInfoType"},"type":"array"},"quantity":{"description":"Contains number of Custom Charge Exemption for a day.","type":"integer"}},"type":"object"},"rsv_read_customerType":{"description":"Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.","properties":{"anonymization":{"$ref":"#/components/schemas/rsv_read_anonymizationType","description":"Provides information about the guest's anonymization status"},"birthDate":{"description":"Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.","format":"date","type":"string"},"birthDateMasked":{"description":"Indicates the date of birth as masked.","type":"string"},"birthPlace":{"description":"Place of birth.","maxLength":80,"minLength":0,"type":"string"},"blacklist":{"description":"This element tells if profile is blacklisted or not.","type":"boolean"},"creditRating":{"description":"Credit Rating of the customer.","maxLength":20,"minLength":0,"type":"string"},"customerValue":{"description":"The supplier's ranking of the customer (e.g., VIP, numerical ranking).","maxLength":20,"minLength":0,"type":"string"},"gender":{"description":"Identifies the profile gender code selected from Gender types List of values. Gender types LOV provides the values configured at gender configuration.","maxLength":20,"minLength":0,"type":"string"},"identifications":{"description":"List of identification of the customer.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"identificationInfo":{"description":"Collection of detailed information on the identification of the customer.","items":{"$ref":"#/components/schemas/rsv_read_identificationInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"nationality":{"description":"Nationality code identification","maxLength":20,"minLength":0,"type":"string"},"nationalityDescription":{"description":"Nationality code description","maxLength":80,"minLength":0,"type":"string"},"personName":{"description":"Detailed name information for the customer.","items":{"$ref":"#/components/schemas/rsv_read_personNameType"},"maxItems":5,"type":"array"},"privateProfile":{"description":"This element tells profile is property exclusive or not.","type":"boolean"},"vipDescription":{"description":"Description of the VIP status.","maxLength":2000,"minLength":0,"type":"string"},"vipStatus":{"description":"VIP status of the customer.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_dateRangeType":{"description":"Date Range with Start and End dates.","properties":{"end":{"description":"The ending value of the date range.","format":"date","type":"string"},"start":{"description":"The starting value of the date range.","format":"date","type":"string"}},"type":"object"},"rsv_read_dateTimeSpanType":{"description":"Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.","properties":{"endDateTime":{"description":"Uses the hotel's time zone.","format":"date-time","type":"string"},"startDateTime":{"description":"Uses the hotel's time zone.","format":"date-time","type":"string"}},"type":"object"},"rsv_read_dateTimeStampGroupType":{"properties":{"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","type":"string"}},"type":"object"},"rsv_read_dateUDFType":{"description":"Used to hold user defined field of Date Type.","properties":{"alternateName":{"description":"Label of user defined field used by vendors or customers.","maxLength":2000,"minLength":0,"type":"string"},"name":{"description":"Used to hold user defined field of Date Type. It is highly recommended to use UDFD01, UDFD02,...UDFN20 (Total 20) as Date UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Value of user defined field.","format":"date","type":"string"}},"type":"object"},"rsv_read_dateUDFsType":{"description":"Used to hold collection of user defined fields of Date Type.","items":{"$ref":"#/components/schemas/rsv_read_dateUDFType"},"maxItems":4000,"type":"array"},"rsv_read_deliveryHistoryLog":{"description":"Response that contains fetched reservation's delivery history.","properties":{"deliveryHistoryLog":{"description":"Delivery History Information.","items":{"$ref":"#/components/schemas/rsv_read_deliveryHistoryType"},"type":"array"},"links":{"$ref":"#/components/schemas/rsv_read_links"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_deliveryHistoryType":{"properties":{"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"deliveryDate":{"description":"Delivery Date.","format":"date","type":"string"},"deliveryId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Reservation Delivery ID"},"deliveryMethod":{"$ref":"#/components/schemas/rsv_read_deliveryMethodType","description":"Reservation Delivery Method"},"deliveryStatus":{"$ref":"#/components/schemas/rsv_read_statusType","description":"Reservation Delivery status"},"errorDescription":{"description":"The error Description Of Reservation Delivery status","maxLength":4000,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel Code.","maxLength":20,"minLength":0,"type":"string"},"interfaceId":{"description":"Interface Id.","maxLength":20,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","type":"string"},"resvNameId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Reservation ID for which the Delivery History belongs."},"retryCount":{"description":"Retry Count","type":"integer"}},"type":"object"},"rsv_read_deliveryMethodType":{"description":"PRINT","enum":["Msmq","Http","Fax","Email","Print"],"type":"string"},"rsv_read_departureReservationInfoType":{"description":"Key information about the departure reservation.","properties":{"reservationExpectedDepartureTime":{"description":"The departure Reservation Expected Departure Time. Uses the hotel's time zone.","format":"date-time","type":"string"},"reservationStatus":{"$ref":"#/components/schemas/rsv_read_pMS_ResStatusType","description":"Indicates the Actual status of the departure reservation."}},"type":"object"},"rsv_read_depositCancelRevenueType":{"description":"The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.","enum":["Rooms","Catering","All"],"type":"string"},"rsv_read_depositPaymentType":{"description":"Request to post a deposit payment to a reservation.","properties":{"criteria":{"$ref":"#/components/schemas/rsv_read_reservationDepositPaymentCriteriaType","description":"Criteria for the deposit payment information to be posted."}},"type":"object"},"rsv_read_depositPolicyType":{"description":"Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.","properties":{"amountPercent":{"$ref":"#/components/schemas/rsv_read_policyAmountPercentType","description":"Payment expressed as a fixed amount, or a percentage of/or room nights."},"deadline":{"$ref":"#/components/schemas/rsv_read_policyDeadlineType","description":"Payment deadline, absolute or relative."},"depositReceiptNo":{"description":"Receipt number associated with the deposit policy","type":"integer"},"depositReqReversed":{"description":"Flag to indicate if deposit policy is reversed","type":"boolean"},"description":{"description":"Text description of the Payment in a given language.","maxLength":2000,"minLength":0,"type":"string"},"formattedRule":{"description":"Formatted Text Rule of the deposit policy.","maxLength":2000,"minLength":0,"type":"string"},"manual":{"description":"Flag to indicate if the cancellation policy is manual.","type":"boolean"},"policyCode":{"description":"Deposit Policy Code","maxLength":20,"minLength":0,"type":"string"},"transactionDate":{"description":"Transaction Date associated with the deposit policy","format":"date","type":"string"},"typeOfCharges":{"$ref":"#/components/schemas/rsv_read_depositCancelRevenueType","description":"Defines if the deposit amount is calculated based on Room Charges, Catering Charges or both"}},"type":"object"},"rsv_read_discountType":{"description":"Identifies and provides details about the discount. This allows for both percentages and flat amounts. If one field is used, the other should be zero/not specified since logically.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"},"discountCode":{"description":"Specifies the type of discount (e.g., No condition, LOS, Deposit or Total amount spent).","maxLength":20,"minLength":0,"type":"string"},"discountReason":{"maxLength":2000,"minLength":0,"type":"string"},"percent":{"description":"Percentage discount.","type":"number"}},"type":"object"},"rsv_read_distinctIDType":{"description":"Unique identifiers for both internal and external systems Eg: ReservationId, ConfirmationNumber, CancellationNumber, ExternalReferenceNumber etc","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":32000,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system. Eg: ConfirmationLegNumber, ExternalLegNumber","type":"integer"},"type":{"description":"A reference to the type of object defined by the UniqueID element. Eg: Reservation, Confirmation, Cancellation, ExternalReference etc","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_downgradeType":{"description":"Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace.","enum":["Grace","Never","Period"],"type":"string"},"rsv_read_eCertificateClassficationType":{"description":"Enumeration of the different type of Ecertificate.","enum":["Promotion","Award","Benefit","Other"],"type":"string"},"rsv_read_eCertificateConsumeSourceType":{"description":"Indicates that OPERA E-Certificate is consumed by hotelPMS.","enum":["Central","Web","Hotel"],"type":"string"},"rsv_read_eCertificateConsumptionType":{"description":"E-Certificates details.","properties":{"date":{"description":"Date the certificate was consumed.","format":"date","type":"string"},"email":{"description":"Email of the person who consumed the certificate.","maxLength":2000,"minLength":0,"type":"string"},"firstName":{"description":"First name of the person who consumed the certificate.","maxLength":40,"minLength":0,"type":"string"},"hotelId":{"description":"Property where certificate was consumed for.","maxLength":20,"minLength":0,"type":"string"},"middleName":{"description":"Middle name of the person who consumed the certificate.","maxLength":40,"minLength":0,"type":"string"},"referenceId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Any reference like reservation no etc against which the certificate was consumed."},"source":{"$ref":"#/components/schemas/rsv_read_eCertificateConsumeSourceType","description":"Source of consumption."},"surname":{"description":"Last name of the person who consumed the certificate..","maxLength":40,"minLength":0,"type":"string"},"userName":{"description":"Application user who created the consumption.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_eCertificateInfoType":{"description":"E-Certificates details.","properties":{"awardCode":{"description":"Award type to which the certificate is linked to.","maxLength":20,"minLength":0,"type":"string"},"benefitSummary":{"description":"Summary of Benefits attached to this ECertificate.","maxLength":4000,"minLength":0,"type":"string"},"certificateType":{"description":"User defined certificate code.","maxLength":20,"minLength":0,"type":"string"},"cost":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Cost of certificate."},"description":{"description":"Description about the certificate.","maxLength":200,"minLength":0,"type":"string"},"hotels":{"description":"Hotel to which certificate is attached to.","properties":{"code":{"items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"scope":{"$ref":"#/components/schemas/rsv_read_eCertificateScopeType","description":"Scope of e-cert: global,single property or multi property."}},"type":"object"},"label":{"description":"Label for the certificate.","maxLength":40,"minLength":0,"type":"string"},"longDescription":{"description":"Detail description about the certificate.","maxLength":4000,"minLength":0,"type":"string"},"membershipType":{"description":"Membership type to which the certificate is linked to.","maxLength":20,"minLength":0,"type":"string"},"promotionCode":{"description":"Promotion code to which certificate is attached to.","maxLength":20,"minLength":0,"type":"string"},"value":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Value of the certificate for the guest."},"voucherBenefitCode":{"description":"Voucher benefit code attached to the certificate.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_eCertificateIssueSourceType":{"description":"Indicates that OPERA E-Certificate is issued by external system.","enum":["Opera","Web","Interface"],"type":"string"},"rsv_read_eCertificateScopeType":{"description":"Indicates that OPERA E-Certificate is available for a specific list of hotels.","enum":["Global","Hotel","MultiHotel"],"type":"string"},"rsv_read_eCertificateStatusType":{"description":"Indicates that OPERA E-Certificate is reserved.","enum":["Cancelled","Consumed","Deleted","Expired","Issued","Reserved"],"type":"string"},"rsv_read_eCertificateType":{"description":"E-Certificates details.","properties":{"certificateNo":{"description":"Printed certificate no. This has to be unique.","maxLength":40,"minLength":0,"type":"string"},"consumptionDetail":{"$ref":"#/components/schemas/rsv_read_eCertificateConsumptionType"},"eCertificateInfo":{"$ref":"#/components/schemas/rsv_read_eCertificateInfoType"},"expiryDate":{"description":"Date of expiry.","format":"date","type":"string"},"issueDate":{"description":"Date when certificate was issued.","format":"date","type":"string"},"printed":{"description":"Print status of the certificate.","type":"boolean"},"profileId":{"$ref":"#/components/schemas/rsv_read_profileId","description":"NameId."},"source":{"$ref":"#/components/schemas/rsv_read_eCertificateIssueSourceType","description":"Source of e-certificate."},"status":{"$ref":"#/components/schemas/rsv_read_eCertificateStatusType","description":"Status of the certificate."},"voucherNo":{"description":"System generated unique voucher number.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_eCertificatesType":{"description":"List of e-certificates for the profile.","items":{"$ref":"#/components/schemas/rsv_read_eCertificateType"},"maxItems":4000,"type":"array"},"rsv_read_eCouponType":{"description":"Reservation eCoupon Type Information.","properties":{"autoAttached":{"description":"Determines whether the eCoupon is attached through the Rate Code or not.","type":"boolean"},"code":{"description":"Code to attach the eCoupon to Reservation.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Description of the eCoupon attached to the Reservation.","maxLength":2000,"minLength":0,"type":"string"},"eCouponId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"ECouponID to attach the eCoupon to Reservation."},"issuedQuantity":{"description":"Assigned Quantity for the eCoupon when attached to Reservation.","type":"integer"},"ratePlanCode":{"description":"Rate plan of the attached eCoupon to Reservation.","maxLength":20,"minLength":0,"type":"string"},"reason":{"description":"Reason for attaching/modifing eCoupon.","maxLength":4000,"minLength":0,"type":"string"},"usedQuantity":{"description":"Used Quantity of the eCoupon for the Reservation.","type":"integer"},"welcomeOffer":{"description":"Determines whether this eCoupon is eligible for welcome offer or not.","type":"boolean"}},"type":"object"},"rsv_read_eCoupons":{"description":"Response object for fetching the eCoupons attached to Reservation.","properties":{"eCoupons":{"$ref":"#/components/schemas/rsv_read_eCouponsType"},"links":{"$ref":"#/components/schemas/rsv_read_links"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_eCouponsType":{"description":"Collection of ECouponType object.","items":{"$ref":"#/components/schemas/rsv_read_eCouponType"},"maxItems":4000,"type":"array"},"rsv_read_emailInfoType":{"description":"Information on an email for the customer.","properties":{"email":{"$ref":"#/components/schemas/rsv_read_emailType","description":"eMail deatils for the profile."},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_emailType":{"description":"Information on an email for the customer.","properties":{"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"emailAddress":{"description":"Defines the e-mail address.","maxLength":2000,"minLength":0,"type":"string"},"emailFormat":{"description":"Supported Email format.","enum":["Html","Text"],"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"},"type":{"description":"Defines the purpose of the e-mail address (e.g. personal, business, listserve).","maxLength":20,"minLength":0,"type":"string"},"typeDescription":{"description":"Describes the Type code","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_employeeInfoType":{"properties":{"addressInfo":{"$ref":"#/components/schemas/rsv_read_addressInfoType"},"birthDate":{"description":"Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.","format":"date","type":"string"},"birthDateMasked":{"description":"Indicates the date of birth as masked.","type":"string"},"department":{"$ref":"#/components/schemas/rsv_read_codeDescriptionType"},"emailInfo":{"$ref":"#/components/schemas/rsv_read_emailInfoType"},"gender":{"description":"Identifies the profile gender code selected from Gender types List of values. Gender types LOV provides the values configured at gender configuration.","maxLength":20,"minLength":0,"type":"string"},"personName":{"$ref":"#/components/schemas/rsv_read_personNameType"},"phoneInfo":{"$ref":"#/components/schemas/rsv_read_telephoneInfoType"},"profileId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type"}},"type":"object"},"rsv_read_entityType":{"description":"Indicates the rule is based on Minutes associated with the charge.","enum":["ThresholdCount","ThresholdQuantity","ThresholdMinutes"],"type":"string"},"rsv_read_eventId":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"rsv_read_excludedDateType":{"description":"Specifies all the enabled dates.","properties":{"date":{"description":"Contains exclusion date.","format":"date","type":"string"},"reason":{"$ref":"#/components/schemas/rsv_read_exclusionReasonType","description":"Contains reason for exclusion."}},"type":"object"},"rsv_read_excludedDatesType":{"description":"Contains list of dates which are valid for custom charge exemptions.","items":{"$ref":"#/components/schemas/rsv_read_excludedDateType"},"maxItems":4000,"type":"array"},"rsv_read_exclusionReasonType":{"description":"Custom Charge has already been Processed for this date within the reservation stay.","enum":["NotConfigured","CustomChargeProcessed"],"type":"string"},"rsv_read_externalReferenceType":{"description":"This type contains unique information of external reference.","properties":{"id":{"description":"Unique ID of external reference.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"ID context for external reference.","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system for the external reference number. It is only applicable to reservation external references.","type":"integer"}},"type":"object"},"rsv_read_externalReferencesType":{"description":"This type contains unique information of external reference.","items":{"$ref":"#/components/schemas/rsv_read_externalReferenceType"},"maxItems":4000,"type":"array"},"rsv_read_fetchActivityBookingsType":{"description":"Used in the request message to describe the \"filtering Criteria\" when executing an activity lookup.","properties":{"activities":{"$ref":"#/components/schemas/rsv_read_activityList","description":"The specific activity information to be used for filtering the Look-up."},"address":{"$ref":"#/components/schemas/rsv_read_addressType","description":"Detailed Address information for the customer."},"hotelId":{"description":"Hotel Code, It is used to filter hotel specific children to this specific hotel code.","maxLength":20,"minLength":0,"type":"string"},"personName":{"$ref":"#/components/schemas/rsv_read_personNameType","description":"Detailed name information for the customer."},"profileId":{"$ref":"#/components/schemas/rsv_read_uniqueIDListType","description":"ProfileID associated with the Activity under lookup."}},"type":"object"},"rsv_read_fetchReservations":{"properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"masterInfoList":{"description":"Refer to Generic common types document.","items":{"$ref":"#/components/schemas/rsv_read_masterInfoType"},"type":"array"},"reservationInfoList":{"description":"List of reservations which can be shared.","properties":{"reservationInfo":{"description":"Information of the reservation which can be shared.","items":{"$ref":"#/components/schemas/rsv_read_reservationInfoType"},"type":"array"}},"type":"object"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_fetchSellMessageConfig":{"description":"This is the fetch response message type for fetch operation of sell messages.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"sellMessageConfigs":{"description":"Sell Messages which are retrieved as per the criteria in the request message. Refer to the generic common types document for the SellMessagesType.","properties":{"sellMessageConfigs":{"$ref":"#/components/schemas/rsv_read_sellMessageConfigsType","description":"Sell Messages which are retrieved as per the criteria in the request message. Refer to the generic common types document for the SellMessagesType."},"totalPages":{"description":"Evaluated total page count based on the requested max fetch count.","type":"integer"}},"type":"object"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_fiscalInfoType":{"description":"Fiscal related information for a reservation.","properties":{"fiscalPayloadType":{"$ref":"#/components/schemas/rsv_read_payloadType","description":"Fiscal Payload Type."},"fiscalStatus":{"description":"OPERA Fiscal status.","type":"string"},"partnerCode":{"description":"Fiscal partner code.","type":"string"}},"type":"object"},"rsv_read_fixedChargeDetailType":{"description":"Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.","properties":{"article":{"$ref":"#/components/schemas/rsv_read_codeDescriptionType","description":"Holds related article code and description."},"chargeAmount":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Price of the product."},"percent":{"description":"Percentage of the rate amount.","maximum":100,"minimum":0,"type":"number"},"quantity":{"description":"Quantity of the product.","type":"integer"},"roomNights":{"description":"Holds number of comp or cash room night to allocate.","type":"integer"},"supplement":{"description":"Additional information regarding the fixed charge.","maxLength":2000,"minLength":0,"type":"string"},"transaction":{"$ref":"#/components/schemas/rsv_read_codeDescriptionType","description":"Transaction code and description of a fixed charge."}},"type":"object"},"rsv_read_fixedChargeFrequencyType":{"description":"Yearly.","enum":["O","D","W","M","Q","Y"],"type":"string"},"rsv_read_fixedChargeScheduleType":{"description":"Holds schedule of fixed charge.","properties":{"dateToExecute":{"description":"Date of when to execute yearly fixed charge. Applicable when frequency is Yearly.","format":"date","type":"string"},"dayToExecute":{"description":"Day of when to execute fixed charge. Applicable when frequency is Daily or Weekly.","maxLength":3,"minLength":0,"type":"string"},"end":{"description":"The ending value of the date range.","format":"date","type":"string"},"frequency":{"$ref":"#/components/schemas/rsv_read_fixedChargeFrequencyType","description":"Frequency of a fixed charge."},"start":{"description":"The starting value of the date range.","format":"date","type":"string"}},"type":"object"},"rsv_read_fixedChargeType":{"description":"Holds fixed charge information.","properties":{"charge":{"$ref":"#/components/schemas/rsv_read_fixedChargeDetailType","description":"Holds specific details of fixed charge."},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"schedule":{"$ref":"#/components/schemas/rsv_read_fixedChargeScheduleType","description":"Holds schedule of fixed charge."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"rsv_read_fixedChargesType":{"description":"Holds fixed charge detail.","items":{"$ref":"#/components/schemas/rsv_read_fixedChargeType"},"maxItems":4000,"type":"array"},"rsv_read_flexFieldValueType":{"description":"Provides the details of a flex field values","properties":{"code":{"description":"Flex field code","maxLength":20,"minLength":0,"type":"string"},"flexFieldValue":{"description":"value of the Dynamic Field ","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_flexFieldsResponse":{"description":"Response object for flex fields.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"flexFieldValues":{"description":"List of flex fields.","items":{"$ref":"#/components/schemas/rsv_read_flexFieldValueType"},"maxItems":100,"type":"array"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response","type":"boolean"},"limit":{"description":"Indicates maximum number of records a Web Service should return","type":"integer"},"links":{"$ref":"#/components/schemas/rsv_read_links"},"offset":{"description":"Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned","type":"integer"},"totalPages":{"description":"Evaluated total page count based on the requested max fetch count","type":"integer"},"totalResults":{"description":"Total number of rows queried","type":"integer"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_folioShortInfoType":{"description":"This type contains information of generated bills.","properties":{"autoGenerated":{"description":"Flag to indicate if the folio is auto generated or not.","type":"boolean"},"folioNo":{"description":"Folio No of the bill generated.","type":"number"},"folioType":{"description":"Folio type of the bill generated.","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_folioTextsType":{"description":"This stores the description for the type of tax calculation especially with tax exemption, etc.","items":{"properties":{"row":{"description":"Row number of the additional text.","type":"integer"},"text":{"description":"Additional text field to display on the folio.","maxLength":50,"minLength":0,"type":"string"}},"type":"object"},"maxItems":2,"type":"array"},"rsv_read_foliosShortInfoType":{"description":"This type contains a list of generated bills for a reservation.","items":{"$ref":"#/components/schemas/rsv_read_folioShortInfoType"},"maxItems":4000,"type":"array"},"rsv_read_formattedTextTextType":{"description":"Provides text and indicates whether it is formatted or not.","properties":{"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"rsv_read_frontOfficeRoomStatusType":{"description":"Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.","enum":["Vacant","Occupied"],"type":"string"},"rsv_read_futureListType":{"description":"A collection of reservation history details attached to Profiles.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"reservationInfo":{"description":"Additional reservation information attached to the profile . Eg : Future reservation details","items":{"$ref":"#/components/schemas/rsv_read_reservationInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"rsv_read_givenNameType":{"description":"Given name, first name or names","maxLength":40,"minLength":0,"type":"string"},"rsv_read_groupDetails":{"description":"Group Details","properties":{"groupID":{"description":"ID of the group for the reservation.","maxLength":20,"minLength":0,"type":"string"},"groupName":{"description":"Name of the group for the reservation.","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_guestCountsType":{"description":"A collection of GuestCount by age group.","properties":{"adults":{"description":"Defines the number of Adults.","type":"integer"},"childAges":{"$ref":"#/components/schemas/rsv_read_childAgesType","description":"Defines Children's Ages. Number of children ages mentioned may mot match with children counts."},"childBuckets":{"$ref":"#/components/schemas/rsv_read_childBucketsType","description":"Defines children counts with Age Qualifying Group(Child Bucket#1) classification."},"children":{"description":"Defines the number of Children.","type":"integer"}},"type":"object"},"rsv_read_guestDetails":{"description":"Guest Details","properties":{"alternateFirstName":{"description":"Alternate first name.","maxLength":80,"minLength":0,"type":"string"},"alternateLastName":{"description":"Alternate last name.","maxLength":80,"minLength":0,"type":"string"},"alternateSalutation":{"description":"Alternate salutation.","maxLength":60,"minLength":0,"type":"string"},"emailAddress":{"description":"Email address of the Guest.","maxLength":200,"minLength":0,"type":"string"},"firstName":{"description":"Reservation first name.","maxLength":80,"minLength":0,"type":"string"},"guestNameId":{"description":"ID of the guest.","maxLength":20,"minLength":0,"type":"string"},"guestTitle":{"description":"Guest title.","maxLength":40,"minLength":0,"type":"string"},"lastName":{"description":"Reservation last name.","maxLength":80,"minLength":0,"type":"string"},"phoneNumber":{"description":"Phone number of the Guest.","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_guestHousekeepingServiceRequestType":{"description":"Possible values for the Guest Service Status.","enum":["DoNotDisturb","MakeUpRoom","NoStatusSelected","ServiceDeclined"],"type":"string"},"rsv_read_guestLastStayInfoType":{"description":"Contains last stay related details of the guest.","properties":{"lastStayDate":{"description":"Guest's last stay date.","format":"date","type":"string"},"lastStayRate":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"The Rate amount of the guest's last stay."},"lastStayRoom":{"description":"Room Number where the guest stayed.","maxLength":20,"minLength":0,"type":"string"},"totalStay":{"description":"The total number of previous stay of the guest.","type":"integer"}},"type":"object"},"rsv_read_guestMessageType":{"description":"Holds the Message information for a Reservation","properties":{"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"delivery":{"$ref":"#/components/schemas/rsv_read_messageDeliveryType","description":"Holds the Delivery Method Information"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"message":{"$ref":"#/components/schemas/rsv_read_messageType","description":"Holds the Message Information"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"rsv_read_guestMessages":{"description":"Response object to the request to retrieve Guest Messages for a Reservation.","properties":{"guestMessages":{"$ref":"#/components/schemas/rsv_read_resvGuestMessagesType","description":"List of Guest Messages in for the requested Reservation. Refer to Generic common types document."},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"limit":{"description":"Indicates maximum number of records a Web Service should return.","type":"integer"},"links":{"$ref":"#/components/schemas/rsv_read_links"},"offset":{"description":"Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.","type":"integer"},"totalPages":{"description":"Evaluated total page count based on the requested max fetch count.","type":"integer"},"totalResults":{"description":"Total number of rows queried","type":"integer"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_guestMessagesType":{"description":"Holds the Message Information","items":{"$ref":"#/components/schemas/rsv_read_guestMessageType"},"maxItems":4000,"type":"array"},"rsv_read_historyListType":{"description":"A collection of reservation history details attached to Profiles.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"reservationInfo":{"description":"Additional reservation information attached to the profile . Eg : History reservation details","items":{"$ref":"#/components/schemas/rsv_read_reservationInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"rsv_read_hotelReservationTraceType":{"description":"Extended Trace object to hold information for a reservation.","properties":{"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"departmentId":{"description":"Indicates the Department code.","maxLength":20,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","type":"string"},"reservationId":{"$ref":"#/components/schemas/rsv_read_reservationId","description":"Reservation ID of the reservation for which the traces are to be retrieved."},"resolveInfo":{"$ref":"#/components/schemas/rsv_read_traceResolveType","description":"Information regarding the status of the trace"},"timeInfo":{"$ref":"#/components/schemas/rsv_read_traceTimeInfoType","description":"Date of the trace."},"traceFrequency":{"$ref":"#/components/schemas/rsv_read_traceFrequencyType","description":"Information regarding the trace frequency"},"traceText":{"description":"The information this trace contains.","type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"updateFrequencyTraces":{"description":"When set as true all associated traces based on the defined trace frequency will also be updated. This is applicable when the trace frequency is set to EveryXNightsStartingNightY, CertainNightsOfTheWeek, or EveryNight","type":"boolean"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"rsv_read_hotelReservationTracesType":{"description":"List of Reservation Traces.","items":{"$ref":"#/components/schemas/rsv_read_hotelReservationTraceType"},"maxItems":4000,"type":"array"},"rsv_read_hotelReservationType":{"description":"The Reservation class contains the current reservation being created or altered.","properties":{"accessRestriction":{"$ref":"#/components/schemas/rsv_read_resAccessRestrictionType","description":"Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both."},"accessRestrictionMessage":{"description":"Configurable Access Restriction Message for Excluded Block or Rate Code.","maxLength":4000,"minLength":0,"type":"string"},"additionalGuestInfo":{"$ref":"#/components/schemas/rsv_read_resGuestAdditionalInfoType","description":"Entry Date into the country. (Croatian Requirements)."},"advanceCheckIn":{"$ref":"#/components/schemas/rsv_read_advanceCheckInType","description":"Information relating to Reservation's Advance Checked In state and Expected Time of Return"},"alerts":{"$ref":"#/components/schemas/rsv_read_alertsType","description":"List of reservation alerts."},"allowAutoCheckin":{"description":"Flag to allow auto checkin","type":"boolean"},"allowMobileCheckout":{"description":"Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false.","type":"boolean"},"allowMobileViewFolio":{"description":"Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.","type":"boolean"},"allowPreRegistration":{"description":"Flag containing true or false value for reservation to be eligible for prior check in by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile check in yes / no. Upon fetch, the current state of the flag will show true or false.","type":"boolean"},"allowedActions":{"$ref":"#/components/schemas/rsv_read_reservationAllowedActionsType","description":"Collection of allowed actions for the reservation."},"attachments":{"$ref":"#/components/schemas/rsv_read_attachmentsType","description":"Collection of attachments available for that reservation"},"autoBorrowFromHouse":{"description":"This flag will force to borrow from house if borrow required for number of rooms requested, this will only applicable when reservation is attached to a Block.","type":"boolean"},"backToBack":{"description":"This attribute indicates if the linked reservation is marked as Back to Back or not.","type":"boolean"},"backToBackGroupId":{"description":"This attribute represents a common identifier for a subgroup of linked reservations marked as Back to Back in a group of linked reservations.","maxLength":80,"minLength":0,"type":"string"},"backToBackSequence":{"$ref":"#/components/schemas/rsv_read_backToBackResSequenceType","description":"This attribute represents Back To Back Sequence of Linked Reservations(e.g. '1 of 2' i.e, 1 indicates Sequence Position of total count 2). This is applicable when OPERA control Back to Back Handling for Linked Reservations is active."},"callHistory":{"$ref":"#/components/schemas/rsv_read_callHistoryType","description":"List of reservation calls."},"cancellation":{"description":"Information regarding why reservation has been/was cancelled. This could hold information as history even if reservation is no more in in Cancelled status.","properties":{"cancellationNo":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Cancellation Number given when reservation was last cancelled."},"code":{"maxLength":20,"minLength":0,"type":"string"},"date":{"description":"Date when reservation was last cancelled.","format":"date","type":"string"},"description":{"maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"cashiering":{"$ref":"#/components/schemas/rsv_read_resCashieringType","description":"Holds cashiering related information for the reservation."},"catering":{"$ref":"#/components/schemas/rsv_read_cateringResInfoType","description":"Catering event information if reservation is associated with the catering event."},"chargeCardNumber":{"description":"This attribute represents Hotel charge card number. This number is generated automatically in OPERA when a reservation is created in OPERA. It is part of a functionality that provide the guest with the convenience of placing all their charges directly on their reservation folio.","maxLength":100,"minLength":0,"type":"string"},"checkInInitiatedBy":{"description":"This indicates who initiated the Check In/Advance Check In.Advance Check In functionality is available when the Advance Check In OPERA Control is active.","maxLength":40,"minLength":0,"type":"string"},"comments":{"description":"List of Notes for the Guest related to the reservation.","items":{"$ref":"#/components/schemas/rsv_read_commentInfoType"},"maxItems":4000,"type":"array"},"compAuthorizer":{"$ref":"#/components/schemas/rsv_read_compAuthorizerInfoType","description":"Reservation Comp Authorizer."},"computedReservationStatus":{"$ref":"#/components/schemas/rsv_read_pMS_ResStatusType","description":"Indicates the Computed status of the reservation."},"confirmationLetters":{"$ref":"#/components/schemas/rsv_read_confirmationsType","description":"List of reservation confirmation letters."},"createBusinessDate":{"description":"Business Date when the reservation was created.","format":"date","type":"string"},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"customChargeExemptionDetails":{"$ref":"#/components/schemas/rsv_read_customChargeExemptionsType","description":"List of Custom Charge Exemptions attached to the reservation."},"customNameValueDetail":{"$ref":"#/components/schemas/rsv_read_nameValueDetailType","description":"List of Custom Name Value Information attached to the reservation."},"customReference":{"description":"Custom Reference to identify reservation.","maxLength":50,"minLength":0,"type":"string"},"depositPayment":{"$ref":"#/components/schemas/rsv_read_depositPaymentType","description":"Request to post a deposit payment to a reservation."},"displayColor":{"description":"The color to display this reservation on room grid displays.","maxLength":20,"minLength":0,"type":"string"},"displayColorDetails":{"$ref":"#/components/schemas/rsv_read_reservationDisplayColorInfoType","description":"Information of reservation display color, determined based on OPERA parameter RESERVATION_COLOR_DEFINITION "},"eCertificates":{"$ref":"#/components/schemas/rsv_read_reservationECertificatesType","description":"List of ECertificates attached to the reservation."},"eCoupons":{"$ref":"#/components/schemas/rsv_read_eCouponsType","description":"List of eCoupons."},"extSystemSync":{"type":"boolean"},"externalReferences":{"$ref":"#/components/schemas/rsv_read_externalReferencesType","description":"External Reference information for Reservation. Please note, for id and idContext elements within externalReferences for the reservation the following maximum character limits are applicable: 50 maximum characters for id and 20 maximum characters for idContext."},"fixedCharges":{"$ref":"#/components/schemas/rsv_read_fixedChargesType","description":"List of reservation fixed charges."},"folios":{"$ref":"#/components/schemas/rsv_read_foliosShortInfoType","description":"This element returns any automatically generated folios during check-in, based on the Fetch Instruction \"AutoFolios\". When the parameter \"Auto Generate Credit Bill for Deposit upon Check In\" is enabled, during check-in credit bills are automatically generated for the deposits. The generated credit bill details are returned so that user can preview/print the folio. For some countries like Portugal, it is mandatory to print the folio and hence this information is needed"},"guestComments":{"description":"List of Notes for the Guest related to the profile.","items":{"$ref":"#/components/schemas/rsv_read_commentInfoType"},"maxItems":4000,"type":"array"},"guestMemberships":{"description":"List of Memberships for the Guest related to the reservation.","items":{"$ref":"#/components/schemas/rsv_read_membershipType"},"maxItems":4000,"type":"array"},"guestMessages":{"$ref":"#/components/schemas/rsv_read_guestMessagesType","description":"List of Messages."},"hasOpenFolio":{"type":"boolean"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"housekeeping":{"$ref":"#/components/schemas/rsv_read_resHousekeepingType","description":"Holds rooms housekeeping information."},"inventoryItems":{"$ref":"#/components/schemas/rsv_read_resInventoryItemsType","description":"A collection of inventory items attached to a reservation."},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"linkedReservation":{"$ref":"#/components/schemas/rsv_read_linkedReservationsInfoType","description":"Reservations related to the current Reservation."},"locators":{"$ref":"#/components/schemas/rsv_read_reservationLocatorsType","description":"Collection of Locators available for that reservation"},"lockHandle":{"description":"An id representing the record lock for this reservation. When passed, update operation will verify that this lock is still valid.","type":"number"},"markAsRecentlyAccessed":{"description":"Mark this reservation as recently accessed.","type":"boolean"},"optedForCommunication":{"description":"Flag containing true or false value to determine if the guest has opted for communications pertaining to this reservation.Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is marked for communication. Upon fetch, the current state of the flag will show true or false.","type":"boolean"},"overrideBlockRestriction":{"description":"Indicates whether the block restrictions should be overriden when creating a new block reservation.","type":"boolean"},"overrideExternalChecks":{"description":"Forcefully override the create/update action on the Reservation. For real-time CRS interfaces, this element is used as force selling indicator in case of Create or Update Reservation","type":"boolean"},"overrideExternallyExcludedPkgRestrictions":{"description":"When enabled (true), packages managed by external systems can be added, removed, or updated on a reservation. When disabled or not specified (default is false), such packages cannot be added, removed, or updated.","type":"boolean"},"overrideInstructions":{"$ref":"#/components/schemas/rsv_read_overrideInstructionsType","description":"List of overrides done for the reservation."},"overrideInventoryCheck":{"description":"Indicates to Override the Room Inventory Check if applicable.","type":"boolean"},"overrideOutOfServiceCheck":{"description":"Indicates to Override the Room Out Of Service Check if applicable.","type":"boolean"},"overrideRoomFeatures":{"description":"This flag indicates true/false. When this is true, it will allow to override the room feature preference validation while assigning rooms. The Reservation Room Features OPERA Control will determine which room feature preferences will be validated. When Reservation Room Features is on, the validation will be against the Room Feature preferences attached to the reservation. If the parameter is off, the validation will be against the room feature preferences attached to the profile. This is applicable when the Room Feature Validation OPERA Control is on.","type":"boolean"},"overrideRoomOwnership":{"default":true,"description":"Override the room ownership of the room currently assigned to this reservation. This is applicable when Room Rotation OPERA Control is active.","type":"boolean"},"overrideRotationRoom":{"default":true,"description":"Override the rotation room that is next in the sequence with the room currently assigned to this reservation. This is applicable when Room Rotation OPERA Control is active.","type":"boolean"},"overrideSharesStayingPastDepartureCheck":{"description":"Indicates to override the check on shared reservations to whom changes can be propagated until their departure date.","type":"boolean"},"party":{"description":"Party/PartyCode when reservation is part of a party(a small group).","maxLength":50,"minLength":0,"type":"string"},"payeeSharer":{"description":"This attribute indicates if the Shared reservation is marked as the Payee Sharer or not.","type":"boolean"},"preArrivalReviewStatus":{"$ref":"#/components/schemas/rsv_read_preArrivalReviewStatusType","description":"The review status of a Pre-Arrival Reservation indicates whether the reservation has been reviewed, is pending review, or has been modified after the initial review."},"preRegistered":{"description":"Is the reservation pre-registered.","type":"boolean"},"preferenceCollection":{"description":"Collection of reservation preferences.","items":{"$ref":"#/components/schemas/rsv_read_preferenceTypeType"},"maxItems":4000,"type":"array"},"prepaidCards":{"$ref":"#/components/schemas/rsv_read_prepaidCardsType","description":"Collection of Prepaid Cards available for that reservation"},"primaryEnrollmentChain":{"description":"Name of the Chain for the primary enrollment","maxLength":80,"minLength":0,"type":"string"},"primaryEnrollmentResort":{"description":"Name Of the Resort/Hotel for the primary enrollment","maxLength":80,"minLength":0,"type":"string"},"printRate":{"description":"Indicates whether to show the rate or not on a printed document which includes the rate.","type":"boolean"},"profileAwards":{"$ref":"#/components/schemas/rsv_read_awardsType","description":"Collection of profile awards available for that reservation"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","type":"string"},"queue":{"$ref":"#/components/schemas/rsv_read_reservationQueueInformationType","description":"Information about the time and duration this reservation was on Queue for Checkin."},"rateSummary":{"$ref":"#/components/schemas/rsv_read_reservationRateSummaryType","description":"Rate Summary of the Reservation."},"reinstateDate":{"description":"Business Date when the reservation was last reinstated.","format":"date","type":"string"},"reservationActivities":{"$ref":"#/components/schemas/rsv_read_activityLookUpList","description":"Collection of Reservation Activities available for that reservation"},"reservationCommunication":{"$ref":"#/components/schemas/rsv_read_resCommunicationType","description":"Collection of reservation communication details."},"reservationGuests":{"description":"Collection of guests associated with the reservation.","items":{"$ref":"#/components/schemas/rsv_read_resGuestType"},"maxItems":4000,"type":"array"},"reservationIdList":{"$ref":"#/components/schemas/rsv_read_reservationIdList","description":"Used to provide PMS and/or CRS identifiers."},"reservationIndicators":{"$ref":"#/components/schemas/rsv_read_indicatorsType","description":"Indicators of additional information attached to the reservation"},"reservationMembershipAwards":{"description":"Collection of membership awards attached to a reservation","items":{"$ref":"#/components/schemas/rsv_read_reservationMembershipAwardType"},"maxItems":4000,"type":"array"},"reservationMemberships":{"description":"List of reservation memberships.","items":{"$ref":"#/components/schemas/rsv_read_reservationMembershipType"},"maxItems":4000,"type":"array"},"reservationPackages":{"description":"A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges.","items":{"$ref":"#/components/schemas/rsv_read_reservationPackageType"},"maxItems":4000,"type":"array"},"reservationPaymentMethods":{"$ref":"#/components/schemas/rsv_read_reservationPaymentMethodsType","description":"A collection of Payment Method objects."},"reservationPolicies":{"$ref":"#/components/schemas/rsv_read_reservationPoliciesType","description":"A collection of Cancellation Penalties objects."},"reservationProfiles":{"description":"Collection of guests associated with the reservation.","properties":{"commissionPayoutTo":{"$ref":"#/components/schemas/rsv_read_commissionPayoutToType","description":"If not null, reservation is considered to pay out commission to either Travel Agent, Source or both."},"reservationProfile":{"items":{"$ref":"#/components/schemas/rsv_read_reservationProfileType"},"maxItems":4000,"type":"array"}},"type":"object"},"reservationProtection":{"$ref":"#/components/schemas/rsv_read_reservationProtectionType","description":"Reservation Protection information related to the reservation."},"reservationStatus":{"$ref":"#/components/schemas/rsv_read_pMS_ResStatusType","description":"Indicates the Actual status of the reservation."},"roomStay":{"$ref":"#/components/schemas/rsv_read_roomStayType","description":"Room stays information."},"roomStayReservation":{"description":"Boolean True if this reservation is reserving rooms. False if it is only reserving services.","type":"boolean"},"routeAllTransactionsToShare":{"description":"Indicates if this joining reservation should route all transactions to the 'Share To' reservation when including Share Reservations Instructions.","type":"boolean"},"routingInstructions":{"$ref":"#/components/schemas/rsv_read_routingInfoListType","description":"Set of Routing Instructions."},"scheduledActivities":{"$ref":"#/components/schemas/rsv_read_activityLookUpList","description":"Collection of Scheduled Activities available for that reservation"},"scheduledRoomMoves":{"description":"Scheduled Room Moves","items":{"$ref":"#/components/schemas/rsv_read_scheduledRoomMoveType"},"maxItems":4000,"type":"array"},"serviceRequests":{"$ref":"#/components/schemas/rsv_read_serviceRequests","description":"Collection of Service Requests available for that reservation"},"sharedGuests":{"$ref":"#/components/schemas/rsv_read_resSharedGuestListType","description":"Collection of guests who share this reservation."},"sourceOfSale":{"$ref":"#/components/schemas/rsv_read_sourceOfSaleType","description":"Point of Sale of reservation. Identifies the entity/channel who made the reservation."},"tickets":{"$ref":"#/components/schemas/rsv_read_ticketsType","description":"List of Reservation Tickets."},"traces":{"$ref":"#/components/schemas/rsv_read_hotelReservationTracesType","description":"List of reservation Traces."},"trackItItems":{"$ref":"#/components/schemas/rsv_read_trackItItemsType","description":"Collection of TrackIt Items available for that reservation"},"transactionDiversions":{"description":"List of transaction diversions attached to the reservation.","properties":{"actionType":{"maxLength":2000,"type":"string"},"transactionDiversions":{"items":{"$ref":"#/components/schemas/rsv_read_reservationTransactionDiversionsType"},"maxItems":4000,"type":"array"}},"type":"object"},"trxCodesInfo":{"$ref":"#/components/schemas/rsv_read_trxCodesInfoType","description":"Summary of Transaction codes information which are related to reservation."},"upgradeEligible":{"description":"Indicates whether the reservation is eligible for upgrade.","type":"boolean"},"userDefinedFields":{"$ref":"#/components/schemas/rsv_read_userDefinedFieldsType","description":"Collections of user defined fields."},"waitlist":{"$ref":"#/components/schemas/rsv_read_waitlistResType","description":"Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is no more in Waitlist status."},"walkIn":{"description":"When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in.","type":"boolean"},"webRegistrationCards":{"$ref":"#/components/schemas/rsv_read_attachmentsType","description":"Collection of Web Registration Cards available for that reservation"}},"type":"object"},"rsv_read_hotelReservationsType":{"description":"A collection of Reservation objects and Unique IDs of Reservation.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"reservation":{"description":"A collection of Reservations.","items":{"$ref":"#/components/schemas/rsv_read_hotelReservationType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"rsv_read_housekeepingRoomStatusType":{"description":"Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.","enum":["Clean","Dirty","Pickup","Inspected","OutOfOrder","OutOfService"],"type":"string"},"rsv_read_identificationInfoType":{"description":"Information on the identification of the customer.","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"identification":{"$ref":"#/components/schemas/rsv_read_identificationType","description":"Detailed information on the identification of the customer."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_identificationType":{"description":"Identification information of the customer.","properties":{"expirationDate":{"description":"Expiration date of Identification.","format":"date","type":"string"},"idNumber":{"description":"Identification Number.","maxLength":80,"minLength":0,"type":"string"},"idNumberMasked":{"description":"Masked Identification Number.","maxLength":80,"minLength":0,"type":"string"},"idType":{"description":"Identification Type. Eg Passport, Driving License etc.","maxLength":40,"minLength":0,"type":"string"},"issuedCountry":{"description":"The country where Identification was issued.","maxLength":20,"minLength":0,"type":"string"},"issuedDate":{"description":"Issued date of Identification.","format":"date","type":"string"},"issuedPlace":{"description":"The place where Identification was issued.","maxLength":80,"minLength":0,"type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"},"registeredProperty":{"description":"Property where the identification belongs to.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_imageSetType":{"description":"Represents on image set record.","properties":{"description":{"description":"The image set description.","maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"description":"The image set hotel code.","maxLength":20,"minLength":0,"type":"string"},"imageSet":{"description":"The image set name.","maxLength":800,"minLength":0,"type":"string"},"imageStyle":{"$ref":"#/components/schemas/rsv_read_imageStyleType","description":"The image set enumerated style."},"imageURL":{"description":"The image set URL.","maxLength":2000,"minLength":0,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"}},"type":"object"},"rsv_read_imageStyleType":{"description":"An enumeration of image styles.","enum":["Full","Thumbnail","Icon","Square","Banner","Button","Lowres","Highres"],"type":"string"},"rsv_read_indicatorType":{"description":"Lamp indicator Type.","properties":{"count":{"description":"Indicates number of occurrences of the indicator.","type":"integer"},"indicatorName":{"description":"Name of the indicator.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_indicatorsType":{"description":"Collection of lamp indicators.","items":{"$ref":"#/components/schemas/rsv_read_indicatorType"},"maxItems":4000,"type":"array"},"rsv_read_instanceLink":{"description":"Metadata describing link description objects that MAY appear in the JSON instance representation.","properties":{"href":{"description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.","type":"string"},"method":{"description":"HTTP method for requesting the target of the link.","enum":["GET","POST","PUT","DELETE","PATCH","OPTIONS","HEAD"],"type":"string"},"operationId":{"description":"The operationId of the path you can call to follow this link.  This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.","type":"string"},"rel":{"description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.","type":"string"},"targetSchema":{"description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..","type":"string"},"templated":{"default":false,"description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.","type":"boolean"},"title":{"description":"Exact copy of the \"summary\" field on the linked operation.","type":"string"}},"type":"object"},"rsv_read_inventoryItems":{"description":"Return object to the request for information regarding inventory Items reserved for a reservation.","properties":{"inventoryItems":{"$ref":"#/components/schemas/rsv_read_resInventoryItemsType","description":"Collection of inventory items attached to a reservation."},"links":{"$ref":"#/components/schemas/rsv_read_links"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_itemInfoType":{"description":"Basic information regarding an Item.","properties":{"availabilityPeriod":{"$ref":"#/components/schemas/rsv_read_timeWindowType","description":"Defines a Time period when the item is available."},"code":{"description":"Item Code.","maxLength":20,"minLength":0,"type":"string"},"defaultDuration":{"description":"Define the default duration in days when booking the item.","type":"integer"},"description":{"description":"Detail description of an item.","maxLength":2000,"minLength":0,"type":"string"},"fixedCharge":{"description":"If true indicates that item has fixed charge when it is attached to a reservation.","type":"boolean"},"itemHoldId":{"description":"ID reference for the hold Item","type":"number"},"itemPool":{"description":"Indicates if it is an item pool. Not applicable for Item within the Item Pool.","type":"boolean"},"name":{"description":"Name of an item.","maxLength":200,"minLength":0,"type":"string"},"outsideStay":{"description":"If true indicates that item could be held outside of the reservation stay days.","type":"boolean"},"quantity":{"description":"Quantity of hold Item","type":"integer"},"requiredForBooking":{"description":"If true indicates that item is required for the reservation.","type":"boolean"},"sellInEvent":{"description":"If true indicates that item can be sold in event.","type":"boolean"},"sellInReservation":{"description":"If true indicates that item can be sold in reservation.","type":"boolean"},"sellSeparate":{"description":"If true indicates that item is allowed to sell separately.","type":"boolean"},"timeSpan":{"$ref":"#/components/schemas/rsv_read_timeSpanType","description":"Date Range to get the inventories of the items."}},"type":"object"},"rsv_read_languageType":{"maxLength":40,"minLength":0,"type":"string"},"rsv_read_lastCommittedResvType":{"properties":{"arrivalDate":{"format":"date","type":"string"},"departureDate":{"format":"date","type":"string"},"numberOfRooms":{"description":"Number of rooms","type":"integer"},"reservationStatus":{"$ref":"#/components/schemas/rsv_read_pMS_ResStatusType","description":"Indicates the Actual status of the reservation."},"roomType":{"description":"Current room type.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_lastStayInfoType":{"description":"Contains last stay related details for the profile","properties":{"lastRoom":{"description":"Used to hold last room information for the profile.","type":"string"},"totalStay":{"description":"The total number of previous stay of the profile.","type":"integer"}},"type":"object"},"rsv_read_linkedHotelReservationType":{"description":"The Reservation class contains the current reservation being created or altered.","properties":{"accessRestriction":{"$ref":"#/components/schemas/rsv_read_resAccessRestrictionType","description":"Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both."},"accessRestrictionMessage":{"description":"Configurable Access Restriction Message for Excluded Block or Rate Code.","maxLength":4000,"minLength":0,"type":"string"},"additionalGuestInfo":{"$ref":"#/components/schemas/rsv_read_resGuestAdditionalInfoType","description":"Entry Date into the country. (Croatian Requirements)."},"advanceCheckIn":{"$ref":"#/components/schemas/rsv_read_advanceCheckInType","description":"Information relating to Reservation's Advance Checked In state and Expected Time of Return"},"alerts":{"$ref":"#/components/schemas/rsv_read_alertsType","description":"List of reservation alerts."},"allowAutoCheckin":{"description":"Flag to allow auto checkin","type":"boolean"},"allowMobileCheckout":{"description":"Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false.","type":"boolean"},"allowMobileViewFolio":{"description":"Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.","type":"boolean"},"allowPreRegistration":{"description":"Flag containing true or false value for reservation to be eligible for prior check in by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile check in yes / no. Upon fetch, the current state of the flag will show true or false.","type":"boolean"},"allowedActions":{"$ref":"#/components/schemas/rsv_read_reservationAllowedActionsType","description":"Collection of allowed actions for the reservation."},"associatedReservations":{"$ref":"#/components/schemas/rsv_read_associatedResType","description":"Information regarding associated reservations."},"attachments":{"$ref":"#/components/schemas/rsv_read_attachmentsType","description":"Collection of attachments available for that reservation"},"autoBorrowFromHouse":{"description":"This flag will force to borrow from house if borrow required for number of rooms requested, this will only applicable when reservation is attached to a Block.","type":"boolean"},"callHistory":{"$ref":"#/components/schemas/rsv_read_callHistoryType","description":"List of reservation calls."},"cancellation":{"description":"Information regarding why reservation has been/was cancelled. This could hold information as history even if reservation is no more in in Cancelled status.","properties":{"cancellationNo":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Cancellation Number given when reservation was last cancelled."},"code":{"maxLength":20,"minLength":0,"type":"string"},"date":{"description":"Date when reservation was last cancelled.","format":"date","type":"string"},"description":{"maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"cashiering":{"$ref":"#/components/schemas/rsv_read_resCashieringType","description":"Holds cashiering related information for the reservation."},"catering":{"$ref":"#/components/schemas/rsv_read_cateringResInfoType","description":"Catering event information if reservation is associated with the catering event."},"chargeCardNumber":{"description":"This attribute represents Hotel charge card number. This number is generated automatically in OPERA when a reservation is created in OPERA. It is part of a functionality that provide the guest with the convenience of placing all their charges directly on their reservation folio.","maxLength":100,"minLength":0,"type":"string"},"comments":{"description":"List of Notes for the Guest related to the reservation.","items":{"$ref":"#/components/schemas/rsv_read_commentInfoType"},"maxItems":4000,"type":"array"},"compAuthorizer":{"$ref":"#/components/schemas/rsv_read_compAuthorizerInfoType","description":"Reservation Comp Authorizer."},"computedReservationStatus":{"$ref":"#/components/schemas/rsv_read_pMS_ResStatusType","description":"Indicates the Computed status of the reservation."},"confirmationLetters":{"$ref":"#/components/schemas/rsv_read_confirmationsType","description":"List of reservation confirmation letters."},"createBusinessDate":{"description":"Business Date when the reservation was created.","format":"date","type":"string"},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"customChargeExemptionDetails":{"$ref":"#/components/schemas/rsv_read_customChargeExemptionsType","description":"List of Custom Charge Exemptions attached to the reservation."},"customNameValueDetail":{"$ref":"#/components/schemas/rsv_read_nameValueDetailType","description":"List of Custom Name Value Information attached to the reservation."},"customReference":{"description":"Custom Reference to identify reservation.","maxLength":50,"minLength":0,"type":"string"},"displayColor":{"description":"The color to display this reservation on room grid displays.","maxLength":20,"minLength":0,"type":"string"},"eCertificates":{"$ref":"#/components/schemas/rsv_read_reservationECertificatesType","description":"List of ECertificates attached to the reservation."},"eCoupons":{"$ref":"#/components/schemas/rsv_read_eCouponsType","description":"List of eCoupons."},"extSystemSync":{"type":"boolean"},"externalReferences":{"$ref":"#/components/schemas/rsv_read_externalReferencesType","description":"External Reference information for Reservation."},"fixedCharges":{"$ref":"#/components/schemas/rsv_read_fixedChargesType","description":"List of reservation fixed charges."},"folios":{"$ref":"#/components/schemas/rsv_read_foliosShortInfoType","description":"This element returns any automatically generated folios during check-in, based on the Fetch Instruction \"AutoFolios\". When the parameter \"Auto Generate Credit Bill for Deposit upon Check In\" is enabled, during check-in credit bills are automatically generated for the deposits. The generated credit bill details are returned so that user can preview/print the folio. For some countries like Portugal, it is mandatory to print the folio and hence this information is needed"},"guestComments":{"description":"List of Notes for the Guest related to the profile.","items":{"$ref":"#/components/schemas/rsv_read_commentInfoType"},"maxItems":4000,"type":"array"},"guestMemberships":{"description":"List of Memberships for the Guest related to the reservation.","items":{"$ref":"#/components/schemas/rsv_read_membershipType"},"maxItems":4000,"type":"array"},"guestMessages":{"$ref":"#/components/schemas/rsv_read_guestMessagesType","description":"List of Messages."},"hasOpenFolio":{"type":"boolean"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"housekeeping":{"$ref":"#/components/schemas/rsv_read_resHousekeepingType","description":"Holds rooms housekeeping information."},"inventoryItems":{"$ref":"#/components/schemas/rsv_read_resInventoryItemsType","description":"A collection of inventory items attached to a reservation."},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"linkReservationType":{"$ref":"#/components/schemas/rsv_read_linkedReservationType","description":"Linked reservation type."},"linkedReservation":{"$ref":"#/components/schemas/rsv_read_linkedReservationsInfoType","description":"Reservations related to the current Reservation."},"locators":{"$ref":"#/components/schemas/rsv_read_reservationLocatorsType","description":"Collection of Locators available for that reservation"},"lockHandle":{"description":"An id representing the record lock for this reservation. When passed, update operation will verify that this lock is still valid.","type":"number"},"markAsRecentlyAccessed":{"description":"Mark this reservation as recently accessed.","type":"boolean"},"optedForCommunication":{"description":"Flag containing true or false value to determine if the guest has opted for communications pertaining to this reservation.Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is marked for communication. Upon fetch, the current state of the flag will show true or false.","type":"boolean"},"overrideBlockRestriction":{"type":"boolean"},"overrideExternalChecks":{"description":"Forcefully override the create/update action on the Reservation. For real-time CRS interfaces, this element is used as force selling indicator in case of Create or Update Reservation","type":"boolean"},"overrideInstructions":{"$ref":"#/components/schemas/rsv_read_overrideInstructionsType","description":"List of overrides done for the reservation."},"overrideInventoryCheck":{"description":"Indicates to Override the Room Inventory Check if applicable.","type":"boolean"},"overrideOutOfServiceCheck":{"description":"Indicates to Override the Room Out Of Service Check if applicable.","type":"boolean"},"party":{"description":"Party/PartyCode when reservation is part of a party(a small group).","maxLength":50,"minLength":0,"type":"string"},"preRegistered":{"description":"Is the reservation pre-registered.","type":"boolean"},"preferenceCollection":{"description":"Collection of reservation preferences.","items":{"$ref":"#/components/schemas/rsv_read_preferenceTypeType"},"maxItems":4000,"type":"array"},"prepaidCards":{"$ref":"#/components/schemas/rsv_read_prepaidCardsType","description":"Collection of Prepaid Cards available for that reservation"},"primaryEnrollmentChain":{"description":"Name of the Chain for the primary enrollment","maxLength":80,"minLength":0,"type":"string"},"primaryEnrollmentResort":{"description":"Name Of the Resort/Hotel for the primary enrollment","maxLength":80,"minLength":0,"type":"string"},"printRate":{"description":"Indicates whether to show the rate or not on a printed document which includes the rate.","type":"boolean"},"profileAwards":{"$ref":"#/components/schemas/rsv_read_awardsType","description":"Collection of profile awards available for that reservation"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","type":"string"},"queue":{"$ref":"#/components/schemas/rsv_read_reservationQueueInformationType","description":"Information about the time and duration this reservation was on Queue for Checkin."},"reinstateDate":{"description":"Business Date when the reservation was last reinstated.","format":"date","type":"string"},"reservationActivities":{"$ref":"#/components/schemas/rsv_read_activityLookUpList","description":"Collection of Reservation Activities available for that reservation"},"reservationAwards":{"$ref":"#/components/schemas/rsv_read_awardsType","description":"Collection of Awards,Certificates for the guest profile."},"reservationCommunication":{"$ref":"#/components/schemas/rsv_read_resCommunicationType","description":"Collection of reservation communication details."},"reservationGuests":{"description":"Collection of guests associated with the reservation.","items":{"$ref":"#/components/schemas/rsv_read_resGuestType"},"maxItems":4000,"type":"array"},"reservationIdList":{"$ref":"#/components/schemas/rsv_read_reservationIdList","description":"Used to provide PMS and/or CRS identifiers."},"reservationIndicators":{"$ref":"#/components/schemas/rsv_read_indicatorsType","description":"Indicators of additional information attached to the reservation"},"reservationMemberships":{"description":"List of reservation memberships.","items":{"$ref":"#/components/schemas/rsv_read_reservationMembershipType"},"maxItems":4000,"type":"array"},"reservationPackages":{"description":"A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges.","items":{"$ref":"#/components/schemas/rsv_read_reservationPackageType"},"maxItems":4000,"type":"array"},"reservationPaymentMethods":{"$ref":"#/components/schemas/rsv_read_reservationPaymentMethodsType","description":"A collection of Payment Method objects."},"reservationPolicies":{"$ref":"#/components/schemas/rsv_read_reservationPoliciesType","description":"A collection of Cancellation Penalties objects."},"reservationProfiles":{"description":"Collection of guests associated with the reservation.","properties":{"commissionPayoutTo":{"$ref":"#/components/schemas/rsv_read_commissionPayoutToType","description":"If not null, reservation is considered to pay out commission to either Travel Agent, Source or both."},"reservationProfile":{"items":{"$ref":"#/components/schemas/rsv_read_reservationProfileType"},"maxItems":4000,"type":"array"}},"type":"object"},"reservationStatus":{"$ref":"#/components/schemas/rsv_read_pMS_ResStatusType","description":"Indicates the Actual status of the reservation."},"roomStay":{"$ref":"#/components/schemas/rsv_read_roomStayType","description":"Room stays information."},"roomStayReservation":{"description":"Boolean True if this reservation is reserving rooms. False if it is only reserving services.","type":"boolean"},"routingInstructions":{"$ref":"#/components/schemas/rsv_read_routingInfoListType","description":"Set of Routing Instructions."},"scheduledActivities":{"$ref":"#/components/schemas/rsv_read_activityLookUpList","description":"Collection of Scheduled Activities available for that reservation"},"serviceRequests":{"$ref":"#/components/schemas/rsv_read_serviceRequests","description":"Collection of Service Requests available for that reservation"},"sharedGuests":{"$ref":"#/components/schemas/rsv_read_resSharedGuestListType","description":"Collection of guests who share this reservation."},"shares":{"$ref":"#/components/schemas/rsv_read_hotelReservationsType","description":"Collection of share reservation available for that reservation"},"sourceOfSale":{"$ref":"#/components/schemas/rsv_read_sourceOfSaleType","description":"Point of Sale of reservation. Identifies the entity/channel who made the reservation."},"statisticalClassification":{"$ref":"#/components/schemas/rsv_read_resStatClassificationType","description":"Catering event information if reservation is associated with the catering event."},"tickets":{"$ref":"#/components/schemas/rsv_read_ticketsType","description":"List of Reservation Tickets."},"traces":{"$ref":"#/components/schemas/rsv_read_hotelReservationTracesType","description":"List of reservation Traces."},"trackItItems":{"$ref":"#/components/schemas/rsv_read_trackItItemsType","description":"Collection of TrackIt Items available for that reservation"},"transactionDiversions":{"description":"List of transaction diversions attached to the reservation.","properties":{"actionType":{"maxLength":2000,"type":"string"},"transactionDiversions":{"items":{"$ref":"#/components/schemas/rsv_read_reservationTransactionDiversionsType"},"maxItems":4000,"type":"array"}},"type":"object"},"upgradeEligible":{"description":"Indicates whether the reservation is eligible for upgrade.","type":"boolean"},"userDefinedFields":{"$ref":"#/components/schemas/rsv_read_userDefinedFieldsType","description":"Collections of user defined fields."},"waitlist":{"$ref":"#/components/schemas/rsv_read_waitlistResType","description":"Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is no more in Waitlist status."},"walkIn":{"description":"When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in.","type":"boolean"},"webRegistrationCards":{"$ref":"#/components/schemas/rsv_read_attachmentsType","description":"Collection of Web Registration Cards available for that reservation"}},"type":"object"},"rsv_read_linkedHotelReservations":{"description":"Return object for retrieving linked reservations.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"reservations":{"$ref":"#/components/schemas/rsv_read_linkedHotelReservationsType","description":"Collection of linked reservations fetched."},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_linkedHotelReservationsType":{"description":"A collection of Linked Reservation objects and Unique IDs of Reservation.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"linkedReservation":{"description":"A collection of Linked Reservations.","items":{"$ref":"#/components/schemas/rsv_read_linkedHotelReservationType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"rsv_read_linkedReservationInfoType":{"properties":{"adultCount":{"description":"Number of adults of the reservation.","type":"integer"},"allowedActions":{"$ref":"#/components/schemas/rsv_read_reservationAllowedActionsType","description":"Collection of allowed actions for the linked reservation."},"backToBack":{"description":"This attribute indicates if the linked reservation is marked as Back to Back or not.","type":"boolean"},"backToBackGroupId":{"description":"This attribute represents a common identifier for a subgroup of linked reservations marked as Back to Back in a group of linked reservations.","maxLength":80,"minLength":0,"type":"string"},"backToBackSequence":{"$ref":"#/components/schemas/rsv_read_backToBackResSequenceType","description":"This attribute represents Back To Back Sequence of Linked Reservations(e.g. '1 of 2' i.e, 1 indicates Sequence Position of total count 2). This is applicable when OPERA control Back to Back Handling for Linked Reservations is active."},"balance":{"$ref":"#/components/schemas/rsv_read_currencyAmountType"},"childCount":{"description":"Number of children of the reservation.","type":"integer"},"displayColor":{"maxLength":20,"minLength":0,"type":"string"},"givenName":{"maxLength":40,"minLength":0,"type":"string"},"guarantee":{"$ref":"#/components/schemas/rsv_read_resGuaranteeType"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"linkReservationType":{"$ref":"#/components/schemas/rsv_read_linkedReservationType"},"profileId":{"$ref":"#/components/schemas/rsv_read_profileId","description":"Unique guest profile identifier for the linked reservation."},"rate":{"$ref":"#/components/schemas/rsv_read_currencyAmountType"},"ratePlanCode":{"maxLength":20,"minLength":0,"type":"string"},"reservationBlock":{"$ref":"#/components/schemas/rsv_read_reservationBlockType","description":"Key information about the block for the linked reservation."},"reservationIdList":{"$ref":"#/components/schemas/rsv_read_reservationIdList"},"reservationStatus":{"$ref":"#/components/schemas/rsv_read_pMS_ResStatusType","description":"Indicates the Actual status of the reservation."},"reverseCheckInAllowed":{"description":"This attribute is to verify if reverse check-in is allowed for the reservation.","type":"boolean"},"room":{"maxLength":20,"minLength":0,"type":"string"},"roomNumberLocked":{"description":"This attribute is to verify if room number is locked for the reservation. When true the room number cannot be changed","type":"boolean"},"roomType":{"maxLength":20,"minLength":0,"type":"string"},"shared":{"description":"This attribute indicates if the linked reservation is a shared reservation or not.","type":"boolean"},"suppressRate":{"description":"This attribute checks if rate is suppressed or not in order to properly show strike through.","type":"boolean"},"surname":{"maxLength":40,"minLength":0,"type":"string"},"timeSpan":{"$ref":"#/components/schemas/rsv_read_timeSpanType"},"title":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_linkedReservationType":{"description":"Enumeration of the different Linked Reservation Types.","enum":["Linked","Shared","Default"],"type":"string"},"rsv_read_linkedReservationsInfo":{"properties":{"linkedReservationList":{"$ref":"#/components/schemas/rsv_read_linkedReservationsInfoType","description":"Set of reservations linked to the requested Reservation."},"links":{"$ref":"#/components/schemas/rsv_read_links"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_linkedReservationsInfoType":{"description":"Linked Reservations.","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"linkedName":{"description":"Name of the group of Linked Reservation.","maxLength":50,"minLength":0,"type":"string"},"reservationInfo":{"items":{"$ref":"#/components/schemas/rsv_read_linkedReservationInfoType"},"maxItems":4000,"type":"array"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"rsv_read_links":{"items":{"$ref":"#/components/schemas/rsv_read_instanceLink"},"type":"array"},"rsv_read_masterAccountInfoType":{"properties":{},"type":"object"},"rsv_read_masterInfoType":{"properties":{"codeInfo":{"items":{"$ref":"#/components/schemas/rsv_read_codeInfoType"},"maxItems":4000,"type":"array"},"codeType":{"$ref":"#/components/schemas/rsv_read_masterType"}},"type":"object"},"rsv_read_masterType":{"enum":["Country","State","AddressType","PhoneType","RateCategory","CalculationRule","PostingRythym","BillingInstruction","TransactionCode","DisplaySet","MailingActions","DistanceType","District","Territory","FiscalRegion","InventoryItem","Package","RoomFeaturePreference","SpecialPreference","Promotion","Department","ReservationPreference","FacilityTask","RoomType","RateCode","OutOfOrderReason","Block"],"type":"string"},"rsv_read_membershipDetails":{"description":"Membership Details","properties":{"membershipId":{"description":"Membership Internal ID.","maxLength":20,"minLength":0,"type":"string"},"membershipLevel":{"description":"Membership Level.","maxLength":32000,"minLength":0,"type":"string"},"membershipNumber":{"description":"Membership number.","maxLength":32000,"minLength":0,"type":"string"},"membershipType":{"description":"Membership Type.","maxLength":32000,"minLength":0,"type":"string"},"multipleMemberships":{"description":"Multiple Memberships.","type":"boolean"}},"type":"object"},"rsv_read_membershipEarningPreferenceType":{"description":"The earning preference of a membership, it depends on the type of property. eg. when the property is a airline it should be Miles, other than Points.","enum":["Points","Miles"],"type":"string"},"rsv_read_membershipInfoType":{"description":"The Membership object identifies the frequent customer reward program.","properties":{"accountId":{"description":"The account identification or membership card number for this particular member in this particular program.","maxLength":50,"minLength":0,"type":"string"},"bonusCode":{"description":"The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.)","maxLength":20,"minLength":0,"type":"string"},"membershipId":{"description":"Membership ID Number(Unique ID from the memberships table).","type":"number"},"membershipLevel":{"description":"The code or name of the membership level and indicates the level of membership (Gold Club, Platinum member, etc.). This is same as the BonusCode.","maxLength":20,"minLength":0,"type":"string"},"membershipLevelDesc":{"description":"The description of the Bonus Code.(Platinum for code P)","maxLength":2000,"minLength":0,"type":"string"},"membershipTypeDesc":{"description":"The description of the ProgramCode.(Delta Previlige for code DP)","maxLength":2000,"minLength":0,"type":"string"},"playerRanking":{"description":"Ranking assigned to the Player Profile by the Gaming system.","type":"integer"},"programCode":{"description":"The code or name of the membership program ('Hertz', 'AAdvantage', etc.).","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_membershipType":{"description":"Detailed information of the memberships.","properties":{"benefits":{"$ref":"#/components/schemas/rsv_read_benefitsType","description":"benefits for the membership."},"centralSetup":{"description":"Indicates how the award points for this membership type will be managed.","type":"boolean"},"comment":{"$ref":"#/components/schemas/rsv_read_paragraphType","description":"Additional comments regarding to the membership."},"createDateTime":{"description":"Time stamp of the creation. Uses database time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"currentPoints":{"description":"Profile MemberShip Points.","type":"number"},"downgrade":{"$ref":"#/components/schemas/rsv_read_downgradeType","description":"Defines how downgrading will be handled for this membership."},"downgradeDescription":{"description":"Indicates information regarding the member's possible downgrades.","maxLength":32000,"minLength":0,"type":"string"},"earningPreference":{"$ref":"#/components/schemas/rsv_read_membershipEarningPreferenceType","description":"Earning preference to the membership."},"effectiveDate":{"description":"Indicates the starting date.","format":"date","type":"string"},"enrollmentResort":{"description":"Resort/CRO where enrollment is done.","maxLength":20,"minLength":0,"type":"string"},"enrollmentSource":{"description":"Source from where the enrollment is done.","maxLength":20,"minLength":0,"type":"string"},"excludeFromBatch":{"description":"True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false.","type":"boolean"},"expireDate":{"description":"Indicates the ending date.","format":"date","type":"string"},"expireDateExclusiveIndicator":{"description":"When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).","type":"boolean"},"inactive":{"description":"Indicates whether membership is active or inactive.","type":"boolean"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses database time zone.","format":"date-time","type":"string"},"memberStatus":{"description":"Indicates where the guest is in the membership enrollment process.","maxLength":20,"minLength":0,"type":"string"},"membershipClass":{"description":"Indicates the membership class.","type":"string"},"membershipEnrollmentCode":{"description":"Indicates how the guest enrolled in the program.","maxLength":20,"minLength":0,"type":"string"},"membershipId":{"description":"Card Number of the membership.","type":"string"},"membershipIdNo":{"description":"Membership ID Number.","type":"integer"},"membershipLevel":{"description":"Indicates the membership level.","type":"string"},"membershipLevelDescription":{"description":"Indicates the membership level description.","maxLength":200,"minLength":0,"type":"string"},"membershipType":{"description":"Type of membership.","type":"string"},"nameOnCard":{"description":"Name to be displayed on the membership card.","type":"string"},"newMembershipNumber":{"description":"Card Number of the membership.","type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"playerRanking":{"description":"Ranking assigned to the Player Profile by the Gaming system.","type":"integer"},"pointsLabel":{"description":"Label used to refer to points for this membership type","maxLength":20,"minLength":0,"type":"string"},"preferredCard":{"description":"Preferred Card.","type":"boolean"},"primaryMembership":{"description":"Boolean indicator set to True implies membership is a Primary Membership.","type":"boolean"},"primaryMembershipYn":{"description":"Indicator if Membership is a Primary Membership.","maxLength":1,"minLength":0,"type":"string"},"programDescription":{"description":"Description of the membership program.","type":"string"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","type":"string"},"rating":{"description":"Value Rating Type Description for this membership.","type":"string"},"reIssueNewCard":{"$ref":"#/components/schemas/rsv_read_cardReIssueType","description":"The status of issuing new membership card to the member."},"signupDate":{"description":"Indicates when the member signed up for the loyalty program.","format":"date","type":"string"},"tierAdministration":{"$ref":"#/components/schemas/rsv_read_tierAdministrationType","description":"Defines the degree of participation for this membership in the tier management portion of the program."},"upgradeDescription":{"description":"Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.","maxLength":32000,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_membershipTypeLevelType":{"properties":{"level":{"description":"Description type for Rule Details","maxLength":20,"minLength":0,"type":"string"},"type":{"description":"Code type for Rule Details","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_messageDeliveryType":{"description":"Holds the Delivery Information of the Message","properties":{"deliveredBy":{"description":"User who delivered the message (who marked message as received)","maxLength":40,"minLength":0,"type":"string"},"deliveryDate":{"description":"Date the message has been delivered (marked as received). Uses the hotel's time zone for getGuestMessages. Uses database time zone for putGuestMessages.","format":"date-time","type":"string"},"deliveryStatus":{"$ref":"#/components/schemas/rsv_read_messageStatusType","description":"Status of the Message (Received or Not Received)"},"printDate":{"description":"Date when message has been printed. Uses database time zone.","format":"date-time","type":"string"},"textMessageRecipientNo":{"description":"Number in which the message is to be sent.","maxLength":2000,"minLength":0,"type":"string"},"textMessageSentBy":{"description":"User who sent the message","maxLength":40,"minLength":0,"type":"string"},"textMessageSentById":{"description":"User Id of who sent the message","type":"integer"},"textMessageSentDate":{"description":"Date when message has been sent via SMS. Uses database time zone.","format":"date-time","type":"string"}},"type":"object"},"rsv_read_messageStatusType":{"description":"Status of the Message.","enum":["Mr","Nr"],"type":"string"},"rsv_read_messageType":{"description":"Holds the Message Information","properties":{"messageDate":{"description":"Date the message was created. Uses the hotel's time zone for getGuestMessages. Uses database time zone for postGuestMessages.","format":"date-time","type":"string"},"messageText":{"description":"Message Content","maxLength":2000,"minLength":0,"type":"string"},"operator":{"description":"User who created the Message","maxLength":256,"minLength":0,"type":"string"},"recipient":{"description":"Recipient of the Message","maxLength":20000,"minLength":0,"type":"string"},"typeOfMessage":{"$ref":"#/components/schemas/rsv_read_typeOfMessageType","description":"Type of message (Voice/Text)"}},"type":"object"},"rsv_read_namePrefixType":{"description":"Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)","maxLength":40,"minLength":0,"type":"string"},"rsv_read_nameTypeType":{"enum":["Guest","Company","Agent","Contact","Source","Group","Employee","Hotel","Purge"],"type":"string"},"rsv_read_nameValueDataTypeType":{"enum":["String","Number","Date","Datetime","Time","Integer"],"type":"string"},"rsv_read_nameValueDetailType":{"description":"Detailed information returned during name value search.","properties":{"nameValues":{"$ref":"#/components/schemas/rsv_read_nameValuesType","description":"Name Value List."}},"type":"object"},"rsv_read_nameValueModuleType":{"enum":["Reservation","Folio","Profile","Fintrix"],"type":"string"},"rsv_read_nameValueOriginType":{"description":"Contains origin details.","properties":{"destination":{"description":"Contains destination column for Origin.","maxLength":200,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"originName":{"$ref":"#/components/schemas/rsv_read_nameValueModuleType","description":"Contains origin i.e. Reseravtion, Profile, Folio or FinTrx."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_nameValueType":{"description":"Contains name value pair.","properties":{"dataType":{"$ref":"#/components/schemas/rsv_read_nameValueDataTypeType","description":"Contains data type for values."},"formatString":{"description":"Contains format string for values.","maxLength":100,"minLength":0,"type":"string"},"name":{"description":"Contains unique key which represents for record field.","maxLength":100,"minLength":0,"type":"string"},"origin":{"$ref":"#/components/schemas/rsv_read_nameValueOriginType","description":"Contains Origin information."},"usageInstruction":{"$ref":"#/components/schemas/rsv_read_codeListType","description":"Contains value(s) to identify the reports to include the collected information in e.g. PFH=Print Folio Header, PFD=Print Folio Detail."},"value":{"description":"Contains value for the record/column.","maxLength":4000,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_nameValuesType":{"description":"List of name value pairs.","items":{"$ref":"#/components/schemas/rsv_read_nameValueType"},"maxItems":4000,"type":"array"},"rsv_read_numericUDFType":{"description":"Used to hold user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02,...UDFN40 (Total 40) as Numeric UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.","properties":{"alternateName":{"description":"Label of user defined field used by vendors or customers.","maxLength":2000,"minLength":0,"type":"string"},"name":{"description":"Name of user defined field.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Value of user defined field.","type":"number"}},"type":"object"},"rsv_read_numericUDFsType":{"description":"Used to hold collection of user defined fields of Numeric Type.","items":{"$ref":"#/components/schemas/rsv_read_numericUDFType"},"maxItems":4000,"type":"array"},"rsv_read_offsetUnitType":{"description":"Indicates deadline offset unit type.","enum":["Year","Month","Day","Hour"],"type":"string"},"rsv_read_offshoreRateType":{"description":"Defines Offshore rate information.","properties":{"offshoreRateAmount":{"description":"Offshore Rate Amount","type":"number"},"offshoreRateCode":{"description":"Offshore Rate Code","maxLength":20,"minLength":0,"type":"string"},"offshoreRateCurrency":{"description":"Offshore Rate Currency specifying the monetary unit for the Offshore Rate. Use ISO 4217, three alpha code","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_overrideInstructionType":{"description":"Type for Overrides. Contains information for the override action performed while booking a reservation.","properties":{"date":{"description":"The date when the override was done.","format":"date","type":"string"},"description":{"description":"The description of the restriction for which the override was done.","maxLength":2000,"minLength":0,"type":"string"},"reasonCode":{"description":"The override reason code.","maxLength":20,"minLength":0,"type":"string"},"reasonDescription":{"description":"The override reason description.","maxLength":2000,"minLength":0,"type":"string"},"type":{"description":"The type of override done. If the override is for Room/Rate Availability, use 'AVAILABILITY', if overriding the sell control availability for inventory items, use 'ITEMAVAILABILITY'.","maxLength":80,"minLength":0,"type":"string"},"userId":{"description":"Login ID of the user who performed the override.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_overrideInstructionsType":{"description":"List of override actions done.","items":{"$ref":"#/components/schemas/rsv_read_overrideInstructionType"},"maxItems":4000,"type":"array"},"rsv_read_ownerType":{"description":"Generic type for information about an owner.","properties":{"department":{"$ref":"#/components/schemas/rsv_read_codeDescriptionType","description":"Department to which the owner belongs to."},"email":{"$ref":"#/components/schemas/rsv_read_emailInfoType","description":"Email information of the owner."},"hotel":{"$ref":"#/components/schemas/rsv_read_codeDescriptionType","description":"Hotel to which the owner belongs to."},"name":{"$ref":"#/components/schemas/rsv_read_personNameType","description":"Provides name information of the owner."},"ownerCode":{"description":"Unique Code to identify the owner.","maxLength":20,"minLength":0,"type":"string"},"phone":{"$ref":"#/components/schemas/rsv_read_telephoneInfoType","description":"Information on the telephone number of the owner."},"primary":{"description":"When true, this is a primary owner.","type":"boolean"},"profileId":{"$ref":"#/components/schemas/rsv_read_profileId","description":"Unique owner profile information."},"relationship":{"$ref":"#/components/schemas/rsv_read_codeDescriptionType","description":"Relationship of the owner within the profile or block."},"userId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Unique application user ID."},"userName":{"description":"Unique application user name of the owner.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_pMS_ResStatusType":{"description":"This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.","enum":["Reserved","Requested","NoShow","Cancelled","InHouse","CheckedOut","Waitlisted","DueIn","DueOut","Walkin","PendingCheckout"],"type":"string"},"rsv_read_packageCalculationRuleType":{"description":"Simple type for package caluculation rules.","enum":["FlatRate","PerPerson","PerAdult","PerChild","PerRoom"],"type":"string"},"rsv_read_packageCategoryInfoType":{"description":"Information about the package category","properties":{"packageCategory":{"description":"The category of the package","type":"string"},"packageCategoryDescription":{"description":"A description of the package category.","type":"string"}},"type":"object"},"rsv_read_packageCategoryReservationType":{"description":"Information regarding each reservation being returned in the response","properties":{"advanceCheckIn":{"$ref":"#/components/schemas/rsv_read_advanceCheckInType","description":"Information relating to Reservation's Advance Checked In state and Expected Time of Return"},"noPost":{"description":"Defines if the no post flag is set on the reservation or not","type":"boolean"},"openFolio":{"description":"Returns true when reservation has an open folio.","type":"boolean"},"paymentMethod":{"description":"Payment Method.","maxLength":20,"minLength":0,"type":"string"},"preRegistered":{"description":"Defines if the reservation is pre-registered or not.","type":"boolean"},"reservationGuest":{"$ref":"#/components/schemas/rsv_read_resGuestInfoType","description":"Collection of guests associated with the reservation."},"reservationIdList":{"$ref":"#/components/schemas/rsv_read_reservationIdList","description":"Unique identifiers for the reservation for both internal and external systems"},"reservationMemberships":{"description":"List of reservation memberships which are attached from profile.","items":{"$ref":"#/components/schemas/rsv_read_reservationMembershipType"},"maxItems":10,"type":"array"},"reservationPackages":{"description":"A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges.","items":{"$ref":"#/components/schemas/rsv_read_reservationPackageType"},"maxItems":4000,"type":"array"},"reservationPaymentMethod":{"$ref":"#/components/schemas/rsv_read_reservationPaymentMethodType","description":"Payment method used for this reservation"},"reservationStatus":{"$ref":"#/components/schemas/rsv_read_pMS_ResStatusType","description":"Indicates the status of the reservation."},"roomStay":{"$ref":"#/components/schemas/rsv_read_stayInfoType","description":"Collection of room stays."},"shareReservation":{"description":"Defines if the reservation is shared with another reservation or not","type":"boolean"},"sharedGuests":{"$ref":"#/components/schemas/rsv_read_resSharedGuestListType","description":"Collection of guests who share this reservation."}},"type":"object"},"rsv_read_packageCategoryReservations":{"description":"Response object to the Fetch Reservations by package request operation. Based on the criteria, reservation information is returned.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"masterInfoList":{"items":{"$ref":"#/components/schemas/rsv_read_masterInfoType"},"type":"array"},"reservations":{"description":"Collection of Reservations and their information.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"limit":{"description":"Indicates maximum number of records a Web Service should return.","type":"integer"},"offset":{"description":"Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.","type":"integer"},"reservationInfo":{"description":"Contains details of the reservations.","items":{"$ref":"#/components/schemas/rsv_read_packageCategoryReservationType"},"maxItems":4000,"type":"array"},"totalPages":{"description":"Evaluated total page count based on the requested max fetch count.","type":"integer"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_packageCodeHeaderType":{"properties":{"postingAttributes":{"$ref":"#/components/schemas/rsv_read_configPostingAttributesType","description":"Package code posting attributes."},"primaryDetails":{"$ref":"#/components/schemas/rsv_read_configPackagePrimaryDetailsType","description":"Package code header primary details."},"transactionDetails":{"$ref":"#/components/schemas/rsv_read_configPackageTransactionType","description":"Package code header transaction information."}},"type":"object"},"rsv_read_packageConsumptionType":{"description":"Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.","properties":{"allowanceConsumed":{"description":"Indicates if Allowance(for POS packages) has been consumed/posted for today.","type":"boolean"},"defaultQuantity":{"description":"Quantity of packages to be attached i.e. the multiplier to be applied against the calculation rule to determine the total quantity of the packages.","type":"integer"},"excludedQuantity":{"description":"The quantity which has been excluded in the package.","type":"integer"},"totalQuantity":{"description":"The total quantity of the package, calculated based on the calculation rule as defined in the PackageHeaderType and defaultQuantity.","type":"integer"}},"type":"object"},"rsv_read_packageElementType":{"properties":{"addRateCombinedLine":{"type":"boolean"},"addRateSeprateLine":{"type":"boolean"},"allowance":{"$ref":"#/components/schemas/rsv_read_currencyAmountType"},"amount":{"$ref":"#/components/schemas/rsv_read_currencyAmountType"},"calculationRule":{"type":"string"},"description":{"items":{"maxLength":2000,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"endDate":{"format":"date","type":"string"},"endTime":{"type":"string"},"includedInRate":{"type":"boolean"},"packageCode":{"type":"string"},"postingRhythm":{"type":"string"},"quantity":{"type":"integer"},"sellSeparate":{"type":"boolean"},"startDate":{"format":"date","type":"string"},"startTime":{"type":"string"}},"type":"object"},"rsv_read_packageInfoType":{"description":"Package information related to a reservation","properties":{"calculatedQuantity":{"description":"The quantity of the package calculated to be consumed based on the package's quantity and the calculation rule","type":"integer"},"calculationRule":{"description":"The price calculation rule for this package","type":"string"},"consumedQuantity":{"description":"The quantity of the package that has been consumed","type":"integer"},"consumptionDate":{"description":"The consumption date of the package.","format":"date","type":"string"},"forecastConsumptionDate":{"description":"The forecasted consumption date of the package.","format":"date","type":"string"},"packageCategoryInfo":{"$ref":"#/components/schemas/rsv_read_packageCategoryInfoType","description":"Information about the category of the package."},"packageCode":{"description":"The unique code identifying the package.","type":"string"},"packageDescription":{"description":"A description of the package.","type":"string"},"quantity":{"description":"Quantity of packages to be attached i.e. the multiplier to be applied against the calculation rule to determine the calculated quantity of the packages","type":"integer"},"reservationDate":{"description":"The reservation date of the package.","format":"date","type":"string"},"unitPrice":{"description":"The price per unit of the package","type":"number"}},"type":"object"},"rsv_read_packagePostingRhythmType":{"description":"Package Posting rhythm type.","properties":{"certainNightsOfTheWeek":{"description":"Post the package on certain nights of the week.","properties":{"friday":{"type":"boolean"},"monday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"thursday":{"type":"boolean"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"}},"type":"object"},"customNightSchedule":{"description":"The start and end of the posting period is determined as follows: If the package is attached to a rate code: The period starts with the date when the rate code to which the package is attached becomes effective for the stay. The period ends with the date of the last night for that rate code (or the last night of the stay if the rate code remains in effect until the departure date). If the package is attached separately to the reservation: The Begin Date specified on the reservation when the package was attached is the start date for the period. The End Date specified on the reservation when the package was attached is the end date for the period. If no Begin Date and/or End Date are specified when the package is attached to the reservation, the Begin Date is assumed to be the arrival date and the End Date is assumed to be the departure date of the reservation, irrespective of when the package is attached to the reservation.","properties":{"night1":{"description":"Night 1 indicator.","type":"boolean"},"night10":{"description":"Night 10 indicator.","type":"boolean"},"night11":{"description":"Night 11 indicator.","type":"boolean"},"night12":{"description":"Night 12 indicator.","type":"boolean"},"night13":{"description":"Night 13 indicator.","type":"boolean"},"night14":{"description":"Night 14 indicator.","type":"boolean"},"night2":{"description":"Night 2 indicator.","type":"boolean"},"night3":{"description":"Night 3 indicator.","type":"boolean"},"night4":{"description":"Night 4 indicator.","type":"boolean"},"night5":{"description":"Night 5 indicator.","type":"boolean"},"night6":{"description":"Night 6 indicator.","type":"boolean"},"night7":{"description":"Night 7 indicator.","type":"boolean"},"night8":{"description":"Night 8 indicator.","type":"boolean"},"night9":{"description":"Night 9 indicator.","type":"boolean"}},"type":"object"},"customStaySchedule":{"description":"This user defined schedule lets you enter a posting rhythm over a 14-day period, starting with the arrival date, by assigning the day (number) within a guest stay for posting this package price.","properties":{"night1":{"description":"Night 1 indicator.","type":"boolean"},"night10":{"description":"Night 10 indicator.","type":"boolean"},"night11":{"description":"Night 11 indicator.","type":"boolean"},"night12":{"description":"Night 12 indicator.","type":"boolean"},"night13":{"description":"Night 13 indicator.","type":"boolean"},"night14":{"description":"Night 14 indicator.","type":"boolean"},"night2":{"description":"Night 2 indicator.","type":"boolean"},"night3":{"description":"Night 3 indicator.","type":"boolean"},"night4":{"description":"Night 4 indicator.","type":"boolean"},"night5":{"description":"Night 5 indicator.","type":"boolean"},"night6":{"description":"Night 6 indicator.","type":"boolean"},"night7":{"description":"Night 7 indicator.","type":"boolean"},"night8":{"description":"Night 8 indicator.","type":"boolean"},"night9":{"description":"Night 9 indicator.","type":"boolean"}},"type":"object"},"everyXNightsStartingNightY":{"description":"Post the package every X nights Staring from Night Y.","properties":{"postEveryXNights":{"description":"Occurance of nights when the package needs to be posted and consumed.","type":"integer"},"startOnNightY":{"description":"Starting night for consumption and posting prices.","type":"integer"}},"type":"object"},"type":{"$ref":"#/components/schemas/rsv_read_postingRhythmType","description":"Posting Rhythm for the package."}},"type":"object"},"rsv_read_packages":{"description":"Response to fetch package availability with the data, success and warnings or errors.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"reservationPackages":{"description":"A collection of Service objects. This is the collection of all services associated with any part of this reservation (the reservation in its entirety, one or more guests, or one or more room stays). Which services are attributable to which part is determined by each object's ServiceRPHs collection.","properties":{"inventoryItems":{"$ref":"#/components/schemas/rsv_read_resInventoryItemsType","description":"A collection of items that are available and successfully held."},"reservationPackage":{"description":"A Service object represents a package provided to guests. Service packages may have associated inventory and charges.","items":{"$ref":"#/components/schemas/rsv_read_reservationPackageType"},"maxItems":4000,"type":"array"}},"type":"object"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_paragraphType":{"description":"An indication of a new paragraph for a sub-section of a formatted text message.","properties":{"text":{"$ref":"#/components/schemas/rsv_read_formattedTextTextType","description":"Formatted text content."}},"type":"object"},"rsv_read_parameterType":{"description":"Name value pair type that will hold generic parameter information. Only use this type when the parameters being passed are too dynamic to be defined.","properties":{"parameterName":{"description":"Name of the parameter.","type":"string"},"parameterValue":{"description":"Value of the parameter.","type":"string"}},"type":"object"},"rsv_read_parametersType":{"description":"Collection of generic Name-Value-Pair parameters.","items":{"$ref":"#/components/schemas/rsv_read_parameterType"},"maxItems":4000,"type":"array"},"rsv_read_payeeInfoType":{"description":"Payee information.","properties":{"payeeAddress":{"$ref":"#/components/schemas/rsv_read_addressInfoType","description":"Address of the payee."},"payeeId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Opera name id of the payee."},"payeeName":{"description":"Name of the payee.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_payloadType":{"description":"Fiscal Payload Type.","enum":["CheckOut","FolioGeneration"],"type":"string"},"rsv_read_personNameType":{"description":"This provides name information for a person.","properties":{"givenName":{"description":"Given name, first name or names.","maxLength":40,"minLength":0,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"middleName":{"description":"The middle name of the person name.","maxLength":40,"minLength":0,"type":"string"},"namePrefix":{"description":"Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)","maxLength":40,"minLength":0,"type":"string"},"nameTitle":{"description":"Degree or honors (e.g., Ph.D., M.D.)","maxLength":80,"minLength":0,"type":"string"},"nameType":{"$ref":"#/components/schemas/rsv_read_personNameTypeType","description":"Type of name of the individual, such as former, nickname, alternate or alias name."},"salutation":{"description":"Salutation of the profile","type":"string"},"surname":{"description":"Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_personNameTypeType":{"description":"Person's name in an external system.","enum":["Primary","Alternate","Incognito","External","Phonetic"],"type":"string"},"rsv_read_phoneNumberType":{"description":"Phone number","maxLength":40,"minLength":0,"type":"string"},"rsv_read_pkgInventoryItemType":{"properties":{"articleNumber":{"description":"Article Number of the inventory item.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Description of the inventory item.","maxLength":200,"minLength":0,"type":"string"},"itemId":{"description":"Identifier for the inventory item.","type":"integer"},"quantity":{"description":"Quantity of the inventory item allocated to the package.","type":"integer"}},"type":"object"},"rsv_read_pointsType":{"description":"The Redeem Points contains the number of points required to book a room type.","properties":{"awardsType":{"description":"Awards type for the award type rate code.","type":"string"},"points":{"description":"No of points required to book this Room Stay.","type":"integer"}},"type":"object"},"rsv_read_policyAmountPercentType":{"description":"Defines the percentage basis for calculating the fee amount or the amount.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"basisType":{"$ref":"#/components/schemas/rsv_read_policyBasisTypeType","description":"Provides the basis for how the amount of the guarantee is calculated."},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"},"nights":{"description":"The number of nights of the hotel stay that are used to calculate the fee amount.","type":"integer"},"percent":{"description":"The percentage used to calculate the amount.","maximum":100,"minimum":0,"type":"number"}},"type":"object"},"rsv_read_policyBasisTypeType":{"description":"Full Amount.","enum":["FlatAmount","Percentage","Nights","NightPercentage","FullAmount"],"type":"string"},"rsv_read_policyDeadlineType":{"description":"Cancellation deadline, absolute or relative.","properties":{"absoluteDeadline":{"description":"Defines the absolute deadline in Property TimeZone. Either this or the offset attributes may be used. Uses the hotel's time zone.","format":"date-time","type":"string"},"offsetDropTime":{"description":"Time on offset day the cancellation penalties applies. Uses the hotel's time zone.","format":"date-time","type":"string"},"offsetFromArrival":{"description":"The number of days before arrival that allows cancellation without penalties.","type":"integer"},"offsetFromBookingDate":{"description":"The number of days after booking deposit must be paid.","type":"integer"}},"type":"object"},"rsv_read_postingIntervalFrequency":{"description":"Specifies the frequency at which charges are posted for the rate plan on the reservation.","enum":["Nightly","Weekly","Monthly"],"type":"string"},"rsv_read_postingIntervalType":{"description":"Posting Interval details for the reservation including begin/end dates, amount and frequency for each posting interval cycle on the reservation. Only available to be returned for extended stay reservations with at least 1 rate code with either a weekly or monthly posting interval.","properties":{"beginDate":{"description":"Begin Date of the Posting Interval.","format":"date","type":"string"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","type":"string"},"endDate":{"description":"End Date of the Posting Interval.","format":"date","type":"string"},"frequency":{"$ref":"#/components/schemas/rsv_read_postingIntervalFrequency","description":"Specifies the frequency at which charges are posted for the rate plan on the reservation."},"postingAmount":{"description":"The amount to be posted for the rate plan on the begin date of the posting interval.","type":"number"},"rateCode":{"description":"Rate code used for the reservation.","type":"string"}},"type":"object"},"rsv_read_postingRhythmType":{"description":"Simple type for posting Rhythm types.","enum":["EveryNight","ArrivalNight","EveryXNightsStartingNightY","CertainNightsOfTheWeek","LastNight","EveryNightExceptArrivalNight","EveryNightExceptLast","EveryNightExceptFirstAndLast","CustomStaySchedule","CustomNightSchedule","FloatingAllowancePerStay","TicketPosting"],"type":"string"},"rsv_read_preArrivalMemberReservationType":{"properties":{"arrivalDate":{"description":"Arrival Date.","format":"date","type":"string"},"createDateTime":{"description":"Date on which Reservation is Created. Uses the hotel's time zone.","format":"date-time","type":"string"},"membershipId":{"description":"Membership Card number.","maxLength":80,"minLength":0,"type":"string"},"reservationIdList":{"$ref":"#/components/schemas/rsv_read_reservationIdList","description":"Reservation Confirmation Number of the External System."}},"type":"object"},"rsv_read_preArrivalMemberReservationsDetails":{"properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"preArrivalMemberReservationType":{"description":"Collection of PreArrivalMemberReservations.","items":{"$ref":"#/components/schemas/rsv_read_preArrivalMemberReservationType"},"type":"array"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_preArrivalReviewStatusType":{"description":"Simple type for Pre-Arrival Review Status.","enum":["Reviewed","NotReviewed","Modified"],"type":"string"},"rsv_read_preConfiguredRoutingInstrListType":{"description":"Set of Pre-Configured Routing Instructions.","items":{"$ref":"#/components/schemas/rsv_read_preConfiguredRoutingInstrType"},"maxItems":4000,"type":"array"},"rsv_read_preConfiguredRoutingInstrType":{"description":"Routing can be promotion code complimentary routing or profile routing.","properties":{"autoPopulateRouting":{"description":"A flag which determines whether the Pre-configured Routing Instruction has to be automatically populated for this profile or not.","maxLength":20,"minLength":0,"type":"string"},"beginDate":{"description":"This is the Begin date for the Default Routing Instruction selected.","format":"date","type":"string"},"billingInstructions":{"$ref":"#/components/schemas/rsv_read_billingInstructionsType","description":"Set of Billing Instruction codes as part of the Pre-configured Routing Instructions."},"compRoutingInstructionType":{"$ref":"#/components/schemas/rsv_read_promoCodeCompRoutingType","description":"PromotionCode RoutingInstruction Details for CompilementaryRouting"},"endDate":{"description":"This is the End date for the Default Routing Instruction selected.","format":"date","type":"string"},"ratePlanCode":{"description":"This is the actual rate code. This will be populated only for Pre-configured Routing Instructions for RateCodes.","maxLength":20,"minLength":0,"type":"string"},"reservationProfile":{"$ref":"#/components/schemas/rsv_read_resAttachedProfileType","description":"Profile on the reservation."},"transactionCodes":{"$ref":"#/components/schemas/rsv_read_trxCodesInfoType","description":"Set of transaction codes as part of the Pre-configured Routing Instructions."}},"type":"object"},"rsv_read_preConfiguredRoutingInstructions":{"description":"This is the Response Message to the request for Pre-Configured Routing Instructions.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"routingInstructions":{"$ref":"#/components/schemas/rsv_read_preConfiguredRoutingInstrListType","description":"Collection of Routing Instructions which have been Pre-Configured."},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_preferenceType":{"description":"Guest Preference details for the profile.","properties":{"copyToProfile":{"description":"Specifies whether to copy the reservation preference to the profile or not.","type":"boolean"},"description":{"description":"Preference Description for display purposes.","maxLength":2000,"minLength":0,"type":"string"},"excludedPreferencesCount":{"description":"Specifies the count of preferences excluded for the attached reservation preference.","type":"integer"},"global":{"description":"Whether this preference is property specific or not.","type":"boolean"},"hotels":{"description":"If specified preference belongs to the Hotels listed, otherwise it is a global preference.","items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"preferenceId":{"maxLength":20,"minLength":0,"type":"string"},"preferenceValue":{"description":"Preference value for display purposes.","maxLength":200,"minLength":0,"type":"string"},"source":{"description":"Source of the preference.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_preferenceTypeType":{"description":"Preference details for the profile.","properties":{"availableQuantity":{"description":"Available quantity of preferences (maximum quantity - Existing preferences)per preference group.","type":"integer"},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"maxQuantity":{"description":"Maximum quantity of preferences allowed per preference group.","type":"integer"},"maxResortUsedQuantity":{"description":"Maximum quantity of preferences used by any resort per preference group.","type":"integer"},"preference":{"description":"Collection of Preferences for the profile.","items":{"$ref":"#/components/schemas/rsv_read_preferenceType"},"maxItems":4000,"type":"array"},"preferenceType":{"description":"Preference group code.","maxLength":20,"minLength":0,"type":"string"},"preferenceTypeDescription":{"description":"Preference group description.","type":"string"},"reservationPreference":{"description":"Whether this preference is reservation preference or not.","type":"boolean"},"sequence":{"description":"Preference Sequence.","type":"string"}},"type":"object"},"rsv_read_prepaidCardType":{"description":"Holds fixed charge information.","properties":{"amount":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Prepaid Card Amount."},"cardNo":{"description":"Prepaid card / account number.","maxLength":80,"minLength":0,"type":"string"},"cardNumberMasked":{"description":"Masked Prepaid card / account number.","maxLength":80,"minLength":0,"type":"string"},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"firstName":{"description":"Given name, first name or names.","maxLength":80,"minLength":0,"type":"string"},"giftCard":{"description":"Indicates a gift card type.","type":"boolean"},"hotelId":{"description":"Hotel context for the Reservations.","maxLength":20,"minLength":0,"type":"string"},"interfaceId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"The unique ID for the Interface."},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"name":{"description":"Family name, last name or Company Name.","maxLength":80,"minLength":0,"type":"string"},"profileId":{"$ref":"#/components/schemas/rsv_read_profileId","description":"Card / Account holder name ID"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","type":"string"},"reservationId":{"$ref":"#/components/schemas/rsv_read_reservationId","description":"The unique ID of the reservation to which this record applies."}},"type":"object"},"rsv_read_prepaidCardsType":{"description":"Holds fixed charge detail.","items":{"$ref":"#/components/schemas/rsv_read_prepaidCardType"},"maxItems":4000,"type":"array"},"rsv_read_primaryShareTypeType":{"enum":["Primary","NonPrimary"],"type":"string"},"rsv_read_productSourceType":{"description":"Sources of Products","enum":["Reservation","RateHeader","RateDetail"],"type":"string"},"rsv_read_profileCashieringDetailType":{"description":"The type contains routing instructions for the profile.","properties":{"fiscalGuestType":{"description":"Guest type code.","maxLength":20,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel Code for which the routing instructions are provided for a profile.","maxLength":20,"minLength":0,"type":"string"},"paymentMethod":{"$ref":"#/components/schemas/rsv_read_codeDescriptionType","description":"Payment Method Details."},"routingInstructions":{"$ref":"#/components/schemas/rsv_read_profileRoutingInstructionsType","description":"Set of preconfigured transaction codes."},"taxType":{"description":"Tax type code.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_profileCashieringType":{"description":"Contains cashiering related details for the profile","properties":{"currencyCode":{"description":"The code specifying a monetary unit. Use ISO 4217, three alpha code.","maxLength":20,"minLength":0,"type":"string"},"currencySymbol":{"description":"The symbol for the currency, e.g, for currencyCode USD the symbol is $.","maxLength":10,"minLength":0,"type":"string"},"decimalPlaces":{"description":"Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).","type":"integer"}},"type":"object"},"rsv_read_profileCommissionType":{"description":"This is the preconfigured routing instruction type.","properties":{"bankAccount":{"description":"Bank account used for the commission for a profile.","maxLength":20,"minLength":0,"type":"string"},"commissionCode":{"description":"commission Code for a profile.","maxLength":20,"minLength":0,"type":"string"},"currencyCode":{"description":"The code specifying a monetary unit. Use ISO 4217, three alpha code.","maxLength":20,"minLength":0,"type":"string"},"currencySymbol":{"description":"The symbol for the currency, e.g, for currencyCode USD the symbol is $.","maxLength":10,"minLength":0,"type":"string"},"decimalPlaces":{"description":"Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).","type":"integer"},"hotelId":{"description":"Hotel Code for the commission being used for a profile.","maxLength":20,"minLength":0,"type":"string"},"paymentMethod":{"$ref":"#/components/schemas/rsv_read_commissionPaymentMethods","description":"Type of payment associated with the bank account."}},"type":"object"},"rsv_read_profileDeliveryMethod":{"description":"Delivery Information type to the profile.","properties":{"deliveryId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Delivery ID. It will be empty in case of new delivery method."},"deliveryModule":{"$ref":"#/components/schemas/rsv_read_profileDeliveryModuleType","description":"Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc.."},"deliveryType":{"description":"Delivery type can have a value EMAIL, ELECTRONIC etc and it depends on the parameter set in OPERA Control.","maxLength":20,"minLength":0,"type":"string"},"deliveryValue":{"description":"Delivery value holds the corresponding value of the delivery type..","maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"description":"Property that has delivery methods configured.","maxLength":20,"minLength":0,"type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"}},"type":"object"},"rsv_read_profileDeliveryModuleType":{"description":"Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..","enum":["EfolioExport"],"type":"string"},"rsv_read_profileId":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_profileIdList":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type"},"maxItems":4000,"type":"array"},"rsv_read_profileMembershipType":{"description":"Detailed information of the memberships.","properties":{"benefits":{"$ref":"#/components/schemas/rsv_read_benefitsType","description":"benefits for the membership."},"centralSetup":{"description":"Indicates how the award points for this membership type will be managed.","type":"boolean"},"comment":{"$ref":"#/components/schemas/rsv_read_paragraphType","description":"Additional comments regarding to the membership."},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"currentPoints":{"description":"Profile MemberShip Points.","type":"number"},"downgrade":{"$ref":"#/components/schemas/rsv_read_downgradeType","description":"Defines how downgrading will be handled for this membership."},"downgradeDescription":{"description":"Indicates information regarding the member's possible downgrades.","maxLength":32000,"minLength":0,"type":"string"},"earningPreference":{"$ref":"#/components/schemas/rsv_read_membershipEarningPreferenceType","description":"Earning preference to the membership."},"effectiveDate":{"description":"Indicates the starting date.","format":"date","type":"string"},"enrollmentResort":{"description":"Resort/CRO where enrollment is done.","maxLength":20,"minLength":0,"type":"string"},"enrollmentSource":{"description":"Source from where the enrollment is done.","maxLength":20,"minLength":0,"type":"string"},"excludeFromBatch":{"description":"True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false.","type":"boolean"},"expireDate":{"description":"Indicates the ending date.","format":"date","type":"string"},"expireDateExclusiveIndicator":{"description":"When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).","type":"boolean"},"inactive":{"description":"Indicates whether membership is active or inactive.","type":"boolean"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"memberStatus":{"description":"Indicates where the guest is in the membership enrollment process.","maxLength":20,"minLength":0,"type":"string"},"membershipClass":{"description":"Indicates the membership class.","type":"string"},"membershipEnrollmentCode":{"description":"Indicates how the guest enrolled in the program.","maxLength":20,"minLength":0,"type":"string"},"membershipId":{"description":"Card Number of the membership.","type":"string"},"membershipIdNo":{"description":"Membership ID Number.","type":"integer"},"membershipLevel":{"description":"Indicates the membership level.","type":"string"},"membershipLevelDescription":{"description":"Indicates the membership level description.","maxLength":200,"minLength":0,"type":"string"},"membershipType":{"description":"Type of membership.","type":"string"},"nameOnCard":{"description":"Name to be displayed on the membership card.","type":"string"},"newMembershipNumber":{"description":"Card Number of the membership.","type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"playerRanking":{"description":"Ranking assigned to the Player Profile by the Gaming system.","type":"integer"},"pointsLabel":{"description":"Label used to refer to points for this membership type","maxLength":20,"minLength":0,"type":"string"},"preferredCard":{"description":"Preferred Card.","type":"boolean"},"primaryMembership":{"description":"Boolean indicator set to True implies membership is a Primary Membership.","type":"boolean"},"primaryMembershipYn":{"description":"Indicator if Membership is a Primary Membership.","maxLength":1,"minLength":0,"type":"string"},"programDescription":{"description":"Description of the membership program.","type":"string"},"rating":{"description":"Value Rating Type Description for this membership.","type":"string"},"reIssueNewCard":{"$ref":"#/components/schemas/rsv_read_cardReIssueType","description":"The status of issuing new membership card to the member."},"signupDate":{"description":"Indicates when the member signed up for the loyalty program.","format":"date","type":"string"},"tierAdministration":{"$ref":"#/components/schemas/rsv_read_tierAdministrationType","description":"Defines the degree of participation for this membership in the tier management portion of the program."},"upgradeDescription":{"description":"Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.","maxLength":32000,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_profileNameType":{"description":"This provides name information for a person.","properties":{"fullName":{"description":"Full display Name.","maxLength":200,"minLength":0,"type":"string"},"givenName":{"description":"Given name, first name or names.","maxLength":40,"minLength":0,"type":"string"},"middleName":{"description":"The middle name of the person name.","maxLength":40,"minLength":0,"type":"string"},"name":{"description":"Family name, last name or Company Name.","maxLength":40,"minLength":0,"type":"string"},"namePrefix":{"description":"Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)","maxLength":40,"minLength":0,"type":"string"},"nameTitle":{"description":"Degree or honors (e.g., Ph.D., M.D.)","maxLength":80,"minLength":0,"type":"string"},"nameType":{"$ref":"#/components/schemas/rsv_read_personNameTypeType","description":"Type of name of the individual, such as former, nickname, alternate or alias name."}},"type":"object"},"rsv_read_profileRestrictions":{"properties":{"reason":{"description":"Restriction reason associated with the current profile.","maxLength":20,"minLength":0,"type":"string"},"reasonDescription":{"description":"Description of restriction reason.","maxLength":2000,"minLength":0,"type":"string"},"restricted":{"description":"True indicates there are restrictions associated with the current profile.","type":"boolean"}},"type":"object"},"rsv_read_profileRoutingInstructionsType":{"description":"The type contains routing instructions for the profile.","properties":{"autoPopulateRouting":{"description":"A flag which determines whether the instructions has to be automatically populated for this profile or not.","type":"boolean"},"billingInstructions":{"$ref":"#/components/schemas/rsv_read_billingInstructionsType","description":"Set of preconfigured Billing Instruction results."},"transactionCodes":{"$ref":"#/components/schemas/rsv_read_trxCodesInfoType","description":"Set of preconfigured transaction codes."}},"type":"object"},"rsv_read_profileStatusType":{"enum":["Active","Inactive"],"type":"string"},"rsv_read_profileType":{"description":"Type provides the detailed information about the profile and its children.","properties":{"addresses":{"description":"List of customer addresses.","properties":{"addressInfo":{"description":"Collection of Detailed information on an address for the customer.","items":{"$ref":"#/components/schemas/rsv_read_addressInfoType"},"maxItems":4000,"type":"array"},"count":{"description":"Total number of rows returned","type":"integer"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"cashiering":{"$ref":"#/components/schemas/rsv_read_profileCashieringType","description":"Contains cashiering related details for the profile"},"comments":{"description":"List of Notes for the customer.","properties":{"commentInfo":{"description":"Collection of Detailed information on comments for the customer.","items":{"$ref":"#/components/schemas/rsv_read_commentInfoType"},"maxItems":4000,"type":"array"},"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"commissionInfoList":{"description":"Contains commission related details for the profile.","items":{"$ref":"#/components/schemas/rsv_read_profileCommissionType"},"maxItems":4000,"type":"array"},"company":{"$ref":"#/components/schemas/rsv_read_companyType","description":"Detailed company information for this profile."},"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"customer":{"$ref":"#/components/schemas/rsv_read_customerType","description":"Detailed customer information for this profile."},"eCertificates":{"$ref":"#/components/schemas/rsv_read_eCertificatesType","description":"E-Certificate assosiated with the profile."},"eligibleForFiscalFolio":{"description":"Eligible for Fiscal Folio/Payload generation.","maxLength":20,"minLength":0,"type":"string"},"emails":{"description":"List of email address for the customer.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"emailInfo":{"description":"Collection of Detailed information on an eMail address for the customer.","items":{"$ref":"#/components/schemas/rsv_read_emailInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"guestAge":{"description":"Age of a guest in years.","minimum":0,"type":"integer"},"hasCommission":{"description":"Populates true if the profile has commission configured false otherwise.","type":"boolean"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"lastStayInfo":{"$ref":"#/components/schemas/rsv_read_lastStayInfoType","description":"Information on last stay of the profile."},"markAsRecentlyAccessed":{"description":"Mark this profile as recently accessed.","type":"boolean"},"markForHistory":{"description":"\"true\" setting marks the profile to be kept from being purged, once the profile is marked inactive.","type":"boolean"},"ownerCode":{"description":"Owner Code associated to the profile.","maxLength":40,"minLength":0,"type":"string"},"preferenceCollection":{"description":"List of customer preferences.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"preferenceType":{"description":"Collection of Detailed information on preferences of the customer.","items":{"$ref":"#/components/schemas/rsv_read_preferenceTypeType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"profileDeliveryMethods":{"description":"List of Delivery methods configured against a Property for this Profile.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"profileDeliveryMethod":{"description":"Collection of delivery methods for this Profile.","items":{"$ref":"#/components/schemas/rsv_read_profileDeliveryMethod"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"profileImage":{"$ref":"#/components/schemas/rsv_read_imageSetType","description":"The profile image."},"profileMemberships":{"description":"List of loyalty program(s) the profile is subscribed to.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"profileMembership":{"description":"Collection of Detailed information on memberships for the customer.","items":{"$ref":"#/components/schemas/rsv_read_profileMembershipType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"profileRestrictions":{"$ref":"#/components/schemas/rsv_read_profileRestrictions","description":"Detailed information on restrictions associated with the profile."},"profileType":{"$ref":"#/components/schemas/rsv_read_profileTypeType","description":"Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact."},"protectedBy":{"description":"What level this profile is protected.","maxLength":40,"minLength":0,"type":"string"},"registeredProperty":{"description":"Hotel which this profile is registered with. This attribute is not used for configuration.","maxLength":20,"minLength":0,"type":"string"},"relationships":{"description":"Contains a collection of profiles that have a relationship with this profile.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"relationship":{"description":"A collection of the profiles that have a relationship with this profile.","items":{"$ref":"#/components/schemas/rsv_read_relationshipInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"relationshipsSummary":{"description":"Contains a collection of profiles that have a relationship with this profile.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"relationship":{"description":"A collection of the profiles summary that have a relationship with this profile.","items":{"$ref":"#/components/schemas/rsv_read_relationshipInfoSummaryType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"requestForHotel":{"description":"Hotel which this profile is to be registered. This attribute is only used during creation of profile.","maxLength":20,"minLength":0,"type":"string"},"reservationInfoList":{"$ref":"#/components/schemas/rsv_read_reservationHistoryFutureInfoType","description":"Collection of Detailed information on history and future reservations associated with the profile."},"roomOwnershipsList":{"description":"Room Ownership records.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"roomOwnershipInfo":{"description":"Collection of Detailed information on Room Ownership records.","items":{"$ref":"#/components/schemas/rsv_read_roomOwnershipType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"showInactiveRoomOwners":{"description":"Flag to show inactive Room Owners.","type":"boolean"},"statusCode":{"$ref":"#/components/schemas/rsv_read_profileStatusType","description":"Status of the profile. Active/Inactive"},"stayReservationInfoList":{"$ref":"#/components/schemas/rsv_read_reservationStayHistoryFutureInfoType","description":"Collection of Detailed information on history and future reservations associated with the profile."},"telephones":{"description":"List of Telephone Number Information","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"telephoneInfo":{"description":"Collection of Detailed information on telephone/fax for the customer.","items":{"$ref":"#/components/schemas/rsv_read_telephoneInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"traceCode":{"description":"Trace Code associated to the profile.","maxLength":40,"minLength":0,"type":"string"},"uRLs":{"description":"List of Information on a URL for the customer.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"totalResults":{"description":"Total number of rows queried","type":"integer"},"uRLInfo":{"description":"Collection of Detailed information on web url/address for the customer.","items":{"$ref":"#/components/schemas/rsv_read_uRLInfoType"},"maxItems":4000,"type":"array"}},"type":"object"},"userDefinedFields":{"$ref":"#/components/schemas/rsv_read_userDefinedFieldsType","description":"Collections of user defined fields."}},"type":"object"},"rsv_read_profileTypeType":{"description":"The types of Profile handled by the web service.","enum":["Guest","Agent","Company","Group","Source","Employee","Hotel","Vendor","Contact","Purge","BusinessHeader","BillingAccount","Activity","Potential","Account"],"type":"string"},"rsv_read_promoCodeCompRoutingType":{"description":"Promotion Code Complimentary Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit","properties":{"authorizerInfo":{"$ref":"#/components/schemas/rsv_read_authorizerInfoType","description":"The authorizer information for promotion code complimentary routing"},"comments":{"description":"User Defined Comments. Used for promotion code Complimentary Routing.","maxLength":2000,"minLength":0,"type":"string"},"compPreApprovalRequired":{"description":"Flag to indicate that pre approval is required for promotion code complimentary routing .","type":"boolean"},"covers":{"description":"Number of covers for this promotion code complimentary routing instruction.","type":"number"},"creditLimit":{"description":"Allowable credit amount for this promotion code complimentary routing instruction. Null value means no limit, 0 equals zero.","type":"number"},"duration":{"description":"Duration of this instruction for promotion code complimentary Routing","properties":{"daily":{"description":"Flag to indicate if the routing instruction is a daily instruction for promotion code complimentary routing","type":"boolean"},"friday":{"type":"boolean"},"monday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"thursday":{"type":"boolean"},"timeSpan":{"$ref":"#/components/schemas/rsv_read_timeSpanType"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"}},"type":"object"},"folioNo":{"description":"The folio number where it is applied for promotion code complimentary routing.","type":"integer"},"membershipId":{"description":"Membership number for promotion code complimentary routing","maxLength":100,"minLength":0,"type":"string"},"percentageLimit":{"description":"The promotion code complimentary routing limit percentage allowed for this routing instruction.","type":"number"},"promotionCode":{"description":"Promotion code for Complimentary Routing","maxLength":20,"minLength":0,"type":"string"},"promptForAuthorizer":{"description":"Flag to indicate to prompt the Authorizer for promotion code complimentary routing.","type":"boolean"}},"type":"object"},"rsv_read_promotionType":{"description":"Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation. \u003cp\u003eNote: For putReservation when promotion type element is sent with no value, existing promotion codes on the reservation will be removed.\u003c/p\u003e","properties":{"couponCode":{"description":"Promotion Coupon Code when promotion is setup to have a valid coupon code.","maxLength":40,"minLength":0,"type":"string"},"promotionCode":{"description":"Promotion code associated with the rate plan.","maxLength":20,"minLength":0,"type":"string"},"promotionName":{"description":"Promotion code Name associated with the rate plan.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_queueTextInfoType":{"description":"Information regarding the message sent to guest.","properties":{"sentBy":{"description":"User name of the user who sent message.","maxLength":40,"minLength":0,"type":"string"},"sentTime":{"description":"Time the text was last sent to the user. Uses the hotel's time zone.","format":"date-time","type":"string"}},"type":"object"},"rsv_read_ratesType":{"description":"Individual rate amount.","properties":{"rate":{"description":"The Rate contains a collection of elements that define the amount of the rate, associated fees, additional occupant amounts. Taxes can be broken out or included within the various amounts. A currency can be associated to each amount.","items":{"$ref":"#/components/schemas/rsv_read_amountType"},"maxItems":4000,"type":"array"}},"type":"object"},"rsv_read_relationshipAddressType":{"description":"Provides address information for a Relationship.","properties":{"addressLine":{"description":"When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.","items":{"maxLength":80,"minLength":0,"type":"string"},"maxItems":4,"type":"array"},"city":{"description":"City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).","maxLength":40,"minLength":0,"type":"string"},"country":{"description":"Country name (e.g., Ireland).","maxLength":200,"minLength":0,"type":"string"},"postalCode":{"description":"Post Office Code number.","maxLength":15,"minLength":0,"type":"string"},"state":{"description":"State or Province name (e.g., Texas).","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_relationshipInfoSummaryType":{"description":"RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.","properties":{"masterAccountDetails":{"$ref":"#/components/schemas/rsv_read_masterAccountInfoType","description":"Refer to Master Profile type document."},"relationshipID":{"description":"Relationship identifier.","maxLength":80,"minLength":0,"type":"string"},"relationshipProfile":{"$ref":"#/components/schemas/rsv_read_relationshipProfileSummaryType","description":"Refer to Relationship Profile Summary type document."},"sourceRelation":{"description":"Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).","maxLength":20,"minLength":0,"type":"string"},"sourceRelationDescription":{"description":"Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).","maxLength":200,"minLength":0,"type":"string"},"targetRelation":{"description":"Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).","maxLength":20,"minLength":0,"type":"string"},"targetRelationDescription":{"description":"Displays the description of the target relation(Target Profile).","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_relationshipInfoType":{"description":"Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.","properties":{"id":{"description":"Relationship identifier.","maxLength":80,"minLength":0,"type":"string"},"relation":{"description":"Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).","maxLength":20,"minLength":0,"type":"string"},"relationDescription":{"description":"Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).","maxLength":200,"minLength":0,"type":"string"},"relationshipProfile":{"$ref":"#/components/schemas/rsv_read_relationshipProfileType","description":"Refer to Relationship Profile type document."},"targetRelation":{"description":"Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).","maxLength":20,"minLength":0,"type":"string"},"targetRelationDescription":{"description":"Displays the description of the target relation(Target Profile).","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_relationshipProfileSummaryType":{"properties":{"address":{"$ref":"#/components/schemas/rsv_read_relationshipAddressType","description":"Information on address details for the customer/company"},"companyName":{"description":"Name of the company.","maxLength":40,"minLength":0,"type":"string"},"customerName":{"description":"Name of the customer","maxLength":40,"minLength":0,"type":"string"},"emailAddress":{"description":"Defines the e-mail address.","maxLength":2000,"minLength":0,"type":"string"},"ownerCode":{"description":"Unique Code to identify the owner.","maxLength":20,"minLength":0,"type":"string"},"primary":{"description":"Indicates if this relationship is the primary relationship.","type":"boolean"},"primaryOwnerCode":{"description":"When true, this is a primary owner.","type":"boolean"},"profileIdList":{"$ref":"#/components/schemas/rsv_read_uniqueIDListType","description":"Original profile details for which the relationships was created"},"profileStatus":{"$ref":"#/components/schemas/rsv_read_profileStatusType","description":"Status of the profile. Active/Inactive"},"profileType":{"$ref":"#/components/schemas/rsv_read_profileTypeType","description":"Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact."},"telephoneNumber":{"description":"Telephone number assigned to a single location","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_relationshipProfileType":{"properties":{"address":{"$ref":"#/components/schemas/rsv_read_addressInfoType","description":"Information on address details for the customer/company"},"company":{"$ref":"#/components/schemas/rsv_read_companyType","description":"Detailed information of the Company."},"customer":{"$ref":"#/components/schemas/rsv_read_customerType","description":"Detailed information of the customer"},"email":{"$ref":"#/components/schemas/rsv_read_emailInfoType","description":"Information on email address for the customer/company"},"id":{"description":"Relationship identifier.","maxLength":80,"minLength":0,"type":"string"},"primary":{"description":"Indicates if this relationship is the primary relationship.","maxLength":20,"minLength":0,"type":"string"},"primaryOwner":{"$ref":"#/components/schemas/rsv_read_ownerType","description":"Primary Owner of the profile"},"profileIdList":{"$ref":"#/components/schemas/rsv_read_uniqueIDListType","description":"Original profile details for which the relationships was created"},"profileType":{"$ref":"#/components/schemas/rsv_read_profileTypeType","description":"Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact."},"statusCode":{"$ref":"#/components/schemas/rsv_read_profileStatusType","description":"Status of the profile. Active/Inactive"},"telephone":{"$ref":"#/components/schemas/rsv_read_telephoneInfoType","description":"Information on telephone details for the customer/company"},"uRLs":{"$ref":"#/components/schemas/rsv_read_uRLInfoType","description":"Information on web url/address for the customer/company"}},"type":"object"},"rsv_read_requestActionType":{"enum":["Create","Remove","Query"],"type":"string"},"rsv_read_resAccessRestrictionType":{"description":"Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.","enum":["Change","Cancel","ChangeOrCancel"],"type":"string"},"rsv_read_resAccompanyGuestInfoType":{"properties":{"alternateFirstName":{"description":"Alternate first name","type":"string"},"alternateFullName":{"description":"Alternate full name","type":"string"},"alternateLastName":{"description":"Alternate last name.","type":"string"},"externalReferences":{"$ref":"#/components/schemas/rsv_read_externalReferencesType","description":"External References information for this Profile. Will be returned in getReservations and getHotelReservations when the 'profileExternalReferencesToFetch' query parameter is sent."},"firstName":{"description":"Given name, first name or names","type":"string"},"fullName":{"description":"String representation of the full name","type":"string"},"lastName":{"description":"Family name, last name.","type":"string"},"profileIdList":{"$ref":"#/components/schemas/rsv_read_profileIdList","description":"Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id."},"registrationCardNo":{"description":"Unique identifier of the police registration card number.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_resAccompanyGuestListType":{"description":"Collection of accompany guests","items":{"$ref":"#/components/schemas/rsv_read_resAccompanyGuestInfoType"},"maxItems":4000,"type":"array"},"rsv_read_resAttachedProfileListType":{"items":{"$ref":"#/components/schemas/rsv_read_resAttachedProfileType"},"maxItems":4000,"type":"array"},"rsv_read_resAttachedProfileType":{"properties":{"externalReferences":{"$ref":"#/components/schemas/rsv_read_externalReferencesType","description":"External References information for this Profile. Will be returned in getReservations and getHotelReservations when the 'profileExternalReferencesToFetch' query parameter is sent."},"name":{"description":"Attached profile name","type":"string"},"profileIdList":{"$ref":"#/components/schemas/rsv_read_profileIdList","description":"Collection of unique profile identifiers"},"reservationProfileType":{"$ref":"#/components/schemas/rsv_read_resProfileTypeType"}},"type":"object"},"rsv_read_resAwardsType":{"description":"Membership Awards code applied on the reservation.","properties":{"membershipNo":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Membership program under which the award is applied."},"originalRoomType":{"description":"Room Type before the Upgrade Award.","maxLength":20,"minLength":0,"type":"string"},"upgradeRoomType":{"description":"Room Type after the Upgrade Award.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_resCancelPenaltyType":{"description":"The CancelPenalty class defines the cancellation policy of the hotel facility.","properties":{"amountPercent":{"$ref":"#/components/schemas/rsv_read_policyAmountPercentType","description":"Cancellation fee expressed as a fixed amount, or percentage of/or room nights."},"deadline":{"$ref":"#/components/schemas/rsv_read_policyDeadlineType","description":"Cancellation deadline, absolute or relative."},"effective":{"description":"Indicator if Cancellation Penalty is currently applicable or not.","type":"boolean"},"formattedRule":{"description":"Formatted Text Rule of the Cancellation Penalty.","maxLength":2000,"minLength":0,"type":"string"},"manual":{"description":"Flag to indicate if the cancellation policy is manual.","type":"boolean"},"nonRefundable":{"description":"Indicates if the amount is refundable if booking is canceled.","type":"boolean"},"offsetUnit":{"$ref":"#/components/schemas/rsv_read_offsetUnitType"},"penaltyDescription":{"description":"Text description of the Penalty in a given language.","maxLength":2000,"minLength":0,"type":"string"},"policyCode":{"description":"Policy Code.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_resCancellationPoliciesType":{"description":"A list of reservation cancellation policies.","items":{"$ref":"#/components/schemas/rsv_read_resCancellationPolicyType"},"maxItems":4000,"type":"array"},"rsv_read_resCancellationPolicyType":{"description":"A cancellation policy attached with the reservation.","properties":{"comments":{"description":"Comments attached with the reservation cancellation.","maxLength":2000,"minLength":0,"type":"string"},"percentageDue":{"description":"The percentage amount due for reservation cancellation.","maximum":100,"minimum":0,"type":"number"},"policy":{"$ref":"#/components/schemas/rsv_read_resCancelPenaltyType","description":"Cancellation policy details."},"policyId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Unique ID of the Reservation Policy."},"revenueType":{"$ref":"#/components/schemas/rsv_read_depositCancelRevenueType","description":"Type of reservation."}},"type":"object"},"rsv_read_resCashieringType":{"description":"Cashiering Information for the reservation.","properties":{"bedTaxReporting":{"$ref":"#/components/schemas/rsv_read_bedTaxReportingType","description":"This stores the information for Bed Tax Reporting. Mainly used in Maldives."},"billingPrivileges":{"$ref":"#/components/schemas/rsv_read_billingPrivilegesType","description":"Billing privileges set on the reservation."},"compAccounting":{"$ref":"#/components/schemas/rsv_read_resCompAccountingType","description":"Information regarding comp accounting on the reservation."},"folioTexts":{"$ref":"#/components/schemas/rsv_read_folioTextsType","description":"Additional text fields to display on the folio."},"lastRoomAndTaxPostedDate":{"description":"Date of the last Room And Tax posting. Used primarily to know the date in case of Advance Billing.","format":"date","type":"string"},"reservationPreConfiguredRoutingInstruction":{"$ref":"#/components/schemas/rsv_read_resPreConfiguredRoutingInstrType","description":"Information regarding the selected preconfigured routing instruction on the reservation. This will be used when Multiple Promotion Code Comp Routings is inactive."},"reservationPreConfiguredRoutingInstructions":{"$ref":"#/components/schemas/rsv_read_reservationPreConfiguredRoutingInstructionsType","description":"Information regarding the selected preconfigured routing instructions on the reservation. This will be used when Multiple Promotion Code Comp Routings is active."},"revenuesAndBalances":{"$ref":"#/components/schemas/rsv_read_resRevenueBalanceType","description":"Revenues and Balances Amount summary for the reservation."},"reverseAdvanceCheckInAllowed":{"description":"This attribute is to verify if reverse advance check-in is allowed for the reservation.","type":"boolean"},"reverseCheckInAllowed":{"description":"This attribute is to verify if reverse check-in is allowed for the reservation.","type":"boolean"},"taxType":{"$ref":"#/components/schemas/rsv_read_reservationTaxTypeInfo"},"transactionsPosted":{"description":"Specifies whether reservation has a financial transaction associated with it.","type":"boolean"}},"type":"object"},"rsv_read_resCommunicationType":{"description":"Communication details for a reservation.","properties":{"emails":{"description":"List of email address for the customer.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"emailInfo":{"description":"Collection of Detailed information on an eMail address for the customer.","items":{"$ref":"#/components/schemas/rsv_read_emailInfoType"},"maxItems":4000,"type":"array"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"telephones":{"description":"List of Telephone Number Information","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"telephoneInfo":{"description":"Collection of Detailed information on telephone/fax for the customer.","items":{"$ref":"#/components/schemas/rsv_read_telephoneInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"}},"type":"object"},"rsv_read_resCompAccountingType":{"description":"Information regarding comp accounting on the reservation.","properties":{"authorizer":{"description":"ID of the employee who will act as the host for this guest.","maxLength":40,"minLength":0,"type":"string"},"compPostings":{"description":"Indicates if the Comp Billing/posting Exist","maxLength":5,"minLength":0,"type":"string"},"compType":{"description":"Code used to identify the casino comp type and ranking of a guest.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_resDepositPoliciesType":{"description":"A list of deposit policies attached with the reservation.","items":{"$ref":"#/components/schemas/rsv_read_resDepositPolicyType"},"maxItems":4000,"type":"array"},"rsv_read_resDepositPolicyType":{"description":"A deposit policy attached with the reservation.","properties":{"amountDue":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Total amount due against the reservation deposit."},"amountPaid":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Total amount paid against the reservation deposit."},"comments":{"description":"Comments attached with a deposit.","maxLength":2000,"minLength":0,"type":"string"},"policy":{"$ref":"#/components/schemas/rsv_read_depositPolicyType","description":"Reservation deposit policy details."},"policyId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Unique ID of the Reservation Policy."},"revenueType":{"$ref":"#/components/schemas/rsv_read_depositCancelRevenueType","description":"Type of reservation."}},"type":"object"},"rsv_read_resExpectedTimesType":{"description":"Holds the Arrival and Departure Time Information","properties":{"reservationExpectedArrivalTime":{"description":"Arrival Time. Uses the hotel's time zone.","format":"date-time","type":"string"},"reservationExpectedDepartureTime":{"description":"Departure Time. Uses the hotel's time zone.","format":"date-time","type":"string"}},"type":"object"},"rsv_read_resGuaranteeType":{"description":"Validations type record returned after Validations are done.","properties":{"guaranteeCode":{"description":"Guarantee Code.","maxLength":20,"minLength":0,"type":"string"},"onHold":{"description":"Guarantee Code.","type":"boolean"},"shortDescription":{"description":"Guarantee Code.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_resGuestAdditionalInfoType":{"properties":{"dateOfEntry":{"description":"Entry Date into the country. (Croatian Requirements).","format":"date","type":"string"},"guestClassification":{"description":"Guest Classification for the data export.","maxLength":40,"minLength":0,"type":"string"},"guestStatus":{"description":"Guest Status for the data export.","maxLength":40,"minLength":0,"type":"string"},"lastStay":{"$ref":"#/components/schemas/rsv_read_guestLastStayInfoType","description":"Last Stay information of the guest."},"nextDestination":{"description":"Entry Date into the country. (Croatian Requirements).","type":"string"},"portOfEntry":{"description":"Entry point into the country. (Croatian Requirements).","maxLength":40,"minLength":0,"type":"string"},"preferredRoomType":{"description":"Preferred Room Type of the guest.","maxLength":20,"minLength":0,"type":"string"},"purposeOfStay":{"description":"Purpose of stay. This is field is mandatory for putReservation/postReservation Request when the Advanced Daily Details functionality is not active. When Advanced Daily Details is active, if a value is sent in the roomRateType object then it will take precedence over this value.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_resGuestInfoType":{"description":"Specifies Company or Travel Agent profile using IATA or Corp. No.","properties":{"accompanyGuests":{"$ref":"#/components/schemas/rsv_read_resAccompanyGuestListType","description":"List of guest names that are accompanying the reservation guest"},"address":{"$ref":"#/components/schemas/rsv_read_addressSearchType","description":"Address information that is attached to the reservation guest"},"alternateFullName":{"description":"Alternate full name","type":"string"},"alternateGivenName":{"description":"Alternate given name, first name or names","maxLength":40,"minLength":0,"type":"string"},"alternateSurname":{"description":"Alternate family name, last name.","maxLength":40,"minLength":0,"type":"string"},"anonymization":{"$ref":"#/components/schemas/rsv_read_anonymizationType","description":"Provides information about the guest's anonymization status"},"birthDate":{"description":"Date of birth","format":"date","type":"string"},"email":{"$ref":"#/components/schemas/rsv_read_basicEmailType","description":"Email address"},"externalReferences":{"$ref":"#/components/schemas/rsv_read_externalReferencesType","description":"External References information for this Profile. Will be returned in getReservations and getHotelReservations when the 'profileExternalReferencesToFetch' query parameter is sent."},"fullName":{"description":"Full display name","type":"string"},"givenName":{"$ref":"#/components/schemas/rsv_read_givenNameType","description":"Given name, first name or names"},"guestLastStayInformation":{"$ref":"#/components/schemas/rsv_read_guestLastStayInfoType","description":"Contains information regarding the last stay of this guest."},"guestRestricted":{"description":"True indicates there are restrictions associated with the current profile.","type":"boolean"},"guestRestrictedCode":{"description":"Guest profile restricted reason code","type":"string"},"guestRestrictedReasonDesc":{"description":"Guest profile restricted reason description","type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"membership":{"$ref":"#/components/schemas/rsv_read_membershipInfoType","description":"The Membership object identifying the frequent customer reward program."},"middleName":{"description":"The middle name of the person name","maxLength":40,"minLength":0,"type":"string"},"namePrefix":{"$ref":"#/components/schemas/rsv_read_namePrefixType","description":"Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)"},"nameTitle":{"description":"Degree or honors (e.g., Ph.D., M.D.)","maxLength":20,"minLength":0,"type":"string"},"nameType":{"$ref":"#/components/schemas/rsv_read_nameTypeType"},"nationality":{"$ref":"#/components/schemas/rsv_read_countryNameType","description":"Affiliation or ethnicity to a particular country."},"phoneNumber":{"$ref":"#/components/schemas/rsv_read_phoneNumberType","description":"Phone number"},"registrationCardNo":{"description":"Unique identifier of the police registration card number.","maxLength":40,"minLength":0,"type":"string"},"surname":{"$ref":"#/components/schemas/rsv_read_surnameType","description":"Family name, last name."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"},"vip":{"$ref":"#/components/schemas/rsv_read_vIPType","description":"The supplier's ranking of the customer (e.g., VIP, numerical ranking)."}},"type":"object"},"rsv_read_resGuestType":{"description":"A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGuestRPHs collection.","properties":{"arrivalTransport":{"$ref":"#/components/schemas/rsv_read_transportInfoType"},"departureTransport":{"$ref":"#/components/schemas/rsv_read_transportInfoType"},"primary":{"description":"When true indicates this is the primary guest.","type":"boolean"},"profileInfo":{"description":"A collection of Profiles or Unique IDs of Profiles.","properties":{"attachDetachType":{"$ref":"#/components/schemas/rsv_read_attachDetachType","description":"Attach and Detach information for accompanying guest profile."},"externalReference":{"$ref":"#/components/schemas/rsv_read_externalReferenceType","description":"External Reference information for Profile. Please note, for id and idContext elements within externalReferences for the reservationGuest the following maximum character limits are applicable: 80 maximum characters for id and 20 maximum characters for idContext. The idContext must match an existing external database."},"externalReferences":{"$ref":"#/components/schemas/rsv_read_externalReferencesType","description":"External References information for this Profile. Will be returned in getReservation and getReservationByExtId calls when the 'profileExternalReferencesToFetch' query parameter is sent."},"profile":{"$ref":"#/components/schemas/rsv_read_profileType","description":"Provides detailed information regarding either a company or a customer profile."},"profileCashieringDetail":{"$ref":"#/components/schemas/rsv_read_profileCashieringDetailType","description":"Cashiering details for the profile."},"profileIdList":{"$ref":"#/components/schemas/rsv_read_profileIdList","description":"Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id."},"registrationCardNo":{"description":"Unique identifier of the police registration card number.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"reservationGuestRPH":{"description":"This is a reference placeholder, used as an index for this guest in this reservation. In the ResGuest object it is used like all other RPH attributes to send the delta of a reservation. It is used by the RoomStay and Service objects to indicate which guests are associated with that room stay or service.","maxLength":8,"minLength":1,"type":"string"},"visaInfo":{"$ref":"#/components/schemas/rsv_read_visaInfoType"}},"type":"object"},"rsv_read_resHousekeepingType":{"description":"Holds housekeeping turndown service information for the room.","properties":{"expectedServiceTime":{"description":"Expected Start Time for housekeeping task(s).","type":"string"},"frontOfficeStatus":{"$ref":"#/components/schemas/rsv_read_frontOfficeRoomStatusType","description":"Front office status ( Occupied/Vacant )."},"housekeepingStatus":{"$ref":"#/components/schemas/rsv_read_frontOfficeRoomStatusType","description":"Housekeeping status ( Occupied/Vacant )."},"instructions":{"description":"Turndown instructions for the room.","type":"string"},"roomStatus":{"$ref":"#/components/schemas/rsv_read_housekeepingRoomStatusType","description":"Current room status. Current room status is populated only if room is assigned to the reservation and reservation is due in or in house."},"turndownRequested":{"description":"Indicates whether guest wants turndown facility or not.","type":"boolean"}},"type":"object"},"rsv_read_resInventoryItemSourceType":{"description":"Defines whether the item is setup due to a Rate Plan, Package or a Block.","properties":{"blockId":{"$ref":"#/components/schemas/rsv_read_blockId","description":"Block Unique ID, If populated specifies that the item is setup due to a Block."},"packageCode":{"description":"Package Code, If populated specifies that the item is setup due to a Package.","maxLength":20,"minLength":0,"type":"string"},"packageInternalId":{"description":"Source Reservation Package Opera Internal Unique Id. This is the unique Id used for the reservation package associated with this item.","type":"number"},"ratePlanCode":{"description":"Rate Plan Code, If populated specifies that the item is setup due to a Rate Plan.","maxLength":20,"minLength":0,"type":"string"},"welcomeOffer":{"description":"If true, it implies that the item has been attached to the reservation as part of a Welcome Offer","type":"boolean"}},"type":"object"},"rsv_read_resInventoryItemType":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"item":{"$ref":"#/components/schemas/rsv_read_itemInfoType","description":"Specifies Items and its attributes. When used for data manipulation for Items setup on reservation, etc only code is considered. Other Attributes are for used to provide information during fetch operation."},"quantity":{"description":"Number of items booked.","type":"integer"},"source":{"$ref":"#/components/schemas/rsv_read_resInventoryItemSourceType","description":"If exists specifies whether the item is setup due to a Rate Plan, Package or a Block."},"timeSpan":{"$ref":"#/components/schemas/rsv_read_dateRangeType","description":"Begin and end date and time of the items applicability."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"rsv_read_resInventoryItemsType":{"description":"Defines a collection of inventory items attached to a reservation.","properties":{"item":{"description":"Inventory item attached to a reservation.","items":{"$ref":"#/components/schemas/rsv_read_resInventoryItemType"},"maxItems":4000,"type":"array"},"itemClassCode":{"description":"The Item Class ID which the item belongs to.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_resMobileNotificationsType":{"description":"Contains the status of Room Ready and Key Ready messages.","properties":{"checkoutMessageReceived":{"description":"Indicates if the Mobile checkout message is received.","type":"boolean"},"errorMessage":{"description":"Error message when Mobile Notification has failed.","type":"string"},"keyReady":{"$ref":"#/components/schemas/rsv_read_communicationStatusType","description":"Denotes the status of Key Ready message. It can have one of the values:PENDING, COMPLETED or FAILED"},"requiresAction":{"description":"Indicates if user action is required. The action could be for sending Room Ready or Key Ready Notification. It could also be for initiating Checkout","type":"boolean"},"roomReady":{"$ref":"#/components/schemas/rsv_read_communicationStatusType","description":"Denotes the status of Room Ready message. It can have one of the values:PENDING, COMPLETED or FAILED"}},"type":"object"},"rsv_read_resPaymentCardType":{"description":"Information on a credit card for the customer.","properties":{"approvalAmountNeeded":{"$ref":"#/components/schemas/rsv_read_currencyAmountType"},"approvalCode":{"description":"Approval code sent by the credit card company on a successful authorization.","maxLength":20,"minLength":0,"type":"string"},"cardHolderName":{"maxLength":200,"minLength":0,"type":"string"},"cardId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"credit card id"},"cardNumber":{"maxLength":80,"minLength":0,"type":"string"},"cardNumberLast4Digits":{"maxLength":80,"minLength":0,"type":"string"},"cardNumberMasked":{"maxLength":80,"minLength":0,"type":"string"},"cardOrToken":{"$ref":"#/components/schemas/rsv_read_cardNumberTypeType","description":"This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates credit card is token enabled and 'CardNumber' indicates non token environment for this payment card type."},"cardPresent":{"description":"Flag to determine if the credit card was swiped/manually entered , This element is only used when PAYMENT SERVICE DIRECTIVE(PSD) Opera Control is active.","type":"boolean"},"cardType":{"$ref":"#/components/schemas/rsv_read_cardTypeType","description":"Indicates the type of credit card from a defined list"},"citId":{"description":"Customer Initiated Transaction(CIT) Id for Credit Cards. This is only used when PAYMENT SERVICES DIRECTIVE (PSD2) Opera Control is active.","maxLength":30,"minLength":0,"type":"string"},"currentAuthorizedAmount":{"$ref":"#/components/schemas/rsv_read_currencyAmountType"},"expirationDate":{"description":"Expiration date of the credit card","format":"date","type":"string"},"expirationDateExpired":{"type":"boolean"},"expirationDateMasked":{"description":"Masked Expiration date of the credit card","maxLength":20,"minLength":0,"type":"string"},"processing":{"$ref":"#/components/schemas/rsv_read_cardProcessingType","description":"This contains information on whether EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type."},"storeToCreditCardWallet":{"description":"Indicate whether the credit card will be stored to the credit card wallet or not.","type":"boolean"},"swiped":{"type":"boolean"},"userDefinedCardType":{"description":"Indicates the user defined credit card type if credit card type from a defined list is not provided","maxLength":2,"minLength":0,"type":"string"},"vcc":{"description":"Flag to determine if the credit card is a Virtual Credit Card.","type":"boolean"}},"type":"object"},"rsv_read_resPreConfiguredRoutingInstrType":{"description":"Instruction to attach Pre-Configured Routing Instructions to a Reservation.","properties":{"authorizerInfo":{"$ref":"#/components/schemas/rsv_read_authorizerInfoType","description":"The authorizer information for Promotion Code with attached Complimentary Routing"},"beginDate":{"description":"Begin Date for attached Routing Instruction.","format":"date","type":"string"},"endDate":{"description":"End Date for attached Routing Instruction.","format":"date","type":"string"},"folioView":{"description":"Folio Window.","type":"integer"},"profileId":{"$ref":"#/components/schemas/rsv_read_profileId","description":"Profile Id with attached Routing Instruction."},"profileType":{"$ref":"#/components/schemas/rsv_read_resProfileTypeType","description":"Profile Type with attached Routing Instruction."},"promotionCode":{"description":"Promotion Code with attached Complimentary Routing.","maxLength":20,"minLength":0,"type":"string"},"ratePlanCode":{"description":"Rate Code with attached Routing Instruction.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_resProfileTypeType":{"enum":["Guest","Company","Group","TravelAgent","Source","ReservationContact","BillingContact","Addressee"],"type":"string"},"rsv_read_resRevenueBalanceType":{"description":"Revenue and Balance Amount summary for the reservation.","properties":{"balance":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Balance amount on the reservation."},"compBalance":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Comp Balance amount"},"foodAndBevRevenue":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Food and Beverage Revenue generated by the reservation."},"nonRevenue":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Total Non Revenue posted on the reservation."},"otherRevenue":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Other Revenue generated by the reservation."},"roomRevenue":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Room Revenue generated by the reservation."},"totalDepositPaid":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Total of all deposit payment posted to the reservation."},"totalFixedCharge":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Total Fixed Charges on the reservation."},"totalPayment":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Total of all payments on the guest ledger for the reservation."},"totalRevenue":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Total Revenue generated by the reservation."}},"type":"object"},"rsv_read_resSharedGuestInfoType":{"description":"Contains information regarding the share reservation.","properties":{"firstName":{"description":"Given name, first name or names","type":"string"},"fullName":{"description":"String representation of the full name","type":"string"},"lastName":{"description":"Family name, last name.","type":"string"},"profileId":{"$ref":"#/components/schemas/rsv_read_profileId"},"reservationId":{"$ref":"#/components/schemas/rsv_read_reservationId"}},"type":"object"},"rsv_read_resSharedGuestListType":{"description":"Collection of shared guest reservations.","items":{"$ref":"#/components/schemas/rsv_read_resSharedGuestInfoType"},"maxItems":4000,"type":"array"},"rsv_read_resStatClassificationType":{"description":"Statistical Classification information for the reservation.","properties":{"rateTier":{"description":"Rate Tier used calculate statistics for export(DRS).","type":"integer"},"roomType":{"description":"Room Type used to calculate statistics for export(DRS).","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_reservation":{"description":"Return object to the request for information regarding a reservation.","properties":{"channelInfo":{"$ref":"#/components/schemas/rsv_read_reservationChannelInfoType","description":"Channel specific information to be received in case the reservation is being created through a channel."},"links":{"$ref":"#/components/schemas/rsv_read_links"},"masterInfoList":{"items":{"$ref":"#/components/schemas/rsv_read_masterInfoType"},"type":"array"},"reservations":{"$ref":"#/components/schemas/rsv_read_hotelReservationsType","description":"Collection of Reservations returned/fetched as per the criteria in the fetch request."},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_reservationAllowedActionType":{"description":"Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.","enum":["Cancel","Move","PreCharge","PostCharge","FacilitySchedule","Upsell","PreCheckIn","PostToNoShowCancel","NoShow","NameChange","Discount","HouseKeeping","EnrollToPrimaryMembership","EnrollInProgress","MemberAwardAttached","UpgradeAwardAttached","DiscountAwardAttached"],"type":"string"},"rsv_read_reservationAllowedActionsType":{"description":"Allowed action.","items":{"$ref":"#/components/schemas/rsv_read_reservationAllowedActionType"},"maxItems":11,"type":"array"},"rsv_read_reservationAttachments":{"description":"Return object to the request for information regarding reservation attachments.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"reservationAttachments":{"$ref":"#/components/schemas/rsv_read_attachmentsType","description":"Collection of information about reservation attachments returned/fetched as per the criteria in the fetch request."},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_reservationAwards":{"description":"Response of fetch awards for a reservation.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"reservationAwards":{"$ref":"#/components/schemas/rsv_read_awardsType","description":"Reservation awards and certificates."},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_reservationBlockType":{"description":"Key information about the block for a reservation.","properties":{"blockIdList":{"$ref":"#/components/schemas/rsv_read_blockIdList","description":"Collection of unique block identifiers for the reservation."},"blockName":{"description":"The Name of the block that is attached to the reservation.","maxLength":40,"minLength":0,"type":"string"},"hotelId":{"description":"This is the HotelCode of the Block.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_reservationCertificateType":{"description":"Certificate is incentive.","enum":["Reward","Incentive"],"type":"string"},"rsv_read_reservationChannelInfoType":{"description":"Holds all the channel reservation specific information.","properties":{"channelResvStatus":{"$ref":"#/components/schemas/rsv_read_channelResvStatusType","description":"Holds the reservation status to be returned to channel."},"channelSummaryInfo":{"$ref":"#/components/schemas/rsv_read_channelSummaryInfoType","description":"Holds channel details such as type, code"},"lastCommittedResv":{"$ref":"#/components/schemas/rsv_read_lastCommittedResvType","description":"Holds the last committed reservation to be returned to channel."}},"type":"object"},"rsv_read_reservationCommissionInfoType":{"properties":{"commissionNotesAvailable":{"type":"boolean"},"commissionsPaid":{"type":"boolean"}},"type":"object"},"rsv_read_reservationConfLettersListType":{"description":"Reservations information and the confirmation letters type attached with them.","items":{"$ref":"#/components/schemas/rsv_read_reservationConfLettersType"},"maxItems":4000,"type":"array"},"rsv_read_reservationConfLettersType":{"description":"Reservation information and the confirmation letters type attached with it.","properties":{"confLetters":{"$ref":"#/components/schemas/rsv_read_confirmationsType","description":"The letters attached with the reservation."},"reservation":{"$ref":"#/components/schemas/rsv_read_reservationInfoType","description":"Reservation details."}},"type":"object"},"rsv_read_reservationConfirmationLetters":{"description":"Response object to the request to fetch a list of reservations for which confirmation letters need to be sent.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"resrvationInfoList":{"$ref":"#/components/schemas/rsv_read_reservationConfLettersListType","description":"Contains details of the reservation and the confirmations letters attached with them.."},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_reservationDates":{"description":"Reservation Dates","properties":{"arrivalDate":{"description":"Date of arrival.","format":"date","type":"string"},"cancelledOn":{"description":"Date when reservation(s) was cancelled.","format":"date","type":"string"},"createDateTime":{"description":"Date when reservation(s) was created. Uses database time zone.","format":"date-time","type":"string"},"departureDate":{"description":"Date of departure.","format":"date","type":"string"},"folioClosedOn":{"description":"Date when folio was closed.","format":"date","type":"string"},"lastModifyDateTime":{"description":"Date when reservation(s) was updated. Uses database time zone.","format":"date-time","type":"string"}},"type":"object"},"rsv_read_reservationDepositPaymentCriteriaType":{"description":"Criteria for posting a deposit payment to a reservation.","properties":{"cashierId":{"type":"integer"},"comments":{"description":"User Defined Comments. Used for Deposit Payment postings.","maxLength":2000,"minLength":0,"type":"string"},"folioWindowNo":{"type":"integer"},"paymentMethod":{"$ref":"#/components/schemas/rsv_read_cashieringPaymentMethodType","description":"Payment method used by the payee."},"postingAmount":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Amount to post to the folio."},"postingReference":{"description":"User-defined posting reference.","maxLength":2000,"minLength":0,"type":"string"},"postingRemark":{"description":"User-defined posting remark.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_reservationDepositType":{"description":"Reservation Deposit Type.","properties":{"amountOwed":{"description":"Deposit Amount Oustanding.","maxLength":40,"minLength":0,"type":"number"},"amountPaid":{"description":"Deposit Amount Paid.","type":"number"},"amountRequired":{"description":"Deposit Amount Required.","maxLength":40,"minLength":0,"type":"number"},"dueDate":{"description":"Deposit Due Date.","format":"date","type":"string"},"hasOutstanding":{"description":"Resolves whether reservation has outstanding deposit.","type":"boolean"},"hasPaid":{"description":"Resolves whether reservation has paid deposit.","type":"boolean"},"hasPayByLinks":{"description":"Resolves whether reservation has Pay By Links.","type":"boolean"},"postingDate":{"description":"Deposit Posting Date.","format":"date","type":"string"}},"type":"object"},"rsv_read_reservationDisplayColorInfoType":{"description":"Information of reservation display color, determined based on OPERA parameter RESERVATION_COLOR_DEFINITION ","properties":{"colorDefinition":{"$ref":"#/components/schemas/rsv_read_colorDefinitionType","description":"Definition populated based on OPERA setting RESERVATION_COLOR_DEFINITION."},"colorDescription":{"description":"Description populated based on DisplayColor.","maxLength":2000,"minLength":0,"type":"string"},"displayColor":{"$ref":"#/components/schemas/rsv_read_colorType","description":"Display Color of Reservation."}},"type":"object"},"rsv_read_reservationECertificateType":{"description":"Reservation ECertificate Type Information.","properties":{"actionType":{"$ref":"#/components/schemas/rsv_read_requestActionType","description":"ECertificate status for the reservation."},"eCertificateNo":{"description":"ECertificate Number for the reservation.","maxLength":40,"minLength":0,"type":"string"},"eCertificateType":{"$ref":"#/components/schemas/rsv_read_eCertificateClassficationType","description":"ECertificate Type where value can be PROMOTION,AWARD,BENEFIT and OTHER"}},"type":"object"},"rsv_read_reservationECertificatesType":{"description":"Collection of ECertificateType object.","items":{"$ref":"#/components/schemas/rsv_read_reservationECertificateType"},"maxItems":4000,"type":"array"},"rsv_read_reservationFolioWindowType":{"description":"Folio window view which holds the set of folios for a reservation.","properties":{"balance":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Running balance of the window."},"folioWindowNo":{"type":"integer"},"payeeInfo":{"$ref":"#/components/schemas/rsv_read_payeeInfoType","description":"The window's configured payee information."},"paymentMethod":{"description":"Payment Method Type","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_reservationFolioWindowsType":{"description":"Collection of reservation folio windows.","items":{"$ref":"#/components/schemas/rsv_read_reservationFolioWindowType"},"maxItems":4000,"type":"array"},"rsv_read_reservationHistoryFutureInfoType":{"description":"Information of History and Future Reservation details attached to Profiles.","properties":{"futureList":{"$ref":"#/components/schemas/rsv_read_futureListType","description":"Refer to Future list type document."},"historyList":{"$ref":"#/components/schemas/rsv_read_historyListType","description":"Refer to History list type document."}},"type":"object"},"rsv_read_reservationId":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"rsv_read_reservationIdList":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type"},"maxItems":4000,"type":"array"},"rsv_read_reservationInfoType":{"description":"The Reservation class contains the current reservation being created or altered.","properties":{"accessRestriction":{"$ref":"#/components/schemas/rsv_read_resAccessRestrictionType","description":"Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both."},"advanceCheckIn":{"$ref":"#/components/schemas/rsv_read_advanceCheckInType","description":"Information relating to Reservation's Advance Checked In state and Expected Time of Return"},"allowMobileCheckout":{"description":"Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false.","type":"boolean"},"allowMobileViewFolio":{"description":"Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.","type":"boolean"},"allowedActions":{"$ref":"#/components/schemas/rsv_read_reservationAllowedActionsType","description":"Collection of reservation allowed actions."},"attachedProfiles":{"$ref":"#/components/schemas/rsv_read_resAttachedProfileListType","description":"List of attached profiles"},"cancellationInfo":{"description":"Information regarding why reservation has been/was cancelled.","properties":{"code":{"maxLength":20,"minLength":0,"type":"string"},"date":{"description":"Date when reservation was last cancelled.","format":"date","type":"string"},"description":{"maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"cashiering":{"$ref":"#/components/schemas/rsv_read_resCashieringType","description":"Holds cashiering related information for the reservation."},"checkInInitiatedBy":{"description":"This indicates who initiated the Check In/Advance Check In.Advance Check In functionality is available when the Advance Check In OPERA Control is active.","maxLength":40,"minLength":0,"type":"string"},"commissionPayoutTo":{"$ref":"#/components/schemas/rsv_read_commissionPayoutToType","description":"If not null, reservation is considered to pay out commission to either Travel Agent, Source or both."},"commissionsInfo":{"$ref":"#/components/schemas/rsv_read_reservationCommissionInfoType","description":"Information related to commissions"},"computedReservationStatus":{"$ref":"#/components/schemas/rsv_read_pMS_ResStatusType","description":"Indicates the status of the reservation."},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"departureReservationInfo":{"$ref":"#/components/schemas/rsv_read_departureReservationInfoType","description":"Information related to the departure reservation."},"deposit":{"$ref":"#/components/schemas/rsv_read_reservationDepositType","description":"Holds reservation deposit information."},"displayColor":{"description":"Color setting of the reservation.","maxLength":20,"minLength":0,"type":"string"},"displayColorDetails":{"$ref":"#/components/schemas/rsv_read_reservationDisplayColorInfoType","description":"Information of reservation display color, determined based on OPERA parameter RESERVATION_COLOR_DEFINITION "},"expectedServiceTime":{"maxLength":20,"minLength":0,"type":"string"},"externalReferences":{"$ref":"#/components/schemas/rsv_read_externalReferencesType","description":"External Reference information for Reservation."},"fiscalInfo":{"$ref":"#/components/schemas/rsv_read_fiscalInfoType","description":"Fiscal related information for a reservation."},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"hotelName":{"maxLength":80,"minLength":0,"type":"string"},"housekeeping":{"$ref":"#/components/schemas/rsv_read_resHousekeepingType","description":"Information regarding housekeeping for this reservation."},"keyCount":{"description":"Number of keys created for the reservation.","type":"integer"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"mobileNotifications":{"$ref":"#/components/schemas/rsv_read_resMobileNotificationsType","description":"Denotes the status of Room Ready, Key Ready messages."},"openFolio":{"description":"Returns true when reservation has an open folio.","type":"boolean"},"optedForCommunication":{"description":"Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation.","type":"boolean"},"parentReservationHotelId":{"description":"Property associated with the Linked Reservation that serves as parent to this reservation.","maxLength":20,"minLength":0,"type":"string"},"paymentMethod":{"description":"Payment Method.","maxLength":20,"minLength":0,"type":"string"},"pkgConsumptionInfo":{"description":"Package consumption information linked to the reservation, including package code, description, category, and consumption details.","items":{"$ref":"#/components/schemas/rsv_read_packageInfoType"},"maxItems":200,"type":"array"},"preArrivalReviewStatus":{"$ref":"#/components/schemas/rsv_read_preArrivalReviewStatusType","description":"The review status of a Pre-Arrival Reservation indicates whether the reservation has been reviewed, is pending review, or has been modified after the initial review."},"preRegistered":{"description":"Defines if the reservation is pre-registered or not.","type":"boolean"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","type":"string"},"queue":{"$ref":"#/components/schemas/rsv_read_reservationQueueInformationType","description":"Information about the time and duration this reservation was on Queue for Checkin."},"reservationCommunication":{"$ref":"#/components/schemas/rsv_read_resCommunicationType","description":"Collection of reservation communication details."},"reservationFolioWindows":{"$ref":"#/components/schemas/rsv_read_reservationFolioWindowsType","description":"Collection of reservation folio windows."},"reservationGuest":{"$ref":"#/components/schemas/rsv_read_resGuestInfoType","description":"Collection of guests associated with the reservation."},"reservationIdList":{"$ref":"#/components/schemas/rsv_read_reservationIdList","description":"Unique identifiers for the reservation for both internal and external systems"},"reservationIndicators":{"$ref":"#/components/schemas/rsv_read_indicatorsType","description":"Indicators of additional information attached to the reservation"},"reservationMemberships":{"description":"List of reservation memberships which are attached from profile.","items":{"$ref":"#/components/schemas/rsv_read_reservationMembershipType"},"maxItems":10,"type":"array"},"reservationPaymentMethod":{"$ref":"#/components/schemas/rsv_read_reservationPaymentMethodType","description":"Payment method used for this reservation"},"reservationStatus":{"$ref":"#/components/schemas/rsv_read_pMS_ResStatusType","description":"Indicates the status of the reservation."},"revenuesAndBalances":{"$ref":"#/components/schemas/rsv_read_resRevenueBalanceType","description":"Revenues and Balances Amount summary for the reservation."},"roomFeatures":{"description":"Set of reservation preferences which belongs to the Room Features.","maxLength":4000,"minLength":0,"type":"string"},"roomStatus":{"$ref":"#/components/schemas/rsv_read_housekeepingRoomStatusType","description":"Current room status"},"roomStay":{"$ref":"#/components/schemas/rsv_read_stayInfoType","description":"Collection of room stays."},"roomStayReservation":{"description":"Boolean True if this reservation is reserving rooms. False if it is only reserving services.","type":"boolean"},"scheduledRoomMoveInfo":{"$ref":"#/components/schemas/rsv_read_scheduledRoomMoveInfoType","description":"Scheduled Room Move information for a reservation."},"searchMatches":{"$ref":"#/components/schemas/rsv_read_searchMatchesType","description":"Super Search matching terms."},"sharedGuests":{"$ref":"#/components/schemas/rsv_read_resSharedGuestListType","description":"Collection of guests who share this reservation."},"sourceOfSale":{"$ref":"#/components/schemas/rsv_read_sourceOfSaleType","description":"Point of Sale of reservation. Identifies the entity/channel who made the reservation."},"specials":{"description":"Set of reservation preferences which belongs to the Specials group.","maxLength":4000,"minLength":0,"type":"string"},"taxType":{"$ref":"#/components/schemas/rsv_read_taxTypeType","description":"This stores the code for the type of tax calculation especially with tax exemption, etc."},"userDefinedFields":{"$ref":"#/components/schemas/rsv_read_userDefinedFieldsType","description":"Collections of user defined fields."},"waitlist":{"$ref":"#/components/schemas/rsv_read_waitlistResType","description":"Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is not in Waitlist status anymore."},"walkInIndicator":{"description":"When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in.","type":"boolean"},"welcomeOffer":{"description":"This flag will determine wheather the reservation is eligible for Welcome Offer or not.","type":"boolean"}},"type":"object"},"rsv_read_reservationKeyInfoType":{"description":"Holds the room key information provided by the Door Lock System.","properties":{"keyPin":{"description":"PIN provided in keyTrack3 from the Door Lock System that is used to unlock a room. This is supported when Key Pin handling is active for the property and the Door Lock System in use.","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_reservationLocatorType":{"description":"Holds the information for a Reservation Guest Locator","properties":{"dateSpan":{"$ref":"#/components/schemas/rsv_read_dateRangeType","description":"Begin and End date range of the Guest Locator."},"locatorBy":{"description":"User that entered this Guest Locator.","type":"string"},"locatorId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Unique Id of the Guest Locator ( Locator Id )"},"locatorOn":{"description":"Date and time of the Guest Locator.","format":"date-time","type":"string"},"locatorText":{"description":"The Locator Text for the guest.","type":"string"},"timeSpan":{"$ref":"#/components/schemas/rsv_read_dateTimeSpanType","description":"Time span for the Guest Locator. Uses the hotel's time zone."}},"type":"object"},"rsv_read_reservationLocators":{"description":"Response object response to retrieve Guest Messages for a Reservation.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"reservationLocators":{"$ref":"#/components/schemas/rsv_read_reservationLocatorsType","description":"Collection of hotel notes to be created."},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_reservationLocatorsType":{"description":"Holds the Locator Information.","items":{"$ref":"#/components/schemas/rsv_read_reservationLocatorType"},"maxItems":4000,"type":"array"},"rsv_read_reservationMembershipAwardType":{"description":"This type contains information of a membership award attached to a reservation.","properties":{"actualCancelPoints":{"description":"The number of points actually deducted from the member's total award points if there is a penalty points restriction associated with the award cancellation.","maxLength":20,"minimum":0,"type":"number"},"arrivalDate":{"description":"The arrival date of the stay for when the award is associated.","format":"date","type":"string"},"awardBasedOn":{"description":"Indicates if the Award is based on RATE, PRODUCT or UPGRADE.","maxLength":20,"minLength":0,"type":"string"},"awardCancelDate":{"description":"If the reservation associated with the award was cancelled, the reservation cancellation date appears here.","format":"date","type":"string"},"awardCancellationNo":{"description":"Unique ID for the award cancellation if cancelled.","maxLength":20,"minimum":0,"type":"number"},"awardType":{"description":"Unique code that identifies this award.","maxLength":40,"minLength":0,"type":"string"},"cancelPenaltyDays":{"description":"The cancel days, set up in awards configuration that establishes the number of days before arrival when a reservation may be cancelled without an award points penalty.","maxLength":20,"minimum":0,"type":"number"},"cancelPenaltyPoints":{"description":"The award points that will be deducted (based on a cancel days restriction) if the award is cancelled. (Cancel days, set up in awards configuration, and establish the number of days before arrival when a reservation may be cancelled without an award points penalty).","maxLength":20,"minimum":0,"type":"number"},"dateAwarded":{"description":"Date when the award was issued.","format":"date","type":"string"},"membershipCardNo":{"description":"The card number associated with this membership.","maxLength":50,"minLength":0,"type":"string"},"membershipType":{"description":"Membership type for which awards are defined.","maxLength":20,"minLength":0,"type":"string"},"nameOnCard":{"description":"Name to be displayed on the membership card.","maxLength":80,"minLength":0,"type":"string"},"pointsRequired":{"description":"Number of points required for the award.","maxLength":20,"minimum":0,"type":"number"},"stayDate":{"description":"The date of the reservation associated with the award.","format":"date","type":"string"}},"type":"object"},"rsv_read_reservationMembershipType":{"description":"Detailed information of the memberships.","properties":{"benefits":{"$ref":"#/components/schemas/rsv_read_benefitsType","description":"benefits for the membership."},"centralSetup":{"description":"Indicates how the award points for this membership type will be managed.","type":"boolean"},"comment":{"$ref":"#/components/schemas/rsv_read_paragraphType","description":"Additional comments regarding to the membership."},"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"currentPoints":{"description":"Profile MemberShip Points.","type":"number"},"downgrade":{"$ref":"#/components/schemas/rsv_read_downgradeType","description":"Defines how downgrading will be handled for this membership."},"downgradeDescription":{"description":"Indicates information regarding the member's possible downgrades.","maxLength":32000,"minLength":0,"type":"string"},"earningPreference":{"$ref":"#/components/schemas/rsv_read_membershipEarningPreferenceType","description":"Earning preference to the membership."},"effectiveDate":{"description":"Indicates the starting date.","format":"date","type":"string"},"enrollmentResort":{"description":"Resort/CRO where enrollment is done.","maxLength":20,"minLength":0,"type":"string"},"enrollmentSource":{"description":"Source from where the enrollment is done.","maxLength":20,"minLength":0,"type":"string"},"excludeFromBatch":{"description":"True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false.","type":"boolean"},"expireDate":{"description":"Indicates the ending date.","format":"date","type":"string"},"expireDateExclusiveIndicator":{"description":"When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).","type":"boolean"},"inactive":{"description":"Indicates whether membership is active or inactive.","type":"boolean"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"linkMembership":{"type":"boolean"},"memberStatus":{"description":"Indicates where the guest is in the membership enrollment process.","maxLength":20,"minLength":0,"type":"string"},"membershipClass":{"description":"Indicates the membership class.","type":"string"},"membershipEnrollmentCode":{"description":"Indicates how the guest enrolled in the program.","maxLength":20,"minLength":0,"type":"string"},"membershipId":{"description":"Card Number of the membership.","type":"string"},"membershipIdNo":{"description":"Membership ID Number.","type":"integer"},"membershipLevel":{"description":"Indicates the membership level.","type":"string"},"membershipLevelDescription":{"description":"Indicates the membership level description.","maxLength":200,"minLength":0,"type":"string"},"membershipType":{"description":"Type of membership.","type":"string"},"nameOnCard":{"description":"Name to be displayed on the membership card.","type":"string"},"newMembershipNumber":{"description":"Card Number of the membership.","type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"playerRanking":{"description":"Ranking assigned to the Player Profile by the Gaming system.","type":"integer"},"pointsLabel":{"description":"Label used to refer to points for this membership type","maxLength":20,"minLength":0,"type":"string"},"preferredCard":{"description":"Preferred Card.","type":"boolean"},"primary":{"type":"boolean"},"primaryMembership":{"description":"Boolean indicator set to True implies membership is a Primary Membership.","type":"boolean"},"primaryMembershipYn":{"description":"Indicator if Membership is a Primary Membership.","maxLength":1,"minLength":0,"type":"string"},"programDescription":{"description":"Description of the membership program.","type":"string"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","type":"string"},"rating":{"description":"Value Rating Type Description for this membership.","type":"string"},"reIssueNewCard":{"$ref":"#/components/schemas/rsv_read_cardReIssueType","description":"The status of issuing new membership card to the member."},"signupDate":{"description":"Indicates when the member signed up for the loyalty program.","format":"date","type":"string"},"tierAdministration":{"$ref":"#/components/schemas/rsv_read_tierAdministrationType","description":"Defines the degree of participation for this membership in the tier management portion of the program."},"upgradeDescription":{"description":"Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.","maxLength":32000,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_reservationPackageScheduleType":{"description":"A HotelPackageSchedule type.","properties":{"ageBucket2OriginalUnitAllowance":{"description":"The original allowance per unit for Child Bucket 2 / Guest Age Category 2 of the package. Applicable when Child Bucket or Guest Age Categories functionality is active and package's price calculation rule is Per Child","type":"number"},"ageBucket2OriginalUnitPrice":{"description":"The original price per unit for Child Bucket 2 / Guest Age Category 2 of the package. Applicable when Child Bucket or Guest Age Categories functionality is active and package's price calculation rule is Per Child","type":"number"},"ageBucket2UnitAllowance":{"description":"Unit Allowance for Child Bucket 2 /Guest Age Category 2. Applicable when Child Bucket or Guest Age Categories functionality is active and package's price calculation rule is Per Child.","type":"number"},"ageBucket2UnitPrice":{"description":"Unit Price for Child Bucket 2 /Guest Age Category 2. Applicable when Child Bucket or Guest Age Categories functionality is active and package's price calculation rule is Per Child.","type":"number"},"ageBucket3OriginalUnitAllowance":{"description":"The original allowance per unit for Child Bucket 3 / Guest Age Category 3 of the package. Applicable when Child Bucket or Guest Age Categories functionality is active and package's price calculation rule is Per Child","type":"number"},"ageBucket3OriginalUnitPrice":{"description":"The original price per unit for Child Bucket 3 / Guest Age Category 3 of the package. Applicable when Child Bucket or Guest Age Categories functionality is active and package's price calculation rule is Per Child","type":"number"},"ageBucket3UnitAllowance":{"description":"Unit Price for Child Bucket 3 /Guest Age Category 3. Applicable when Child Bucket or Guest Age Categories functionality is active and package's price calculation rule is Per Child","type":"number"},"ageBucket3UnitPrice":{"description":"Unit Price for Child Bucket 3 /Guest Age Category 3. Applicable when Child Bucket or Guest Age Categories functionality is active and package's price calculation rule is Per Child","type":"number"},"calculatedQuantity":{"description":"The calculated quantity available to be consumed for the package based on the package's quantity and posting rhythm.","type":"integer"},"computedResvAllowance":{"description":"Computed Reservation Allowance of the package. Calculation is based off of the allowance amount, posting rhythm, and quantity for the package.","type":"number"},"computedResvPrice":{"description":"Computed Reservation Price of the package. Calculation Will Be Performed Based On Other Parameters.","type":"number"},"consumedAllowance":{"description":"The allowance amount consumed for the package based on transactions posted.","type":"number"},"consumedQuantity":{"description":"The quantity consumed for the package.","type":"integer"},"consumptionDate":{"description":"The date the package was used or can be used.","format":"date","type":"string"},"forecastConsumptionDate":{"description":"The forecasted consumption date of the package.","format":"date","type":"string"},"originalUnitAllowance":{"description":"The original allowance per unit of the package if it has been changed.","type":"number"},"originalUnitPrice":{"description":"The original price per unit of the package if it has been changed.","type":"number"},"reservationDate":{"description":"The date of the Reservation when this package is applicable. This can be different from the date the package will be consumed. Example are next day packages. Reservation date is when the package is applied to the guest and Consumption date is when the guest can consume the package.","format":"date","type":"string"},"totalQuantity":{"description":"The total quantity of the package for this date, calculated based on the calculation rule as defined in the PackageHeaderType","type":"integer"},"unitAllowance":{"description":"The allowance per unit of the package.","type":"number"},"unitPrice":{"description":"The price per unit of the package.","type":"number"}},"type":"object"},"rsv_read_reservationPackageType":{"description":"A ReservationPackageType class.","properties":{"awardCode":{"description":"This is the Award code used to redeem the package if the package is a redemption package.","maxLength":20,"minLength":0,"type":"string"},"consumptionDetails":{"$ref":"#/components/schemas/rsv_read_packageConsumptionType","description":"Package consumption details. Includes information for quantity , allowance etc."},"endDate":{"description":"Required value when changing a reservation package. If the original end date was null, then null is required.","format":"date","type":"string"},"internalId":{"description":"Reservation Package Opera Internal Unique Id. This is the unique Id used for this reservation package.","type":"number"},"newTimeSpan":{"$ref":"#/components/schemas/rsv_read_timeSpanType","description":"The changed dates(Start and End dates) for this product."},"packageCode":{"description":"Package code. This is the unique code used for the package and is a required element.","maxLength":20,"minLength":0,"type":"string"},"packageGroup":{"description":"Package group code. If this package is part of a package group, the group code is indicated here. This is a required element and is part of the key to fetch the correct package record .","maxLength":20,"minLength":0,"type":"string"},"packageHeaderType":{"$ref":"#/components/schemas/rsv_read_packageCodeHeaderType","description":"Package information from configuration."},"points":{"description":"Indicates the points used to redeem the redemption package.","type":"integer"},"ratePlanCode":{"description":"The rate code which contains this package. If the package is not part of a rate code, this will be empty. Required element and part of the key to fetch the correct package record on the reservation.","maxLength":20,"minLength":0,"type":"string"},"scheduleList":{"description":"A HotelPackageSchedule type.","items":{"$ref":"#/components/schemas/rsv_read_reservationPackageScheduleType"},"maxItems":4000,"type":"array"},"source":{"$ref":"#/components/schemas/rsv_read_productSourceType","description":"Indicates if the source of the product is Rate header, Rate Detail or Reservation. For new development this field is to be used for passing the product scource"},"startDate":{"description":"Required value when changing a reservation package. If the original start date was null, then null is required.","format":"date","type":"string"}},"type":"object"},"rsv_read_reservationPaymentMethodType":{"properties":{"authorizationRule":{"$ref":"#/components/schemas/rsv_read_authorizationRuleType"},"balance":{"$ref":"#/components/schemas/rsv_read_currencyAmountType"},"confidential":{"description":"Flag indicating a billing window (2-8) as confidential. Applied only when Confidential Billing Window Opera Control is active.","type":"boolean"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"emailFolioInfo":{"description":"Information on an email for the customer.","properties":{"email":{"$ref":"#/components/schemas/rsv_read_emailType","description":"eMail deatils for the profile."},"emailFolio":{"type":"boolean"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"folioView":{"type":"integer"},"paymentCard":{"$ref":"#/components/schemas/rsv_read_resPaymentCardType"},"paymentMethod":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_reservationPaymentMethods":{"description":"Method to create a reservation's payment methods.","properties":{"hotelId":{"$ref":"#/components/schemas/rsv_read_codeType","description":"Property code of the reservation."},"links":{"$ref":"#/components/schemas/rsv_read_links"},"reservationId":{"$ref":"#/components/schemas/rsv_read_reservationId","description":"Reservation Id for which the payment method is to be applied."},"reservationPaymentMethods":{"$ref":"#/components/schemas/rsv_read_reservationPaymentMethodsType","description":"List of payment methods which are to be attached to the reservation."},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_reservationPaymentMethodsType":{"description":"Defines reservation payment methods.","items":{"$ref":"#/components/schemas/rsv_read_reservationPaymentMethodType"},"maxItems":4000,"type":"array"},"rsv_read_reservationPolicies":{"description":"Response that contains deposit and cancellation policies attached with the reservation.","properties":{"cancellationPolicies":{"$ref":"#/components/schemas/rsv_read_resCancellationPoliciesType","description":"Cancellation policies associated with a reservation."},"depositPolicies":{"$ref":"#/components/schemas/rsv_read_resDepositPoliciesType","description":"Deposit policies associated with a reservation."},"links":{"$ref":"#/components/schemas/rsv_read_links"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_reservationPoliciesType":{"description":"A collection of reservation deposit and cancellation policies.","properties":{"cancellationPolicies":{"$ref":"#/components/schemas/rsv_read_resCancellationPoliciesType","description":"A collection of reservation cancellation policies.."},"depositPolicies":{"$ref":"#/components/schemas/rsv_read_resDepositPoliciesType","description":"A collection of reservation deposit policies."},"name":{"description":"Name identifier for the reservation.","type":"string"},"reservationIdList":{"$ref":"#/components/schemas/rsv_read_uniqueIDListType","description":"A list of Ids for reservation."}},"type":"object"},"rsv_read_reservationPreConfiguredRoutingInstructionsType":{"properties":{"consumableInventory":{"description":"List of default routing instructions.","items":{"$ref":"#/components/schemas/rsv_read_resPreConfiguredRoutingInstrType"},"maxItems":4000,"type":"array"}},"type":"object"},"rsv_read_reservationPreference":{"description":"Response for the reservation's preferences.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"reservationPreferences":{"description":"For reservation preferences, you will want to send ReservationPreferenceType as the preferenceType object to acknowledge any reservation related process with the request.","items":{"$ref":"#/components/schemas/rsv_read_preferenceTypeType"},"type":"array"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_reservationProfileType":{"properties":{"externalReferences":{"$ref":"#/components/schemas/rsv_read_externalReferencesType","description":"External References information for this Profile. Will be returned in getReservation and getReservationByExtId calls when the 'profileExternalReferencesToFetch' query parameter is sent."},"profile":{"$ref":"#/components/schemas/rsv_read_profileType","description":"Provides detailed information regarding either a company or a customer profile."},"profileIdList":{"$ref":"#/components/schemas/rsv_read_profileIdList","description":"Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id."},"reservationProfileType":{"$ref":"#/components/schemas/rsv_read_resProfileTypeType"}},"type":"object"},"rsv_read_reservationProtectionType":{"description":"Reservation Protection information related to the reservation.","properties":{"reservationProtected":{"description":"This attribute indicates if the reservation is marked as Protected or not.","type":"boolean"}},"type":"object"},"rsv_read_reservationQueueInformationType":{"description":"Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.","properties":{"averageQueueTimeCurrentReservations":{"description":"The average time, in seconds, of the reservations currently in queue.","type":"integer"},"averageQueueTimeToCheckIn":{"description":"The average time, in seconds, a reservation was on queue prior to Check-In.","type":"integer"},"guestTextInfo":{"$ref":"#/components/schemas/rsv_read_queueTextInfoType","description":"Information for the message sent to the user"},"priority":{"description":"The Queue Priority given to this reservation.","type":"integer"},"queueDate":{"description":"The Business date on which the reservation was due to arrive and is currently placed on Queue for Check In.","format":"date","type":"string"},"timeSpan":{"description":"Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.","properties":{"duration":{"type":"string"},"durationInSeconds":{"description":"The total duration, in seconds, the reservation is on Queue.","type":"integer"},"endDate":{"format":"date","type":"string"},"startDate":{"format":"date","type":"string"}},"type":"object"}},"type":"object"},"rsv_read_reservationRateSummaryDetailType":{"properties":{"currencyCode":{"description":"Currency revenue calculation is based on.","maxLength":3,"minLength":3,"type":"string"},"gross":{"description":"Amount of revenue and package excluding tax.","type":"number"},"isCycleStartDate":{"description":"Indicates whether the current date marks the start of a new posting cycle","type":"boolean"},"net":{"description":"Amount of revenue and package including tax.","type":"number"},"package":{"description":"Amount of an additional product or service that is sold as part of the rate or in addition to the rate.","type":"number"},"postingInterval":{"description":"Posting Interval of the rate plan code","maxLength":20,"minLength":0,"type":"string"},"ratePlanCode":{"description":"Rate code calculation is based on.","maxLength":20,"minLength":0,"type":"string"},"rateSuppressed":{"description":"Indicates if the rate is to be hidden.","type":"boolean"},"revenue":{"description":"Base Amount of rate.","type":"number"},"revenueSimulationDate":{"description":"Date revenue calculation is based on.","format":"date","type":"string"},"summaryDate":{"description":"Stay date for which revenue calculation is done.","format":"date","type":"string"},"tax":{"description":"Amount of tax generated separately on the revenue and package.","type":"number"}},"type":"object"},"rsv_read_reservationRateSummaryType":{"properties":{"currencyCode":{"description":"Currency revenue calculation is based on.","maxLength":3,"minLength":3,"type":"string"},"deposit":{"description":"Amount paid prior to the stay.","type":"number"},"details":{"items":{"$ref":"#/components/schemas/rsv_read_reservationRateSummaryDetailType"},"maxItems":4000,"type":"array"},"end":{"description":"The ending value of the date range.","format":"date","type":"string"},"fixedCharges":{"description":"Amount of automatically posted charges along with room and taxes.","type":"number"},"gross":{"description":"Amount of revenue and package excluding tax.","type":"number"},"guestPay":{"description":"Amount to be paid by Guest.","type":"number"},"hasSuppressedRate":{"description":"Whether suppressed rate is present or not.","type":"boolean"},"net":{"description":"Amount of revenue and package including tax.","type":"number"},"outStandingCostOfStay":{"description":"Remaining amount to be paid.","type":"number"},"routing":{"description":"Amount of automatically forwarded charges for specific transaction codes.","type":"number"},"start":{"description":"The starting value of the date range.","format":"date","type":"string"},"totalCostOfStay":{"description":"Amount of total cost of stay.","type":"number"}},"type":"object"},"rsv_read_reservationRoomOwnershipType":{"description":"Indicates if the assigned reservation room is an Owner/Referral or Regular room.","enum":["Owner","Referral","Regular"],"type":"string"},"rsv_read_reservationStatusEnum":{"enum":["Cancelled","CheckedOut","CheckedIn","DueIn","DueOut","InHouse","NoShow","WaitList"],"type":"string"},"rsv_read_reservationStayHistoryFutureInfoType":{"description":"Information of History and Future Reservation details attached to Profiles.","properties":{"futureList":{"$ref":"#/components/schemas/rsv_read_stayFutureListType","description":"Refer to Future list type document."},"historyList":{"$ref":"#/components/schemas/rsv_read_stayHistoryListType","description":"Refer to History list type document."}},"type":"object"},"rsv_read_reservationTaxTypeInfo":{"description":"Provides information about the Tax Type.","properties":{"code":{"description":"Code of the Tax Type.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Description of the Tax Type.","maxLength":2000,"minLength":0,"type":"string"},"taxExemptNo":{"description":"Tax exempt number on the profile.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_reservationTransactionDiversionType":{"description":"A Transaction Diversion Rule Type","properties":{"code":{"description":"Transaction Diversion Code","maxLength":20,"minLength":0,"type":"string"},"dailyDetails":{"$ref":"#/components/schemas/rsv_read_transactionDiversionDailyDetailsType","description":"Collection of daily details of a Transaction diversion rule for a particular reservation."},"description":{"description":"User defined message for the Transaction Diversion Rule.","maxLength":2000,"minLength":0,"type":"string"},"displaySequence":{"description":"User configured Sequence number.","type":"number"},"diverted":{"description":"Transaction diversions that are diverted .","type":"integer"},"hotelId":{"description":"Hotel code with which Transaction Diversion Rule is associated.","maxLength":20,"minLength":0,"type":"string"},"inactive":{"description":"Indicator that tells whether the transaction diversion rule is active or not.","type":"boolean"},"level":{"$ref":"#/components/schemas/rsv_read_transactionDiversionRuleLevelType","description":"Level of the Transaction Diversion rule that can be Property or Reservation."},"membership":{"$ref":"#/components/schemas/rsv_read_membershipTypeLevelType","description":"Membership type to consider while applying Diversion Instruction."},"notes":{"$ref":"#/components/schemas/rsv_read_commentInfoType","description":"The Note details related to the Transaction Diversion Rule."},"posted":{"description":"Transaction diversions that are posted.","type":"integer"},"targetRoom":{"description":"Room number to receive all the diverted transactions configured for this instruction.","maxLength":20,"minLength":0,"type":"string"},"thresholds":{"$ref":"#/components/schemas/rsv_read_thresholdDetailsType","description":"Threshold Details related to the Transaction diversion rule."},"transactionCodes":{"description":"Collection of Transaction Code List","items":{"$ref":"#/components/schemas/rsv_read_codeDescriptionType"},"maxItems":4000,"type":"array"},"type":{"$ref":"#/components/schemas/rsv_read_transactionDiversionRuleTypeType","description":"Transaction Diversion Rule Types"},"vipCode":{"description":"VIP code to consider while applying Diversion Instruction.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_reservationTransactionDiversionsType":{"description":"List of Transaction Diversion rules.","items":{"$ref":"#/components/schemas/rsv_read_reservationTransactionDiversionType"},"maxItems":4000,"type":"array"},"rsv_read_reservationUpsellInfo":{"description":"Response object to the that contains information for a reservation prior to upgrade.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"upsellInfo":{"$ref":"#/components/schemas/rsv_read_upsellInfoType","description":"Reservation Upsale information."},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_reservationsDetails":{"description":"Response object to the Fetch Reservation Request operation. Based on the criteria, reservation information is returned.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"masterInfoList":{"items":{"$ref":"#/components/schemas/rsv_read_masterInfoType"},"type":"array"},"reservations":{"description":"Collection of Reservations and their information.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"limit":{"description":"Indicates maximum number of records a Web Service should return.","type":"integer"},"offset":{"description":"Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.","type":"integer"},"reservationInfo":{"description":"Contains details of the reservation.","items":{"$ref":"#/components/schemas/rsv_read_reservationInfoType"},"maxItems":4000,"type":"array"},"similaritySearchResults":{"description":"Total number of results returned by similarity search. Returned only when similaritySearch query parameter is true.","type":"integer"},"totalPages":{"description":"Evaluated total page count based on the requested max fetch count.","type":"integer"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_reservationsInformationType":{"description":"Reservations Information.","properties":{"adults":{"description":"Total number of adults.","type":"integer"},"advancedCheckedIn":{"description":"Indicates if the reservation has performed an Advance Check In.","type":"boolean"},"amount":{"description":"Total share amount.","type":"number"},"arrivalTime":{"description":"Arrival Time of reservation.","maxLength":10,"minLength":0,"type":"string"},"balance":{"description":"Balance.","type":"number"},"blockIdList":{"description":"Unique identifiers for Blocks. Eg: BlockId, BlockCode","items":{"$ref":"#/components/schemas/rsv_read_distinctIDType"},"maxItems":5,"type":"array"},"bookedRoomType":{"description":"Booked Room Type.","maxLength":32000,"minLength":0,"type":"string"},"children":{"description":"Number of children.","type":"integer"},"companyDetails":{"$ref":"#/components/schemas/rsv_read_companyDetails","description":"Company Details"},"computedReservationStatus":{"description":"Computed reservation status.","maxLength":20,"minLength":0,"type":"string"},"creatorId":{"description":"Internal User ID used to create reservation.","maxLength":100,"minLength":0,"type":"string"},"currencyCode":{"description":"Currency code.","maxLength":20,"minLength":0,"type":"string"},"departureTime":{"description":"Departure Time of reservation.","maxLength":10,"minLength":0,"type":"string"},"externalReferences":{"$ref":"#/components/schemas/rsv_read_externalReferencesType","description":"This type stores the External Reference information for Reservation. Confirmation Number is also supported here if its having a valid non default leg number identifiable via idContext as OPERA"},"groupDetails":{"$ref":"#/components/schemas/rsv_read_groupDetails","description":"Group Details"},"guaranteeCode":{"description":"Reservation guarantee code.","maxLength":20,"minLength":0,"type":"string"},"guestDetails":{"$ref":"#/components/schemas/rsv_read_guestDetails","description":"Guest Information"},"hotelId":{"description":"Property code.","maxLength":20,"minLength":0,"type":"string"},"lastModifierId":{"description":"Internal User ID used to update the reservation details.","maxLength":100,"minLength":0,"type":"string"},"linkCode":{"description":"Party code.","maxLength":50,"minLength":0,"type":"string"},"marketCode":{"description":"Market code of the reservation.","maxLength":20,"minLength":0,"type":"string"},"membershipDetails":{"$ref":"#/components/schemas/rsv_read_membershipDetails","description":"Membership Details"},"nights":{"description":"Number of Nights","type":"integer"},"noOfRooms":{"description":"Number of rooms.","type":"integer"},"originCode":{"description":"Channel used to create the reservation.","maxLength":40,"minLength":0,"type":"string"},"paymentType":{"description":"Payment method used for the reservation.","maxLength":50,"minLength":0,"type":"string"},"preRegistered":{"description":"Indicates whether the reservation is pre-registered for internet check-in or not.","type":"boolean"},"promotionCode":{"description":"Promotion Code for the Reservation.","maxLength":32000,"minLength":0,"type":"string"},"rateCode":{"description":"Rate code used for the reservation.","maxLength":20,"minLength":0,"type":"string"},"registrationCardNumber":{"description":"Registration card number.","maxLength":40,"minLength":0,"type":"string"},"reservationDates":{"$ref":"#/components/schemas/rsv_read_reservationDates","description":"Reservation Dates"},"reservationIdList":{"description":"Unique identifiers for both internal and external systems Eg: ReservationId, ConfirmationNumber, CancellationNumber, ExternalReferenceNumber etc","items":{"$ref":"#/components/schemas/rsv_read_distinctIDType"},"maxItems":10,"type":"array"},"reservationStatus":{"description":"Reservation status.","maxLength":20,"minLength":0,"type":"string"},"roomId":{"description":"Room Number.","maxLength":20,"minLength":0,"type":"string"},"roomType":{"description":"Room Type.","maxLength":32000,"minLength":0,"type":"string"},"shared":{"description":"Indicates if the reservation is shared or not.","type":"boolean"},"sourceCode":{"description":"Source of the created reservation.","maxLength":20,"minLength":0,"type":"string"},"travelAgentDetails":{"$ref":"#/components/schemas/rsv_read_travelAgentDetails","description":"Travel Agent Details"},"vipStatus":{"description":"VIP Status.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_reservationsSummary":{"description":"Response object to the Fetch Reservations information. Based on the criteria, reservation information is returned.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"reservationsSummaryInformation":{"$ref":"#/components/schemas/rsv_read_reservationsSummaryInformationType","description":"Collection of reservations summary fetched."},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_reservationsSummaryInformationType":{"description":"Reservations Summary.","properties":{"count":{"description":"Indicates number of records the API has returned actually as per the API request criteria.","type":"integer"},"hasMore":{"description":"Indicates whether there are more records available to be returned as per the API request criteria or not.","type":"boolean"},"limit":{"description":"Indicates number of records the API can return as per the API request limit sent. A maximum of 200 records can be only returned at a time.","type":"integer"},"offset":{"description":"Indicates the index of the next applicable set(page).","type":"integer"},"reservationsInformation":{"items":{"$ref":"#/components/schemas/rsv_read_reservationsInformationType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Indicates total number of records available that can be returned as per the API request criteria.","type":"integer"}},"type":"object"},"rsv_read_resvGuestMessageType":{"description":"List of Guest Messages","properties":{"createDateTime":{"description":"Time stamp of the creation. Uses the hotel's time zone.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"delivery":{"$ref":"#/components/schemas/rsv_read_messageDeliveryType","description":"Holds the Delivery Method Information"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification. Uses the hotel's time zone.","format":"date-time","type":"string"},"message":{"$ref":"#/components/schemas/rsv_read_resvMessageType","description":"Holds the Message Information"},"purgeDate":{"description":"Date an item will be purged from a database (e.g., from a live database to an archive).","format":"date","type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"rsv_read_resvGuestMessagesType":{"description":"Holds the Message Information","items":{"$ref":"#/components/schemas/rsv_read_resvGuestMessageType"},"maxItems":4000,"type":"array"},"rsv_read_resvMessageType":{"description":"Holds the Message Information","properties":{"arrivalDate":{"description":"Display the arrival date of the guest. Uses the hotel's time zone.","format":"date-time","type":"string"},"blockCode":{"description":"Display the block code associated with the reservation.","type":"string"},"blockId":{"$ref":"#/components/schemas/rsv_read_blockId","description":"Display the block Id associated with the reservation."},"confirmationNo":{"description":"Confirmation number of the reservation.","type":"string"},"departureDate":{"description":"Display the departure date of the guest. Uses the hotel's time zone.","format":"date-time","type":"string"},"guaranteeCode":{"description":"Guarantee Code.","maxLength":20,"minLength":0,"type":"string"},"guestNameId":{"description":"shows the Id of the Guest.","type":"integer"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"messageDate":{"description":"Date the message was created. Uses the hotel's time zone.","format":"date-time","type":"string"},"messageText":{"description":"Message Content","maxLength":2000,"minLength":0,"type":"string"},"noOfNights":{"description":"shows the number of nights for the reservation.","type":"integer"},"operator":{"description":"User who created the Message","maxLength":256,"minLength":0,"type":"string"},"recipient":{"description":"Recipient of the Message","maxLength":80,"minLength":0,"type":"string"},"reservationId":{"$ref":"#/components/schemas/rsv_read_reservationId","description":"Unique identifier of the reservation."},"reservationStatus":{"description":"Status of the reservation.","maxLength":80,"minLength":0,"type":"string"},"roomId":{"description":"Display room number if it has been assigned.","type":"string"},"roomStatus":{"description":"Display the status of the Room.","type":"string"},"typeOfMessage":{"$ref":"#/components/schemas/rsv_read_typeOfMessageType","description":"Type of message (Voice/Text)"}},"type":"object"},"rsv_read_rewardCertificateType":{"description":"Point Saver reward.","enum":["Regular","StayAnytime","PointSaver"],"type":"string"},"rsv_read_roomOccupancyType":{"description":"Room Occupancy information.","properties":{"estimatedDepartureTime":{"description":"Estimated Time of Departure of reservation when room status is occupied.","format":"date-time","type":"string"},"guestFirstName":{"description":"Guest First/Given Name on reservation when room status is occupied.","maxLength":40,"minLength":0,"type":"string"},"guestLastName":{"description":"Guest Last Name /Surname on reservation when room status is occupied.","maxLength":40,"minLength":0,"type":"string"},"reservationIdList":{"$ref":"#/components/schemas/rsv_read_uniqueIDListType","description":"A list of Ids for reservation( ResvNameId and ConfirmationNumber)."},"roomId":{"description":"Room Id.","maxLength":20,"minLength":0,"type":"string"},"roomIsOccupied":{"description":"Indicates if the Room is currently occupied.","type":"boolean"},"roomNumberLocked":{"description":"This attribute is to verify if room number is locked for the reservation. When true the room number cannot be changed. This is supported when OPERA Control Do Not Move is active.","type":"boolean"},"roomStatus":{"$ref":"#/components/schemas/rsv_read_housekeepingRoomStatusType","description":"Room status"},"roomType":{"description":"Room Type.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_roomOwnershipType":{"description":"Define the search criteria for retrieving room ownership records","properties":{"contractNumber":{"description":"Contract number for room owner.","type":"string"},"endDate":{"description":"End Date of the room ownership record.","format":"date","type":"string"},"profileId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Profile ID of the room ownership record."},"roomCategory":{"description":"Room Category of the room ownership record.","type":"string"},"roomId":{"description":"Room Id of room owner.","type":"string"},"roomOwnershipId":{"description":"Unique Id for Room Owner record.","type":"integer"},"roomType":{"description":"Room Type of the room ownership record.","type":"string"},"startDate":{"description":"Start Date of the room ownership record.","format":"date","type":"string"},"status":{"description":"Status of the room ownership record.","type":"string"}},"type":"object"},"rsv_read_roomRateType":{"properties":{"allowAutoCheckIn":{"description":"It represents whether auto check-in is enabled or not for psuedo room types.","type":"boolean"},"awardCode":{"description":"Used by 3rd party CRS, the Award Code defines if this day/rate was booked as an Award in the Loyalty System.","maxLength":20,"minLength":0,"type":"string"},"awardNumber":{"description":"Used by 3rd party CRS, the Award Number defines if this day/rate was booked as an Award in the Loyalty System.","maxLength":80,"minLength":0,"type":"string"},"awards":{"$ref":"#/components/schemas/rsv_read_resAwardsType","description":"Membership Awards code applied on the reservation."},"barRanking":{"description":"Best Available rates ranking.","type":"integer"},"bogoDiscount":{"description":"Indicates if the Rate Code has BOGO(Bye one Get one) indicator.","type":"boolean"},"bookingMedium":{"description":"Classifies the medium(Channel field on reservation screen) through which the reservation is made.","maxLength":40,"minLength":0,"type":"string"},"bookingMediumDescription":{"description":"Description of the booking medium.","maxLength":2000,"minLength":0,"type":"string"},"commissionAmount":{"description":"Indicates commission amount used by the rate plan.","type":"integer"},"commissionCode":{"description":"Commission Code applicable for commission calculation for Travel Agent/Company.","maxLength":20,"minLength":0,"type":"string"},"commissionPercentage":{"description":"Indicates commission percentage used by the rate plan.","type":"integer"},"commissionable":{"description":"Indicates Commission is applicable for commission calculation for Travel Agent/Company.","type":"boolean"},"complimentary":{"description":"Indicates this reservation rate is complimentary.","type":"boolean"},"discountAllowed":{"description":"Indicates if the Rate Code is discountable i.e discounts are allowed on the rate code.","type":"boolean"},"eligibilityCode":{"description":"Used by 3rd party CRS, the Eligible Reservation Code defines if this day/rate is eligible for points in the Loyalty System.","maxLength":20,"minLength":0,"type":"string"},"end":{"description":"The ending value of the date range.","format":"date","type":"string"},"fixedRate":{"description":"Fixed Rate Indicator.","type":"boolean"},"guestCounts":{"$ref":"#/components/schemas/rsv_read_guestCountsType","description":"A collection of Guest Counts associated with the room rate."},"houseUseOnly":{"description":"Indicates this reservation is for House use.","type":"boolean"},"inventoryLender":{"description":"Indicates whether the room type inventory was taken from the allotment or House availability.","type":"string"},"marketCode":{"description":"The code that relates to the market being sold to (e.g., the corporate market, packages).","maxLength":20,"minLength":0,"type":"string"},"marketCodeDescription":{"description":"Description of the market code.","maxLength":4000,"minLength":0,"type":"string"},"membershipEligible":{"description":"Is rate plan code flagged as eligible for memberships? This flag controls whether the guest stay, which this rate plan is attached to, qualifies for point calculations for Frequent Flyer or Frequent Guest programs. If the rate plan associated to the reservation has not been flagged for Membership then the guest will not earn any points/miles for their stay.","type":"boolean"},"numberOfUnits":{"description":"The number of rooms.","type":"integer"},"offshoreRateInformation":{"$ref":"#/components/schemas/rsv_read_offshoreRateType"},"ownerReferralRateCode":{"description":"Indicates if the rate code is restricted for use by Owner Referral Reservations","type":"boolean"},"ownerUseRateCode":{"description":"Indicates if the rate code is restricted for use by Owner Reservations.","type":"boolean"},"packages":{"items":{"$ref":"#/components/schemas/rsv_read_packageElementType"},"maxItems":4000,"type":"array"},"promotionCode":{"maxLength":20,"minLength":0,"type":"string"},"pseudoRoom":{"description":"True indicates as pseudo room type. This is usually used for a posting master reservation.","type":"boolean"},"purposeOfStay":{"description":"Purpose of stay.","maxLength":20,"minLength":0,"type":"string"},"rateGroup":{"description":"For RatePlanSet equals BESTAVAILABLERATE, in case Rate Groups are enabled the element provides the rate group for the rate plan code.","maxLength":20,"minLength":0,"type":"string"},"rateIncludesTax":{"description":"Indicates if the calculated amount for the day is inclusive of tax.","type":"boolean"},"rateLevel":{"description":"Rate plan type like Corporate,Regular,Military,Weekend etc.","maxLength":20,"minLength":0,"type":"string"},"ratePlanCode":{"maxLength":20,"minLength":0,"type":"string"},"rates":{"$ref":"#/components/schemas/rsv_read_ratesType"},"reservationBlock":{"$ref":"#/components/schemas/rsv_read_reservationBlockType","description":"Key information about the block for this reservation."},"roomId":{"description":"A string value representing the unique identification of a room.","maxLength":20,"minLength":0,"type":"string"},"roomNumberLocked":{"description":"This attribute is to verify if the move in room number is locked. When true the move in room number cannot be changed. Locking a room number is available when the Do Not Move OPERA Control is active.","type":"boolean"},"roomRateInfo":{"description":"Information about the Room Rate Combination.","maxLength":2000,"minLength":0,"type":"string"},"roomType":{"maxLength":20,"minLength":0,"type":"string"},"roomTypeCharged":{"description":"Room Type used for the Rate calculation.","maxLength":20,"minLength":0,"type":"string"},"scheduledMoveStatus":{"$ref":"#/components/schemas/rsv_read_scheduledRoomMoveStatusType","description":"Scheduled room move status for the room segment of the reservation. Scheduled Room Move functionality is available when the Advance Daily Detail OPERA Control is active."},"sourceCode":{"description":"To specify where the business came from e.g. radio, newspaper ad, etc.","maxLength":20,"minLength":0,"type":"string"},"sourceCodeDescription":{"description":"Description of the source of business.","maxLength":4000,"minLength":0,"type":"string"},"start":{"description":"The starting value of the date range.","format":"date","type":"string"},"stayProfiles":{"description":"Profile associated with the room Stay.","items":{"$ref":"#/components/schemas/rsv_read_reservationProfileType"},"maxItems":4000,"type":"array"},"suppressRate":{"type":"boolean"},"taxFreeGuestCounts":{"$ref":"#/components/schemas/rsv_read_guestCountsType","description":"A collection of Tax Free Guest Counts associated with the room rate. This list does not add to the guest count but just indicates number of tax free guests out of guest counts."},"taxIncluded":{"description":"If true, indicates if tax is included in the rate code.","type":"boolean"},"total":{"$ref":"#/components/schemas/rsv_read_totalType"},"totalPoints":{"$ref":"#/components/schemas/rsv_read_pointsType"}},"type":"object"},"rsv_read_roomStayType":{"properties":{"ageThresholdAllGuestsExceeded":{"description":"Returns as true if all guests on the reservation have a DOB which exceeds the configured minimum age threshold of the property. Returns as False if there are valid DOBs for all guests on the reservation, but 1 or more does not exceed the configured age threshold of the property.","type":"boolean"},"ageThresholdAnyGuestsExceeded":{"description":"Returns as true if 1 or more guests on the reservation has a DOB which exceeds the configured age threshold of the property.","type":"boolean"},"ageThresholdPrimaryGuestExceeded":{"description":"Returns as true if the primary guest on the reservation has a DOB which exceeds the configured minimum age threshold of the property. Returns as False if the DOB of the guest does not exceed the age threshold of the property.","type":"boolean"},"arrivalDate":{"format":"date","type":"string"},"availableUpsellOfferCount":{"description":"Number of Upsell Offers Available for this stay. This will only be populated if the Upsell Instruction is included in the Allowed Instruction request","type":"integer"},"bookingMedium":{"description":"Classifies the medium(Channel field on reservation screen) through which the reservation is made.","maxLength":40,"minLength":0,"type":"string"},"bookingMediumDescription":{"description":"Description of the booking medium.","maxLength":2000,"minLength":0,"type":"string"},"bookingTimeSpan":{"$ref":"#/components/schemas/rsv_read_bookingTimeSpanType","description":"The booking time span of the reservation, only applicable when time increments are being used."},"currentRoomInfo":{"$ref":"#/components/schemas/rsv_read_currentRoomInfoType","description":"Room information of the reservation for the current day."},"departureDate":{"format":"date","type":"string"},"expectedTimes":{"$ref":"#/components/schemas/rsv_read_resExpectedTimesType","description":"The Expected Arrival and Departure Times."},"guarantee":{"$ref":"#/components/schemas/rsv_read_resGuaranteeType","description":"The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context."},"guestCounts":{"$ref":"#/components/schemas/rsv_read_guestCountsType"},"hasExtendedStayRates":{"description":"Indicates if resertvation has a rate that is configured with a non-nightly posting interval.","type":"boolean"},"mobileNotifications":{"$ref":"#/components/schemas/rsv_read_resMobileNotificationsType","description":"Denotes the status of Room Ready and Key Ready messages."},"multiValueAttrs":{"description":"Informative indicators indicating different values of an attribute exists over the stay.","items":{"maxLength":2000,"type":"string"},"maxItems":4000,"type":"array"},"originalTimeSpan":{"$ref":"#/components/schemas/rsv_read_timeSpanType","description":"The Original Time Span(Arrival, Departure) which covers the Room Stay. In case of Rolling No Show TimeSpan's StratDate moves forward but OriginalTimeSpan's StratDate remains the same."},"postingIntervals":{"description":"A collection of Posting Interval details for the reservation.","items":{"$ref":"#/components/schemas/rsv_read_postingIntervalType"},"maxItems":4000,"type":"array"},"primaryShareType":{"$ref":"#/components/schemas/rsv_read_primaryShareTypeType","description":"This is populated in case of primary share scenario. This indicates whether this reservation is primary or non primary. Changes or postings to the 'non-primary' share reservation is not allowed."},"printRate":{"description":"This control whether rate info will be printed in confirmation letter.","type":"boolean"},"promotion":{"$ref":"#/components/schemas/rsv_read_promotionType","description":"Promotions applied to the reservation to get the promotional rate."},"registrationNumber":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Registration Number of the reservation for the current day."},"remoteCheckInAllowed":{"description":"Indicates whether the reservation is pre-registered for internet check-in or not.","type":"boolean"},"reservationKeyInfo":{"$ref":"#/components/schemas/rsv_read_reservationKeyInfoType","description":"Holds the room key information provided by the Door Lock System."},"roomNumberLocked":{"description":"When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.","type":"boolean"},"roomRates":{"description":"A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can have multiple rates. Example King room, Rack rate plan, Monday through Thursday, weekday amount, Friday and Saturday, weekend amount.","items":{"$ref":"#/components/schemas/rsv_read_roomRateType"},"maxItems":4000,"type":"array"},"scheduledRoomMoveRoomPending":{"description":"Pending Scheduled Move Room.","type":"boolean"},"suiteWith":{"description":"Connecting Rooms.","maxLength":200,"minLength":0,"type":"string"},"total":{"$ref":"#/components/schemas/rsv_read_totalType","description":"The total amount charged for the Room Stay."},"totalPoints":{"$ref":"#/components/schemas/rsv_read_pointsType","description":"The total number of Points charged for the Room Stay."},"upsellInfo":{"$ref":"#/components/schemas/rsv_read_upsellInfoType","description":"Indicates Upsell Information to be applied on Reservation."}},"type":"object"},"rsv_read_routingInfoListType":{"description":"A routing info object can either be of type Folio OR of type Room with its corresponding instructions.","items":{"$ref":"#/components/schemas/rsv_read_routingInfoType"},"maxItems":4000,"type":"array"},"rsv_read_routingInfoType":{"description":"A routing info object can either be of type Folio OR of type Room with its corresponding object.","properties":{"comp":{"description":"Comp Accounting Routing Info","properties":{"compAccountingInfo":{"$ref":"#/components/schemas/rsv_read_compAccountingType"},"compRequestInfo":{"$ref":"#/components/schemas/rsv_read_compRoutingRequestType"},"folioWindowNo":{"type":"integer"},"instructions":{"description":"Set of routing instructions associated to this routing type.","items":{"$ref":"#/components/schemas/rsv_read_routingInstructionType"},"maxItems":4000,"type":"array"},"payeeInfo":{"$ref":"#/components/schemas/rsv_read_payeeInfoType"}},"type":"object"},"folio":{"description":"Folio routing type.","properties":{"aRNumber":{"description":"Accounts Receivable.","maxLength":20,"minLength":0,"type":"string"},"folioWindowNo":{"type":"integer"},"guestInfo":{"description":"Guest details","properties":{"profileIdList":{"$ref":"#/components/schemas/rsv_read_profileIdList","description":"Unique identifiers for the Profile for both internal and external systems."}},"type":"object"},"instructions":{"description":"Set of routing instructions associated to this routing type.","items":{"$ref":"#/components/schemas/rsv_read_routingInstructionType"},"maxItems":4000,"type":"array"},"payeeInfo":{"$ref":"#/components/schemas/rsv_read_payeeInfoType"},"paymentMethod":{"maxLength":2000,"type":"string"}},"type":"object"},"refreshFolio":{"description":"On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions.","type":"boolean"},"request":{"description":"Comp Accounting Request routing","properties":{"compRequestInfo":{"$ref":"#/components/schemas/rsv_read_compRoutingRequestType"},"instructions":{"description":"Set of routing instructions associated to this routing type.","items":{"$ref":"#/components/schemas/rsv_read_routingInstructionType"},"maxItems":4000,"type":"array"}},"type":"object"},"room":{"description":"Room routing type.","properties":{"guestDisplayName":{"description":"Display Name for the guest.","maxLength":80,"minLength":0,"type":"string"},"guestNameId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Guest unique identifier to which the instruction will be routed."},"instructions":{"description":"Set of routing instructions associated to this routing type.","items":{"$ref":"#/components/schemas/rsv_read_routingInstructionType"},"maxItems":4000,"type":"array"},"reservationNameId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Reservation name id to which the instruction will be routed."},"roomId":{"description":"Room number to route the instructions.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"}},"type":"object"},"rsv_read_routingInstructionType":{"description":"Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit","properties":{"billingInstructions":{"$ref":"#/components/schemas/rsv_read_billingInstructionsType","description":"Set of Billing Instructions configured in this time span."},"covers":{"description":"Number of covers for this routing instruction.","type":"number"},"creditLimit":{"description":"Allowable credit amount for this routing instruction. Null value means no limit, 0 equals zero.","type":"number"},"duration":{"description":"Duration of this instruction.","properties":{"daily":{"description":"Flag to indicate if the routing instruction is a daily instruction.","type":"boolean"},"friday":{"type":"boolean"},"monday":{"type":"boolean"},"saturday":{"type":"boolean"},"sunday":{"type":"boolean"},"thursday":{"type":"boolean"},"timeSpan":{"$ref":"#/components/schemas/rsv_read_timeSpanType"},"tuesday":{"type":"boolean"},"wednesday":{"type":"boolean"}},"type":"object"},"limitUsed":{"description":"Amount of Credit used for this routing instruction.","type":"number"},"percentageLimit":{"description":"The routing limit percentage allowed for this routing instruction.","type":"number"},"routingLinkId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Internal Routing Link Id identifier to which limit group the instruction belongs."},"transactionCodes":{"$ref":"#/components/schemas/rsv_read_trxCodesInfoType","description":"Set of Transaction Codes configured in this time span."}},"type":"object"},"rsv_read_routingInstructions":{"description":"Response object containing routing instructions for a reservation.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"routingInstructions":{"$ref":"#/components/schemas/rsv_read_routingInfoListType","description":"Set of Routing Instructions."},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_scheduledRoomMoveInfoType":{"description":"Scheduled Move information.","properties":{"estimatedMoveTime":{"description":"Estimated Move Time. Uses the hotel's time zone.","format":"date-time","type":"string"},"moveComments":{"description":"Comments about scheduled move.","maxLength":200,"minLength":0,"type":"string"},"moveInRoomOccupancyInfo":{"$ref":"#/components/schemas/rsv_read_roomOccupancyType","description":"Scheduled Move In Room Occupancy Information."},"moveOutRoomId":{"description":"Scheduled Move Out Room Id.","maxLength":20,"minLength":0,"type":"string"},"moveOutRoomStatus":{"$ref":"#/components/schemas/rsv_read_housekeepingRoomStatusType","description":"Scheduled Move Out Room Status."},"moveOutRoomType":{"description":"Scheduled Move Out Room Type.","maxLength":20,"minLength":0,"type":"string"},"moveStatus":{"$ref":"#/components/schemas/rsv_read_scheduledRoomMoveStatusType","description":"Scheduled Room Move Status."}},"type":"object"},"rsv_read_scheduledRoomMoveResponseType":{"description":"Scheduled Room Move information.","properties":{"estimatedMoveTime":{"description":"Estimated Move Time in 24Hour Format. Uses the hotel's time zone.","format":"date-time","type":"string"},"moveComments":{"description":"Comments about scheduled move.","maxLength":200,"minLength":0,"type":"string"},"moveInRoomOccupancyInfo":{"$ref":"#/components/schemas/rsv_read_roomOccupancyType","description":"Scheduled Move In Room Occupancy Information."}},"type":"object"},"rsv_read_scheduledRoomMoveStatusType":{"description":"Flag indicating scheduled room move status.","enum":["Completed","Pending"],"type":"string"},"rsv_read_scheduledRoomMoveType":{"description":"Scheduled Move information.","properties":{"roomAssignmentSegmentBegin":{"description":"Date Room Assignment Begins. Uses the hotel's time zone.","format":"date-time","type":"string"},"roomAssignmentSegmentEnd":{"description":"Date of the Scheduled Move Room. Uses the hotel's time zone.","format":"date-time","type":"string"},"roomAssignmentSegmentNo":{"description":"Room Assignment Segment Number.","type":"integer"},"roomNumberLocked":{"description":"This attribute is to verify if room number is locked for the reservation. When true the room number cannot be changed. This is supported when OPERA Control Do Not Move is active.","type":"boolean"},"scheduledRoomMoveInfo":{"$ref":"#/components/schemas/rsv_read_scheduledRoomMoveInfoType","description":"Scheduled Room Move information for a reservation."}},"type":"object"},"rsv_read_scopeType":{"description":"Minimum required and complimentary values are applicable Per Stay.","enum":["PerDay","PerStay"],"type":"string"},"rsv_read_script":{"description":"Script for a Reservation based on its StayDetails as well as itinerary.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"script":{"description":"The script for the reservation, which was requested.","format":"byte","type":"string"},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_searchMatchType":{"description":"Search match indicating attribute and the matching value.","properties":{"attribute":{"description":"Search match attribute.","maxLength":2000,"minLength":0,"type":"string"},"value":{"description":"Search match value.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_searchMatchesType":{"description":"List of Generic Name-Value-Pair Parameters used for super search matches.","items":{"$ref":"#/components/schemas/rsv_read_searchMatchType"},"maxItems":4000,"type":"array"},"rsv_read_searchPreConfiguredRoutingInstructionsRequest":{"additionalProperties":false,"properties":{"addresseeIds":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","items":{"type":"string"},"type":"array"},"addresseeName":{"description":"Attached profile name","type":"string"},"billingContactIds":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","items":{"type":"string"},"type":"array"},"billingContactName":{"description":"Attached profile name","type":"string"},"companyIds":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","items":{"type":"string"},"type":"array"},"companyName":{"description":"Attached profile name","type":"string"},"contactIds":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","items":{"type":"string"},"type":"array"},"contactName":{"description":"Attached profile name","type":"string"},"groupIds":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","items":{"type":"string"},"type":"array"},"groupName":{"description":"Attached profile name","type":"string"},"guestIds":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","items":{"type":"string"},"type":"array"},"guestName":{"description":"Attached profile name","type":"string"},"promotionCodes":{"description":"Promotion Code for ComplimentaryRouting","items":{"type":"string"},"maxItems":4000,"type":"array"},"rateCode":{"type":"string"},"reservationId":{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","maxLength":2000,"minLength":1,"type":"string"},"sourceIds":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","items":{"type":"string"},"type":"array"},"sourceName":{"description":"Attached profile name","type":"string"},"travelAgentIds":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","items":{"type":"string"},"type":"array"},"travelAgentName":{"description":"Attached profile name","type":"string"}},"type":"object"},"rsv_read_searchReservationsSummaryRequest":{"additionalProperties":false,"properties":{"advancedCheckedIn":{"description":"This filter indicates if the reservation(s) has performed an Advance Check-In or not. Data fetched is for 30 days ahead of business date.","type":"boolean"},"arrivalDate":{"description":"This filter is for the date of arrival of reservation.","format":"date","type":"string"},"balance":{"description":"This filter checks reservations with balance amount greater than or equal to this amount. Departure date is required along with balance to filter the data.","type":"number"},"cancellationNumber":{"description":"This filter is ID of cancellation for the reservation.","type":"string"},"cancelledOn":{"description":"This filter is for the date when reservation(s) was cancelled.","format":"date","type":"string"},"companyId":{"description":"This filter is ID of the company used for the reservation. Data fetched is for +-2 business date only when passed alone.","type":"number"},"confirmationNumber":{"description":"This filter is ID of confirmation for the reservation.","type":"string"},"createDateTime":{"description":"This filter is for the business date when reservation(s) was created in the system.","format":"date","type":"string"},"departureDate":{"description":"This filter is for the date of departure of reservation.","format":"date","type":"string"},"externalReferenceNumber":{"description":"This filter is ID of external reference for the reservation.","type":"string"},"folioClosedOn":{"description":"This filter is for the date when reservation(s) folio was closed.","format":"date","type":"string"},"guestNameId":{"description":"This filter is ID of the guest.","type":"number"},"lastName":{"description":"This filter looks up reservations with this last Name. Data fetched is for +-2 business date only when passed alone.","type":"string"},"limit":{"default":200,"description":"This filter indicates number of records the API has to fetch.","type":"integer"},"membershipNumber":{"description":"This filter is used for looking up reservations with this membership number. Last Name is required along with membership number to filter the data.","type":"string"},"offset":{"default":0,"description":"This filter is for the index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.","type":"integer"},"preRegistered":{"description":"This filter indicates whether the reservation is Pre-Registered for Internet Check-In or not. Data fetched is for 30 days ahead of business date.","type":"boolean"},"registeredCardNumber":{"description":"This filter is unique identifier of the registration card number. Last Name is required along with registration card number to filter the data.","type":"string"},"reservationStatus":{"$ref":"#/components/schemas/rsv_read_reservationStatusEnum","description":"This filter is computed reservation status of the reservation(s)."},"roomId":{"description":"This filter is for room number.","type":"string"}},"type":"object"},"rsv_read_sellMessageConfigType":{"description":"Only one of the following can hold a value: HotelCode, CROCode or ChainCode","properties":{"blockCode":{"description":"Block Code to which the sell message is defined.","maxLength":20,"minLength":0,"type":"string"},"blockId":{"$ref":"#/components/schemas/rsv_read_blockId","description":"Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA."},"chainCode":{"description":"Chain Code for which the sell message is defined.","maxLength":20,"minLength":0,"type":"string"},"croCode":{"description":"CRO Code for which the sell message is defined.","maxLength":20,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel Code for which the sell message is defined.","maxLength":20,"minLength":0,"type":"string"},"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"languageCode":{"description":"Language in which the sell message is defined.","maxLength":20,"minLength":0,"type":"string"},"message":{"description":"Sell message text.","maxLength":2000,"minLength":0,"type":"string"},"ratePlanCode":{"description":"Rate Plan Code for which the sell message is defined.","maxLength":20,"minLength":0,"type":"string"},"roomType":{"description":"Room type for which the sell message is defined.","maxLength":20,"minLength":0,"type":"string"},"sellSequence":{"description":"This number indicates the display order of the sell message.","type":"number"},"stickyFlag":{"description":"Sticky flag is used to define if the sell message should display on the block screen by default.","type":"boolean"},"timespan":{"$ref":"#/components/schemas/rsv_read_timeSpanType","description":"Begin and End date for the sell message."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"},"usedInModule":{"description":"This represents the moduleType where we want to display this SellMessage.","items":{"$ref":"#/components/schemas/rsv_read_usedInModuleType"},"maxItems":10,"type":"array"}},"type":"object"},"rsv_read_sellMessageConfigsType":{"description":"The SellMessageConfigsType is the list of sell messages, each comprising of all the sell message attributes and other details.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"sellMessageConfig":{"items":{"$ref":"#/components/schemas/rsv_read_sellMessageConfigType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"rsv_read_sentConfirmationStatus":{"enum":["Pending","Succeeded","Failed"],"type":"string"},"rsv_read_serviceRequest":{"description":"Service request.","properties":{"action":{"description":"Description of the action taken to complete the request.","maxLength":200,"minLength":0,"type":"string"},"code":{"description":"Service request code.","maxLength":20,"minLength":0,"type":"string"},"comment":{"description":"Description of the service request.","maxLength":2000,"minLength":0,"type":"string"},"department":{"$ref":"#/components/schemas/rsv_read_codeDescriptionType","description":"The department that is associated with the service request code."},"guestName":{"description":"The guest name.","maxLength":200,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel Code of the service request.","maxLength":20,"minLength":0,"type":"string"},"priority":{"description":"The priority level of the service request.","maxLength":20,"minLength":0,"type":"string"},"profileId":{"$ref":"#/components/schemas/rsv_read_profileId","description":"Unique identifier of the guest."},"reservationIdList":{"$ref":"#/components/schemas/rsv_read_reservationIdList","description":"Unique identifier of the reservation."},"room":{"description":"The room number in which the service request was created.","maxLength":20,"minLength":0,"type":"string"},"status":{"$ref":"#/components/schemas/rsv_read_serviceRequestStatusType","description":"The status of the service request."}},"type":"object"},"rsv_read_serviceRequestStatusType":{"enum":["Open","PendingFollowUp","Closed","DoNotDisturb","MakeUpRoom"],"type":"string"},"rsv_read_serviceRequests":{"description":"Service request.","items":{"$ref":"#/components/schemas/rsv_read_serviceRequest"},"maxItems":4000,"type":"array"},"rsv_read_shareDistributionInstructionType":{"description":"The type of Rate Amount Change to be done on the Sharer reservation. This can be FULL -\u003e Full Rate for each Sharer. SPLIT-\u003e Split the Rate amount between Sharer Reservations. ENTIRE -\u003e This Sharer will get the total amount of the rate code for all the Sharer Reservations.","enum":["Full","Entire","Split","CustomSplit"],"type":"string"},"rsv_read_shareReservations":{"description":"Response for the fetch share reservation request. This returns all sharer reservations including the request reservation.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"shareReservations":{"$ref":"#/components/schemas/rsv_read_hotelReservationsType","description":"Collection of guests who share this reservation. Reservation information will only include the Room Information and Guest Information."},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_sourceOfSaleType":{"description":"Point of Sale of reservation. Identifies the entity/channel who made the reservation.","properties":{"sourceCode":{"description":"The entity/channel who made the reservation.","maxLength":20,"minLength":0,"type":"string"},"sourceType":{"description":"Type of entity/channel who made the reservation..","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_statusType":{"description":"Status of the batch process.","enum":["Success","Error","Running","Stopped","Warning","Failed","Started","CompletedWithLogs"],"type":"string"},"rsv_read_stayFutureListType":{"description":"A collection of reservation history details attached to Profiles.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"reservationInfo":{"description":"Additional reservation information attached to the profile . Eg : Future reservation details","items":{"$ref":"#/components/schemas/rsv_read_stayReservationInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"rsv_read_stayHistoryListType":{"description":"A collection of reservation history details attached to Profiles.","properties":{"count":{"description":"Total number of rows returned","type":"integer"},"hasMore":{"description":"Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.","type":"boolean"},"reservationInfo":{"description":"Additional reservation information attached to the profile . Eg : History reservation details","items":{"$ref":"#/components/schemas/rsv_read_stayReservationInfoType"},"maxItems":4000,"type":"array"},"totalResults":{"description":"Total number of rows queried","type":"integer"}},"type":"object"},"rsv_read_stayInfoType":{"description":"Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties.","properties":{"adultCount":{"description":"A collection of Guest Counts associated with Room Stay.","type":"integer"},"arrivalDate":{"format":"date","type":"string"},"assignedByAI":{"description":"Represents the room was assigned by AI Room Assignment.","type":"boolean"},"backToBack":{"description":"This attribute indicates if the linked reservation is marked as Back to Back or not.","type":"boolean"},"backToBackGroupId":{"description":"This attribute represents a common identifier for a subgroup of linked reservations marked as Back to Back in a group of linked reservations.","maxLength":80,"minLength":0,"type":"string"},"backToBackSequence":{"$ref":"#/components/schemas/rsv_read_backToBackResSequenceType","description":"This attribute represents Back To Back Sequence of Linked Reservations(e.g. '1 of 2' i.e, 1 indicates Sequence Position of total count 2). This is applicable when OPERA control Back to Back Handling for Linked Reservations is active."},"balance":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Balance amount"},"bookingChannelCode":{"description":"Classifies the medium(Channel field on reservation screen) through which the reservation is made.","maxLength":40,"minLength":0,"type":"string"},"bookingTimeSpan":{"$ref":"#/components/schemas/rsv_read_bookingTimeSpanType","description":"The booking time span of the reservation, only applicable when time increments are being used."},"childAges":{"$ref":"#/components/schemas/rsv_read_childAgesType","description":"Defines Children's Ages. Number of children ages mentioned may mot match with children counts."},"childBuckets":{"$ref":"#/components/schemas/rsv_read_childBucketsType","description":"Defines children counts with Age Qualifying Group(Child Bucket#1) classification."},"childCount":{"description":"A collection of Child Counts associated with Room Stay.","type":"integer"},"compBalance":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Comp Balance amount"},"departureDate":{"format":"date","type":"string"},"depositPayments":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"A collection of deposit and/or payments for the Room Stay."},"expectedTimes":{"$ref":"#/components/schemas/rsv_read_resExpectedTimesType","description":"The expected arrival, return and departure times of the guest."},"fixedRate":{"description":"True if the rate is a fixed rate, otherwise false","type":"boolean"},"guarantee":{"$ref":"#/components/schemas/rsv_read_resGuaranteeType","description":"The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context."},"guestServiceStatus":{"$ref":"#/components/schemas/rsv_read_guestHousekeepingServiceRequestType","description":"Service Status of In House guest like DND or MUP"},"linkCode":{"description":"Party code","maxLength":2000,"type":"string"},"marketCode":{"description":"Market code","maxLength":20,"minLength":0,"type":"string"},"numberOfRooms":{"description":"Room Id","type":"integer"},"offshoreRateInformation":{"$ref":"#/components/schemas/rsv_read_offshoreRateType"},"originalTimeSpan":{"$ref":"#/components/schemas/rsv_read_timeSpanType","description":"The Original Time Span covers the Room Stay dates of the original reservation."},"points":{"$ref":"#/components/schemas/rsv_read_pointsType","description":"The Points contains the number of points used to book a particular room type."},"postingInterval":{"$ref":"#/components/schemas/rsv_read_postingIntervalType","description":"Specifies the frequency at which charges are posted for the rate plan on the reservation."},"promotion":{"$ref":"#/components/schemas/rsv_read_promotionType","description":"Promotion Codes"},"pseudoRoom":{"description":"True indicates as pseudo room type. This is usually used for a posting master reservation.","type":"boolean"},"rateAmount":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Rate amount"},"ratePlanCode":{"description":"Rate plan code","maxLength":20,"minLength":0,"type":"string"},"rateSuppressed":{"description":"Whether this rate should be suppressed from view","type":"boolean"},"reservationBlock":{"$ref":"#/components/schemas/rsv_read_reservationBlockType","description":"Key information about the block for this reservation."},"roomAvailableNights":{"description":"Number of nights this room is avaiable if room is assigned to reservation","type":"integer"},"roomClass":{"description":"Room class code","maxLength":20,"minLength":0,"type":"string"},"roomId":{"description":"Room Id","maxLength":20,"minLength":0,"type":"string"},"roomNumberLocked":{"description":"When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.","type":"boolean"},"roomOwnershipType":{"$ref":"#/components/schemas/rsv_read_reservationRoomOwnershipType","description":"Provides the information of the assigned reservation room is an Owner, Referral or regular room.This value is returned when Room Rotation OPERA Control is active and room number is assigned to a reservation."},"roomType":{"description":"Room type code","maxLength":20,"minLength":0,"type":"string"},"roomTypeCharged":{"description":"Room type code that was charged","maxLength":20,"minLength":0,"type":"string"},"scheduledCheckoutTime":{"description":"Indicates that this reservation is scheduled for automated check out.","format":"date","type":"string"},"scheduledRoomMoveResponseType":{"$ref":"#/components/schemas/rsv_read_scheduledRoomMoveResponseType","description":"Scheduled Room Move Response Information."},"scheduledRoomMoveRoomPending":{"description":"Pending Scheduled Move Room.","type":"boolean"},"sourceCode":{"description":"Source of business","maxLength":20,"minLength":0,"type":"string"},"sourceCodeDescription":{"description":"Description of the source of business.","maxLength":4000,"minLength":0,"type":"string"},"totalAmount":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount."},"upgradedByAI":{"description":"Represents the room was assigned by AI Room Assignment.","type":"boolean"}},"type":"object"},"rsv_read_stayReservationInfoType":{"description":"The Reservation class contains the current reservation being created or altered.","properties":{"attachedProfiles":{"$ref":"#/components/schemas/rsv_read_resAttachedProfileListType","description":"List of attached profiles"},"computedReservationStatus":{"$ref":"#/components/schemas/rsv_read_pMS_ResStatusType","description":"Indicates the status of the reservation."},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"reservationIdList":{"$ref":"#/components/schemas/rsv_read_reservationIdList","description":"Unique identifiers for the reservation for both internal and external systems"},"reservationStatus":{"$ref":"#/components/schemas/rsv_read_pMS_ResStatusType","description":"Indicates the status of the reservation."},"roomStay":{"$ref":"#/components/schemas/rsv_read_stayInfoType","description":"Collection of room stays."}},"type":"object"},"rsv_read_surnameType":{"description":"Family name, last name.","maxLength":80,"minLength":0,"type":"string"},"rsv_read_taxType":{"description":"Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"code":{"description":"Code identifying the fee (e.g.,agency fee, municipality fee).","maxLength":20,"minLength":0,"type":"string"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"generateTransactionCode":{"description":"Unique identifier for Generate Tax Transaction code.","maxLength":20,"minLength":0,"type":"string"},"type":{"$ref":"#/components/schemas/rsv_read_amountDeterminationType","description":"Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other)."}},"type":"object"},"rsv_read_taxTypeType":{"description":"Provides information about the Tax Type.","properties":{"code":{"description":"Code of the Tax Type.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Description of the Tax Type.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_taxesType":{"description":"A collection of taxes.","properties":{"amount":{"description":"A monetary amount.","type":"number"},"currencyCode":{"description":"Provides a currency code to reflect the currency in which an amount may be expressed.","maxLength":3,"minLength":3,"type":"string"},"tax":{"description":"An individual tax.","items":{"$ref":"#/components/schemas/rsv_read_taxType"},"maxItems":99,"type":"array"},"totalTax":{"description":"A sum of the taxes which are related to Rate Info.","type":"number"}},"type":"object"},"rsv_read_telephoneInfoType":{"description":"Information on a telephone number for the customer.","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"telephone":{"$ref":"#/components/schemas/rsv_read_telephoneType","description":"Phone details for the profile."},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_telephoneType":{"description":"Information on a telephone number for the customer.","properties":{"createDateTime":{"description":"Time stamp of the creation.","format":"date-time","type":"string"},"creatorId":{"description":"ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.","maxLength":200,"minLength":0,"type":"string"},"extension":{"description":"Extension to reach a specific party at the phone number.","maxLength":20,"minLength":0,"type":"string"},"lastModifierId":{"description":"Identifies the last software system or person to modify a record.","maxLength":200,"minLength":0,"type":"string"},"lastModifyDateTime":{"description":"Time stamp of last modification.","format":"date-time","type":"string"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"phoneNumber":{"description":"Telephone number assigned to a single location.","maxLength":40,"minLength":0,"type":"string"},"phoneTechType":{"description":"Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc.","maxLength":20,"minLength":0,"type":"string"},"phoneUseType":{"description":"Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening).","maxLength":20,"minLength":0,"type":"string"},"phoneUseTypeDescription":{"description":"Description of the PhoneUseType code","maxLength":2000,"minLength":0,"type":"string"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"}},"type":"object"},"rsv_read_thresholdDetailsType":{"description":"Type for the threshold elements.","properties":{"complimentary":{"description":"The number of quantities, counts or minutes for which transaction diversion is allowed .","type":"integer"},"entity":{"$ref":"#/components/schemas/rsv_read_entityType","description":"Diversion entity type associated with the charge for the transaction diversion rule ."},"isEditable":{"description":"Configuring this flag to be TRUE will make the thresholds editable.","type":"boolean"},"minRequired":{"description":"Minimum required number of quantities, counts or minutes that must be posted.","type":"integer"},"scope":{"$ref":"#/components/schemas/rsv_read_scopeType","description":"Diversion scope for the transaction diversion rule."}},"type":"object"},"rsv_read_ticketType":{"description":"Reservation Ticket Type Information.","properties":{"consumptionDate":{"description":"Tickets comsumption date.","format":"date","type":"string"},"description":{"description":"Package description.","maxLength":2000,"minLength":0,"type":"string"},"issueDate":{"description":"Tickets issue date.","format":"date","type":"string"},"packageCode":{"description":"Package Code.","maxLength":20,"minLength":0,"type":"string"},"price":{"description":"Tickets price.","type":"number"},"quantity":{"description":"Number of tickets used to create multiple tickets.","type":"integer"},"rateCode":{"description":"The Rate Code to which tickets belong to.","maxLength":20,"minLength":0,"type":"string"},"reference":{"description":"Free text field for reference information.","maxLength":2000,"minLength":0,"type":"string"},"reservationProductId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Reference to the reservation product."},"status":{"description":"The Status Code for outbound WS call.","maxLength":20,"minLength":0,"type":"string"},"statusDescription":{"description":"The Status Description for outbound WS call.","maxLength":2000,"minLength":0,"type":"string"},"ticketId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Internal Unique ID."},"ticketNumber":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type","description":"Ticket number."}},"type":"object"},"rsv_read_tickets":{"description":"Common tickets request base type.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"tickets":{"$ref":"#/components/schemas/rsv_read_ticketsType","description":"Collection of inquired tickets."},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_ticketsType":{"description":"Collection of TicketType objects.","items":{"$ref":"#/components/schemas/rsv_read_ticketType"},"maxItems":4000,"type":"array"},"rsv_read_tierAdministrationType":{"description":"Do not upgrade membership. The membership may be downgraded.","enum":["Disabled","NoUpgrade"],"type":"string"},"rsv_read_timeSpanType":{"description":"Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.","properties":{"duration":{"type":"string"},"endDate":{"format":"date","type":"string"},"startDate":{"format":"date","type":"string"}},"type":"object"},"rsv_read_timeWindowType":{"description":"Defines a Time period with start time and an end time.","properties":{"endTime":{"description":"End Time of the Time window.","type":"string"},"startTime":{"description":"Start Time of the Time window.","type":"string"}},"type":"object"},"rsv_read_totalType":{"description":"The total amount charged for the service including additional amounts and fees.","properties":{"amountAfterTax":{"description":"The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).","type":"number"},"amountAfterTaxPerRoom":{"description":"The total amount per room including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).","type":"number"},"amountBeforeAnyTax":{"description":"The total amount per room does not include any associated tax (e.g., sales tax, VAT, GST or any associated tax), for both Tax Exclusive/Inclusive.","type":"number"},"amountBeforeTax":{"description":"The total amount not including any exclusive associated tax ( e.g., sales tax, VT, GST, or any associated tax configured as an exclusive generate ). Taxes marked as Tax Inclusive are included in this amount.","type":"number"},"amountBeforeTaxPerRoom":{"description":"The total amount per room not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).","type":"number"},"baseAmount":{"description":"The rate's base price. Amount excluding price for any add to rate combine line package attached to the rate.Also excludes any discounts","type":"number"},"code":{"description":"Type of charge.","maxLength":20,"minLength":0,"type":"string"},"currencyCode":{"description":"The code specifying a monetary unit. Use ISO 4217, three alpha code.","maxLength":20,"minLength":0,"type":"string"},"currencySymbol":{"description":"The symbol for the currency, e.g, for currencyCode USD the symbol is $.","maxLength":10,"minLength":0,"type":"string"},"decimalPlaces":{"description":"Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).","type":"integer"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"rateOverride":{"description":"When true indicates that the rate amount has been overridden.","type":"boolean"},"taxes":{"$ref":"#/components/schemas/rsv_read_taxesType","description":"A collection of taxes."}},"type":"object"},"rsv_read_traceFrequencyPatternType":{"description":"Defines the Trace Frequency for the created trace. Traces created with a defined trace frequency will have the trace dates automatically updated when a reservation changes based on selected frequency and corresponding configuration.","enum":["ArrivalNight","EveryXNightsStartingNightY","CertainNightsOfTheWeek","DepartureNight","EveryNight","XDaysPriorToArrival"],"type":"string"},"rsv_read_traceFrequencyType":{"description":"Defines the trace frequency settings and associated parameters for creating reservation traces. Fields are conditionally required  depending on the selected traceFrequencyPattern value.","properties":{"certainNightsOfTheWeek":{"$ref":"#/components/schemas/rsv_read_certainNightsOfTheWeek","description":"Applicable to 'Certain Nights Of The Week' frequency pattern. Represents which weekdays a trace should be generated for."},"daysPriorToArrival":{"description":"Applicable to 'X Days Prior To Arrival' frequency pattern. Represents the days prior to arrival on which a trace should be generated.","type":"integer"},"everyXDays":{"description":"Applicable to 'Every X Nights Starting Night Y' frequency pattern. Determines how often the trace recurs after the start day.","type":"integer"},"startOnDayY":{"description":"Applicable to 'Every X Nights Starting Night Y' frequency pattern. Specifies which day the trace should first be generated.","type":"integer"},"traceFrequencyPattern":{"$ref":"#/components/schemas/rsv_read_traceFrequencyPatternType","description":"Selects how frequently the trace should be generated."}},"type":"object"},"rsv_read_traceResolveType":{"properties":{"resolvedBy":{"description":"User that resolved the trace","type":"string"},"resolvedOn":{"description":"Date the trace was resolved","format":"date","type":"string"}},"type":"object"},"rsv_read_traceTimeInfoType":{"properties":{"dateTimeSpan":{"$ref":"#/components/schemas/rsv_read_dateTimeSpanType","description":"Time span for the trace."},"enteredBy":{"description":"User that entered this trace.","type":"string"},"traceOn":{"description":"Date of the trace. Uses the hotel's time zone.","format":"date-time","type":"string"},"traceTime":{"description":"Time of the trace","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_traces":{"description":"Return object to the request for information regarding traces.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"traces":{"$ref":"#/components/schemas/rsv_read_hotelReservationTracesType","description":"List of traces returned/fetched as per the criteria in the fetch request."},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_trackItActionType":{"description":"Identifies the response expected from staff or other parties relative to a Track It ticket.","properties":{"status":{"$ref":"#/components/schemas/rsv_read_actionStatusType"},"trackItAction":{"$ref":"#/components/schemas/rsv_read_codeDescriptionType"}},"type":"object"},"rsv_read_trackItGroup":{"description":"Group to which the Track It items belong.","enum":["Parcel","Valet","Baggage","Lost"],"type":"string"},"rsv_read_trackItId":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idContext":{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system.","type":"integer"},"instance":{"description":"The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":20,"minLength":0,"type":"string"},"url":{"description":"URL that identifies the location associated with the record identified by the UniqueID.","type":"string"}},"type":"object"},"rsv_read_trackItItemType":{"description":"Detailed information of a Track It item.","properties":{"action":{"$ref":"#/components/schemas/rsv_read_trackItActionType"},"assignedTo":{"$ref":"#/components/schemas/rsv_read_applicationUserType"},"description":{"maxLength":2000,"minLength":0,"type":"string"},"followUpDate":{"format":"date","type":"string"},"group":{"$ref":"#/components/schemas/rsv_read_trackItGroup"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"location":{"$ref":"#/components/schemas/rsv_read_codeDescriptionType"},"quantity":{"type":"integer"},"referenceNumber":{"maxLength":20,"minLength":0,"type":"string"},"reservationInfo":{"$ref":"#/components/schemas/rsv_read_trackItReservationInfoType"},"ticketNumber":{"maxLength":80,"minLength":0,"type":"string"},"trackItId":{"$ref":"#/components/schemas/rsv_read_trackItId"},"trackItLogList":{"$ref":"#/components/schemas/rsv_read_trackItLogListType"},"type":{"$ref":"#/components/schemas/rsv_read_trackItType"}},"type":"object"},"rsv_read_trackItItemsType":{"description":"","items":{"$ref":"#/components/schemas/rsv_read_trackItItemType"},"maxItems":4000,"type":"array"},"rsv_read_trackItLogListType":{"items":{"$ref":"#/components/schemas/rsv_read_trackItLogType"},"maxItems":4000,"type":"array"},"rsv_read_trackItLogType":{"description":"Individual activity log related to the Track It ticket.","properties":{"businessDate":{"format":"date","type":"string"},"description":{"maxLength":200,"minLength":0,"type":"string"},"hotelId":{"maxLength":20,"minLength":0,"type":"string"},"logDate":{"description":"Uses the hotel's time zone.","format":"date-time","type":"string"},"logUserId":{"type":"integer"},"logUserName":{"type":"string"},"trackItId":{"$ref":"#/components/schemas/rsv_read_trackItId"},"trackItLogId":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type"},"type":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_trackItReservationInfoType":{"description":"Reservation info associated with a Track It item.","properties":{"computedReservationStatus":{"$ref":"#/components/schemas/rsv_read_pMS_ResStatusType"},"guarantee":{"$ref":"#/components/schemas/rsv_read_resGuaranteeType"},"guestInfo":{"$ref":"#/components/schemas/rsv_read_resGuestInfoType"},"reservationIdList":{"$ref":"#/components/schemas/rsv_read_reservationIdList"},"reservationStatus":{"$ref":"#/components/schemas/rsv_read_pMS_ResStatusType"},"roomId":{"maxLength":20,"minLength":0,"type":"string"},"roomStatus":{"$ref":"#/components/schemas/rsv_read_housekeepingRoomStatusType"},"roomType":{"maxLength":20,"minLength":0,"type":"string"},"timeSpan":{"$ref":"#/components/schemas/rsv_read_timeSpanType"}},"type":"object"},"rsv_read_trackItType":{"description":"Identifies the kind of Parcel, Baggage, or Lost items or Valet-managed vehicles or services.","properties":{"type":{"$ref":"#/components/schemas/rsv_read_codeDescriptionType"},"url":{"$ref":"#/components/schemas/rsv_read_uRLType"}},"type":"object"},"rsv_read_transactionDiversionDailyDetailType":{"description":"List of daily details for Transaction Diversion rule.","properties":{"date":{"description":"Daily details Date about when the rules are posted or diverted.","format":"date","type":"string"},"diverted":{"description":"Transaction diversion rules that are diverted .","type":"integer"},"posted":{"description":"Transaction diversion rules that are posted.","type":"integer"}},"type":"object"},"rsv_read_transactionDiversionDailyDetailsType":{"description":"List of daily details for Transaction Diversion rule.","items":{"$ref":"#/components/schemas/rsv_read_transactionDiversionDailyDetailType"},"maxItems":4000,"type":"array"},"rsv_read_transactionDiversionRuleLevelType":{"description":"Reservation level.","enum":["Property","Reservation"],"type":"string"},"rsv_read_transactionDiversionRuleTypeType":{"description":"The rule type on which the Transaction Diversion Rule is based. If a reservation has any of the following code, Transaction Diversion rule gets active for that reservation","enum":["Vip","Membership"],"type":"string"},"rsv_read_transactionDiversions":{"description":"Response to fetch the transaction diversion rules attached to a reservation.","properties":{"links":{"$ref":"#/components/schemas/rsv_read_links"},"transactionDiversions":{"$ref":"#/components/schemas/rsv_read_reservationTransactionDiversionsType","description":"A collection of transaction diversion rules."},"warnings":{"$ref":"#/components/schemas/rsv_read_warningsType"}},"type":"object"},"rsv_read_transportInfoType":{"properties":{"carrierCode":{"maxLength":20,"minLength":0,"type":"string"},"comments":{"maxLength":2000,"minLength":0,"type":"string"},"dateTime":{"description":"Uses the hotel's time zone.","format":"date-time","type":"string"},"stationCode":{"maxLength":20,"minLength":0,"type":"string"},"transportCode":{"maxLength":20,"minLength":0,"type":"string"},"transportationReqd":{"type":"boolean"},"type":{"maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_travelAgentDetails":{"description":"Travel Agent Details","properties":{"travelAgentID":{"description":"ID of the travel agent for the reservation.","maxLength":20,"minLength":0,"type":"string"},"travelAgentName":{"description":"Name of the travel agent for the reservation.","maxLength":200,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_trxCodesInfoType":{"description":"List of Transaction codes info.","items":{"$ref":"#/components/schemas/rsv_read_trxInfoType"},"maxItems":4000,"type":"array"},"rsv_read_trxInfoType":{"description":"Transaction codes info.","properties":{"description":{"description":"Transaction codes info.","maxLength":2000,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel context of the Transaction code.","maxLength":20,"minLength":0,"type":"string"},"otaTaxType":{"description":"Open Travel Alliance(OTA) tax type for the given Transaction code.","maxLength":20,"minLength":0,"type":"string"},"printTrxReceipt":{"description":"Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code.","type":"boolean"},"transactionCode":{"description":"Unique identifier for the Transaction code.","maxLength":20,"minLength":0,"type":"string"},"trxServiceType":{"description":"Contains service type for transaction code.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_typeOfMessageType":{"description":"The type of Message for Guest Messages.","enum":["Tm","Vm"],"type":"string"},"rsv_read_uRLInfoType":{"description":"Web site address.","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"},"url":{"$ref":"#/components/schemas/rsv_read_uRLType","description":"Provides URL information."}},"type":"object"},"rsv_read_uRLType":{"description":"Web site address, in IETF(The Internet Engineering Task Force) specified format.","properties":{"orderSequence":{"description":"Display Order sequence.","type":"number"},"primaryInd":{"description":"When true, indicates a primary information.","type":"boolean"},"type":{"description":"Defines the purpose of the URL address, such as personal, business, public, etc.","maxLength":20,"minLength":0,"type":"string"},"typeDescription":{"description":"Describes the Type code","maxLength":2000,"minLength":0,"type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"rsv_read_uniqueIDListType":{"description":"Unique Id that references an object uniquely in the system.","items":{"$ref":"#/components/schemas/rsv_read_uniqueID_Type"},"maxItems":4000,"type":"array"},"rsv_read_uniqueID_Type":{"description":"An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).","properties":{"id":{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","maxLength":80,"minLength":0,"type":"string"},"idExtension":{"description":"Additional identifying value assigned by the creating system. Eg: ConfirmationLegNumber, ExternalLegNumber","type":"integer"},"type":{"description":"A reference to the type of object defined by the UniqueID element.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_upsellInfoType":{"description":"Information regarding upsell for a reservation.","properties":{"originalInfo":{"description":"Original Values of the reservation prior to upgrade.","properties":{"nights":{"description":"The number of nights of the reservation before being upgraded.","type":"integer"},"rateCode":{"description":"The Rate Code of the Reservation before it was upgraded","maxLength":20,"minLength":0,"type":"string"},"roomType":{"$ref":"#/components/schemas/rsv_read_codeDescriptionType","description":"Original Reservation Room Type before being upgraded."},"totalAmount":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Total Amount of the reservation before it was upgraded."}},"type":"object"},"upsellInfo":{"description":"Information of a reservation during the process of upgrade.","properties":{"firstNightUpsellAmount":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"First Night Total Amount including Upsell."},"firstNightUpsellCharge":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"First Night Upsell Charges."},"percentageSavings":{"description":"Percentage savings resulting from accepting upsell offer. This will be calculated as the ratio of the amount saved by accepting the upsell offer to the actual room rate (i.e. room rate when upsell is not offered)","maximum":100,"minimum":0,"type":"number"},"roomLongDescription":{"description":"Detail description of the Room Type.","maxLength":2000,"minLength":0,"type":"string"},"roomType":{"$ref":"#/components/schemas/rsv_read_codeDescriptionType","description":"Reservation Room Type for Upsell."},"ruleCode":{"description":"Upsell rule code","maxLength":20,"minLength":0,"type":"string"},"ruleDescription":{"description":"Upsell rule description","maxLength":2000,"minLength":0,"type":"string"},"ruleId":{"description":"Upsell Rule Id.","type":"integer"},"totalActualRateAmount":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Actual Total Room Rate for the Target Upsell Room Type."},"totalUpsellCharge":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Amount that was charged for the upsell."},"totalUpsellMoneyAmount":{"$ref":"#/components/schemas/rsv_read_currencyAmountType","description":"Total Amount that was charged including upsell."},"totalUpsellPoints":{"description":"Total Upsell Points.","type":"integer"},"upsellDate":{"description":"The date on which reservation is upgraded.","format":"date","type":"string"},"upsellUser":{"description":"User who upgraded the reservation.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"}},"type":"object"},"rsv_read_usedInModuleType":{"description":"Simple type for indicating the module for which user wants to create the SellMessage. Valid module types are Look To Book Sales,Reservations,Blocks,Function Diary and Group Rooms Control.","enum":["Blocks","Reservations","FunctionDiary","LookToBookSales","GroupRoomsControl"],"type":"string"},"rsv_read_userDefinedFieldsType":{"description":"A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc.","properties":{"characterUDFs":{"$ref":"#/components/schemas/rsv_read_characterUDFsType","description":"Collection of user defined fields of Character/String Type."},"dateUDFs":{"$ref":"#/components/schemas/rsv_read_dateUDFsType","description":"Collection of user defined fields of Date Type."},"numericUDFs":{"$ref":"#/components/schemas/rsv_read_numericUDFsType","description":"Collection of user defined fields of Numeric Type."}},"type":"object"},"rsv_read_userInfoType":{"description":"Opera User Information","properties":{"userId":{"description":"User Id of the Opera User","type":"integer"},"userName":{"description":"Name of the Opera User","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_userSessionDefaultsType":{"properties":{"baseLanguage":{"maxLength":20,"minLength":0,"type":"string"},"currencyCode":{"maxLength":20,"minLength":0,"type":"string"},"currencyFormat":{"type":"string"},"dbDateFormat":{"type":"string"},"defaultLanguage":{"type":"string"},"javaDateFormat":{"type":"string"},"javaTimeFormat":{"type":"string"},"oracleDateFormat":{"type":"string"},"oracleTimeFormat":{"type":"string"}},"type":"object"},"rsv_read_userSessionInfoType":{"properties":{"businessDate":{"format":"date","type":"string"},"cROCountryCode":{"maxLength":20,"minLength":0,"type":"string"},"chain":{"maxLength":20,"minLength":0,"type":"string"},"cro":{"$ref":"#/components/schemas/rsv_read_codeDescriptionType"},"hotel":{"$ref":"#/components/schemas/rsv_read_codeDescriptionType"},"parameters":{"$ref":"#/components/schemas/rsv_read_parametersType"},"runningApp":{"type":"string"},"sessionDefaults":{"$ref":"#/components/schemas/rsv_read_userSessionDefaultsType"},"shareProfiles":{"type":"boolean"},"systemDate":{"format":"date","type":"string"},"terminal":{"type":"string"}},"type":"object"},"rsv_read_vIPStatusType":{"description":"VIP status of the customer.","properties":{"code":{"description":"VIP status of the customer.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Used for Character Strings, length 0 to 2000.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_vIPType":{"description":"The supplier's ranking of the customer.","properties":{"vipCode":{"description":"VIP Code.","maxLength":20,"minLength":0,"type":"string"},"vipDescription":{"description":"VIP Description.","maxLength":80,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_visaInfoType":{"properties":{"visaExpiryDate":{"format":"date","type":"string"},"visaIssueDate":{"format":"date","type":"string"},"visaNumber":{"maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_waitlistResType":{"description":"Information regarding why reservation is being /has been waitlisted.","properties":{"description":{"description":"Description why the reservation is being /has been waitlisted.","maxLength":2000,"minLength":0,"type":"string"},"priorityCode":{"description":"Waitlist Priority Code.","maxLength":20,"minLength":0,"type":"string"},"priorityDescription":{"description":"Waitlist priority Description.","maxLength":2000,"minLength":0,"type":"string"},"reasonCode":{"description":"Waitlist Reason Code.","maxLength":20,"minLength":0,"type":"string"},"reasonDescription":{"description":"Waitlist Reason Description.","maxLength":2000,"minLength":0,"type":"string"},"telephone":{"description":"Guest telephone number.","maxLength":40,"minLength":0,"type":"string"}},"type":"object"},"rsv_read_warningType":{"description":"Used when a message has been successfully processed to report any warnings or business errors that occurred.","properties":{"code":{"description":"If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.","maxLength":20,"minLength":0,"type":"string"},"docURL":{"description":"If present, this URL refers to an online description of the error that occurred.","maxLength":2000,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"recordId":{"description":"If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.","maxLength":2000,"type":"string"},"rph":{"description":"Reference Place Holder used as an index for this warning.","maxLength":8,"minLength":1,"type":"string"},"shortText":{"description":"An abbreviated version of the error in textual format.","maxLength":2000,"type":"string"},"status":{"description":"If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.","maxLength":2000,"type":"string"},"tag":{"description":"If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].","maxLength":2000,"type":"string"},"type":{"description":"The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"rsv_read_warningsType":{"description":"Used in conjunction with the Success element to define a business error.","items":{"$ref":"#/components/schemas/rsv_read_warningType"},"maxItems":4000,"type":"array"},"rsv_read_welcomeOfferOptionsType":{"description":"None of the Welcome Offer option is selected.","enum":["BonusPoints","Ecoupons","Items","PostIt","NotSelected"],"type":"string"},"rsv_read_welcomeOfferType":{"properties":{"status":{"description":"Determines the status of the welcome offer.","maxLength":20,"minLength":0,"type":"string"},"type":{"$ref":"#/components/schemas/rsv_read_welcomeOfferOptionsType","description":"Determines the welcome offer option selected while availing the welcome offer."}},"type":"object"},"rsvcfg_bookingTypeType":{"description":"Contains Common Master configuration detail.","properties":{"code":{"description":"Common Master unique code.","maxLength":40,"minLength":0,"type":"string"},"description":{"$ref":"#/components/schemas/rsvcfg_translationTextType2000","description":"Description of the Master code."},"displayOrder":{"description":"Common Master record sequence number.","type":"number"},"managedBy":{"$ref":"#/components/schemas/rsvcfg_managedByOptions"}},"type":"object"},"rsvcfg_bookingTypesCriteria":{"description":"Request object for creating Booking Types.","properties":{"bookingTypes":{"$ref":"#/components/schemas/rsvcfg_bookingTypesType","description":"Booking Typesto be created."},"links":{"$ref":"#/components/schemas/rsvcfg_links"},"warnings":{"$ref":"#/components/schemas/rsvcfg_warningsType"}},"type":"object"},"rsvcfg_bookingTypesToBeChanged":{"description":"Request object for changing Booking Types.","properties":{"bookingTypes":{"$ref":"#/components/schemas/rsvcfg_bookingTypesType","description":"Booking Typesto be changed."},"links":{"$ref":"#/components/schemas/rsvcfg_links"},"warnings":{"$ref":"#/components/schemas/rsvcfg_warningsType"}},"type":"object"},"rsvcfg_bookingTypesType":{"description":"List of Booking Types.","items":{"$ref":"#/components/schemas/rsvcfg_bookingTypeType"},"maxItems":4000,"type":"array"},"rsvcfg_cancellationCodeType":{"description":"Contains Common Master configuration detail.","properties":{"code":{"description":"Common Master unique code.","maxLength":40,"minLength":0,"type":"string"},"description":{"$ref":"#/components/schemas/rsvcfg_translationTextType2000","description":"Description of the Master code."},"displayOrder":{"description":"Common Master record sequence number.","type":"number"},"managedBy":{"$ref":"#/components/schemas/rsvcfg_managedByOptions"}},"type":"object"},"rsvcfg_cancellationCodesCriteria":{"description":"Request object for creating Cancellation Codes.","properties":{"cancellationCodes":{"$ref":"#/components/schemas/rsvcfg_cancellationCodesType","description":"Cancellation Codes to be created."},"links":{"$ref":"#/components/schemas/rsvcfg_links"},"warnings":{"$ref":"#/components/schemas/rsvcfg_warningsType"}},"type":"object"},"rsvcfg_cancellationCodesToBeChanged":{"description":"Request object for changing Cancellation Codes.","properties":{"cancellationCodes":{"$ref":"#/components/schemas/rsvcfg_cancellationCodesType","description":"Cancellation Codes to be changed."},"links":{"$ref":"#/components/schemas/rsvcfg_links"},"warnings":{"$ref":"#/components/schemas/rsvcfg_warningsType"}},"type":"object"},"rsvcfg_cancellationCodesType":{"description":"List of Cancellation Codes.","items":{"$ref":"#/components/schemas/rsvcfg_cancellationCodeType"},"maxItems":4000,"type":"array"},"rsvcfg_codeType":{"description":"Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.","maxLength":20,"minLength":0,"type":"string"},"rsvcfg_distributionAttributesType":{"properties":{"availableChannels":{"description":"Distribution channels in which the guarantee code may be used. If no channels are selected, the guarantee code is available for all distribution channels.","items":{"maxLength":2000,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"distributionGuaranteeType":{"description":"Distribution Guarantee Types to which the guarantee code may be mapped","type":"string"},"releaseTime":{"description":"Time (HH24:MM format) in which the reservation is to be released, available when distributionGuaranteeType is set to '38' (None) ","type":"string"}},"type":"object"},"rsvcfg_guaranteeCodeCriteria":{"description":"Request object that holds the details of Guarantee Code to be created.","properties":{"guaranteeCode":{"$ref":"#/components/schemas/rsvcfg_guaranteeConfigType","description":"Details of Guarantee Code to be created."},"hotelId":{"$ref":"#/components/schemas/rsvcfg_codeType","description":"Hotel code for Guarantee Code."},"links":{"$ref":"#/components/schemas/rsvcfg_links"},"warnings":{"$ref":"#/components/schemas/rsvcfg_warningsType"}},"type":"object"},"rsvcfg_guaranteeCodeToBeChanged":{"description":"Request object that holds the details of Guarantee Code to be changed.","properties":{"guaranteeCode":{"$ref":"#/components/schemas/rsvcfg_guaranteeConfigType","description":"Details of Guarantee Code to be changed."},"hotelId":{"$ref":"#/components/schemas/rsvcfg_codeType","description":"Hotel code for Guarantee Code."},"links":{"$ref":"#/components/schemas/rsvcfg_links"},"warnings":{"$ref":"#/components/schemas/rsvcfg_warningsType"}},"type":"object"},"rsvcfg_guaranteeConfigType":{"description":"Specifies Guarantee Code attributes.","properties":{"description":{"description":"Description of the Guarantee Code.","maxLength":2000,"minLength":0,"type":"string"},"distributionAttributes":{"$ref":"#/components/schemas/rsvcfg_distributionAttributesType","description":"Specifies various distribution attributes for the guarantee code."},"guaranteeCode":{"description":"Code assigned to the Guarantee.","maxLength":20,"minLength":0,"type":"string"},"inactive":{"description":"Indicates the reservation type is inactive or not.","type":"boolean"},"lateArrival":{"description":"Represents the late arrival time.","type":"string"},"managedBy":{"$ref":"#/components/schemas/rsvcfg_managedByOptions"},"massCancellation":{"description":"Defines the Auto mass cancellation criteria (i.e. number of days pending before auto cancellation).","properties":{"autoCancel":{"description":"If true indicates, the reservations having this Guarantee Code will be auto canceled for which the credit card info is missing for number of days specified in pending days.","type":"boolean"},"pendingDays":{"description":"Number of days, with in which the credit card info should be received for the reservation, using this guarnatee code, to avoid auto cancellation.","type":"integer"}},"type":"object"},"onHold":{"description":"If true indicates this Guarantee Code is used only to hold the inventory during reservation process.","type":"boolean"},"orderSequence":{"description":"Display Order sequence.","type":"number"},"paymentTypes":{"$ref":"#/components/schemas/rsvcfg_paymentTypesType","description":"Specifies various payment types for the guarantee code."},"requirements":{"$ref":"#/components/schemas/rsvcfg_guaranteeRequirementsType","description":"Specifies various requirements for the guarantee code."},"reserveInventory":{"description":"If true indicates inventory will be reserved/deducted when reservation uses this Guarantee Code.","type":"boolean"},"shortDescription":{"$ref":"#/components/schemas/rsvcfg_translationTextType80","description":"Brief description of the Guarantee Code."}},"type":"object"},"rsvcfg_guaranteeRequirementsType":{"description":"Specifies various requirement for the guarantee code.","properties":{"address":{"description":"When true indicates address on the reservation is required for this guarantee code.","type":"boolean"},"arrivalTime":{"description":"When true indicates arrival Time on the reservation is required for this guarantee code.","type":"boolean"},"cancellation":{"description":"When true indicates cancellation on the reservation is required for this guarantee code.","type":"boolean"},"company":{"description":"When true indicates attaching a company profile on the reservation is required for this guarantee code.","type":"boolean"},"creditCard":{"description":"When true indicates Credit Card on the reservation is required for this guarantee code.","type":"boolean"},"deposit":{"description":"When true indicates deposit is required for this guarantee code.","type":"boolean"},"email":{"description":"When true indicates an email on the reservation is required for this guarantee code.","type":"boolean"},"phoneNumber":{"description":"When true indicates phone number on the reservation is required for this guarantee code.","type":"boolean"},"requirementCode":{"description":"Requirement Code.","type":"string"},"travelAgent":{"description":"When true indicates attaching a travel agent profile on the reservation is required for this guarantee code.","type":"boolean"}},"type":"object"},"rsvcfg_instanceLink":{"description":"Metadata describing link description objects that MAY appear in the JSON instance representation.","properties":{"href":{"description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.","type":"string"},"method":{"description":"HTTP method for requesting the target of the link.","enum":["GET","POST","PUT","DELETE","PATCH","OPTIONS","HEAD"],"type":"string"},"operationId":{"description":"The operationId of the path you can call to follow this link.  This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.","type":"string"},"rel":{"description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.","type":"string"},"targetSchema":{"description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..","type":"string"},"templated":{"default":false,"description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.","type":"boolean"},"title":{"description":"Exact copy of the \"summary\" field on the linked operation.","type":"string"}},"type":"object"},"rsvcfg_links":{"items":{"$ref":"#/components/schemas/rsvcfg_instanceLink"},"type":"array"},"rsvcfg_mGRank":{"maximum":999,"minimum":1,"type":"integer"},"rsvcfg_managedByOptions":{"description":"Describes of the Configuration is Managed by Enterprise or Property.","enum":["EnterpriseManaged","PropertyManaged","EnterpriseEnforced","PropertyOverridden"],"type":"string"},"rsvcfg_marketCodeColorsType":{"description":"Simple type for Market Code colors.","enum":["None","Blue","Red","Cyan","Green","Black","White","Gray","Yellow","Deepteal","Sunsetorange","Aquasky","Mochabrown","Mossgreen","Rosewood","Claybrown","Softlavender","Olivegold","Plumpurple","Mistblue","Forestgreen","Dustyviolet","Oceanblue","Copper"],"type":"string"},"rsvcfg_marketCodeCriteria":{"description":"Request object that holds the details of Market Code to be created.","properties":{"links":{"$ref":"#/components/schemas/rsvcfg_links"},"marketCode":{"$ref":"#/components/schemas/rsvcfg_marketCodeType","description":"Details of Market Code to be created."},"warnings":{"$ref":"#/components/schemas/rsvcfg_warningsType"}},"type":"object"},"rsvcfg_marketCodePrintGroupType":{"description":"Group Print Group Type for country code Sweden.","enum":["Business","Conference","Leisure","BusinessSe","ConferenceSe","LeisureSe","GroupSe"],"type":"string"},"rsvcfg_marketCodeToBeChanged":{"description":"Request object that holds the details of Market Code to be changed.","properties":{"links":{"$ref":"#/components/schemas/rsvcfg_links"},"marketCode":{"$ref":"#/components/schemas/rsvcfg_marketCodeType","description":"Details of Market Code to be changed."},"warnings":{"$ref":"#/components/schemas/rsvcfg_warningsType"}},"type":"object"},"rsvcfg_marketCodeType":{"description":"Common code type for code, description, seq and inactive","properties":{"central":{"description":"Indicates if market code is originated from Central.","type":"boolean"},"code":{"description":"Code for the code type.","maxLength":20,"minLength":0,"type":"string"},"description":{"$ref":"#/components/schemas/rsvcfg_translationTextType50","description":"Description for the code type."},"displayColor":{"$ref":"#/components/schemas/rsvcfg_marketCodeColorsType","description":"Display color for the marketing type."},"groupCode":{"description":"Group code to which this code type belongs.","maxLength":20,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel code for the code type.","maxLength":20,"minLength":0,"type":"string"},"inactive":{"description":"Indicates the code type is inactive or not.","type":"boolean"},"managedBy":{"$ref":"#/components/schemas/rsvcfg_managedByOptions"},"printGroup":{"$ref":"#/components/schemas/rsvcfg_marketCodePrintGroupType","description":"Print Group to map Market Code."},"sequence":{"description":"Display sequence for the code type.","type":"integer"},"transactionCode":{"description":"Transaction code to map Market Code.","maxLength":20,"minLength":0,"type":"string"}},"type":"object"},"rsvcfg_marketCodesType":{"description":"Collection of Market Codes.","items":{"$ref":"#/components/schemas/rsvcfg_marketCodeType"},"maxItems":4000,"type":"array"},"rsvcfg_marketGroupCriteria":{"description":"Request object that holds the details of Market Group to be created.","properties":{"links":{"$ref":"#/components/schemas/rsvcfg_links"},"marketGroup":{"$ref":"#/components/schemas/rsvcfg_marketGroupType","description":"Details of Market Group to be created."},"warnings":{"$ref":"#/components/schemas/rsvcfg_warningsType"}},"type":"object"},"rsvcfg_marketGroupToBeChanged":{"description":"Request object that holds the details of Market Group to be changed.","properties":{"links":{"$ref":"#/components/schemas/rsvcfg_links"},"marketGroup":{"$ref":"#/components/schemas/rsvcfg_marketGroupType","description":"Details of Market Group to be changed."},"warnings":{"$ref":"#/components/schemas/rsvcfg_warningsType"}},"type":"object"},"rsvcfg_marketGroupType":{"description":"Common code type for code, description, seq and inactive","properties":{"central":{"description":"Indicates if market code is originated from Central.","type":"boolean"},"code":{"description":"Code for the code type.","maxLength":20,"minLength":0,"type":"string"},"description":{"$ref":"#/components/schemas/rsvcfg_translationTextType50","description":"Description for the code type."},"hotelId":{"description":"Hotel code for the code type.","maxLength":20,"minLength":0,"type":"string"},"inactive":{"description":"Indicates the code type is inactive or not.","type":"boolean"},"managedBy":{"$ref":"#/components/schemas/rsvcfg_managedByOptions"},"marketCodes":{"$ref":"#/components/schemas/rsvcfg_marketCodesType","description":"Collection of Market Codes."},"ranking":{"$ref":"#/components/schemas/rsvcfg_mGRank","description":"Rank of the Market Group used for Room Assignment Optimization"},"sequence":{"description":"Display sequence for the code type.","type":"integer"},"upgradable":{"description":"Defines if the Market Group is eligible for auto upgrade for Room Assignment Optimization","type":"boolean"}},"type":"object"},"rsvcfg_paymentTypesType":{"description":"Payment card code like AX,VI etc.","items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"rsvcfg_sourceCodeCriteria":{"description":"Request object that holds the details of Source Code to be created.","properties":{"links":{"$ref":"#/components/schemas/rsvcfg_links"},"sourceCode":{"$ref":"#/components/schemas/rsvcfg_sourceCodeType","description":"Details of Source Code to be created."},"warnings":{"$ref":"#/components/schemas/rsvcfg_warningsType"}},"type":"object"},"rsvcfg_sourceCodeToBeChanged":{"description":"Request object that holds the details of Source Code to be changed.","properties":{"links":{"$ref":"#/components/schemas/rsvcfg_links"},"sourceCode":{"$ref":"#/components/schemas/rsvcfg_sourceCodeType","description":"Details of Source Code to be changed."},"warnings":{"$ref":"#/components/schemas/rsvcfg_warningsType"}},"type":"object"},"rsvcfg_sourceCodeType":{"description":"Common code type for code, description, seq and inactive","properties":{"central":{"description":"Indicates if market code is originated from Central.","type":"boolean"},"code":{"description":"Code for the code type.","maxLength":20,"minLength":0,"type":"string"},"description":{"$ref":"#/components/schemas/rsvcfg_translationTextType50","description":"Description for the code type."},"groupCode":{"description":"Group code to which this code type belongs.","maxLength":20,"minLength":0,"type":"string"},"hotelId":{"description":"Hotel code for the code type.","maxLength":20,"minLength":0,"type":"string"},"inactive":{"description":"Indicates the code type is inactive or not.","type":"boolean"},"managedBy":{"$ref":"#/components/schemas/rsvcfg_managedByOptions"},"sequence":{"description":"Display sequence for the code type.","type":"integer"}},"type":"object"},"rsvcfg_sourceCodesType":{"description":"Collection of Source Codes.","items":{"$ref":"#/components/schemas/rsvcfg_sourceCodeType"},"maxItems":4000,"type":"array"},"rsvcfg_sourceGroupCriteria":{"description":"Request object that holds the details of Source Group to be created.","properties":{"links":{"$ref":"#/components/schemas/rsvcfg_links"},"sourceGroup":{"$ref":"#/components/schemas/rsvcfg_sourceGroupType","description":"Details of Source Group to be created."},"warnings":{"$ref":"#/components/schemas/rsvcfg_warningsType"}},"type":"object"},"rsvcfg_sourceGroupToBeChanged":{"description":"Request object that holds the details of Source Group to be changed.","properties":{"links":{"$ref":"#/components/schemas/rsvcfg_links"},"sourceGroup":{"$ref":"#/components/schemas/rsvcfg_sourceGroupType","description":"Details of Source Group to be changed."},"warnings":{"$ref":"#/components/schemas/rsvcfg_warningsType"}},"type":"object"},"rsvcfg_sourceGroupType":{"description":"Common code type for code, description, seq and inactive","properties":{"central":{"description":"Indicates if market code is originated from Central.","type":"boolean"},"code":{"description":"Code for the code type.","maxLength":20,"minLength":0,"type":"string"},"description":{"$ref":"#/components/schemas/rsvcfg_translationTextType50","description":"Description for the code type."},"hotelId":{"description":"Hotel code for the code type.","maxLength":20,"minLength":0,"type":"string"},"inactive":{"description":"Indicates the code type is inactive or not.","type":"boolean"},"managedBy":{"$ref":"#/components/schemas/rsvcfg_managedByOptions"},"sequence":{"description":"Display sequence for the code type.","type":"integer"},"sourceCodes":{"$ref":"#/components/schemas/rsvcfg_sourceCodesType","description":"Collection of Source Codes."}},"type":"object"},"rsvcfg_translationTextType2000":{"description":"Contains Multiple translated texts and language codes.","properties":{"defaultText":{"description":"Default text with Character length from 0 to 2000.","maxLength":2000,"minLength":0,"type":"string"},"translatedTexts":{"$ref":"#/components/schemas/rsvcfg_translationsTextType","description":"List of translated text and language codes."}},"type":"object"},"rsvcfg_translationTextType50":{"description":"Contains Multiple translated texts and language codes.","properties":{"defaultText":{"description":"Default text with Character length from 0 to 50.","maxLength":50,"minLength":0,"type":"string"},"translatedTexts":{"$ref":"#/components/schemas/rsvcfg_translationsTextType","description":"List of translated text and language codes."}},"type":"object"},"rsvcfg_translationTextType80":{"description":"Contains Multiple translated texts and language codes.","properties":{"defaultText":{"description":"Default text with Character length from 0 to 80.","maxLength":80,"minLength":0,"type":"string"},"translatedTexts":{"$ref":"#/components/schemas/rsvcfg_translationsTextType","description":"List of translated text and language codes."}},"type":"object"},"rsvcfg_translationsTextType":{"description":"Language code for the translation.","items":{"description":"Language code for the translation.","properties":{"language":{"description":"Language identification.","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Used for Character Strings, length 0 to 2000.","maxLength":2000,"minLength":0,"type":"string"}},"type":"object"},"maxItems":4000,"type":"array"},"rsvcfg_warningType":{"description":"Used when a message has been successfully processed to report any warnings or business errors that occurred.","properties":{"code":{"description":"If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.","maxLength":20,"minLength":0,"type":"string"},"docURL":{"description":"If present, this URL refers to an online description of the error that occurred.","maxLength":2000,"type":"string"},"language":{"description":"Language identification.","pattern":"[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*","type":"string"},"recordId":{"description":"If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.","maxLength":2000,"type":"string"},"rph":{"description":"Reference Place Holder used as an index for this warning.","maxLength":8,"minLength":1,"type":"string"},"shortText":{"description":"An abbreviated version of the error in textual format.","maxLength":2000,"type":"string"},"status":{"description":"If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.","maxLength":2000,"type":"string"},"tag":{"description":"If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].","maxLength":2000,"type":"string"},"type":{"description":"The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".","maxLength":20,"minLength":0,"type":"string"},"value":{"description":"Property Value","type":"string"}},"type":"object"},"rsvcfg_warningsType":{"description":"Used in conjunction with the Success element to define a business error.","items":{"$ref":"#/components/schemas/rsvcfg_warningType"},"maxItems":4000,"type":"array"}},"securitySchemes":{"AdminAPIKey":{"description":"Bootstrap and recovery credential; never expose it to browser code.","in":"header","name":"X-Admin-API-Key","type":"apiKey"},"AdminSession":{"description":"Opaque HttpOnly, Secure, SameSite=Strict production console session.","in":"cookie","name":"__Host-ohip_console_session","type":"apiKey"},"AutomationToken":{"description":"Independently revocable Coding Agent credential.","scheme":"bearer","type":"http"},"CallerAPIKey":{"in":"header","name":"X-API-Key","type":"apiKey"}}},"info":{"description":"Authenticated REST boundary for the fixed Oracle Property API operations required by reservation handling and read-only finance review. Oracle URLs, methods, Operation IDs, Hotel IDs, and credentials are server configuration and are never caller-controlled. The root x-query-allowlists extension is the exact set of query names accepted for each listed Oracle operation; value shapes follow that operation's Oracle Property API 26.3 contract.","title":"Oracle OHIP Edge Service","version":"0.11.0"},"openapi":"3.1.0","paths":{"/admin/v1/admin-users":{"post":{"description":"Uses the bootstrap administrator API Key. Passwords must contain 15 to 128 Unicode characters and are persisted only as Argon2id verifiers.","operationId":"createAdminUser","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"password":{"maxLength":128,"minLength":15,"type":"string","writeOnly":true},"username":{"maxLength":64,"minLength":3,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9._-]{2,63}$","type":"string"}},"required":["username","password"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUser"}}},"description":"Administrator account created.","headers":{"Cache-Control":{"schema":{"const":"no-store","type":"string"}}}},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminAPIKey":[]}],"summary":"Bootstrap a local administrator account"}},"/admin/v1/api-keys/{keyID}":{"delete":{"operationId":"revokeAPIKey","parameters":[{"$ref":"#/components/parameters/KeyID"},{"$ref":"#/components/parameters/CSRFToken"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIKey"}}},"description":"API Key revoked; repetition is safe."},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminAPIKey":[]},{"AdminSession":[]}],"summary":"Revoke an API Key"}},"/admin/v1/audits":{"get":{"description":"Joins append-only request-start and request-completion events. An incomplete result has no completion event.","operationId":"listAudits","parameters":[{"$ref":"#/components/parameters/AuditFrom"},{"$ref":"#/components/parameters/AuditTo"},{"$ref":"#/components/parameters/AuditSurface"},{"$ref":"#/components/parameters/AuditCallerID"},{"$ref":"#/components/parameters/AuditOperationID"},{"$ref":"#/components/parameters/AuditResult"},{"$ref":"#/components/parameters/AuditRequestID"},{"$ref":"#/components/parameters/AuditCursor"},{"$ref":"#/components/parameters/AuditLimit"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditPage"}}},"description":"Newest-first cursor page of request records."},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminAPIKey":[]},{"AdminSession":[]}],"summary":"List compliance ledger requests"}},"/admin/v1/audits/summary":{"get":{"operationId":"summarizeAudits","parameters":[{"$ref":"#/components/parameters/AuditFrom"},{"$ref":"#/components/parameters/AuditTo"},{"$ref":"#/components/parameters/AuditSurface"},{"$ref":"#/components/parameters/AuditCallerID"},{"$ref":"#/components/parameters/AuditOperationID"},{"$ref":"#/components/parameters/AuditRequestID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditSummary"}}},"description":"Counts by final result plus incomplete starts."},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminAPIKey":[]},{"AdminSession":[]}],"summary":"Summarize compliance ledger requests"}},"/admin/v1/audits/{requestID}":{"get":{"operationId":"getAudit","parameters":[{"in":"path","name":"requestID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditRecord"}}},"description":"One request with permitted operational metadata only."},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminAPIKey":[]},{"AdminSession":[]}],"summary":"Get one compliance ledger request"}},"/admin/v1/automation-principals":{"get":{"operationId":"listAutomationPrincipals","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"items":{"items":{"$ref":"#/components/schemas/AutomationPrincipal"},"type":"array"}},"required":["items"],"type":"object"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminAPIKey":[]},{"AdminSession":[]}],"summary":"List delegation metadata"},"post":{"description":"Human administrators/developers delegate access. Developer credentials are owned by the current user and bounded by their current ceiling. Owner disable revokes tokens, not runtime application keys.","operationId":"createAutomationPrincipal","parameters":[{"$ref":"#/components/parameters/CSRFToken"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"capability_ceiling":{"$ref":"#/components/schemas/CapabilityGroupIDs"},"expires_at":{"format":"date-time","type":"string"},"name":{"type":"string"},"owner_user_id":{"description":"Optional administrator-only owner; omission defaults to current user (bootstrap remains platform-managed).","type":"string"},"scopes":{"items":{"enum":["catalog.read","applications.manage","keys.manage","audits.read"],"type":"string"},"minItems":1,"type":"array"}},"required":["name","scopes","capability_ceiling"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"principal":{"$ref":"#/components/schemas/AutomationPrincipal"},"token":{"description":"Shown once; persist only in a protected local automation credential file.","type":"string"}},"required":["principal","token"],"type":"object"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminAPIKey":[]},{"AdminSession":[]}],"summary":"Delegate control access to a Coding Agent"}},"/admin/v1/automation-principals/{principalID}":{"delete":{"operationId":"revokeAutomationPrincipal","parameters":[{"in":"path","name":"principalID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/CSRFToken"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationPrincipal"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminAPIKey":[]},{"AdminSession":[]}],"summary":"Revoke a delegation"}},"/admin/v1/automation-principals/{principalID}/owner":{"put":{"operationId":"claimPrincipalOwner","parameters":[{"in":"path","name":"principalID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/CSRFToken"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"owner_user_id":{"minLength":1,"type":"string"}},"required":["owner_user_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationPrincipal"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminSession":[]},{"AdminAPIKey":[]}],"summary":"Administrator claims platform-managed Principal; owned Principal cannot transfer"}},"/admin/v1/automation/whoami":{"get":{"operationId":"automationWhoami","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"catalog_version":{"type":"string"},"manifest_version":{"type":"string"},"principal":{"$ref":"#/components/schemas/AutomationPrincipal"}},"required":["principal","catalog_version","manifest_version"],"type":"object"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AutomationToken":[]}],"summary":"Inspect the current delegation"}},"/admin/v1/callers":{"get":{"operationId":"listCallers","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Caller"},"type":"array"}},"required":["items"],"type":"object"}}},"description":"Applications with effective capability groups and active-key counts."},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminAPIKey":[]},{"AdminSession":[]}],"summary":"List downstream applications"},"post":{"operationId":"createCaller","parameters":[{"$ref":"#/components/parameters/CSRFToken"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"capability_groups":{"$ref":"#/components/schemas/CapabilityGroupIDs"},"name":{"maxLength":100,"minLength":1,"type":"string"}},"required":["name","capability_groups"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Caller"}}},"description":"Caller created."},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminAPIKey":[]},{"AdminSession":[]}],"summary":"Create a downstream caller"}},"/admin/v1/callers/{callerID}":{"get":{"operationId":"getCaller","parameters":[{"$ref":"#/components/parameters/CallerID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Caller"}}},"description":"Application identity, grants, and active-key count."},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminAPIKey":[]},{"AdminSession":[]}],"summary":"Get a downstream application"}},"/admin/v1/callers/{callerID}/automation-principal":{"put":{"operationId":"setApplicationPrincipal","parameters":[{"in":"path","name":"callerID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/CSRFToken"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"automation_principal_id":{"type":"string"}},"required":["automation_principal_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Caller"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminSession":[]},{"AdminAPIKey":[]}],"summary":"Owner or administrator binds same-owner Agent; empty clears"}},"/admin/v1/callers/{callerID}/capability-groups":{"put":{"operationId":"replaceCapabilityGroups","parameters":[{"$ref":"#/components/parameters/CallerID"},{"$ref":"#/components/parameters/CSRFToken"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"capability_groups":{"$ref":"#/components/schemas/CapabilityGroupIDs"}},"required":["capability_groups"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Caller"}}},"description":"Application with the replaced effective grant set."},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminAPIKey":[]},{"AdminSession":[]}],"summary":"Replace an application's capability grants"}},"/admin/v1/callers/{callerID}/keys":{"get":{"operationId":"listAPIKeys","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/APIKey"},"type":"array"}},"required":["items"],"type":"object"}}},"description":"Non-secret API Key metadata."},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminAPIKey":[]},{"AdminSession":[]}],"summary":"List a caller's API Keys"},"parameters":[{"$ref":"#/components/parameters/CallerID"}],"post":{"description":"The plaintext value is returned only by this response.","operationId":"issueAPIKey","parameters":[{"$ref":"#/components/parameters/CSRFToken"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"expires_at":{"format":"date-time","type":["string","null"]}},"type":"object"}}},"required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuedAPIKey"}}},"description":"API Key issued.","headers":{"Cache-Control":{"schema":{"const":"no-store","type":"string"}}}},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminAPIKey":[]},{"AdminSession":[]}],"summary":"Issue an API Key"}},"/admin/v1/callers/{callerID}/owner":{"put":{"operationId":"setApplicationOwner","parameters":[{"in":"path","name":"callerID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/CSRFToken"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"owner_user_id":{"description":"Empty means platform managed.","type":"string"}},"required":["owner_user_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Caller"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminSession":[]},{"AdminAPIKey":[]}],"summary":"Administrator transfers app, clears Agent binding and preserves runtime keys"}},"/admin/v1/callers/{callerID}/status":{"put":{"operationId":"setApplicationStatus","parameters":[{"in":"path","name":"callerID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/CSRFToken"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Caller"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminSession":[]},{"AdminAPIKey":[]}],"summary":"Administrator enables or blocks business access"}},"/admin/v1/capability-groups":{"get":{"operationId":"listCapabilityGroups","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CapabilityGroup"},"type":"array"}},"required":["items"],"type":"object"}}},"description":"Stable groups mapped to the fixed Operation-ID catalog."},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminAPIKey":[]},{"AdminSession":[]}],"summary":"List fixed application capability groups"}},"/admin/v1/integrations":{"get":{"operationId":"listIntegrations","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"items":{"items":{"$ref":"#/components/schemas/Caller"},"type":"array"}},"required":["items"],"type":"object"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AutomationToken":[]}],"summary":"List applications owned by the delegation"},"put":{"operationId":"applyIntegration","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationManifest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"application":{"$ref":"#/components/schemas/Caller"},"plan":{"$ref":"#/components/schemas/IntegrationPlan"}},"required":["application","plan"],"type":"object"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AutomationToken":[]}],"summary":"Create or reconcile an owned application and exact grants"}},"/admin/v1/integrations/plan":{"post":{"operationId":"planIntegration","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationManifest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationPlan"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AutomationToken":[]}],"summary":"Validate operation intent and expose group-expanded access"}},"/admin/v1/integrations/{callerID}/audits":{"get":{"description":"Default last 24 hours; query historical windows of at most 90 days and paginate using next_cursor. Caller scope is fixed by the path.","operationId":"integrationAudits","parameters":[{"in":"path","name":"callerID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AuditFrom"},{"$ref":"#/components/parameters/AuditTo"},{"$ref":"#/components/parameters/AuditSurface"},{"$ref":"#/components/parameters/AuditOperationID"},{"$ref":"#/components/parameters/AuditResult"},{"$ref":"#/components/parameters/AuditRequestID"},{"$ref":"#/components/parameters/AuditCursor"},{"$ref":"#/components/parameters/AuditLimit"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditPage"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AutomationToken":[]}],"summary":"Read the owned application's audit trail"}},"/admin/v1/integrations/{callerID}/issuances/{issuanceID}":{"delete":{"operationId":"cancelIntegrationIssuance","parameters":[{"in":"path","name":"callerID","required":true,"schema":{"type":"string"}},{"in":"path","name":"issuanceID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"issuance_id":{"type":"string"},"status":{"const":"cancelled","type":"string"}},"required":["issuance_id","status"],"type":"object"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AutomationToken":[]}],"summary":"Cancel issuance and revoke its key, including an in-flight issuance"}},"/admin/v1/integrations/{callerID}/keys":{"get":{"operationId":"listIntegrationKeys","parameters":[{"in":"path","name":"callerID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"items":{"items":{"$ref":"#/components/schemas/APIKey"},"type":"array"}},"required":["items"],"type":"object"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AutomationToken":[]}],"summary":"List owned application keys"},"post":{"operationId":"issueIntegrationKey","parameters":[{"in":"path","name":"callerID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"issuance_id":{"maxLength":100,"minLength":8,"type":"string"}},"required":["issuance_id"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuedAPIKey"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AutomationToken":[]}],"summary":"Issue one correlated application credential"}},"/admin/v1/integrations/{callerID}/keys/{keyID}":{"delete":{"operationId":"revokeIntegrationKey","parameters":[{"in":"path","name":"callerID","required":true,"schema":{"type":"string"}},{"in":"path","name":"keyID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIKey"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AutomationToken":[]}],"summary":"Revoke an owned application key"}},"/admin/v1/me":{"get":{"operationId":"getCurrentUser","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUser"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminSession":[]}],"summary":"Read own account including during forced password change"}},"/admin/v1/me/password":{"put":{"operationId":"changeOwnPassword","parameters":[{"$ref":"#/components/parameters/CSRFToken"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"new_password":{"maxLength":128,"minLength":15,"type":"string"},"old_password":{"type":"string"}},"required":["old_password","new_password"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"login_url":{"type":"string"},"status":{"const":"password_changed","type":"string"}},"required":["status","login_url"],"type":"object"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminSession":[]}],"summary":"Change password and revoke all sessions; available during forced change"}},"/admin/v1/users":{"get":{"operationId":"listUsers","parameters":[{"in":"query","name":"q","schema":{"type":"string"}},{"in":"query","name":"role","schema":{"type":"string"}},{"in":"query","name":"enabled","schema":{"type":"boolean"}},{"in":"query","name":"cursor","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPage"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminSession":[]}],"summary":"Administrator-only list with stable cursor"},"post":{"operationId":"createUser","parameters":[{"$ref":"#/components/parameters/CSRFToken"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"capability_ceiling":{"$ref":"#/components/schemas/CapabilityGroupIDs"},"role":{"$ref":"#/components/schemas/UserRole"},"username":{"maxLength":64,"minLength":3,"type":"string"}},"required":["username","role"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuedUser"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminSession":[]}],"summary":"Administrator creates user; temporary password shown once"}},"/admin/v1/users/{userID}":{"get":{"operationId":"getUser","parameters":[{"in":"path","name":"userID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUser"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminSession":[]}],"summary":"Administrator reads user metadata"},"patch":{"operationId":"updateUser","parameters":[{"in":"path","name":"userID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/CSRFToken"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"capability_ceiling":{"$ref":"#/components/schemas/CapabilityGroupIDs"},"enabled":{"type":"boolean"},"role":{"$ref":"#/components/schemas/UserRole"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUser"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminSession":[]}],"summary":"Update role, ceiling or status; retain last enabled admin"}},"/admin/v1/users/{userID}/reset-password":{"post":{"operationId":"resetUserPassword","parameters":[{"in":"path","name":"userID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/CSRFToken"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuedUser"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[{"AdminSession":[]}],"summary":"Reset to temporary password and revoke sessions; does not enable user"}},"/api/v1/availability":{"get":{"description":"Uses only the configured hotel. See the Oracle getHotelAvailability schema for allowlisted field semantics.","operationId":"getHotelAvailability","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"}},"summary":"Get hotel availability and prices","x-capability-group":"hotel.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":"PAR","x-sensitive-query-fields-excluded":["membershipIdNumber","membershipCardNumber"]}},"/api/v1/availability/rate-plans":{"get":{"description":"Oracle GET /par/v1/hotels/{hotelId}/rates. Rate-plan descriptions and policies, not a room-price quotation or a replacement for reservation rate information. Only the configured hotel is used. Oracle 204 becomes HTTP 200 with data: {}. Returned Oracle fields are provisional until customer UAT.","operationId":"getAvailabilityRatePlanInfoByMultipleRatePlans","parameters":[{"description":"Rate Plan code.","explode":true,"in":"query","name":"ratePlanCodeList","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rate_par_availabilityRatePlanInfo"}},"type":"object"}]}}},"description":"Bounded Oracle rate information; data is an empty object when Oracle returns 204.","headers":{"Cache-Control":{"schema":{"const":"no-store","type":"string"}}}},"default":{"$ref":"#/components/responses/Error"}},"summary":"查询多个房价计划说明与政策","x-capability-group":"hotel.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved hotel.read application capability"],"retry":"Read-only query (including POST search); retry transient failures with bounded backoff and honor Retry-After. No reservation or price is modified."},"x-oracle-api":"PAR","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/par.json"}},"/api/v1/availability/rate-plans/{ratePlanCode}":{"get":{"description":"Oracle GET /par/v1/hotels/{hotelId}/rates/{ratePlanCode}. Rate-plan descriptions and policies, not a room-price quotation or a replacement for reservation rate information. Only the configured hotel is used. Oracle 204 becomes HTTP 200 with data: {}. Returned Oracle fields are provisional until customer UAT.","operationId":"getAvailabilityRatePlanInfo","parameters":[{"description":"Rate Plan Code.","in":"path","name":"ratePlanCode","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Rate Plan code.","explode":true,"in":"query","name":"ratePlanCodeList","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rate_par_availabilityRatePlanInfo"}},"type":"object"}]}}},"description":"Bounded Oracle rate information; data is an empty object when Oracle returns 204.","headers":{"Cache-Control":{"schema":{"const":"no-store","type":"string"}}}},"default":{"$ref":"#/components/responses/Error"}},"summary":"查询单个房价计划说明与政策","x-capability-group":"hotel.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved hotel.read application capability"],"retry":"Read-only query (including POST search); retry transient failures with bounded backoff and honor Retry-After. No reservation or price is modified."},"x-oracle-api":"PAR","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/par.json"}},"/api/v1/availability/searches":{"post":{"operationId":"searchHotelAvailability","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"}},"summary":"Search hotel availability using an Oracle search document","x-capability-group":"hotel.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":"PAR"}},"/api/v1/blocks":{"post":{"operationId":"postBlock","requestBody":{"$ref":"#/components/requestBodies/ConfirmedWrite"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Block creation verified by getBlock.","headers":{"Cache-Control":{"schema":{"const":"no-store","type":"string"}}}},"default":{"$ref":"#/components/responses/Error"}},"summary":"Create a hotel-confirmed Block and read it back","x-capability-group":"blocks.write","x-integration":{"pattern":"confirmed-write","prerequisites":["Hotel-approved confirmation","Read-back reconciliation ownership"],"retry":"Reuse the original idempotency key. Reconcile unknown outcomes with read-back before retrying."},"x-oracle-api":"BLK"}},"/api/v1/blocks/daily-revenue":{"get":{"operationId":"getBlockDailyRevenue","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"}},"summary":"Get Block daily revenue","x-capability-group":"blocks.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":"BLK"}},"/api/v1/blocks/next-status":{"get":{"description":"Use this API to retrieve next set of statuses and their next statuses for the current status passed in the request. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetNextBlockStatus\u003c/p\u003e Fixed configured hotel; native status is in upstream_status. Native 204 is represented by HTTP 200 with upstream_status=204 and data={}. No automatic pagination.Hotel/current-status query, not validation of an individual block. Distinct from getNextBlockStatusCodes configuration.","operationId":"getNextBlockStatus","parameters":[{"description":"Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.","in":"query","name":"currentStatus","required":true,"schema":{"minLength":1,"type":"string"}},{"description":"Flag to include catering next status.","in":"query","name":"includeCateringStatus","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/booking_blk_nextBlockStatus"}},"type":"object"}]}}},"description":"Oracle read or confirmed-write outcome; inspect status before continuing business workflow."},"default":{"$ref":"#/components/responses/Error"}},"summary":"查询当前状态可转入的团队状态","x-capability-group":"blocks.read","x-fixed-hotel-query":"hotelId","x-integration":{"pattern":"sync-read","prerequisites":["Approved blocks.read capability and Oracle access for the configured hotel","Use actual target IDs/codes; synthetic examples are not hotel configuration"],"retry":"Bounded read retries; honor Retry-After"},"x-oracle-api":"BLK","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/blk.json"}},"/api/v1/blocks/searches":{"post":{"operationId":"searchBlocks","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"}},"summary":"Search Blocks","x-capability-group":"blocks.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":"BLK"}},"/api/v1/blocks/validations":{"post":{"operationId":"postBlockValidate","requestBody":{"$ref":"#/components/requestBodies/RequiredOracleDocument"},"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"}},"summary":"Validate Block creation data without mutation","x-capability-group":"blocks.write","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":"BLK"}},"/api/v1/blocks/{blockID}":{"get":{"operationId":"getBlock","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"}},"summary":"Get a Block by OPERA ID","x-capability-group":"blocks.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":"BLK"},"parameters":[{"$ref":"#/components/parameters/BlockID"}],"put":{"operationId":"putBlock","requestBody":{"$ref":"#/components/requestBodies/ConfirmedWrite"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Block update verified by getBlock.","headers":{"Cache-Control":{"schema":{"const":"no-store","type":"string"}}}},"default":{"$ref":"#/components/responses/Error"}},"summary":"Apply a hotel-confirmed Block update and read it back","x-capability-group":"blocks.write","x-integration":{"pattern":"confirmed-write","prerequisites":["Hotel-approved confirmation","Read-back reconciliation ownership"],"retry":"Reuse the original idempotency key. Reconcile unknown outcomes with read-back before retrying."},"x-oracle-api":"BLK"}},"/api/v1/blocks/{blockID}/allocation":{"put":{"description":"Use this API to add block room type allocations and rates to a specified Block. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003eputBlockAllocation\u003c/p\u003e Fixed configured hotel; native status is in upstream_status. Single-target confirmed write. Check status: verified or pending_verification. Known success returns its native HTTP 200/201 even if readback is pending. Exact replay repeats reads only; unknown outcomes require reconciliation. receipt is the original Oracle response on the first successful mutation only, never persisted; save it in the consuming application's approved evidence store.","operationId":"putBlockAllocation","parameters":[{"description":"Block Id","in":"path","name":"blockID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"case_id":"case-test","expected_hotel_id":"HOTEL1","hotel_confirmation_id":"approval-test","idempotency_key":"unique-test-key","payload":{"criteria":{"allocationRoomTypes":[{"allocationGridDates":[{"allocation":"ACTUAL","roomAllocationInfo":[{"end":"2026-10-01","inventory":{"fourPerson":0,"onePerson":0,"threePerson":0,"twoPerson":2},"start":"2026-10-01"},{"end":"2026-10-02","inventory":{"fourPerson":0,"onePerson":0,"threePerson":0,"twoPerson":3},"start":"2026-10-02"}]}],"roomType":"TEST"}],"blockId":{"id":"BLOCK1","type":"Block"},"hotelId":"HOTEL1"}},"task_id":"task-test"},"schema":{"allOf":[{"$ref":"#/components/schemas/ConfirmedWriteRequest"},{"properties":{"payload":{"$ref":"#/components/schemas/BookingPayload_putBlockAllocation"}},"type":"object"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingWriteResult"}}},"description":"Oracle read or confirmed-write outcome; inspect status before continuing business workflow."},"default":{"$ref":"#/components/responses/Error"}},"summary":"设置团队逐晚绝对房量","x-capability-group":"blocks.write","x-integration":{"pattern":"confirmed-write","prerequisites":["Approved blocks.write capability and Oracle access for the configured hotel","Use actual target IDs/codes; synthetic examples are not hotel configuration"],"retry":"Never blindly retry mutations. Resubmit identical confirmation and idempotency key to retry readback only; unknown outcomes stay blocked."},"x-oracle-api":"BLK","x-oracle-response-schema":{"$ref":"#/components/schemas/booking_blk_status"},"x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/blk.json","x-verification-operation":"getBlockRoomRateGrid"}},"/api/v1/blocks/{blockID}/availability":{"get":{"operationId":"getBlockAvailability","parameters":[{"$ref":"#/components/parameters/BlockID"}],"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"}},"summary":"Get Block availability","x-capability-group":"blocks.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":"BLK"}},"/api/v1/blocks/{blockID}/posting-master/reservations":{"get":{"description":"Use this API to retrieve PM (Posting Master) reservations for a block. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetBlockPMReservations\u003c/p\u003e Fixed configured hotel; native status is in upstream_status. Native 204 is represented by HTTP 200 with upstream_status=204 and data={}. No automatic pagination.Always sends postingmaster=false; true is rejected because the Oracle GET may create a PM.","operationId":"getBlockPMReservations","parameters":[{"description":"Block Id","in":"path","name":"blockID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"If true, a PM reservation will be created for the block if no PM reservations exist.","in":"query","name":"postingmaster","required":false,"schema":{"const":false,"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/booking_blk_blockPMReservations"}},"type":"object"}]}}},"description":"Oracle read or confirmed-write outcome; inspect status before continuing business workflow."},"default":{"$ref":"#/components/responses/Error"}},"summary":"只读查询团队 PM 预订","x-capability-group":"blocks.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved blocks.read capability and Oracle access for the configured hotel","Use actual target IDs/codes; synthetic examples are not hotel configuration"],"retry":"Bounded read retries; honor Retry-After"},"x-oracle-api":"BLK","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/blk.json"}},"/api/v1/blocks/{blockID}/room-rate-grid":{"get":{"operationId":"getBlockRoomRateGrid","parameters":[{"$ref":"#/components/parameters/BlockID"}],"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"}},"summary":"Get the Block room/rate grid","x-capability-group":"blocks.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":"BLK"}},"/api/v1/blocks/{blockID}/status":{"put":{"description":"Use this to change the status of a block in Opera.  To know a hotels Block status codes, use the List Of Values API - BlockStatuses.  Also note, you can only change the status in a particular order, for example INQ to DEF, but not DEF to INQ. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003eputBlockStatus\u003c/p\u003e Fixed configured hotel; native status is in upstream_status. Single-target confirmed write. Check status: verified or pending_verification. Known success returns its native HTTP 200/201 even if readback is pending. Exact replay repeats reads only; unknown outcomes require reconciliation. receipt is the original Oracle response on the first successful mutation only, never persisted; save it in the consuming application's approved evidence store.","operationId":"putBlockStatus","parameters":[{"description":"Block Id","in":"path","name":"blockID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"case_id":"case-test","expected_hotel_id":"HOTEL1","hotel_confirmation_id":"approval-test","idempotency_key":"unique-test-key","payload":{"changeBlockStatus":{"blockId":{"id":"BLOCK1","type":"Block"},"cancellationDetails":{"cancellationCode":{"code":"TEST_REASON"}},"currentBlockStatus":"TEST_CURRENT","hotelId":"HOTEL1","newBlockStatus":"TEST_CANCEL"},"verificationOnly":false},"task_id":"task-test"},"schema":{"allOf":[{"$ref":"#/components/schemas/ConfirmedWriteRequest"},{"properties":{"payload":{"$ref":"#/components/schemas/BookingPayload_putBlockStatus"}},"type":"object"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingWriteResult"}}},"description":"Oracle read or confirmed-write outcome; inspect status before continuing business workflow."},"default":{"$ref":"#/components/responses/Error"}},"summary":"确认变更单个团队状态","x-capability-group":"blocks.write","x-integration":{"pattern":"confirmed-write","prerequisites":["Approved blocks.write capability and Oracle access for the configured hotel","Use actual target IDs/codes; synthetic examples are not hotel configuration"],"retry":"Never blindly retry mutations. Resubmit identical confirmation and idempotency key to retry readback only; unknown outcomes stay blocked."},"x-oracle-api":"BLK","x-oracle-response-schema":{"$ref":"#/components/schemas/booking_blk_changedBlockStatus"},"x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/blk.json","x-verification-operation":"getBlock"}},"/api/v1/business-date":{"get":{"operationId":"getBusinessDate","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessDate"}}},"description":"Current open Business Date."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get the configured hotel's Business Date","x-capability-group":"hotel.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":"BOF"}},"/api/v1/codes/guarantees":{"get":{"operationId":"getGuaranteeCodes","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"}},"summary":"Get hotel Guarantee Codes","x-capability-group":"hotel.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":"RSVCFG"}},"/api/v1/codes/markets":{"get":{"operationId":"getMarketCodes","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"}},"summary":"Get hotel Market Codes","x-capability-group":"hotel.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":"RSVCFG"}},"/api/v1/codes/payment-methods":{"get":{"operationId":"getPaymentMethodsLOV","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"}},"summary":"Get hotel Payment Method values","x-capability-group":"hotel.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":"LOV"}},"/api/v1/codes/sources":{"get":{"operationId":"getSourceCodes","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"}},"summary":"Get hotel Source Codes","x-capability-group":"hotel.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":"RSVCFG"}},"/api/v1/config/blocks/block-cancellation-reasons":{"get":{"operationId":"getBlockCancellationReasons","parameters":[{"explode":true,"in":"query","name":"fetchInactive","required":false,"schema":{"type":"boolean"},"style":"form"},{"explode":true,"in":"query","name":"codes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"wildCard","required":false,"schema":{"type":"string"},"style":"form"},{"explode":true,"in":"query","name":"description","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OHIPDocument"}}},"description":"Oracle document; an upstream 204 becomes data {}."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房取消原因 · 查询","x-capability-group":"configuration.read","x-configuration-scope":"chain","x-integration":{"pattern":"sync-read","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties"],"retry":"Bounded read retries."},"x-oracle-path":"/blk/config/v1/blockCancellationReasons","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"},"post":{"operationId":"postBlockCancellationReasons","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/blkcfg_blockCancellationReasonsCriteria"},{"properties":{"blockCancellationReasons":{"items":{"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"required":["blockCancellationReasons"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"resource_code":{"maxLength":2000,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","resource_code","payload"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房取消原因 · 新增","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/blockCancellationReasons","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"}},"/api/v1/config/blocks/block-cancellation-reasons/{code}":{"delete":{"operationId":"deleteBlockCancellationReasons","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房取消原因 · 删除","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/blockCancellationReasons/{blockCancellationReasonsId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"},"put":{"operationId":"putBlockCancellationReasons","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/blkcfg_blockCancellationReasonsToBeChanged"},{"properties":{"blockCancellationReasons":{"items":{"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"required":["blockCancellationReasons"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房取消原因 · 更新","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/blockCancellationReasons/{blockCancellationReasonsId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"}},"/api/v1/config/blocks/block-lost-booking-codes":{"get":{"operationId":"getBlockLostBookingCodes","parameters":[{"explode":true,"in":"query","name":"fetchInactive","required":false,"schema":{"type":"boolean"},"style":"form"},{"explode":true,"in":"query","name":"codes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"wildCard","required":false,"schema":{"type":"string"},"style":"form"},{"explode":true,"in":"query","name":"description","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OHIPDocument"}}},"description":"Oracle document; an upstream 204 becomes data {}."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房流失原因 · 查询","x-capability-group":"configuration.read","x-configuration-scope":"chain","x-integration":{"pattern":"sync-read","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties"],"retry":"Bounded read retries."},"x-oracle-path":"/blk/config/v1/blockLostBookingCodes","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"},"post":{"operationId":"postBlockLostBookingCodes","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/blkcfg_blockLostBookingCodesCriteria"},{"properties":{"blockLostBookingCodes":{"items":{"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"required":["blockLostBookingCodes"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"resource_code":{"maxLength":2000,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","resource_code","payload"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房流失原因 · 新增","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/blockLostBookingCodes","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"}},"/api/v1/config/blocks/block-lost-booking-codes/{code}":{"delete":{"operationId":"deleteBlockLostBookingCodes","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房流失原因 · 删除","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/blockLostBookingCodes/{blockLostBookingCodesId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"},"put":{"operationId":"putBlockLostBookingCodes","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/blkcfg_blockLostBookingCodesToBeChanged"},{"properties":{"blockLostBookingCodes":{"items":{"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"required":["blockLostBookingCodes"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房流失原因 · 更新","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/blockLostBookingCodes/{blockLostBookingCodesId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"}},"/api/v1/config/blocks/block-rate-override-reasons":{"get":{"operationId":"getBlockRateOverrideReasons","parameters":[{"explode":true,"in":"query","name":"fetchInactive","required":false,"schema":{"type":"boolean"},"style":"form"},{"explode":true,"in":"query","name":"codes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"wildCard","required":false,"schema":{"type":"string"},"style":"form"},{"explode":true,"in":"query","name":"description","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OHIPDocument"}}},"description":"Oracle document; an upstream 204 becomes data {}."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房房价覆盖原因 · 查询","x-capability-group":"configuration.read","x-configuration-scope":"chain","x-integration":{"pattern":"sync-read","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties"],"retry":"Bounded read retries."},"x-oracle-path":"/blk/config/v1/blockRateOverrideReasons","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"},"post":{"operationId":"postBlockRateOverrideReasons","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/blkcfg_blockRateOverrideReasonsCriteria"},{"properties":{"blockRateOverrideReasons":{"items":{"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"required":["blockRateOverrideReasons"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"resource_code":{"maxLength":2000,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","resource_code","payload"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房房价覆盖原因 · 新增","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/blockRateOverrideReasons","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"}},"/api/v1/config/blocks/block-rate-override-reasons/{code}":{"delete":{"operationId":"deleteBlockRateOverrideReasons","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房房价覆盖原因 · 删除","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/blockRateOverrideReasons/{blockRateOverrideReasonsId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"},"put":{"operationId":"putBlockRateOverrideReasons","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/blkcfg_blockRateOverrideReasonsToBeChanged"},{"properties":{"blockRateOverrideReasons":{"items":{"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"required":["blockRateOverrideReasons"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房房价覆盖原因 · 更新","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/blockRateOverrideReasons/{blockRateOverrideReasonsId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"}},"/api/v1/config/blocks/block-refused-reasons":{"get":{"operationId":"getBlockRefusedReasons","parameters":[{"explode":true,"in":"query","name":"fetchInactive","required":false,"schema":{"type":"boolean"},"style":"form"},{"explode":true,"in":"query","name":"codes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"wildCard","required":false,"schema":{"type":"string"},"style":"form"},{"explode":true,"in":"query","name":"description","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OHIPDocument"}}},"description":"Oracle document; an upstream 204 becomes data {}."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房拒绝原因 · 查询","x-capability-group":"configuration.read","x-configuration-scope":"chain","x-integration":{"pattern":"sync-read","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties"],"retry":"Bounded read retries."},"x-oracle-path":"/blk/config/v1/blockRefusedReasons","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"},"post":{"operationId":"postBlockRefusedReasonspostBlo","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/blkcfg_blockRefusedReasonsCriteria"},{"properties":{"blockRefusedReasons":{"items":{"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"required":["blockRefusedReasons"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"resource_code":{"maxLength":2000,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","resource_code","payload"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房拒绝原因 · 新增","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/blockRefusedReasons","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"}},"/api/v1/config/blocks/block-refused-reasons/{code}":{"delete":{"operationId":"deleteBlockRefusedReasons","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房拒绝原因 · 删除","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/blockRefusedReasons/{blockRefusedReasonsId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"},"put":{"operationId":"putBlockRefusedReasons","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/blkcfg_blockRefusedReasonsToBeChanged"},{"properties":{"blockRefusedReasons":{"items":{"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"required":["blockRefusedReasons"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房拒绝原因 · 更新","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/blockRefusedReasons/{blockRefusedReasonsId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"}},"/api/v1/config/blocks/block-status-codes":{"get":{"operationId":"getBlockStatusCodes","parameters":[{"explode":true,"in":"query","name":"blockStatusCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OHIPDocument"}}},"description":"Oracle document; an upstream 204 becomes data {}."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房状态 · 查询","x-capability-group":"configuration.read","x-configuration-scope":"chain","x-integration":{"pattern":"sync-read","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties"],"retry":"Bounded read retries."},"x-oracle-path":"/blk/config/v1/blockStatusCodes","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"},"post":{"operationId":"postBlockStatusCode","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/blkcfg_blockStatusCodeDetails"},{"properties":{"blockStatusCode":{"type":"object"}},"required":["blockStatusCode"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"resource_code":{"maxLength":2000,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","resource_code","payload"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房状态 · 新增","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/blockStatusCodes","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"}},"/api/v1/config/blocks/block-status-codes/next-status-codes":{"get":{"operationId":"getNextBlockStatusCodes","parameters":[{"explode":true,"in":"query","name":"configuredOnly","required":false,"schema":{"type":"boolean"},"style":"form"},{"explode":true,"in":"query","name":"blockStatusCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OHIPDocument"}}},"description":"Oracle document; an upstream 204 becomes data {}."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房状态流转 · 查询","x-capability-group":"configuration.read","x-configuration-scope":"chain","x-integration":{"pattern":"sync-read","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties"],"retry":"Bounded read retries."},"x-oracle-path":"/blk/config/v1/blockStatusCodes/nextStatusCodes","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"}},"/api/v1/config/blocks/block-status-codes/{code}":{"delete":{"operationId":"deleteBlockStatusCode","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房状态 · 删除","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/blockStatusCodes/{blockStatusCode}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"},"put":{"operationId":"putBlockStatusCode","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/blkcfg_blockStatusCodeDetails"},{"properties":{"blockStatusCode":{"type":"object"}},"required":["blockStatusCode"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房状态 · 更新","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/blockStatusCodes/{blockStatusCode}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"}},"/api/v1/config/blocks/block-status-codes/{code}/next-status-codes":{"put":{"operationId":"putNextBlockStatusCodes","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/blkcfg_nextBlockStatusCode"},{"properties":{"nextBlockStatusCodeList":{"items":{"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"required":["nextBlockStatusCodeList"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房状态流转 · 更新","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/blockStatusCodes/{srcBlockStatusCode}/nextStatusCodes","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"}},"/api/v1/config/blocks/destination-codes":{"get":{"operationId":"getDestinationCodes","parameters":[{"explode":true,"in":"query","name":"fetchInactive","required":false,"schema":{"type":"boolean"},"style":"form"},{"explode":true,"in":"query","name":"codes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"wildCard","required":false,"schema":{"type":"string"},"style":"form"},{"explode":true,"in":"query","name":"description","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OHIPDocument"}}},"description":"Oracle document; an upstream 204 becomes data {}."},"default":{"$ref":"#/components/responses/Error"}},"summary":"目的地代码 · 查询","x-capability-group":"configuration.read","x-configuration-scope":"chain","x-integration":{"pattern":"sync-read","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties"],"retry":"Bounded read retries."},"x-oracle-path":"/blk/config/v1/destinationCodes","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"},"post":{"operationId":"postDestinationCodes","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/blkcfg_destinationCodesCriteria"},{"properties":{"destinationCodes":{"items":{"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"required":["destinationCodes"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"resource_code":{"maxLength":2000,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","resource_code","payload"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"目的地代码 · 新增","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/destinationCodes","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"}},"/api/v1/config/blocks/destination-codes/{code}":{"delete":{"operationId":"deleteDestinationCodes","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"目的地代码 · 删除","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/destinationCodes/{destinationCodesId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"},"put":{"operationId":"putDestinationCodes","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/blkcfg_destinationCodesToBeChanged"},{"properties":{"destinationCodes":{"items":{"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"required":["destinationCodes"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"目的地代码 · 更新","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/destinationCodes/{destinationCodesId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"}},"/api/v1/config/blocks/reservation-methods":{"get":{"operationId":"getReservationMethods","parameters":[{"explode":true,"in":"query","name":"fetchInactive","required":false,"schema":{"type":"boolean"},"style":"form"},{"explode":true,"in":"query","name":"codes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"wildCard","required":false,"schema":{"type":"string"},"style":"form"},{"explode":true,"in":"query","name":"description","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OHIPDocument"}}},"description":"Oracle document; an upstream 204 becomes data {}."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房预订方式 · 查询","x-capability-group":"configuration.read","x-configuration-scope":"chain","x-integration":{"pattern":"sync-read","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties"],"retry":"Bounded read retries."},"x-oracle-path":"/blk/config/v1/reservationMethods","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"},"post":{"operationId":"postReservationMethods","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/blkcfg_reservationMethodsCriteria"},{"properties":{"reservationMethods":{"items":{"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"required":["reservationMethods"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"resource_code":{"maxLength":2000,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","resource_code","payload"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房预订方式 · 新增","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/reservationMethods","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"}},"/api/v1/config/blocks/reservation-methods/{code}":{"delete":{"operationId":"deleteReservationMethods","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房预订方式 · 删除","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/reservationMethods/{reservationMethodsId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"},"put":{"operationId":"putReservationMethods","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/blkcfg_reservationMethodsToBeChanged"},{"properties":{"reservationMethods":{"items":{"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"required":["reservationMethods"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"团队房预订方式 · 更新","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/blk/config/v1/reservationMethods/{reservationMethodsId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/blkcfg.json"}},"/api/v1/config/opera-settings":{"get":{"description":"Use this API to return OPERA controls based on search criteria such as hotelId, cROCode, parameterNameWildCard. OPERA Controls determine the functionality, behavior and defaults for OPERA Cloud. The functions, parameters and settings available are determined by the Cloud Service subscriptions.\u003c/p\u003e Fixed configured hotel; native status is in upstream_status. Native 204 is represented by HTTP 200 with upstream_status=204 and data={}. No automatic pagination.","operationId":"getOperaSettings","parameters":[{"description":"This is the Central Reservation office code.","in":"query","name":"cROCode","required":false,"schema":{"maxLength":200,"type":"string"}},{"description":"Wildcard search parameter.","in":"query","name":"parameterNameWildCard","required":false,"schema":{"maxLength":4000,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/booking_entcfg_operaSettingsDetails"}},"type":"object"}]}}},"description":"Oracle read or confirmed-write outcome; inspect status before continuing business workflow."},"default":{"$ref":"#/components/responses/Error"}},"summary":"查询 OPERA Controls","x-capability-group":"configuration.read","x-fixed-hotel-query":"hotelId","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and Oracle access for the configured hotel","Use actual target IDs/codes; synthetic examples are not hotel configuration"],"retry":"Bounded read retries; honor Retry-After"},"x-oracle-api":"ENTCFG","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/entcfg.json"}},"/api/v1/config/reservations/booking-types":{"get":{"operationId":"getBookingTypes","parameters":[{"explode":true,"in":"query","name":"fetchInactive","required":false,"schema":{"type":"boolean"},"style":"form"},{"explode":true,"in":"query","name":"codes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"wildCard","required":false,"schema":{"type":"string"},"style":"form"},{"explode":true,"in":"query","name":"description","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OHIPDocument"}}},"description":"Oracle document; an upstream 204 becomes data {}."},"default":{"$ref":"#/components/responses/Error"}},"summary":"预订类型 · 查询","x-capability-group":"configuration.read","x-configuration-scope":"chain","x-integration":{"pattern":"sync-read","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties"],"retry":"Bounded read retries."},"x-oracle-path":"/rsv/config/v1/bookingTypes","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"},"post":{"operationId":"postBookingTypes","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/rsvcfg_bookingTypesCriteria"},{"properties":{"bookingTypes":{"items":{"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"required":["bookingTypes"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"resource_code":{"maxLength":2000,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","resource_code","payload"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"预订类型 · 新增","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/bookingTypes","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"}},"/api/v1/config/reservations/booking-types/{code}":{"delete":{"operationId":"deleteBookingTypes","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"预订类型 · 删除","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/bookingTypes/{bookingTypesId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"},"put":{"operationId":"putBookingTypes","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/rsvcfg_bookingTypesToBeChanged"},{"properties":{"bookingTypes":{"items":{"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"required":["bookingTypes"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"预订类型 · 更新","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/bookingTypes/{bookingTypesId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"}},"/api/v1/config/reservations/cancellation-codes":{"get":{"operationId":"getCancellationCodes","parameters":[{"explode":true,"in":"query","name":"fetchInactive","required":false,"schema":{"type":"boolean"},"style":"form"},{"explode":true,"in":"query","name":"codes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"wildCard","required":false,"schema":{"type":"string"},"style":"form"},{"explode":true,"in":"query","name":"description","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OHIPDocument"}}},"description":"Oracle document; an upstream 204 becomes data {}."},"default":{"$ref":"#/components/responses/Error"}},"summary":"预订取消原因 · 查询","x-capability-group":"configuration.read","x-configuration-scope":"chain","x-integration":{"pattern":"sync-read","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties"],"retry":"Bounded read retries."},"x-oracle-path":"/rsv/config/v1/cancellationCodes","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"},"post":{"operationId":"postCancellationCodes","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/rsvcfg_cancellationCodesCriteria"},{"properties":{"cancellationCodes":{"items":{"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"required":["cancellationCodes"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"resource_code":{"maxLength":2000,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","resource_code","payload"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"预订取消原因 · 新增","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/cancellationCodes","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"}},"/api/v1/config/reservations/cancellation-codes/{code}":{"delete":{"operationId":"deleteCancellationCodes","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"预订取消原因 · 删除","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/cancellationCodes/{cancellationCodesId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"},"put":{"operationId":"putCancellationCodes","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"chain","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/rsvcfg_cancellationCodesToBeChanged"},{"properties":{"cancellationCodes":{"items":{"type":"object"},"maxItems":1,"minItems":1,"type":"array"}},"required":["cancellationCodes"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"预订取消原因 · 更新","x-capability-group":"configuration.write","x-configuration-scope":"chain","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover chain scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/cancellationCodes/{cancellationCodesId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"}},"/api/v1/config/reservations/guarantee-codes":{"post":{"operationId":"postGuaranteeCode","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/rsvcfg_guaranteeCodeCriteria"},{"properties":{"hotelId":{"description":"Must equal the server-configured hotel.","type":"string"}},"required":["hotelId"],"type":"object"},{"properties":{"guaranteeCode":{"type":"object"}},"required":["guaranteeCode"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"resource_code":{"maxLength":2000,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","resource_code","payload"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"担保类型 · 新增","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/guaranteeCodes","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"}},"/api/v1/config/reservations/guarantee-codes/{code}":{"delete":{"operationId":"deleteGuaranteeCode","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"担保类型 · 删除","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/guaranteeCodes/{guaranteeCode}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"},"put":{"operationId":"changeGuaranteeCode","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/rsvcfg_guaranteeCodeToBeChanged"},{"properties":{"hotelId":{"description":"Must equal the server-configured hotel.","type":"string"}},"required":["hotelId"],"type":"object"},{"properties":{"guaranteeCode":{"type":"object"}},"required":["guaranteeCode"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"担保类型 · 更新","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/guaranteeCodes/{guaranteeCode}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"}},"/api/v1/config/reservations/market-codes/{code}":{"delete":{"operationId":"removeMarketCode","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"市场代码 · 删除","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/hotels/{hotelId}/marketCodes/{marketcode}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"},"post":{"operationId":"postMarketCode","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/rsvcfg_marketCodeCriteria"},{"properties":{"marketCode":{"type":"object"}},"required":["marketCode"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"市场代码 · 新增","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/hotels/{hotelId}/marketCodes/{marketcode}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"},"put":{"operationId":"changeMarketCode","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"explode":true,"in":"query","name":"forceOverride","required":false,"schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/rsvcfg_marketCodeToBeChanged"},{"properties":{"marketCode":{"type":"object"}},"required":["marketCode"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"市场代码 · 更新","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/hotels/{hotelId}/marketCodes/{marketcode}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"}},"/api/v1/config/reservations/market-groups":{"get":{"operationId":"getMarketGroups","parameters":[{"explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"explode":true,"in":"query","name":"pageNumber","required":false,"schema":{"type":"integer"},"style":"form"},{"explode":true,"in":"query","name":"marketCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"marketGroupsCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"includeInactive","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OHIPDocument"}}},"description":"Oracle document; an upstream 204 becomes data {}."},"default":{"$ref":"#/components/responses/Error"}},"summary":"市场分组 · 查询","x-capability-group":"configuration.read","x-configuration-scope":"hotel","x-integration":{"pattern":"sync-read","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties"],"retry":"Bounded read retries."},"x-oracle-path":"/rsv/config/v1/marketGroups","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"}},"/api/v1/config/reservations/market-groups/{code}":{"delete":{"operationId":"removeMarketGroup","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"市场分组 · 删除","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/hotels/{hotelId}/marketGroups/{marketGroupCode}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"},"post":{"operationId":"postMarketGroup","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/rsvcfg_marketGroupCriteria"},{"properties":{"marketGroup":{"type":"object"}},"required":["marketGroup"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"市场分组 · 新增","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/hotels/{hotelId}/marketGroups/{marketGroupCode}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"},"put":{"operationId":"changeMarketGroup","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/rsvcfg_marketGroupToBeChanged"},{"properties":{"marketGroup":{"type":"object"}},"required":["marketGroup"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"市场分组 · 更新","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/hotels/{hotelId}/marketGroups/{marketGroupCode}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"}},"/api/v1/config/reservations/source-codes":{"post":{"operationId":"postSourceCode","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/rsvcfg_sourceCodeCriteria"},{"properties":{"sourceCode":{"type":"object"}},"required":["sourceCode"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"resource_code":{"maxLength":2000,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","resource_code","payload"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"来源代码 · 新增","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/hotels/{hotelId}/sourceCodes/","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"}},"/api/v1/config/reservations/source-codes/{code}":{"delete":{"operationId":"removeSourceCode","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"来源代码 · 删除","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/hotels/{hotelId}/sourceCodes/{sourceCode}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"},"put":{"operationId":"changeSourceCode","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/rsvcfg_sourceCodeToBeChanged"},{"properties":{"sourceCode":{"type":"object"}},"required":["sourceCode"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"来源代码 · 更新","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/hotels/{hotelId}/sourceCodes/{sourceCode}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"}},"/api/v1/config/reservations/source-groups":{"get":{"operationId":"getSourceGroups","parameters":[{"explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"explode":true,"in":"query","name":"pageNumber","required":false,"schema":{"type":"integer"},"style":"form"},{"explode":true,"in":"query","name":"sourceCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"sourceGroupsCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"includeInactive","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OHIPDocument"}}},"description":"Oracle document; an upstream 204 becomes data {}."},"default":{"$ref":"#/components/responses/Error"}},"summary":"来源分组 · 查询","x-capability-group":"configuration.read","x-configuration-scope":"hotel","x-integration":{"pattern":"sync-read","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties"],"retry":"Bounded read retries."},"x-oracle-path":"/rsv/config/v1/hotels/{hotelId}/sourceGroups","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"},"post":{"operationId":"postSourceGroup","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/rsvcfg_sourceGroupCriteria"},{"properties":{"sourceGroup":{"type":"object"}},"required":["sourceGroup"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"resource_code":{"maxLength":2000,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","resource_code","payload"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"来源分组 · 新增","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/hotels/{hotelId}/sourceGroups","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"}},"/api/v1/config/reservations/source-groups/{code}":{"delete":{"operationId":"removeSourceGroup","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"来源分组 · 删除","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/hotels/{hotelId}/sourceGroups/{sourceGroupCode}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"},"put":{"operationId":"changeSourceGroup","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/rsvcfg_sourceGroupToBeChanged"},{"properties":{"sourceGroup":{"type":"object"}},"required":["sourceGroup"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"来源分组 · 更新","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rsv/config/v1/hotels/{hotelId}/sourceGroups/{sourceGroupCode}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsvcfg.json"}},"/api/v1/config/rooms/room-classes":{"get":{"operationId":"getRoomClasses","parameters":[{"explode":true,"in":"query","name":"roomClassCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OHIPDocument"}}},"description":"Oracle document; an upstream 204 becomes data {}."},"default":{"$ref":"#/components/responses/Error"}},"summary":"房型分类 · 查询","x-capability-group":"configuration.read","x-configuration-scope":"hotel","x-integration":{"pattern":"sync-read","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties"],"retry":"Bounded read retries."},"x-oracle-path":"/rm/config/v1/hotels/{hotelId}/roomClasses","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rmcfg.json"},"post":{"operationId":"postRoomClass","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/rmcfg_roomClassCriteria"},{"properties":{"roomClass":{"type":"object"}},"required":["roomClass"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"resource_code":{"maxLength":2000,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","resource_code","payload"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"房型分类 · 新增","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rm/config/v1/hotels/{hotelId}/roomClasses","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rmcfg.json"}},"/api/v1/config/rooms/room-classes/{code}":{"delete":{"operationId":"deleteRoomClass","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"房型分类 · 删除","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rm/config/v1/hotels/{hotelId}/roomClasses/{roomClassId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rmcfg.json"},"put":{"operationId":"putRoomClass","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/rmcfg_roomClassToBeChanged"},{"properties":{"roomClass":{"type":"object"}},"required":["roomClass"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"房型分类 · 更新","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rm/config/v1/hotels/{hotelId}/roomClasses/{roomClassId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rmcfg.json"}},"/api/v1/config/rooms/room-types":{"post":{"operationId":"postRoomTypes","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/rmcfg_roomTypesCriteria"},{"properties":{"roomType":{"properties":{"hotelId":{"description":"Must equal the server-configured hotel.","type":"string"}},"required":["hotelId"],"type":"object"}},"required":["roomType"],"type":"object"},{"properties":{"roomType":{"properties":{"roomTypeDetails":{"type":"object"}},"required":["roomTypeDetails"],"type":"object"}},"required":["roomType"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"resource_code":{"maxLength":2000,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","resource_code","payload"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"房型 · 新增","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rm/config/v1/hotels/{hotelId}/roomTypes","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rmcfg.json"}},"/api/v1/config/rooms/room-types/{code}":{"delete":{"operationId":"deleteRoomTypes","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"房型 · 删除","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rm/config/v1/hotels/{hotelId}/roomTypes/{roomTypeId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rmcfg.json"},"put":{"operationId":"putRoomTypes","parameters":[{"in":"path","name":"code","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"case_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_hotel_id":{"maxLength":200,"minLength":1,"type":"string"},"expected_scope":{"const":"hotel","type":"string"},"hotel_confirmation_id":{"maxLength":200,"minLength":1,"type":"string"},"idempotency_key":{"maxLength":200,"minLength":1,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/rmcfg_roomTypesToBeChanged"},{"properties":{"roomType":{"properties":{"hotelId":{"description":"Must equal the server-configured hotel.","type":"string"}},"required":["hotelId"],"type":"object"}},"required":["roomType"],"type":"object"},{"properties":{"roomType":{"properties":{"roomTypeDetails":{"type":"object"}},"required":["roomTypeDetails"],"type":"object"}},"required":["roomType"],"type":"object"}],"description":"One target code only, matching resource_code or the path code. Oracle-shaped fields are forwarded unchanged."},"task_id":{"maxLength":200,"minLength":1,"type":"string"}},"required":["case_id","task_id","hotel_confirmation_id","idempotency_key","expected_hotel_id","expected_scope","payload"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Upstream accepted and the target code was read back (or its absence verified for deletion). Inspect returned fields for business correctness."},"default":{"$ref":"#/components/responses/Error"}},"summary":"房型 · 更新","x-capability-group":"configuration.write","x-configuration-scope":"hotel","x-integration":{"pattern":"confirmed-write","prerequisites":["Oracle functional area and configuration access","Configured hotel context; chain configuration can affect multiple properties","Confirmation must cover hotel scope; one resource code per request; a chain code can affect multiple hotels"],"retry":"Reuse the same idempotency key; never blindly retry an unknown result. Replays perform verification reads only."},"x-oracle-path":"/rm/config/v1/hotels/{hotelId}/roomTypes/{roomTypeId}","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/tree/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rmcfg.json"}},"/api/v1/connectivity":{"get":{"operationId":"checkAuthenticatedConnectivity","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"caller_id":{"type":"string"},"caller_name":{"type":"string"},"key_id":{"type":"string"},"status":{"const":"ok","type":"string"}},"required":["status","caller_id","caller_name","key_id"],"type":"object"}}},"description":"Authentication succeeded."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Check downstream API Key authentication"}},"/api/v1/external-systems/{externalSystemCode}/reservations/{reservationExternalID}":{"get":{"description":"Retrieve a reservation using the external ID. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetReservationByExtId\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getReservationByExtId","parameters":[{"description":"Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system.","in":"path","name":"externalSystemCode","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"External reservation Id.","in":"path","name":"reservationExternalID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Define the external system(s) to return external reference ids for associated profiles for the reservation. A maximum of 10 different external systems can be be provided for this parameter.","explode":true,"in":"query","name":"profileExternalReferencesToFetch","required":false,"schema":{"items":{"type":"string"},"maxItems":10,"type":"array"},"style":"form"},{"description":"Instruction on which of the reservation's elements are to be returned e.g. DailySummary will return summarized information for each day of the reservation. Instructions are cumulative i.e. if multiple instructions are sent in a request, then the combined reservation elements would be returned, elements will not be duplicated in the response.","explode":true,"in":"query","name":"fetchInstructions","required":false,"schema":{"items":{"enum":["Reservation","Comments","GuestComments","Packages","TotalCostOfStay","InventoryItems","ReservationPaymentMethods","RoutingInstructions","Preferences","Memberships","Alerts","Traces","ConfirmationLetters","CallHistory","FixedCharges","GuestMessages","ReservationPolicies","Indicators","LinkedReservations","RevenuesAndBalances","GuestLastStay","ECoupons","TrackItItems","ReservationAwards","WebRegistrationCards","ReservationActivities","ScheduledActivities","PrepaidCards","Shares","Attachments","Locators","ProfileAwards","TransactionDiversions","Tickets","GuestMemberships","ECertificates","UpsellInfo","RoomAssignedByAI","DailySummary","OffshoreRates","PostingIntervals","AgeThresholds"],"type":"string"},"type":"array","uniqueItems":true},"style":"form"},{"description":"Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.","explode":true,"in":"query","name":"allowedActions","required":false,"schema":{"items":{"enum":["Cancel","Move","PreCharge","PostCharge","FacilitySchedule","Upsell","PreCheckIn","PostToNoShowCancel","NoShow","NameChange","Discount","HouseKeeping","EnrollToPrimaryMembership","EnrollInProgress"],"type":"string"},"type":"array","uniqueItems":true},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_reservation"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get Reservation by external ID","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/external-systems/{externalSystemCode}/reservations/{reservationExternalID}/shares":{"get":{"description":"This API can be used to retrieve the share reservations that exist on a reservation. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetShareReservationsByExtId\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getShareReservationsByExtId","parameters":[{"description":"Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system.","in":"path","name":"externalSystemCode","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"External reservation ID.","in":"path","name":"reservationExternalID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_shareReservations"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get share Reservations","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/finance/ar/accounts":{"get":{"operationId":"getAccounts","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"}},"summary":"Search AR accounts","x-capability-group":"finance.read","x-finance-policy":"read-only","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":"ARS"}},"/api/v1/finance/ar/accounts/{accountID}":{"get":{"operationId":"getAccount","parameters":[{"$ref":"#/components/parameters/AccountID"}],"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"}},"summary":"Get an AR account","x-capability-group":"finance.read","x-finance-policy":"read-only","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":"ARS"}},"/api/v1/finance/ar/accounts/{accountID}/statements":{"get":{"operationId":"getStatements","parameters":[{"$ref":"#/components/parameters/AccountID"}],"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"}},"summary":"Get statements for an AR account","x-capability-group":"finance.read","x-finance-policy":"read-only","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":"ARS"}},"/api/v1/finance/ar/aging-cycles":{"get":{"operationId":"getARAgingCycles","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"}},"summary":"Get AR aging cycles","x-capability-group":"finance.read","x-finance-policy":"read-only","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":"ARS"}},"/api/v1/finance/ar/profiles/{profileID}/aging":{"get":{"operationId":"getProfileAging","parameters":[{"$ref":"#/components/parameters/ProfileID"}],"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"}},"summary":"Get profile aging detail","x-capability-group":"finance.read","x-finance-policy":"read-only","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":"ARS"}},"/api/v1/finance/ar/statements":{"get":{"operationId":"getARStatements","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"}},"summary":"Search AR statements","x-capability-group":"finance.read","x-finance-policy":"read-only","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":"ARS"}},"/api/v1/finance/ar/transactions":{"get":{"operationId":"getARTransactions","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"}},"summary":"Get AR transactions","x-capability-group":"finance.read","x-finance-policy":"read-only","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":"ARS"}},"/api/v1/finance/ar/transactions/searches":{"post":{"operationId":"searchARTransactions","requestBody":{"$ref":"#/components/requestBodies/RequiredOracleDocument"},"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"}},"summary":"Search AR transactions without mutation","x-capability-group":"finance.read","x-finance-policy":"read-only-search","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":"ARS"}},"/api/v1/finance/balance":{"get":{"operationId":"getBalanceInfo","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"}},"summary":"Get balance information","x-capability-group":"finance.read","x-finance-policy":"read-only","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":"CSH"}},"/api/v1/finance/financial-posting-jobs":{"post":{"description":"The service does not retry this job start automatically.","operationId":"startFinancialPostingsAsync","requestBody":{"$ref":"#/components/requestBodies/RequiredOracleDocument"},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAccepted"}}},"description":"Oracle accepted the asynchronous retrieval job.","headers":{"Cache-Control":{"schema":{"const":"no-store","type":"string"}}}},"default":{"$ref":"#/components/responses/Error"}},"summary":"Start a read-only Financial Postings Net/VAT extract","x-capability-group":"finance.async","x-finance-policy":"read-only-job","x-integration":{"pattern":"async-read","prerequisites":["Approved retrieval parameters","Retain process ID"],"retry":"Do not blindly retry a timed-out start. Retain job ID; poll status respecting Retry-After, then fetch result."},"x-oracle-api":"CSHASYNC"}},"/api/v1/finance/financial-posting-jobs/{jobID}":{"get":{"operationId":"getFinancialPostingsAsync","parameters":[{"$ref":"#/components/parameters/JobID"}],"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"}},"summary":"Get Financial Postings Net/VAT extract results","x-capability-group":"finance.async","x-finance-policy":"read-only-job","x-integration":{"pattern":"async-read","prerequisites":["Approved retrieval parameters","Retain process ID"],"retry":"Do not blindly retry a timed-out start. Retain job ID; poll status respecting Retry-After, then fetch result."},"x-oracle-api":"CSHASYNC"}},"/api/v1/finance/financial-posting-jobs/{jobID}/status":{"get":{"operationId":"getFinancialPostingsProcessStatusAsync","parameters":[{"$ref":"#/components/parameters/JobID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobStatus"}}},"description":"Current Oracle process status.","headers":{"Cache-Control":{"schema":{"const":"no-store","type":"string"}},"Retry-After":{"description":"Seconds from Oracle Cache-Control max-age before polling again, when supplied.","schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/Error"}},"summary":"Check Financial Postings extract status","x-capability-group":"finance.async","x-finance-policy":"read-only-job","x-integration":{"pattern":"async-read","prerequisites":["Approved retrieval parameters","Retain process ID"],"retry":"Do not blindly retry a timed-out start. Retain job ID; poll status respecting Retry-After, then fetch result."},"x-oracle-api":"CSHASYNC"}},"/api/v1/finance/financial-postings":{"get":{"operationId":"getFinancialPostings","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"}},"summary":"Get Financial Postings","x-capability-group":"finance.read","x-finance-policy":"read-only","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":"CSH","x-sensitive-query-fields-excluded":["cardNumber","cardHolderName","expirationDate"]}},"/api/v1/finance/hotel-revenue":{"get":{"operationId":"getHotelRevenue","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"}},"summary":"Get hotel revenue","x-capability-group":"finance.read","x-finance-policy":"read-only","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":"CSH"}},"/api/v1/finance/posting-summary":{"get":{"operationId":"getPostingSummary","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"}},"summary":"Get Posting Summary","x-capability-group":"finance.read","x-finance-policy":"read-only","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":"CSH"}},"/api/v1/finance/reservations/{reservationID}/folios":{"get":{"operationId":"getFolio","parameters":[{"$ref":"#/components/parameters/ReservationID"}],"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"}},"summary":"Get reservation folios","x-capability-group":"finance.read","x-finance-policy":"read-only","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":"CSH"}},"/api/v1/finance/reservations/{reservationID}/revenue":{"get":{"operationId":"getReservationRevenueBucketTotals","parameters":[{"$ref":"#/components/parameters/ReservationID"}],"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"}},"summary":"Get reservation revenue bucket totals","x-capability-group":"finance.read","x-finance-policy":"read-only","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":"CSH"}},"/api/v1/finance/transaction-details":{"get":{"operationId":"getFolioTransactionDetails","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"}},"summary":"Get folio transaction details","x-capability-group":"finance.read","x-finance-policy":"read-only","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":"CSH"}},"/api/v1/finance/transactions":{"get":{"operationId":"getGuestsTransactions","parameters":[{"description":"One or more OPERA reservation IDs; repeat the query parameter for multiple values.","explode":true,"in":"query","name":"reservationList","required":true,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"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"}},"summary":"Get guest transactions","x-capability-group":"finance.read","x-finance-policy":"read-only","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":"CSH"}},"/api/v1/profiles":{"get":{"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"}},"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"]},"post":{"description":"When a profile doesn't already exist for a guest, use this to create a new profile. The response will provide the newly created profile's OPERA ID. There are many fields in postProfile defined by ListOfValues; ensure you have reviewed ListOfValues APIs in order successfully to use postProfile. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003epostProfile\u003c/p\u003e Fixed configured hotel; native status is in upstream_status. Single-target confirmed write. Check status: verified or pending_verification. Known success returns its native HTTP 200/201 even if readback is pending. Exact replay repeats reads only; unknown outcomes require reconciliation. receipt is the original Oracle response on the first successful mutation only, never persisted; save it in the consuming application's approved evidence store.","operationId":"postProfile","parameters":[],"requestBody":{"content":{"application/json":{"example":{"case_id":"case-test","expected_hotel_id":"HOTEL1","hotel_confirmation_id":"approval-test","idempotency_key":"unique-test-key","payload":{"profileDetails":{"addresses":{"addressInfo":[{"address":{"country":{"code":"CN"}}}]},"customer":{"personName":[{"surname":"测试客人"}]},"profileType":"Guest","registeredProperty":"HOTEL1"}},"task_id":"task-test"},"schema":{"allOf":[{"$ref":"#/components/schemas/ConfirmedWriteRequest"},{"properties":{"payload":{"$ref":"#/components/schemas/BookingPayload_postProfile"}},"type":"object"}]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingWriteResult"}}},"description":"Oracle read or confirmed-write outcome; inspect status before continuing business workflow."},"default":{"$ref":"#/components/responses/Error"}},"summary":"创建 Guest 客档","x-capability-group":"profiles.write","x-integration":{"pattern":"confirmed-write","prerequisites":["Approved profiles.write capability and Oracle access for the configured hotel","Use actual target IDs/codes; synthetic examples are not hotel configuration"],"retry":"Never blindly retry mutations. Resubmit identical confirmation and idempotency key to retry readback only; unknown outcomes stay blocked."},"x-oracle-api":"CRM","x-oracle-response-schema":{"$ref":"#/components/schemas/booking_crm_status"},"x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/crm.json","x-verification-operation":"getProfile"}},"/api/v1/profiles/searches":{"post":{"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"}},"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"}},"/api/v1/profiles/{profileID}":{"get":{"operationId":"getProfile","parameters":[{"$ref":"#/components/parameters/ProfileID"}],"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"}},"summary":"Get a profile by OPERA ID","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"}},"/api/v1/profiles/{profileID}/relationships":{"get":{"description":" \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetProfileRelationships\u003c/p\u003e Fixed configured hotel; native status is in upstream_status. Native 204 is represented by HTTP 200 with upstream_status=204 and data={}. No automatic pagination.","operationId":"getProfileRelationships","parameters":[{"in":"path","name":"profileID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Type of Profile to be fetched from OPERA.","in":"query","name":"relationshipPrimaryProfile","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/booking_crm_profileRelationships"}},"type":"object"}]}}},"description":"Oracle read or confirmed-write outcome; inspect status before continuing business workflow."},"default":{"$ref":"#/components/responses/Error"}},"summary":"查询客档关系","x-capability-group":"profiles.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved profiles.read capability and Oracle access for the configured hotel","Use actual target IDs/codes; synthetic examples are not hotel configuration"],"retry":"Bounded read retries; honor Retry-After"},"x-oracle-api":"CRM","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/crm.json"}},"/api/v1/profiles/{profileID}/reservations/share-candidates":{"get":{"deprecated":true,"description":"Get Reservations to share by profile id. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetReservationsToShareByProfileId\u003c/p\u003e \u003cp\u003eThe maximum allowable limit for this API is \u003cstrong\u003e100\u003c/strong\u003e.\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getReservationsToShareByProfileId","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"profileID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Indicates maximum number of records a Web Service should return.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Free form text field for searching all reservation fields","in":"query","name":"superSearch","required":false,"schema":{"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","in":"query","name":"reservationGuestId","required":false,"schema":{"type":"string"}},{"description":"A reference to the type of object defined by the UniqueID element.","in":"query","name":"reservationGuestIdType","required":false,"schema":{"type":"string"}},{"description":"Membership ID criteria.","in":"query","name":"membershipId","required":false,"schema":{"type":"string"}},{"explode":true,"in":"query","name":"membershipLevel","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"membershipType","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"Family name, last name.","in":"query","name":"surname","required":false,"schema":{"type":"string"}},{"description":"Given name, first name or names","in":"query","name":"givenName","required":false,"schema":{"type":"string"}},{"description":"Room number","in":"query","name":"roomId","required":false,"schema":{"type":"string"}},{"description":"Instruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.","explode":true,"in":"query","name":"fetchInstructions","required":false,"schema":{"items":{"enum":["Reservation","Comments","GuestComments","Packages","InventoryItems","ReservationPaymentMethods","RoutingInstructions","Preferences","Memberships","Alerts","Traces","ConfirmationLetters","CallHistory","FixedCharges","GuestMessages","ReservationPolicies","Indicators","LinkedReservations","RevenuesAndBalances","GuestLastStay","ECoupons","TrackItItems","TotalCostOfStay","ReservationAwards","WebRegistrationCards","ServiceRequests","ReservationActivities","ScheduledActivities","PrepaidCards","Shares","Attachments","Locators","ProfileAwards","TransactionDiversions","Tickets","GuestMemberships","ECertificates","UpsellInfo","RoomAssignedByAI","CustomNameValue","CustomChargeExemptions"],"type":"string"},"type":"array","uniqueItems":true},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_fetchReservations"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get Reservations to share ","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/rate-plans":{"get":{"operationId":"getRatePlansByHotel","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"}},"summary":"Get Rate Plans for the configured hotel","x-capability-group":"hotel.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":"RTP"}},"/api/v1/rate-plans/{ratePlanCode}":{"get":{"operationId":"getRatePlan","parameters":[{"$ref":"#/components/parameters/RatePlanCode"}],"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"}},"summary":"Get one Rate Plan","x-capability-group":"hotel.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":"RTP"}},"/api/v1/reports":{"get":{"description":"Use this API to return reports based on search criteria such as excludeGroup, includeInternalReports, includeRnAReports, includeUnpublished, includeWatermarkDetails, limit, multiPropertyOnly, protectedReportParam, scheduled, name, group, hotel, id, idContext, type. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetReports\u003c/p\u003e Read-only report metadata/options; does not execute, schedule or download a report. Edge supplies the configured hotel in the header and any hotel path/query field. Original JSON is preserved without pagination; upstream 204 becomes 200 with data {}.","operationId":"getReports","parameters":[{"description":"Indicates whether a report group should be excluded","in":"query","name":"excludeGroup","required":false,"schema":{"maxLength":2000,"minLength":0,"type":"string"}},{"description":"Indicates whether sample internal reports are to be included","in":"query","name":"includeInternalReports","required":false,"schema":{"type":"boolean"}},{"description":"Indicates whether RnA reports are to be included","in":"query","name":"includeRnAReports","required":false,"schema":{"type":"boolean"}},{"description":"Indicates whether protected reports should be included","in":"query","name":"includeUnpublished","required":false,"schema":{"type":"boolean"}},{"description":"Indicates whether the watermark details is to be populated. This is needed only for the configuration and not for the actual execution.","in":"query","name":"includeWatermarkDetails","required":false,"schema":{"type":"boolean"}},{"description":"Indicates maximum number of records a Web Service should return.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Indicates whether the result set should only include multi-property reports.","in":"query","name":"multiPropertyOnly","required":false,"schema":{"type":"boolean"}},{"description":"Indicates whether protected reports should be included","in":"query","name":"protectedReportParam","required":false,"schema":{"type":"boolean"}},{"description":"Indicates that only reports that can be scheduled are included","in":"query","name":"scheduled","required":false,"schema":{"type":"boolean"}},{"description":"Partial report name or description to search.","in":"query","name":"name","required":false,"schema":{"maxLength":2000,"minLength":0,"type":"string"}},{"description":"Report group to limit search.","in":"query","name":"group","required":false,"schema":{"maxLength":2000,"minLength":0,"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","in":"query","name":"id","required":false,"schema":{"maxLength":80,"minLength":0,"type":"string"}},{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","in":"query","name":"idContext","required":false,"schema":{"maxLength":80,"minLength":0,"type":"string"}},{"description":"A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).","in":"query","name":"type","required":false,"schema":{"maxLength":80,"minLength":0,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/report_repcfg_reports"}},"type":"object"}]}}},"description":"Oracle JSON in the edge envelope; upstream 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"查询报表","x-capability-group":"configuration.read","x-fixed-hotel-query":"hotel","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and upstream REPCFG access","Use actual report identity and parameter/option codes from the target environment; no inferred ARR execution contract"],"retry":"Bounded read retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"REPCFG","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/repcfg.json"}},"/api/v1/reports/all":{"get":{"description":"Use this API to return all reports based on search criteria such as excludeGroup, includeInternalReports, includeRnAReports, includeUnpublished, includeWatermarkDetails, limit, multiPropertyOnly, protectedReportParam, scheduled, name, group, hotel, id, idContext, type. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetAllReports\u003c/p\u003e Read-only report metadata/options; does not execute, schedule or download a report. Edge supplies the configured hotel in the header and any hotel path/query field. Original JSON is preserved without pagination; upstream 204 becomes 200 with data {}.","operationId":"getAllReports","parameters":[{"description":"Indicates whether a report group should be excluded","in":"query","name":"excludeGroup","required":false,"schema":{"maxLength":2000,"minLength":0,"type":"string"}},{"description":"Indicates whether sample internal reports are to be included","in":"query","name":"includeInternalReports","required":false,"schema":{"type":"boolean"}},{"description":"Indicates whether RnA reports are to be included","in":"query","name":"includeRnAReports","required":false,"schema":{"type":"boolean"}},{"description":"Indicates whether protected reports should be included","in":"query","name":"includeUnpublished","required":false,"schema":{"type":"boolean"}},{"description":"Indicates whether the watermark details is to be populated. This is needed only for the configuration and not for the actual execution.","in":"query","name":"includeWatermarkDetails","required":false,"schema":{"type":"boolean"}},{"description":"Indicates maximum number of records a Web Service should return.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Indicates whether the result set should only include multi-property reports.","in":"query","name":"multiPropertyOnly","required":false,"schema":{"type":"boolean"}},{"description":"Indicates whether protected reports should be included","in":"query","name":"protectedReportParam","required":false,"schema":{"type":"boolean"}},{"description":"Indicates that only reports that can be scheduled are included","in":"query","name":"scheduled","required":false,"schema":{"type":"boolean"}},{"description":"Partial report name or description to search.","in":"query","name":"name","required":false,"schema":{"maxLength":2000,"minLength":0,"type":"string"}},{"description":"Report group to limit search.","in":"query","name":"group","required":false,"schema":{"maxLength":2000,"minLength":0,"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","in":"query","name":"id","required":false,"schema":{"maxLength":80,"minLength":0,"type":"string"}},{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","in":"query","name":"idContext","required":false,"schema":{"maxLength":80,"minLength":0,"type":"string"}},{"description":"A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).","in":"query","name":"type","required":false,"schema":{"maxLength":80,"minLength":0,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/report_repcfg_reports"}},"type":"object"}]}}},"description":"Oracle JSON in the edge envelope; upstream 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"查询集成报表目录","x-capability-group":"configuration.read","x-fixed-hotel-query":"hotel","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and upstream REPCFG access","Use actual report identity and parameter/option codes from the target environment; no inferred ARR execution contract"],"retry":"Bounded read retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"REPCFG","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/repcfg.json"}},"/api/v1/reports/groups":{"get":{"description":" \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetAllReportGroups\u003c/p\u003e Read-only report metadata/options; does not execute, schedule or download a report. Edge supplies the configured hotel in the header and any hotel path/query field. Original JSON is preserved without pagination; upstream 204 becomes 200 with data {}.","operationId":"getAllReportGroups","parameters":[{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","in":"query","name":"id","required":false,"schema":{"type":"string"}},{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","in":"query","name":"idContext","required":false,"schema":{"type":"string"}},{"description":"A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).","in":"query","name":"type","required":false,"schema":{"type":"string"}},{"description":"Used for Character Strings, length 0 to 20.","in":"query","name":"moduleName","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/report_repcfg_retrievedReportGroups"}},"type":"object"}]}}},"description":"Oracle JSON in the edge envelope; upstream 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"查询报表分组","x-capability-group":"configuration.read","x-fixed-hotel-query":"HotelId","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and upstream REPCFG access","Use actual report identity and parameter/option codes from the target environment; no inferred ARR execution contract"],"retry":"Bounded read retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"REPCFG","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/repcfg.json"}},"/api/v1/reports/lov/bank-accounts":{"get":{"description":"Use this API to return the list of values for bank accounts for reports for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetBankAccountsForReportsLOV\u003c/p\u003e Read-only report metadata/options; does not execute, schedule or download a report. Edge supplies the configured hotel in the header and any hotel path/query field. Original JSON is preserved without pagination; upstream 204 becomes 200 with data {}.","operationId":"getBankAccountsForReportsLOV","parameters":[{"description":"Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.","in":"query","name":"includeInactiveFlag","required":false,"schema":{"type":"boolean"}},{"description":"Name of the parameter.","explode":true,"in":"query","name":"parameterName","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Value of the parameter.","explode":true,"in":"query","name":"parameterValue","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"excludeCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/report_lov_listOfValues"}},"type":"object"}]}}},"description":"Oracle JSON in the edge envelope; upstream 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"报表银行账户选项","x-capability-group":"configuration.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and upstream LOV access","Use actual report identity and parameter/option codes from the target environment; no inferred ARR execution contract"],"retry":"Bounded read retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"LOV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/lov.json"}},"/api/v1/reports/lov/configuration/{moduleName}":{"get":{"description":"Use this API to return the list of values for configuration reports based on search criteria such as moduleName, includeInactiveFlag, parameterName, parameterValue. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetConfigReportsLOV\u003c/p\u003e Read-only report metadata/options; does not execute, schedule or download a report. Edge supplies the configured hotel in the header and any hotel path/query field. Original JSON is preserved without pagination; upstream 204 becomes 200 with data {}.","operationId":"getConfigReportsLOV","parameters":[{"description":"Value of the parameter 'moduleName' which is required to fetch ConfigReports LOV","in":"path","name":"moduleName","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.","in":"query","name":"includeInactiveFlag","required":false,"schema":{"type":"boolean"}},{"description":"Name of the parameter.","explode":true,"in":"query","name":"parameterName","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Value of the parameter.","explode":true,"in":"query","name":"parameterValue","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"excludeCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/report_lov_listOfValues"}},"type":"object"}]}}},"description":"Oracle JSON in the edge envelope; upstream 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"模块配置报表选项","x-capability-group":"configuration.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and upstream LOV access","Use actual report identity and parameter/option codes from the target environment; no inferred ARR execution contract"],"retry":"Bounded read retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"LOV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/lov.json"}},"/api/v1/reports/lov/confirmation-letters":{"get":{"description":"Use this API to return the list of values for confirmation letter reports for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetConfLetterReportsLOV\u003c/p\u003e Read-only report metadata/options; does not execute, schedule or download a report. Edge supplies the configured hotel in the header and any hotel path/query field. Original JSON is preserved without pagination; upstream 204 becomes 200 with data {}.","operationId":"getConfLetterReportsLOV","parameters":[{"description":"Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.","in":"query","name":"includeInactiveFlag","required":false,"schema":{"type":"boolean"}},{"description":"Name of the parameter.","explode":true,"in":"query","name":"parameterName","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Value of the parameter.","explode":true,"in":"query","name":"parameterValue","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"excludeCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/report_lov_listOfValues"}},"type":"object"}]}}},"description":"Oracle JSON in the edge envelope; upstream 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"确认函报表选项","x-capability-group":"configuration.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and upstream LOV access","Use actual report identity and parameter/option codes from the target environment; no inferred ARR execution contract"],"retry":"Bounded read retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"LOV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/lov.json"}},"/api/v1/reports/lov/end-of-day/{beforeIncomeAudit}":{"get":{"description":"Use this API to return the list of values for end of day reports for a specific property based on search criteria such as beforeIncomeAudit, hotelId, includeInactiveFlag, parameterName, parameterValue. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetEndOfDayReportsLOV\u003c/p\u003e Read-only report metadata/options; does not execute, schedule or download a report. Edge supplies the configured hotel in the header and any hotel path/query field. Original JSON is preserved without pagination; upstream 204 becomes 200 with data {}.","operationId":"getEndOfDayReportsLOV","parameters":[{"description":"Value of the parameter 'beforeIncomeAudit' which is required to fetch EndOfDayReports LOV","in":"path","name":"beforeIncomeAudit","required":true,"schema":{"enum":["Y","N"],"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.","in":"query","name":"includeInactiveFlag","required":false,"schema":{"type":"boolean"}},{"description":"Name of the parameter.","explode":true,"in":"query","name":"parameterName","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Value of the parameter.","explode":true,"in":"query","name":"parameterValue","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"excludeCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/report_lov_listOfValues"}},"type":"object"}]}}},"description":"Oracle JSON in the edge envelope; upstream 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"日结报表选项","x-capability-group":"configuration.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and upstream LOV access","Use actual report identity and parameter/option codes from the target environment; no inferred ARR execution contract"],"retry":"Bounded read retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"LOV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/lov.json"}},"/api/v1/reports/lov/generic":{"get":{"description":"Use this API to return the list of values for generic reports for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetGenericReportsLOV\u003c/p\u003e Read-only report metadata/options; does not execute, schedule or download a report. Edge supplies the configured hotel in the header and any hotel path/query field. Original JSON is preserved without pagination; upstream 204 becomes 200 with data {}.","operationId":"getGenericReportsLOV","parameters":[{"description":"Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.","in":"query","name":"includeInactiveFlag","required":false,"schema":{"type":"boolean"}},{"description":"Name of the parameter.","explode":true,"in":"query","name":"parameterName","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Value of the parameter.","explode":true,"in":"query","name":"parameterValue","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"excludeCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/report_lov_listOfValues"}},"type":"object"}]}}},"description":"Oracle JSON in the edge envelope; upstream 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"通用报表选项","x-capability-group":"configuration.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and upstream LOV access","Use actual report identity and parameter/option codes from the target environment; no inferred ARR execution contract"],"retry":"Bounded read retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"LOV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/lov.json"}},"/api/v1/reports/lov/groups/{groupName}/reports":{"get":{"description":"Use this API to return the list of values for rep group reports based on search criteria such as groupName, includeInactiveFlag, parameterName, parameterValue. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetRepGroupReportsLOV\u003c/p\u003e Read-only report metadata/options; does not execute, schedule or download a report. Edge supplies the configured hotel in the header and any hotel path/query field. Original JSON is preserved without pagination; upstream 204 becomes 200 with data {}.","operationId":"getRepGroupReportsLOV","parameters":[{"description":"Value of the parameter 'groupName' which is required to fetch RepGroupReports LOV","in":"path","name":"groupName","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.","in":"query","name":"includeInactiveFlag","required":false,"schema":{"type":"boolean"}},{"description":"Name of the parameter.","explode":true,"in":"query","name":"parameterName","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Value of the parameter.","explode":true,"in":"query","name":"parameterValue","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"excludeCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/report_lov_listOfValues"}},"type":"object"}]}}},"description":"Oracle JSON in the edge envelope; upstream 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"报表分组内的报表选项","x-capability-group":"configuration.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and upstream LOV access","Use actual report identity and parameter/option codes from the target environment; no inferred ARR execution contract"],"retry":"Bounded read retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"LOV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/lov.json"}},"/api/v1/reports/lov/manager-details":{"get":{"description":"Use this API to return the list of values for manager report details for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetManagerReportDetailsLOV\u003c/p\u003e Read-only report metadata/options; does not execute, schedule or download a report. Edge supplies the configured hotel in the header and any hotel path/query field. Original JSON is preserved without pagination; upstream 204 becomes 200 with data {}.","operationId":"getManagerReportDetailsLOV","parameters":[{"description":"Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.","in":"query","name":"includeInactiveFlag","required":false,"schema":{"type":"boolean"}},{"description":"Name of the parameter.","explode":true,"in":"query","name":"parameterName","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Value of the parameter.","explode":true,"in":"query","name":"parameterValue","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"excludeCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/report_lov_listOfValues"}},"type":"object"}]}}},"description":"Oracle JSON in the edge envelope; upstream 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"经理报表明细选项","x-capability-group":"configuration.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and upstream LOV access","Use actual report identity and parameter/option codes from the target environment; no inferred ARR execution contract"],"retry":"Bounded read retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"LOV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/lov.json"}},"/api/v1/reports/lov/managers":{"get":{"description":"Use this API to return the list of values for manager reports for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetManagersReportsLOV\u003c/p\u003e Read-only report metadata/options; does not execute, schedule or download a report. Edge supplies the configured hotel in the header and any hotel path/query field. Original JSON is preserved without pagination; upstream 204 becomes 200 with data {}.","operationId":"getManagersReportsLOV","parameters":[{"description":"Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.","in":"query","name":"includeInactiveFlag","required":false,"schema":{"type":"boolean"}},{"description":"Name of the parameter.","explode":true,"in":"query","name":"parameterName","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Value of the parameter.","explode":true,"in":"query","name":"parameterValue","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"excludeCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/report_lov_listOfValues"}},"type":"object"}]}}},"description":"Oracle JSON in the edge envelope; upstream 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"经理报表选项","x-capability-group":"configuration.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and upstream LOV access","Use actual report identity and parameter/option codes from the target environment; no inferred ARR execution contract"],"retry":"Bounded read retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"LOV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/lov.json"}},"/api/v1/reports/lov/modules/{moduleId}/parameters/{parameter}":{"get":{"description":"Use this API to return the list of values for generic reports based on search criteria such as parameter, moduleId, includeInactiveFlag, parameterName, parameterValue. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetReportsGenericLOV\u003c/p\u003e Read-only report metadata/options; does not execute, schedule or download a report. Edge supplies the configured hotel in the header and any hotel path/query field. Original JSON is preserved without pagination; upstream 204 becomes 200 with data {}.","operationId":"getReportsGenericLOV","parameters":[{"description":"Value of the parameter 'parameter' which is required to fetch ReportsGeneric LOV","in":"path","name":"parameter","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Value of the parameter 'moduleId' which is required to fetch ReportsGeneric LOV","in":"path","name":"moduleId","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.","in":"query","name":"includeInactiveFlag","required":false,"schema":{"type":"boolean"}},{"description":"Name of the parameter.","explode":true,"in":"query","name":"parameterName","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Value of the parameter.","explode":true,"in":"query","name":"parameterValue","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"excludeCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/report_lov_listOfValues"}},"type":"object"}]}}},"description":"Oracle JSON in the edge envelope; upstream 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"读取报表参数可选值","x-capability-group":"configuration.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and upstream LOV access","Use actual report identity and parameter/option codes from the target environment; no inferred ARR execution contract"],"retry":"Bounded read retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"LOV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/lov.json"}},"/api/v1/reports/lov/reservation-statistics/{beginDate}/{endDate}/rate-codes":{"get":{"description":"Use this API to return the list of values for report rate codes for a specific property based on search criteria such as endDate, beginDate, hotelId, includeInactiveFlag, parameterName, parameterValue. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetResStatReportRateCodeLOV\u003c/p\u003e Read-only report metadata/options; does not execute, schedule or download a report. Edge supplies the configured hotel in the header and any hotel path/query field. Original JSON is preserved without pagination; upstream 204 becomes 200 with data {}.","operationId":"getResStatReportRateCodeLOV","parameters":[{"description":"Value of the parameter 'endDate' which is required to fetch ResStatReportRateCode LOV","in":"path","name":"endDate","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Value of the parameter 'beginDate' which is required to fetch ResStatReportRateCode LOV","in":"path","name":"beginDate","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.","in":"query","name":"includeInactiveFlag","required":false,"schema":{"type":"boolean"}},{"description":"Name of the parameter.","explode":true,"in":"query","name":"parameterName","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Value of the parameter.","explode":true,"in":"query","name":"parameterValue","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"excludeCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/report_lov_listOfValues"}},"type":"object"}]}}},"description":"Oracle JSON in the edge envelope; upstream 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"预订统计报表价码选项","x-capability-group":"configuration.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and upstream LOV access","Use actual report identity and parameter/option codes from the target environment; no inferred ARR execution contract"],"retry":"Bounded read retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"LOV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/lov.json"}},"/api/v1/reports/lov/scheduled-exports":{"get":{"description":"Use this API to return the list of values for scheduled report exports for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetScheduledReportsExportLOV\u003c/p\u003e Read-only report metadata/options; does not execute, schedule or download a report. Edge supplies the configured hotel in the header and any hotel path/query field. Original JSON is preserved without pagination; upstream 204 becomes 200 with data {}.","operationId":"getScheduledReportsExportLOV","parameters":[{"description":"Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.","in":"query","name":"includeInactiveFlag","required":false,"schema":{"type":"boolean"}},{"description":"Name of the parameter.","explode":true,"in":"query","name":"parameterName","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Value of the parameter.","explode":true,"in":"query","name":"parameterValue","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"excludeCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/report_lov_listOfValues"}},"type":"object"}]}}},"description":"Oracle JSON in the edge envelope; upstream 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"计划报表导出选项（不执行导出）","x-capability-group":"configuration.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and upstream LOV access","Use actual report identity and parameter/option codes from the target environment; no inferred ARR execution contract"],"retry":"Bounded read retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"LOV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/lov.json"}},"/api/v1/reports/lov/shift-groups/{shiftGroupId}/without-parameters":{"get":{"description":"Use this API to return the list of values for shift reports no parameter based on search criteria such as shiftGroupId, includeInactiveFlag, parameterName, parameterValue. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetShiftReportsNoParamLOV\u003c/p\u003e Read-only report metadata/options; does not execute, schedule or download a report. Edge supplies the configured hotel in the header and any hotel path/query field. Original JSON is preserved without pagination; upstream 204 becomes 200 with data {}.","operationId":"getShiftReportsNoParamLOV","parameters":[{"description":"Value of the parameter 'shiftGroupId' which is required to fetch ShiftReportsNoParam LOV","in":"path","name":"shiftGroupId","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.","in":"query","name":"includeInactiveFlag","required":false,"schema":{"type":"boolean"}},{"description":"Name of the parameter.","explode":true,"in":"query","name":"parameterName","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Value of the parameter.","explode":true,"in":"query","name":"parameterValue","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"excludeCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/report_lov_listOfValues"}},"type":"object"}]}}},"description":"Oracle JSON in the edge envelope; upstream 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"无需参数的班次报表选项","x-capability-group":"configuration.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and upstream LOV access","Use actual report identity and parameter/option codes from the target environment; no inferred ARR execution contract"],"retry":"Bounded read retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"LOV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/lov.json"}},"/api/v1/reports/lov/shifts":{"get":{"description":"Use this API to return the list of values for shift reports for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetShiftReportsLOV\u003c/p\u003e Read-only report metadata/options; does not execute, schedule or download a report. Edge supplies the configured hotel in the header and any hotel path/query field. Original JSON is preserved without pagination; upstream 204 becomes 200 with data {}.","operationId":"getShiftReportsLOV","parameters":[{"description":"Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.","in":"query","name":"includeInactiveFlag","required":false,"schema":{"type":"boolean"}},{"description":"Name of the parameter.","explode":true,"in":"query","name":"parameterName","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Value of the parameter.","explode":true,"in":"query","name":"parameterValue","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"excludeCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/report_lov_listOfValues"}},"type":"object"}]}}},"description":"Oracle JSON in the edge envelope; upstream 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"班次报表选项","x-capability-group":"configuration.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and upstream LOV access","Use actual report identity and parameter/option codes from the target environment; no inferred ARR execution contract"],"retry":"Bounded read retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"LOV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/lov.json"}},"/api/v1/reports/parameters":{"get":{"description":"Use this API to return report parameters based on search criteria such as id, idContext, type. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetReportParameters\u003c/p\u003e Read-only report metadata/options; does not execute, schedule or download a report. Edge supplies the configured hotel in the header and any hotel path/query field. Original JSON is preserved without pagination; upstream 204 becomes 200 with data {}.","operationId":"getReportParameters","parameters":[{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","in":"query","name":"id","required":false,"schema":{"maxLength":80,"minLength":0,"type":"string"}},{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","in":"query","name":"idContext","required":false,"schema":{"maxLength":80,"minLength":0,"type":"string"}},{"description":"A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).","in":"query","name":"type","required":false,"schema":{"maxLength":80,"minLength":0,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/report_repcfg_reportParameters"}},"type":"object"}]}}},"description":"Oracle JSON in the edge envelope; upstream 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"读取报表参数定义","x-capability-group":"configuration.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and upstream REPCFG access","Use actual report identity and parameter/option codes from the target environment; no inferred ARR execution contract"],"retry":"Bounded read retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"REPCFG","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/repcfg.json"}},"/api/v1/reports/service-status":{"get":{"description":" \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003epingReportsConfigServiceStatus\u003c/p\u003e Read-only report metadata/options; does not execute, schedule or download a report. Edge supplies the configured hotel in the header and any hotel path/query field. Original JSON is preserved without pagination; upstream 204 becomes 200 with data {}.","operationId":"pingReportsConfigServiceStatus","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/report_repcfg_operaVersion"}},"type":"object"}]}}},"description":"Oracle JSON in the edge envelope; upstream 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"查询报表配置服务状态","x-capability-group":"configuration.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved configuration.read capability and upstream REPCFG access","Use actual report identity and parameter/option codes from the target environment; no inferred ARR execution contract"],"retry":"Bounded read retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"REPCFG","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/repcfg.json"}},"/api/v1/reservation-daily-summary-jobs":{"post":{"description":"Requires configured OHIP_EXTERNAL_SYSTEM_CODE; the service does not retry this job start automatically.","operationId":"startReservationsDailySummaryProcess","requestBody":{"$ref":"#/components/requestBodies/RequiredOracleDocument"},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAccepted"}}},"description":"Oracle accepted the asynchronous retrieval job.","headers":{"Cache-Control":{"schema":{"const":"no-store","type":"string"}}}},"default":{"$ref":"#/components/responses/Error"}},"summary":"Start a Reservation Daily Summary retrieval job","x-capability-group":"reservations.async","x-integration":{"pattern":"async-read","prerequisites":["Approved retrieval parameters","Retain process ID","Server-configured External System Code"],"retry":"Do not blindly retry a timed-out start. Retain job ID; poll status respecting Retry-After, then fetch result."},"x-oracle-api":"RSVASYNC"}},"/api/v1/reservation-daily-summary-jobs/{jobID}":{"get":{"operationId":"getReservationsDailySummary","parameters":[{"$ref":"#/components/parameters/JobID"}],"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"}},"summary":"Get Reservation Daily Summary results","x-capability-group":"reservations.async","x-integration":{"pattern":"async-read","prerequisites":["Approved retrieval parameters","Retain process ID","Server-configured External System Code"],"retry":"Do not blindly retry a timed-out start. Retain job ID; poll status respecting Retry-After, then fetch result."},"x-oracle-api":"RSVASYNC"}},"/api/v1/reservation-daily-summary-jobs/{jobID}/status":{"get":{"operationId":"getReservationsProcessStatus","parameters":[{"$ref":"#/components/parameters/JobID"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobStatus"}}},"description":"Current Oracle process status.","headers":{"Cache-Control":{"schema":{"const":"no-store","type":"string"}},"Retry-After":{"description":"Seconds from Oracle Cache-Control max-age before polling again, when supplied.","schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/Error"}},"summary":"Check Reservation Daily Summary process status","x-capability-group":"reservations.async","x-integration":{"pattern":"async-read","prerequisites":["Approved retrieval parameters","Retain process ID","Server-configured External System Code"],"retry":"Do not blindly retry a timed-out start. Retain job ID; poll status respecting Retry-After, then fetch result."},"x-oracle-api":"RSVASYNC"}},"/api/v1/reservations":{"get":{"deprecated":true,"description":"This API will allow a user to retrieve a list of reservations based on the search criteria specified in the request body. For example you can search for reservations using query parameters like first name, last name, arrival/departure date, external confirmation number. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetHotelReservations\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}. Unsupported input fields: recentlyAccessed.","operationId":"getHotelReservations","parameters":[{"description":"keyTrack2 is an id which is either generated by the PMS or provided by the door lock system and which is associated to the reservation. With the keyTrack2 value a reservation can be identified.","in":"query","name":"keyTrack2","required":false,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"in":"query","name":"discrepancy","required":false,"schema":{"enum":["Skip","Sleep"],"type":"string","uniqueItems":true}},{"description":"Indicates maximum number of records a Web Service should return.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.","in":"query","name":"offset","required":false,"schema":{"default":0,"type":"integer"}},{"description":"Represents Reservation search type Player Snapshot.","in":"query","name":"searchType","required":false,"schema":{"enum":["Any","DayUse","Arrival","Arrived","Departure","WaitList","Cancellation","CheckedOut","NoShow","Complimentary","InHouse","PostStayPendingBalance","PreRegistered","PostToRoom","OpenFolio","ScheduledCheckOut","Queued","MobileCheckout","RegisteredAndInHouse","ResvBlockTraces","GuestMessages","MassCancellation","Operator","Turndown","WalkIn","AdvanceCheckedIn","OpenBalance","AutoFolioSettlement","Routing","PlayerSnapshot","FiscalInfo","CorrectionPostings","Vouchers","ScheduledRoomMoves","PayByLinks"],"type":"string","uniqueItems":true}},{"description":"Free form text field for searching all reservation fields","in":"query","name":"text","required":false,"schema":{"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"reservationIdList","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"confirmationNumberList","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"cancellationNumberList","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"externalReferenceIds","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","explode":true,"in":"query","name":"externalSystemCodes","required":false,"schema":{"default":["External"],"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"External reference leg number","in":"query","name":"externalReferenceLegId","required":false,"schema":{"type":"number"}},{"description":"The ending value of the date range.","in":"query","name":"arrivalEndDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"The starting value of the date range.","in":"query","name":"arrivalStartDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"The ending value of the date range.","in":"query","name":"departureEndDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"The starting value of the date range.","in":"query","name":"departureStartDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"The starting value of the date range.","in":"query","name":"stayOnStartDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"Fetches reservations which are created on the given property business date.","in":"query","name":"createdOnStartDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"The ending value of the time span. Uses the hotel's time zone.","in":"query","name":"expectedArrivalEndTime","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"The starting value of the time span. Uses the hotel's time zone.","in":"query","name":"expectedArrivalStartTime","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"The ending value of the date range.","in":"query","name":"depositDueEndDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"The starting value of the date range.","in":"query","name":"depositDueStartDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"The ending value of the time span. Uses the hotel's time zone.","in":"query","name":"expectedReturnEndTime","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"The starting value of the time span. Uses the hotel's time zone.","in":"query","name":"expectedReturnStartTime","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Attached profile name","explode":true,"in":"query","name":"companyNames","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Attached profile name","explode":true,"in":"query","name":"sourceNames","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Attached profile name","explode":true,"in":"query","name":"travelAgentNames","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Attached profile name","explode":true,"in":"query","name":"groupNames","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. API expects CompanyName Query parameter along with the ID to obtain correct results.","explode":true,"in":"query","name":"travelAgentIds","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. API expects CompanyName Query parameter along with the ID to obtain correct results.","explode":true,"in":"query","name":"companyIds","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. API expects CompanyName Query parameter along with the ID to obtain correct results.","explode":true,"in":"query","name":"sourceIds","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. API expects CompanyName Query parameter along with the ID to obtain correct results.","explode":true,"in":"query","name":"contactIds","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. API expects CompanyName Query parameter along with the ID to obtain correct results.","explode":true,"in":"query","name":"groupIds","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. API expects CompanyName Query parameter along with the ID to obtain correct results.","explode":true,"in":"query","name":"billingContactIds","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Unique Identifier for a guest profile associated with the reservation(s)","in":"query","name":"profileId","required":false,"schema":{"type":"string"}},{"description":"Commission Paid criteria","in":"query","name":"commissionPaid","required":false,"schema":{"type":"boolean"}},{"description":"All reservations with generated vouchers to be returned if vouchersGenerated is set to true. All reservations without the generated vouchers to be returned if it is set to false.","in":"query","name":"vouchersGenerated","required":false,"schema":{"type":"boolean"}},{"description":"Membership ID criteria.","in":"query","name":"membershipCardNumber","required":false,"schema":{"type":"string"}},{"explode":true,"in":"query","name":"membershipLevels","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"membershipTypes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"When set to true, only reservations with a membership belonging to the specified membership type will be returned","in":"query","name":"reservationsWithMembershipType","required":false,"schema":{"type":"boolean"}},{"description":"Family name, last name.","in":"query","name":"surname","required":false,"schema":{"type":"string"}},{"description":"Given name, first name or names","in":"query","name":"givenName","required":false,"schema":{"type":"string"}},{"description":"Given name, first name or names","in":"query","name":"fromName","required":false,"schema":{"type":"string"}},{"description":"Given name, first name or names","in":"query","name":"toName","required":false,"schema":{"type":"string"}},{"description":"VIP status of the customer.","in":"query","name":"anyVIPStatus","required":false,"schema":{"type":"boolean"}},{"description":"VIP status of the customer.","explode":true,"in":"query","name":"vipCodes","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Fetches the reservation having Guarantee Code(Reservation Type) supplied here.","in":"query","name":"guaranteeCode","required":false,"schema":{"type":"string"}},{"description":"Fetches the reservation having method of payment supplied here.","in":"query","name":"paymentMethod","required":false,"schema":{"type":"string"}},{"description":"Fetches the reservation for which discount is applied","in":"query","name":"discountApplied","required":false,"schema":{"default":false,"type":"boolean"}},{"explode":true,"in":"query","name":"user","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"Fetches reservation created by specified user. If both CreatedByUsers and CreatedBy is specified, CreatedByUsers will take precedence.","in":"query","name":"createdBy","required":false,"schema":{"type":"string"}},{"description":"Fetches reservations cancelled by list of users.","explode":true,"in":"query","name":"cancelledByList","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"Fetches reservations which are cancelled on the given property business date.","in":"query","name":"cancelledOn","required":false,"schema":{"format":"date","type":"string"}},{"explode":true,"in":"query","name":"ratePlanCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"sourceCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"marketCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"If true the search result will exclude the blocks reservations.","in":"query","name":"excludeBlockReservations","required":false,"schema":{"type":"boolean"}},{"description":"The Hotel Code of the Block.","in":"query","name":"blockCriteriaHotelCode","required":false,"schema":{"type":"string"}},{"description":"The Name of the block that is attached to the reservation.","in":"query","name":"blockName","required":false,"schema":{"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"blockIds","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"blockCodes","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Custom reference","in":"query","name":"customReference","required":false,"schema":{"type":"string"}},{"description":"GDS Record Locator for reservation.","in":"query","name":"recordLocator","required":false,"schema":{"type":"string"}},{"explode":true,"in":"query","name":"orderBy","required":false,"schema":{"items":{"enum":["Nights","ArrivalDate","ArrivalDateETR","DepartureDate","GuestSurname","RateAmount","RateCode","Room","RoomType","QueuePriority","QueueDurationTime","ConfirmationNo"],"type":"string"},"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"sortOrder","required":false,"schema":{"default":["Asc"],"items":{"enum":["Asc","Desc"],"type":"string"},"type":"array","uniqueItems":true},"style":"form"},{"description":"Indicator to query reservations which have a room number assigned.","in":"query","name":"roomAssignedOnly","required":false,"schema":{"type":"boolean"}},{"description":"Indicator to query reservations which does not have a room number assigned.","in":"query","name":"roomUnassignedOnly","required":false,"schema":{"type":"boolean"}},{"description":"Room number of the reservation to search by.","in":"query","name":"roomId","required":false,"schema":{"type":"string"}},{"description":"Room Type.","explode":false,"in":"query","name":"roomType","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"A code representing a room feature.","explode":true,"in":"query","name":"roomFeatures","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Preference value for display purposes.","explode":true,"in":"query","name":"roomSpecials","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Preference value for display purposes.","in":"query","name":"roomSmokingPreference","required":false,"schema":{"type":"string"}},{"description":"Preference value for display purposes.","explode":true,"in":"query","name":"roomFloorPreferences","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.","explode":true,"in":"query","name":"housekeepingRoomStatuses","required":false,"schema":{"items":{"enum":["Clean","Dirty","Pickup","Inspected","OutOfOrder","OutOfService"],"type":"string"},"type":"array","uniqueItems":true},"style":"form"},{"explode":true,"in":"query","name":"roomClasses","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"in":"query","name":"roomRangeFrom","required":false,"schema":{"type":"string"}},{"in":"query","name":"roomRangeTo","required":false,"schema":{"type":"string"}},{"description":"Any communication attached to the reservation from the primary guest's profile such as phone, fax or email address.","in":"query","name":"communication","required":false,"schema":{"type":"string"}},{"description":"The phone number attached to the reservation from the primary guest's profile.","in":"query","name":"phone","required":false,"schema":{"type":"string"}},{"description":"The email address attached to the reservation from the primary guest's profile.","in":"query","name":"email","required":false,"schema":{"type":"string"}},{"description":"Define the external system(s) to return external reference ids for associated profiles for the reservation. A maximum of 10 different external systems can be be provided for this parameter.","explode":true,"in":"query","name":"profileExternalReferencesToFetch","required":false,"schema":{"items":{"type":"string"},"maxItems":10,"type":"array"},"style":"form"},{"description":"Define the external system(s) to return external reference ids for reservations. A maximum of 10 different external systems can be be provided for this parameter.","explode":true,"in":"query","name":"resvExternalReferencesToFetch","required":false,"schema":{"items":{"type":"string"},"maxItems":10,"type":"array"},"style":"form"},{"description":"Instruction on which elements of the reservation are to be fetched. Instructions are cumulative i.e. additional elements would be added, but not duplicated.","explode":true,"in":"query","name":"fetchInstructions","required":false,"schema":{"items":{"enum":["Reservation","ReservationID","Indicators","Deposits","RevenuesAndBalances","GuestServiceStatus","MasterInfo","CancellationInfo","BlockReservations","TaxType","GuestDeviceNotification","RoomAssignedByAI","SwapShiftRooms","ReservationPreferences","FiscalInfo","CommissionsInfo","DepartureReservationInfo","Vouchers","MultipleMemberships","FetchChildAges","OffshoreRates","PostingIntervals","PreArrivals"],"type":"string"},"type":"array","uniqueItems":true},"style":"form"},{"description":"Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.","explode":true,"in":"query","name":"allowedReservationActions","required":false,"schema":{"items":{"enum":["Cancel","Move","PreCharge","PostCharge","FacilitySchedule","Upsell","PreCheckIn","PostToNoShowCancel","NoShow","NameChange","Discount","HouseKeeping","EnrollToPrimaryMembership","EnrollInProgress","MemberAwardAttached"],"type":"string"},"type":"array","uniqueItems":true},"style":"form"},{"description":"Flag containing true or false value for reservation to be eligible for prior check in by guest using mobile device. Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile check in yes / no. Upon fetch, the current state of the flag will show true or false.","in":"query","name":"allowPreRegistration","required":false,"schema":{"type":"boolean"}},{"description":"Indicates that reservations with No Post flag should not be expected from the result.","in":"query","name":"excludeNoPost","required":false,"schema":{"type":"boolean"}},{"description":"Indicates that reservations with PM room type should not be expected from the result.","in":"query","name":"excludePMRooms","required":false,"schema":{"type":"boolean"}},{"description":"Indicates that only reservations with deposit balance should be expected from the result.","in":"query","name":"hasDepositBalance","required":false,"schema":{"type":"boolean"}},{"description":"Indicates that only reservations with open balance should be expected from the result.","in":"query","name":"hasOpenBalance","required":false,"schema":{"type":"boolean"}},{"description":"Indicates that only reservations with open folio should be expected from the result.","in":"query","name":"hasOpenFolio","required":false,"schema":{"type":"boolean"}},{"description":"Criteria that indicates whether to scheduled checkouts or not.","in":"query","name":"includeScheduledCheckOut","required":false,"schema":{"type":"boolean"}},{"description":"Indicates that only linked reservations should be expected from the result.","in":"query","name":"linkedOnly","required":false,"schema":{"type":"boolean"}},{"description":"Indicates that only unlinked reservations should be expected from the result.","in":"query","name":"unlinkedOnly","required":false,"schema":{"type":"boolean"}},{"description":"Indicates if reservations which have already arrived on the Search Date is required.","in":"query","name":"actualArrivals","required":false,"schema":{"type":"boolean"}},{"description":"Indicates if reservations which were expected to depart on the Search Date and have already checked, is required.","in":"query","name":"actualDepartures","required":false,"schema":{"type":"boolean"}},{"description":"Indicates if reservations where rate codes are marked as Complimentary Rates , is required. This flag should be used in conjunction with the Arrivals, Departures or StayOvers criteria.","in":"query","name":"complimentaryReservations","required":false,"schema":{"type":"boolean"}},{"description":"Indicates if reservations which have cancelled on the Search Date which is also the day of arrival is required.","in":"query","name":"dayOfArrivalCancels","required":false,"schema":{"type":"boolean"}},{"description":"Indicates if reservations which are day use reservation on the Search Date, is required.","in":"query","name":"dayUse","required":false,"schema":{"type":"boolean"}},{"description":"Indicates if reservations which checked out early on the Search Date, is required.","in":"query","name":"earlyDepartures","required":false,"schema":{"type":"boolean"}},{"description":"Indicates if reservations which are expected arrivals for the Search Date and who have not yet arrived, is required.","in":"query","name":"expectedArrivals","required":false,"schema":{"type":"boolean"}},{"description":"Indicates if reservations which are expected departures for the Search Date and who have not yet departed, is required.","in":"query","name":"expectedDepartures","required":false,"schema":{"type":"boolean"}},{"description":"Indicates if reservations which have extended their stays on the Search Date, is required.","in":"query","name":"extendedStays","required":false,"schema":{"type":"boolean"}},{"description":"Indicates if reservations where rate codes are marked as House Use Rates , is required. This flag should be used in conjunction with the Arrivals, Departures or StayOvers criteria.","in":"query","name":"houseUseReservations","required":false,"schema":{"type":"boolean"}},{"description":"Indicates if reservations which are StayOvers on the Search Date, is required.","in":"query","name":"stayovers","required":false,"schema":{"type":"boolean"}},{"description":"Date for searching the reservations. This is the date for which the search types are applicable. If date is not available, the business date will be used by default.","in":"query","name":"stayDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","in":"query","name":"roomRoutingId","required":false,"schema":{"type":"string"}},{"description":"Periodic folio type.","in":"query","name":"periodicFolio","required":false,"schema":{"enum":["Weekly","Monthly","Days"],"type":"string","uniqueItems":true}},{"description":"Comma-delimited list of Folio Settlement Type codes.","in":"query","name":"folioSettlementTypes","required":false,"schema":{"type":"string"}},{"description":"Use the Number of Days For Settlement, defined for the Reservation.","in":"query","name":"defaultDays","required":false,"schema":{"type":"boolean"}},{"description":"Use the Number of days since last auto settled.","in":"query","name":"daysSinceLastAutoSettled","required":false,"schema":{"type":"number"}},{"description":"Use the Date since last auto settled.","in":"query","name":"dateSinceLastAutoSettled","required":false,"schema":{"format":"date","type":"string"}},{"description":"Indicates to exclude Pseudo room reservations.","in":"query","name":"excludePseudoRoomReservations","required":false,"schema":{"type":"boolean"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"excludeReservationIds","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"VIP status of the customer.","explode":true,"in":"query","name":"excludeVIPStatusCodes","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Preference value for display purposes.","explode":true,"in":"query","name":"excludeSpecials","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Preference value for display purposes.","explode":true,"in":"query","name":"excludeFloorPreferences","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Indicates to exclude Advance Checked In Reservations from search result.","in":"query","name":"excludeAdvanceCheckedIn","required":false,"schema":{"type":"boolean"}},{"description":"Exclude the reservation(s) with provided room features from the search result.","explode":true,"in":"query","name":"excludeRoomFeatures","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Player ID associated to the reservation.","in":"query","name":"playerId","required":false,"schema":{"type":"string"}},{"description":"Balance from.","in":"query","name":"gamingBalanceFrom","required":false,"schema":{"type":"number"}},{"description":"Balance to.","in":"query","name":"gamingBalanceTo","required":false,"schema":{"type":"number"}},{"description":"Comp Balance From","in":"query","name":"compAccountingBalanceFrom","required":false,"schema":{"type":"number"}},{"description":"Comp Balance To","in":"query","name":"compAccountingBalanceTo","required":false,"schema":{"type":"number"}},{"description":"Represents Reservation search type Player Snapshot.","explode":true,"in":"query","name":"searchTypes","required":false,"schema":{"items":{"enum":["Any","DayUse","Arrival","Arrived","Departure","WaitList","Cancellation","CheckedOut","NoShow","Complimentary","InHouse","PostStayPendingBalance","PreRegistered","PostToRoom","OpenFolio","ScheduledCheckOut","Queued","MobileCheckout","RegisteredAndInHouse","ResvBlockTraces","GuestMessages","MassCancellation","Operator","Turndown","WalkIn","AdvanceCheckedIn","OpenBalance","AutoFolioSettlement","Routing","PlayerSnapshot","IncludeDetachedGuest"],"type":"string"},"type":"array","uniqueItems":true},"style":"form"},{"description":"Reservation status type for reservations search.","explode":true,"in":"query","name":"reservationStatuses","required":false,"schema":{"items":{"enum":["Cancelled","CheckedOut","CheckedIn","DueIn","DueOut","InHouse","NoShow","WaitList"],"type":"string"},"type":"array","uniqueItems":true},"style":"form"},{"description":"Codes to be searched.","explode":true,"in":"query","name":"transportationCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"Enum to denote the Status of Readiness messages sent to Guest Devices.","explode":true,"in":"query","name":"roomReadyStatuses","required":false,"schema":{"items":{"enum":["Pending","Completed","Failed","Sent","Received","Cancelled","PendingAvailability"],"type":"string"},"type":"array","uniqueItems":true},"style":"form"},{"description":"Fetches the reservations for which Checkout Message is received.","in":"query","name":"checkoutMessageReceived","required":false,"schema":{"type":"boolean"}},{"description":"Fetches the reservations for which reservation communication has been opted.","in":"query","name":"optedForCommunication","required":false,"schema":{"type":"boolean"}},{"description":"Fetches the reservations for which this reservation room can be shifted or swapped.","in":"query","name":"swapShiftRoomReservationId","required":false,"schema":{"type":"string"}},{"description":"The smoking preferences of rooms to be fetched.","explode":true,"in":"query","name":"roomSmokingPreferences","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"The room features of the rooms. Fetches reservations with rooms that have same room features. It has to be used in conjunction with roomType, arrivalStartDate, and arrivalEndDate.","explode":true,"in":"query","name":"roomFeaturePreferences","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"The floor of the rooms. Fetches reservations with rooms that are on the same floor. It has to be used in conjunction with roomType, arrivalStartDate, and arrivalEndDate.","explode":true,"in":"query","name":"roomsFloorPreferences","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Name of Contact Profile associated with Reservation.","explode":true,"in":"query","name":"contactNames","required":false,"schema":{"items":{"maxLength":82,"minLength":0,"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"Travel Agent Record Locators List.","explode":true,"in":"query","name":"taRecordLocatorList","required":false,"schema":{"items":{"type":"string"},"maxItems":30,"type":"array"},"style":"form"},{"description":"Package Codes and Package Groups to be searched, can only be used when searching for reservations at a single property with a maximum date range of 90 days. It is required to populate either Arrival From/To, Departure From/To, or the Stay Date filter(s).","explode":true,"in":"query","name":"packageCodes","required":false,"schema":{"items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":100,"type":"array"},"style":"form"},{"description":"Inventory Items to be searched, can only be used when searching for reservations at a single property with a maximum date range of 90 days. It is required to populate either Arrival From/To, Departure From/To, or the Stay Date filter(s)","explode":true,"in":"query","name":"inventoryItems","required":false,"schema":{"items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":100,"type":"array"},"style":"form"},{"description":"Fetches the reservation having Guarantee Codes(Reservation Type) supplied here. Example guaranteeCodes=6PM","explode":true,"in":"query","name":"guaranteeCodes","required":false,"schema":{"items":{"maxLength":20,"minLength":0,"type":"string"},"maxItems":100,"type":"array"},"style":"form"},{"description":"Name of the group of Linked Reservations to be searched.","in":"query","name":"linkedName","required":false,"schema":{"maxLength":50,"minLength":0,"type":"string"}},{"description":"Indicates that only reservations marked as Back to Back should be expected in the result.","in":"query","name":"backToBackOnly","required":false,"schema":{"type":"boolean"}},{"description":"Fetches linked Back to Back reservations with the specified Back to Back Date. Fetched reservations will be marked as Back to Back and they will either depart or arrive on the specified Back to Back day.","in":"query","name":"backToBackDateOn","required":false,"schema":{"format":"date","type":"string"}},{"description":"Scheduled Move Rooms Date Criteria. This will parameter be mandatory when search Type is ScheduledRoomMove.","in":"query","name":"scheduledRoomMoveDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"Start of Scheduled Move Room Time Range Criteria (in 24 hour time format). Applicable when Search Type is ScheduledRoomMove. Uses the hotel's time zone.","in":"query","name":"scheduledRoomMoveStartTime","required":false,"schema":{"maxLength":8,"minLength":0,"pattern":"([0-1]?[0-9]|2[0-3]):[0-5][0-9]","type":"string"}},{"description":"End of Scheduled Move Room Time Range Criteria (in 24 hour time format). Applicable when Search Type is ScheduledRoomMove. Uses the hotel's time zone.","in":"query","name":"scheduledRoomMoveEndTime","required":false,"schema":{"maxLength":8,"minLength":0,"pattern":"([0-1]?[0-9]|2[0-3]):[0-5][0-9]","type":"string"}},{"description":"Scheduled Move Room Status Criteria.","in":"query","name":"scheduledRoomMoveStatus","required":false,"schema":{"enum":["Completed","Pending"],"type":"string","uniqueItems":true}},{"description":"When this flag is set to true, it will exclude the linked reservations which are marked as Back to Back in the result. Marking reservations as Back to Back is available when the Back to Back Handling for Linked Reservations OPERA control is active.","in":"query","name":"excludeBackToBackReservations","required":false,"schema":{"type":"boolean"}},{"description":"This indicates who initiated the Check In/Advance Check In.Advance Check In functionality is available when the Advance Check In OPERA Control is active.","in":"query","name":"checkInInitiatedBy","required":false,"schema":{"type":"string"}},{"description":"Search by User Defined Character Field. Available to be used when searchType = Arrival, Arrived, InHouse, Departure or CheckedOut. Format for searching by User Defined Character field is UDFCXX:\u003cSEARCH CRITERIA\u003e. For example to search for reservations with the value 'Test123' in UDFC01 field use the value UDFC01:Test123","explode":false,"in":"query","name":"flexChar","required":false,"schema":{"items":{"type":"string"},"type":"array","uniqueItems":true},"style":"form"},{"description":"Search by User Defined Number Field. Available to be used when searchType = Arrival, Arrived, InHouse, Departure or CheckedOut. Format for searching by User Defined Number field is UDFNXX:\u003cSEARCH CRITERIA\u003e. For example to search for reservations with the value '123' in UDFN01 field use the value UDFN01:123","explode":false,"in":"query","name":"flexNum","required":false,"schema":{"items":{"type":"string"},"type":"array","uniqueItems":true},"style":"form"},{"description":"Search by User Defined Date Field. Available to be used when searchType = Arrival, Arrived, InHouse, Departure or CheckedOut. Format for searching by User Defined Date field is UDFDXX:\u003cYYYY-MM-DD\u003e. For example to search for reservations with a date of December 31, 2024 as a value in UDFD01 field use the value 'UDFD01:2024-12-31'.","explode":false,"in":"query","name":"flexDate","required":false,"schema":{"items":{"type":"string"},"type":"array","uniqueItems":true},"style":"form"},{"description":"Provide a package category code to return details for packages belonging to the specified category.","in":"query","name":"pkgCategoryToFetch","required":false,"schema":{"type":"string"}},{"description":"Forecasted package consumption date for which package details are to be returned. When used,  the details of packages with a forecasted consumption date equal to the specified date will be returned for each reservation. Required if pkgCategoryToFetch is used.","in":"query","name":"pkgForecastedConsumptionDateToFetch","required":false,"schema":{"format":"date","type":"string"}},{"description":"Itinerary leg number filter; must be used with ConfirmationNumberList.","in":"query","name":"itineraryLeg","required":false,"schema":{"type":"integer"}},{"description":"Fetch only reservations that are pre-registered.","in":"query","name":"preRegisteredOnly","required":false,"schema":{"type":"boolean"}},{"description":"When set to true, the search will include results that are similar matches based on fields such as surname, givenName, and email. All other specified search criteria will still be applied to the similar results. Set to false to restrict results to only exact matches.","in":"query","name":"similaritySearch","required":false,"schema":{"type":"boolean"}},{"description":"Indicates whether to include Pre-Arrival Reservations that are currently in a Reviewed status.","in":"query","name":"includeReviewedPreArrivals","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_reservationsDetails"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get Reservations for a hotel","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"},"post":{"operationId":"postReservation","requestBody":{"$ref":"#/components/requestBodies/ConfirmedWrite"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Reservation creation verified by getReservation.","headers":{"Cache-Control":{"schema":{"const":"no-store","type":"string"}}}},"default":{"$ref":"#/components/responses/Error"}},"summary":"Create a hotel-confirmed reservation and read it back","x-capability-group":"reservations.write","x-integration":{"pattern":"confirmed-write","prerequisites":["Hotel-approved confirmation","Read-back reconciliation ownership"],"retry":"Reuse the original idempotency key. Reconcile unknown outcomes with read-back before retrying."},"x-oracle-api":"RSV"}},"/api/v1/reservations/activity-log":{"get":{"description":"Get the activity log for a reservation. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetReservationActivityLog\u003c/p\u003e \u003cp\u003eThis API allows a time span of \u003cstrong\u003e90\u003c/strong\u003e days.\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getReservationActivityLog","parameters":[{"description":"Indicates maximum number of records a Web Service should return.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.","in":"query","name":"offset","required":false,"schema":{"default":0,"type":"integer"}},{"description":"Name of the parameter.","explode":true,"in":"query","name":"parameterName","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Value of the parameter.","explode":true,"in":"query","name":"parameterValue","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"in":"query","name":"activityGroup","required":false,"schema":{"type":"string"}},{"in":"query","name":"activityType","required":false,"schema":{"type":"string"}},{"description":"Search from date for the user activity log.","in":"query","name":"fromDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"Search to date for the user activity log.","in":"query","name":"toDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"Search text for the user activity log.","in":"query","name":"searchText","required":false,"schema":{"type":"string"}},{"explode":true,"in":"query","name":"userByIdsUserId","required":false,"schema":{"items":{"type":"integer"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"userForIdsUserId","required":false,"schema":{"items":{"type":"integer"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_activityLog"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Fetch Reservation Activity Log","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/award-upgrades":{"get":{"description":"Get award upgrades for a specific property. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetAwardUpgrades\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getAwardUpgrades","parameters":[{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","in":"query","name":"profileId","required":false,"schema":{"type":"string"}},{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","in":"query","name":"idContext","required":false,"schema":{"type":"string"}},{"description":"A reference to the type of object defined by the UniqueID element.","in":"query","name":"profileIdType","required":false,"schema":{"type":"string"}},{"description":"The type of the membership.","in":"query","name":"membershipType","required":false,"schema":{"type":"string"}},{"description":"The card number associated with this membership.","in":"query","name":"membershipCardNo","required":false,"schema":{"type":"string"}},{"description":"Current membership points available for this guest.","in":"query","name":"membershipPoints","required":false,"schema":{"type":"integer"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"id","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"in":"query","name":"reservationTimeSpanStartDate","required":false,"schema":{"format":"date","type":"string"}},{"in":"query","name":"reservationTimeSpanEndDate","required":false,"schema":{"format":"date","type":"string"}},{"in":"query","name":"reservationTimeSpanDuration","required":false,"schema":{"type":"string"}},{"description":"The number of rooms.","in":"query","name":"numberOfRooms","required":false,"schema":{"type":"integer"}},{"description":"Room type associated with the reservation.","in":"query","name":"roomType","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_awardUpgrades"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get Award Upgrades","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/awards":{"get":{"description":"Get certificates and awards associated with the Reservation. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetAwards\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getAwards","parameters":[{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","in":"query","name":"reservationId","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_reservationAwards"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Fetch Awards","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/confirmation-letters":{"get":{"description":"Get a list of Reservations for which confirmation letters need to be sent. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetConfirmationLetters\u003c/p\u003e \u003cp\u003eThis API allows a time span of \u003cstrong\u003e90\u003c/strong\u003e days.\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getConfirmationLetters","parameters":[{"description":"If true then the fetch result will include the reservations that do not have a letter attached to them.","in":"query","name":"notAttached","required":false,"schema":{"type":"boolean"}},{"description":"If true then the result will include only the pending confirmation letters.","in":"query","name":"pending","required":false,"schema":{"type":"boolean"}},{"description":"If true then the result will include only the confirmation letters that have been sent to the guest.","in":"query","name":"sent","required":false,"schema":{"type":"boolean"}},{"description":"The ending value of the date range.","in":"query","name":"createdOnEndDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"The starting value of the date range.","in":"query","name":"createdOnStartDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"The ending value of the date range.","in":"query","name":"arrivalEndDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"The starting value of the date range.","in":"query","name":"arrivalStartDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"letterStyleId","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Name of the confirmation letter style.","explode":true,"in":"query","name":"letterStyle","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A reference to the type of object defined by the UniqueID element.","explode":true,"in":"query","name":"letterStyleIdType","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","in":"query","name":"reservationGuestId","required":false,"schema":{"type":"string"}},{"description":"A reference to the type of object defined by the UniqueID element.","in":"query","name":"reservationGuestIdType","required":false,"schema":{"type":"string"}},{"description":"Membership ID criteria.","in":"query","name":"membershipId","required":false,"schema":{"type":"string"}},{"explode":true,"in":"query","name":"membershipLevelCode","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"membershipTypeCode","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"Family name, last name.","in":"query","name":"surname","required":false,"schema":{"type":"string"}},{"description":"Given name, first name or names","in":"query","name":"givenName","required":false,"schema":{"type":"string"}},{"description":"This is the HotelCode of the Block.","in":"query","name":"blockHotelId","required":false,"schema":{"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"blockId","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A reference to the type of object defined by the UniqueID element.","explode":true,"in":"query","name":"blockIdType","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"The Name of the block that is attached to the reservation.","in":"query","name":"blockName","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_reservationConfirmationLetters"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Fetch Confirmation Letters","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/external-system-delivery-history":{"get":{"description":"Get external system delivery history. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetExternalSystemDeliveryHistory\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getExternalSystemDeliveryHistory","parameters":[{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","in":"query","name":"reservationId","required":false,"schema":{"type":"string"}},{"description":"A reference to the type of object defined by the UniqueID element.","in":"query","name":"reservationIdType","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_deliveryHistoryLog"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get External system delivery history","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/guest-messages":{"get":{"description":"Get guest messages which exist on a reservation. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetGuestMessages\u003c/p\u003e \u003cp\u003eThe maximum allowable limit for this API is \u003cstrong\u003e100\u003c/strong\u003e.\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getGuestMessages","parameters":[{"description":"Indicates maximum number of records a Web Service should return.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.","in":"query","name":"offset","required":false,"schema":{"default":0,"type":"integer"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","in":"query","name":"reservationId","required":false,"schema":{"type":"string"}},{"description":"Flag that specified if Delivered Guest Messages will also be retrieved.","in":"query","name":"retrieveDeliveredMessages","required":false,"schema":{"type":"boolean"}},{"description":"Room number attached to the reservation.","in":"query","name":"room","required":false,"schema":{"type":"string"}},{"description":"Lookup guest messages with this Travel agent name.","in":"query","name":"travelAgent","required":false,"schema":{"type":"string"}},{"description":"Lookup guest messages with the Company name.","in":"query","name":"company","required":false,"schema":{"type":"string"}},{"description":"Lookup guest messages with the Travel agent name.","in":"query","name":"group","required":false,"schema":{"type":"string"}},{"description":"Lookup guest messages with the Source name.","in":"query","name":"source","required":false,"schema":{"type":"string"}},{"description":"Represents Reservation search type Player Snapshot.","in":"query","name":"reservationStatus","required":false,"schema":{"enum":["Any","DayUse","Arrival","Arrived","Departure","WaitList","Cancellation","CheckedOut","NoShow","Complimentary","InHouse","PostStayPendingBalance","PreRegistered","PostToRoom","OpenFolio","ScheduledCheckOut","Queued","MobileCheckout","RegisteredAndInHouse","ResvBlockTraces","GuestMessages","MassCancellation","Operator","Turndown","WalkIn","AdvanceCheckedIn","OpenBalance","AutoFolioSettlement","Routing","PlayerSnapshot"],"type":"string","uniqueItems":true}},{"description":"Flag that specified if Undelivered Guest Messages will also be retrieved.","in":"query","name":"retrieveUndeliveredMessages","required":false,"schema":{"type":"boolean"}},{"description":"Flag that specified if Printed Guest Messages will also be retrieved.","in":"query","name":"retrievePrintedMessages","required":false,"schema":{"type":"boolean"}},{"description":"Flag that specified if Texted Guest Messages will also be retrieved.","in":"query","name":"retrieveTextedMessages","required":false,"schema":{"type":"boolean"}},{"description":"Lookup messages using Block name.","in":"query","name":"blockName","required":false,"schema":{"type":"string"}},{"description":"Lookup guest messages with the recipient name.","in":"query","name":"recipientName","required":false,"schema":{"type":"string"}},{"description":"Lookup guest messages using reservation confirmation no.","in":"query","name":"confirmationNo","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_guestMessages"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get guest messages","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/package-category":{"get":{"description":"Use this API to get reservations with package consumption for a specific date. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetReservationsByPackage\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getReservationsByPackage","parameters":[{"description":"Package Category of the package attached to the reservation. Reserved for future development.","explode":true,"in":"query","name":"packageCategory","required":false,"schema":{"items":{"maxItems":20,"type":"string"},"type":"array"},"style":"form"},{"description":"Package code of the package attached to the reservation","explode":true,"in":"query","name":"packageCode","required":false,"schema":{"items":{"maxItems":20,"type":"string"},"type":"array"},"style":"form"},{"description":"Forecasted package consumption date","in":"query","name":"date","required":true,"schema":{"format":"date","type":"string"}},{"description":"Indicated maximum number of reservations to be sent in the response","in":"query","name":"limit","required":false,"schema":{"default":30,"type":"integer"}},{"description":"Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.","in":"query","name":"offset","required":false,"schema":{"default":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_packageCategoryReservations"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get Reservations by pacakge and consumption date","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/pre-arrival-members":{"get":{"description":"Get preArrival Member Reservations. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetPreArrivalMemberReservations\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getPreArrivalMemberReservations","parameters":[{"description":"The ending value of the date range.","in":"query","name":"end","required":false,"schema":{"format":"date","type":"string"}},{"description":"The starting value of the date range.","in":"query","name":"start","required":false,"schema":{"format":"date","type":"string"}},{"description":"Membership Type.","in":"query","name":"membershipType","required":false,"schema":{"type":"string"}},{"description":"Type of the desired reservation external confirmation number.","in":"query","name":"externalReferenceType","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_preArrivalMemberReservationsDetails"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get preArrival Member Reservations","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/preconfigured-routing-instructions":{"get":{"deprecated":true,"description":"Get preConfigured Routing Instructions. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetPreConfiguredRoutingInstructions\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getPreConfiguredRoutingInstructions","parameters":[{"in":"query","name":"rateCode","required":false,"schema":{"type":"string"}},{"description":"Promotion Code for ComplimentaryRouting","explode":true,"in":"query","name":"promotionCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"Attached profile name","in":"query","name":"guestName","required":false,"schema":{"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"guestIds","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Attached profile name","in":"query","name":"companyName","required":false,"schema":{"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"companyIds","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Attached profile name","in":"query","name":"groupName","required":false,"schema":{"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"groupIds","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Attached profile name","in":"query","name":"travelAgentName","required":false,"schema":{"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"travelAgentIds","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Attached profile name","in":"query","name":"sourceName","required":false,"schema":{"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"sourceIds","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Attached profile name","in":"query","name":"contactName","required":false,"schema":{"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"contactIds","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Attached profile name","in":"query","name":"billingContactName","required":false,"schema":{"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"billingContactIds","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Attached profile name","in":"query","name":"addresseeName","required":false,"schema":{"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"addresseeIds","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"query","name":"reservationId","required":false,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_preConfiguredRoutingInstructions"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get pre-Configured Routing Instructions","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/preconfigured-routing-instructions/searches":{"post":{"description":"Get preConfigured Routing Instructions. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003esearchPreConfiguredRoutingInstructions\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"searchPreConfiguredRoutingInstructions","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rsv_read_searchPreConfiguredRoutingInstructionsRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_preConfiguredRoutingInstructions"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get pre-Configured Routing Instructions","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/rate-info":{"get":{"deprecated":true,"description":"Oracle GET /rsv/v1/hotels/{hotelId}/reservations/rateInfo. Read-only reservation rate lookup; Oracle limits the requested time span to 21 days and validates criteria and value types. Prefer searchRateInfo for new integrations; GET getRateInfo is deprecated upstream. Only the configured hotel is used. Oracle 204 becomes HTTP 200 with data: {}. Returned Oracle fields are provisional until customer UAT.","operationId":"getRateInfo","parameters":[{"description":"The code specifying a monetary unit. Use ISO 4217, three alpha code.","in":"query","name":"currencyCode","required":false,"schema":{"type":"string"}},{"description":"Flag to indicate if summary information is required.","in":"query","name":"summaryInfo","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"criteriaStartDate","required":false,"schema":{"format":"date","type":"string"}},{"in":"query","name":"criteriaEndDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"Defines the number of Adults.","in":"query","name":"adults","required":false,"schema":{"type":"integer"}},{"description":"Defines the number of Children.","in":"query","name":"children","required":false,"schema":{"type":"integer"}},{"description":"Age of a child in years.","explode":true,"in":"query","name":"childAge","required":false,"schema":{"items":{"type":"integer"},"type":"array"},"style":"form"},{"description":"Number of children classified under the first Age Qualifying Group(Child Bucket#1).","in":"query","name":"bucket1Count","required":false,"schema":{"type":"integer"}},{"description":"Number of children classified under the second Age Qualifying Group(Child Bucket#2).","in":"query","name":"bucket2Count","required":false,"schema":{"type":"integer"}},{"description":"Number of children classified under the third Age Qualifying Group(Child Bucket#3).","in":"query","name":"bucket3Count","required":false,"schema":{"type":"integer"}},{"description":"Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).","in":"query","name":"bucket4Count","required":false,"schema":{"type":"integer"}},{"description":"Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).","in":"query","name":"bucket5Count","required":false,"schema":{"type":"integer"}},{"description":"This field is only required when the criteria is meant for a detailed results. The date for the rate detail is needed.","in":"query","name":"detailDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","in":"query","name":"blockId","required":false,"schema":{"type":"string"}},{"description":"A reference to the type of object defined by the UniqueID element.","in":"query","name":"blockIdType","required":false,"schema":{"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","in":"query","name":"id","required":false,"schema":{"type":"string"}},{"description":"Additional identifying value assigned by the creating system.","in":"query","name":"idExtension","required":false,"schema":{"type":"integer"}},{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","in":"query","name":"idContext","required":false,"schema":{"type":"string"}},{"description":"A reference to the type of object defined by the UniqueID element.","in":"query","name":"type","required":false,"schema":{"type":"string"}},{"description":"Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.","in":"query","name":"ratePlanCode","required":false,"schema":{"type":"string"}},{"description":"The ending value of the date range.","explode":true,"in":"query","name":"effectiveRateEnd","required":false,"schema":{"items":{"format":"date","type":"string"},"type":"array"},"style":"form"},{"description":"The starting value of the date range.","explode":true,"in":"query","name":"effectiveRateStart","required":false,"schema":{"items":{"format":"date","type":"string"},"type":"array"},"style":"form"},{"description":"Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.","in":"query","name":"roomType","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rate_rsv_rateInfo"}},"type":"object"}]}}},"description":"Bounded Oracle rate information; data is an empty object when Oracle returns 204.","headers":{"Cache-Control":{"schema":{"const":"no-store","type":"string"}}}},"default":{"$ref":"#/components/responses/Error"}},"summary":"查询预订房价信息（Oracle 已弃用，优先使用 searchRateInfo）","x-capability-group":"reservations.read","x-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."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/rate-info/searches":{"post":{"description":"Oracle POST /rsv/v1/hotels/{hotelId}/reservations/rateInfo/searches. Read-only reservation rate lookup; Oracle limits the requested time span to 21 days and validates criteria and value types. Prefer searchRateInfo for new integrations; GET getRateInfo is deprecated upstream. Only the configured hotel is used. Oracle 204 becomes HTTP 200 with data: {}. Returned Oracle fields are provisional until customer UAT.","operationId":"searchRateInfo","requestBody":{"content":{"application/json":{"example":{"adults":2,"criteriaEndDate":"2026-10-03","criteriaStartDate":"2026-10-01","ratePlanCode":"BAR","roomType":"DLX","summaryInfo":true},"schema":{"$ref":"#/components/schemas/rate_rsv_searchRateInfoRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rate_rsv_rateInfo"}},"type":"object"}]}}},"description":"Bounded Oracle rate information; data is an empty object when Oracle returns 204.","headers":{"Cache-Control":{"schema":{"const":"no-store","type":"string"}}}},"default":{"$ref":"#/components/responses/Error"}},"summary":"查询预订房价信息（推荐）","x-capability-group":"reservations.read","x-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."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/room-calendar":{"get":{"description":"Read the configured hotel room calendar, including checked-out records and room moves when Oracle returns them. Pass includeRoomMoveHistory=true and showRoomMoveSegments=true for history/segments. Optional segmentStartDateTime/segmentEndDateTime depend on Advance Daily Detail OPERA Control. Oracle documents a maximum span of 366 days, but does not specify inclusive/exclusive date endpoints, same-day zero-night coverage, pageIndex origin/default or recordsPerPage maximum in this pinned contract. Omit pageIndex on an initial discovery request; use returned pageIndex/recordsPerPage after environment verification. Pagination is by rooms, not reservations; totalRooms is not a reservation count. Edge does not fill defaults, paginate automatically, discard segments or choose an ARR display room. Preserve all matches by internal Reservation ID. Room schedule/dateTimeSpan timestamps use hotel time zone; roomMoveHistory.date uses database time zone; strings are unchanged. Oracle 204 becomes a 200 envelope with data {}.","operationId":"getRoomCalendar","parameters":[{"description":"If true, then filter room results to rooms with Advance Checked In Reservations.","in":"query","name":"advanceCheckedIn","required":false,"schema":{"type":"boolean"}},{"description":"If 'Y', then filter room results to rooms that are assigned to guest.","in":"query","name":"assignedRooms","required":false,"schema":{"type":"string"}},{"description":"If 'Y', then filter room results to component rooms.","in":"query","name":"componentRooms","required":false,"schema":{"type":"string"}},{"description":"If 'Y', then filter room results to only connecting rooms.","in":"query","name":"connectingRoomsOnly","required":false,"schema":{"type":"string"}},{"description":"Indicates that only reservations marked as Back to Back should be expected in the result.","in":"query","name":"backToBackOnly","required":false,"schema":{"type":"boolean"}},{"description":"Indicates that only linked reservations are expected in the result.","in":"query","name":"linkedReservationsOnly","required":false,"schema":{"type":"boolean"}},{"description":"Name of the group of Linked Reservations to be searched.","in":"query","name":"linkedName","required":false,"schema":{"maxLength":50,"minLength":0,"type":"string"}},{"description":"Indicates that only reservations having scheduled room moves should be expected in the result.","in":"query","name":"scheduledRoomMoveOnly","required":false,"schema":{"type":"boolean"}},{"description":"If 'Y', then filter room results to rooms with Due Out Reservations.","in":"query","name":"dueOut","required":false,"schema":{"type":"string"}},{"description":"The ending value of the date range.","in":"query","name":"endDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"If true, then fetch result will be sorted in descending order.","in":"query","name":"isSortDescending","required":false,"schema":{"type":"boolean"}},{"description":"Page index to be retrieved.","in":"query","name":"pageIndex","required":false,"schema":{"type":"integer"}},{"description":"If 'Y', then filter room results to component rooms that have at least one of its rooms assigned to guest.","in":"query","name":"partiallyAssignedRooms","required":false,"schema":{"type":"string"}},{"description":"Number of records per page.","in":"query","name":"recordsPerPage","required":false,"schema":{"type":"integer"}},{"description":"If 'Y', then filter room results to rooms with Room Conditions.","in":"query","name":"roomConditions","required":false,"schema":{"type":"string"}},{"description":"If 'Y', then filter room results to rooms with rotation rooms only. It is supported only if OPERA Control Room Rotation is active.","in":"query","name":"ownerRoomsOnly","required":false,"schema":{"type":"string"}},{"description":"If 'Y', then filter room results to rooms that are exclusive to the owner. It is supported only if OPERA Control Room Rotation is active.","in":"query","name":"ownerExclusiveOnly","required":false,"schema":{"type":"string"}},{"description":"A collection of supported sorting for room calendar.","in":"query","name":"sortingBy","required":false,"schema":{"enum":["Default","Room","RoomType","RoomStatus"],"type":"string","uniqueItems":true}},{"description":"Include Room Move History in result.","in":"query","name":"includeRoomMoveHistory","required":false,"schema":{"type":"boolean"}},{"description":"Include information about Component Room Reservation dates when fetching a component suite.","in":"query","name":"includeComponentRoomBlockOutDates","required":false,"schema":{"type":"boolean"}},{"description":"The starting value of the date range.","in":"query","name":"startDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"If 'Y', then filter room results to rooms that are not yet assigned to guest.","in":"query","name":"unassignedRooms","required":false,"schema":{"type":"string"}},{"description":"Room search filter.","explode":true,"in":"query","name":"roomId","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"Room Type search filter.","explode":true,"in":"query","name":"roomType","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"Room Class search filter.","explode":true,"in":"query","name":"roomClass","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"Floor search filter.","explode":true,"in":"query","name":"floor","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"A code representing a room feature.","explode":true,"in":"query","name":"roomFeature","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.","explode":true,"in":"query","name":"roomStatus","required":false,"schema":{"items":{"enum":["Clean","Dirty","Pickup","Inspected","OutOfOrder","OutOfService"],"type":"string"},"type":"array","uniqueItems":true},"style":"form"},{"description":"Smoking Preference filter.","explode":true,"in":"query","name":"smokingPreference","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"bedType","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"If set to true then reservations having past or future room moves will come according to the exact stay dates in the rooms.","in":"query","name":"showRoomMoveSegments","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/room_calendar_roomCalendar"}},"type":"object"}]}}},"description":"Oracle document preserved in the edge envelope; upstream 204 yields empty data.","headers":{"Cache-Control":{"schema":{"const":"no-store","type":"string"}}}},"default":{"$ref":"#/components/responses/Error"}},"summary":"Read room calendar and room move history","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access","Validate pagination/date boundary behavior in the target environment before claiming complete historical coverage"],"retry":"Read-only: bounded backoff for transient errors; honor Retry-After. Keep explicit page coordinates on retries; no automatic page traversal."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/script":{"get":{"description":"This API will get the script for your property. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetScript\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getScript","parameters":[{"description":"Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.","in":"query","name":"languageCode","required":false,"schema":{"type":"string"}},{"description":"Used for Character Strings, length 0 to 40.","in":"query","name":"scriptType","required":false,"schema":{"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"reservationId","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A reference to the type of object defined by the UniqueID element.","explode":true,"in":"query","name":"reservationIdType","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Indicates whether to display offshore rate information in the closing script or not.","in":"query","name":"displayOffshoreRateInfo","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_script"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get a script","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/searches":{"post":{"operationId":"searchHotelReservations","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"}},"summary":"Search reservations","x-capability-group":"reservations.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":"RSV"}},"/api/v1/reservations/sell-messages/config":{"get":{"description":"Fetch the existing sell message configuration for a property. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetSellMessageConfig\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getSellMessageConfig","parameters":[{"description":"Indicates maximum number of records a Web Service should return.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.","in":"query","name":"offset","required":false,"schema":{"default":0,"type":"integer"}},{"description":"Sell Message text.","in":"query","name":"message","required":false,"schema":{"type":"string"}},{"description":"Room Type.","explode":true,"in":"query","name":"roomType","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"Rate Plan code.","explode":true,"in":"query","name":"ratePlanCode","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"blockId","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A reference to the type of object defined by the UniqueID element.","explode":true,"in":"query","name":"blockIdType","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Block Code to query for.","in":"query","name":"blockCode","required":false,"schema":{"type":"string"}},{"description":"Language code for the sell message.","in":"query","name":"languageCode","required":false,"schema":{"type":"string"}},{"description":"CRO code to query for.","in":"query","name":"croCode","required":false,"schema":{"type":"string"}},{"description":"The date on which the fetched sell message should be active.","in":"query","name":"displayDate","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_fetchSellMessageConfig"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get sell messages ","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/statistics":{"get":{"description":"Get DistributionReservationsSummary. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetDistributionReservationsSummary\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getDistributionReservationsSummary","parameters":[{"description":"This is the EnterpriseId of Hotel Code","in":"query","name":"enterpriseId","required":false,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"This is the ChannelCode of Hotel Code in the Reservations","explode":true,"in":"query","name":"channelCode","required":false,"schema":{"items":{"type":"string"},"maxItems":100,"type":"array","uniqueItems":true},"style":"form"},{"description":"This is the Last Updated From Date for a Reservation","in":"query","name":"startDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"This is the Last Updated To Date for a Reservation","in":"query","name":"endDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"Indicates maximum number of records a Web Service should return.","in":"query","name":"limit","required":false,"schema":{"default":20,"minimum":0,"type":"integer"}},{"description":"Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.","in":"query","name":"offset","required":false,"schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_checkDistributionReservationsSummary"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get Reservation DistributionReservationsSummary","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/summary":{"get":{"deprecated":true,"description":"\u003cp\u003eThis operation fetches brief summary for the reservations and also supports the Global Parameter \u003cstrong\u003eMAX ROWS FETCH COUNT\u003c/strong\u003e.\u003cbr\u003eBy default this parameter is configured to support an overall fetch of \u003cstrong\u003e5000\u003c/strong\u003e Records in total, with maximum number of records that can be fetched at a time being \u003cstrong\u003e200\u003c/strong\u003e (limit). However, this parameter can be updated to support an overall fetch value being a valid number between \u003cstrong\u003e1\u003c/strong\u003e and \u003cstrong\u003e10000\u003c/strong\u003e with maximum number of records that can be fetched at a time being same i.e. \u003cstrong\u003e200\u003c/strong\u003e (limit).\u003c/p\u003e\u003cp\u003eRequests with an \u003cstrong\u003eoffset\u003c/strong\u003e and \u003cstrong\u003elimit\u003c/strong\u003e sum exceeding the \u003cstrong\u003eMAX ROWS FETCH COUNT\u003c/strong\u003e configured would fail the request.\u003c/p\u003e \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetReservationsSummary\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getReservationsSummary","parameters":[{"description":"This filter indicates if the reservation(s) has performed an Advance Check-In or not. Data fetched is for 30 days ahead of business date.","in":"query","name":"advancedCheckedIn","required":false,"schema":{"type":"boolean"}},{"description":"This filter indicates number of records the API has to fetch.","in":"query","name":"limit","required":false,"schema":{"default":"200","type":"integer"}},{"description":"This filter is for the index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.","in":"query","name":"offset","required":false,"schema":{"default":0,"type":"integer"}},{"description":"This filter indicates whether the reservation is Pre-Registered for Internet Check-In or not. Data fetched is for 30 days ahead of business date.","in":"query","name":"preRegistered","required":false,"schema":{"type":"boolean"}},{"description":"This filter is for the date of arrival of reservation.","in":"query","name":"arrivalDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"This filter is for the date of departure of reservation.","in":"query","name":"departureDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"This filter is for the business date when reservation(s) was created in the system.","in":"query","name":"createDateTime","required":false,"schema":{"format":"date","type":"string"}},{"description":"This filter is for the date when reservation(s) was cancelled.","in":"query","name":"cancelledOn","required":false,"schema":{"format":"date","type":"string"}},{"description":"This filter is for the date when reservation(s) folio was closed.","in":"query","name":"folioClosedOn","required":false,"schema":{"format":"date","type":"string"}},{"description":"This filter looks up reservations with this last Name. Data fetched is for +-2 business date only when passed alone.","in":"query","name":"lastName","required":false,"schema":{"type":"string"}},{"description":"This filter is ID of the company used for the reservation. Data fetched is for +-2 business date only when passed alone.","in":"query","name":"companyId","required":false,"schema":{"type":"number"}},{"description":"This filter is ID of the guest.","in":"query","name":"guestNameId","required":false,"schema":{"type":"number"}},{"description":"This filter is computed reservation status of the reservation(s).","in":"query","name":"reservationStatus","required":false,"schema":{"enum":["Cancelled","CheckedOut","CheckedIn","DueIn","DueOut","InHouse","NoShow","WaitList"],"type":"string","uniqueItems":true}},{"description":"This filter is ID of confirmation for the reservation.","in":"query","name":"confirmationNumber","required":false,"schema":{"type":"string"}},{"description":"This filter is ID of external reference for the reservation.","in":"query","name":"externalReferenceNumber","required":false,"schema":{"type":"string"}},{"description":"This filter is ID of cancellation for the reservation.","in":"query","name":"cancellationNumber","required":false,"schema":{"type":"string"}},{"description":"This filter is used for looking up reservations with this membership number. Last Name is required along with membership number to filter the data.","in":"query","name":"membershipNumber","required":false,"schema":{"type":"string"}},{"description":"This filter is unique identifier of the registration card number. Last Name is required along with registration card number to filter the data.","in":"query","name":"registeredCardNumber","required":false,"schema":{"type":"string"}},{"description":"This filter checks reservations with balance amount greater than or equal to this amount. Departure date is required along with balance to filter the data.","in":"query","name":"balance","required":false,"schema":{"type":"number"}},{"description":"This filter is for room number.","in":"query","name":"roomId","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_reservationsSummary"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get brief summary for Reservations","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/summary/searches":{"post":{"description":"\u003cp\u003eThis operation fetches brief summary for the reservations and also supports the Global Parameter \u003cstrong\u003eMAX ROWS FETCH COUNT\u003c/strong\u003e.\u003cbr\u003eBy default this parameter is configured to support an overall fetch of \u003cstrong\u003e5000\u003c/strong\u003e Records in total, with maximum number of records that can be fetched at a time being \u003cstrong\u003e200\u003c/strong\u003e (limit). However, this parameter can be updated to support an overall fetch value being a valid number between \u003cstrong\u003e1\u003c/strong\u003e and \u003cstrong\u003e10000\u003c/strong\u003e with maximum number of records that can be fetched at a time being same i.e. \u003cstrong\u003e200\u003c/strong\u003e (limit).\u003c/p\u003e\u003cp\u003eRequests with an \u003cstrong\u003eoffset\u003c/strong\u003e and \u003cstrong\u003elimit\u003c/strong\u003e sum exceeding the \u003cstrong\u003eMAX ROWS FETCH COUNT\u003c/strong\u003e configured would fail the request.\u003c/p\u003e \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003esearchReservationsSummary\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"searchReservationsSummary","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rsv_read_searchReservationsSummaryRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_reservationsSummary"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Search brief summary for Reservations","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/validations":{"put":{"operationId":"putValidateReservationChanges","requestBody":{"$ref":"#/components/requestBodies/RequiredOracleDocument"},"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"}},"summary":"Validate reservation create/change data without mutation","x-capability-group":"reservations.write","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":"RSV"}},"/api/v1/reservations/{reservationID}":{"get":{"operationId":"getReservation","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"}},"summary":"Get a reservation by OPERA ID","x-capability-group":"reservations.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":"RSV"},"parameters":[{"$ref":"#/components/parameters/ReservationID"}],"put":{"operationId":"putReservation","requestBody":{"$ref":"#/components/requestBodies/ConfirmedWrite"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmedWriteResult"}}},"description":"Reservation update verified by getReservation.","headers":{"Cache-Control":{"schema":{"const":"no-store","type":"string"}}}},"default":{"$ref":"#/components/responses/Error"}},"summary":"Apply a hotel-confirmed reservation update and read it back","x-capability-group":"reservations.write","x-integration":{"pattern":"confirmed-write","prerequisites":["Hotel-approved confirmation","Read-back reconciliation ownership"],"retry":"Reuse the original idempotency key. Reconcile unknown outcomes with read-back before retrying."},"x-oracle-api":"RSV"}},"/api/v1/reservations/{reservationID}/alerts":{"get":{"description":"Get the alert notices including global alerts for a reservation. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetAlertNotices\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getAlertNotices","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"in":"query","name":"alertArea","required":false,"schema":{"enum":["CheckIn","CheckOut","Reservation","Billing","InHouse"],"type":"string","uniqueItems":true}},{"description":"Determines whether to fetch Global Alert Notices or Welcome Offer Alert Notice.","in":"query","name":"welcomeOffer","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_alerts"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Fetch Alert Notices","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/attachments":{"get":{"description":"Get Reservation attachments \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetReservationAttachments\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getReservationAttachments","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Indicator to retrieve e-Signed registration card attachments.","in":"query","name":"webRegistrationCard","required":false,"schema":{"type":"boolean"}},{"description":"File name used to filter final list of attachments. For example, Document.txt.","in":"query","name":"attachedFileName","required":false,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Description used to filter final list of attachments. For example, Offical guest ID. (This parameter does not require wildcard characters like * or % ).","in":"query","name":"description","required":false,"schema":{"maxLength":100,"minLength":1,"type":"string"}},{"description":"Indicator to retrieve digital registration attachments.","in":"query","name":"digitalRegistration","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_reservationAttachments"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get Reservation attachments","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/calls":{"get":{"description":"Get the Reservation Call History \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetCallHistory\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getCallHistory","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_callHistory"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get the Reservation Call History","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/cancellation-history":{"get":{"description":"Get cancellation history for a reservation. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetCancellationHistory\u003c/p\u003e \u003cp\u003eThis API allows a time span of \u003cstrong\u003e30\u003c/strong\u003e days.\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getCancellationHistory","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"in":"query","name":"hotelName","required":false,"schema":{"type":"string"}},{"in":"query","name":"roomStayStartDate","required":false,"schema":{"format":"date","type":"string"}},{"in":"query","name":"roomStayEndDate","required":false,"schema":{"format":"date","type":"string"}},{"in":"query","name":"roomStayDuration","required":false,"schema":{"type":"string"}},{"description":"Room class code","in":"query","name":"roomClass","required":false,"schema":{"type":"string"}},{"description":"Room type code","in":"query","name":"roomType","required":false,"schema":{"type":"string"}},{"description":"Room Id","in":"query","name":"numberOfRooms","required":false,"schema":{"type":"integer"}},{"description":"Room Id","in":"query","name":"roomId","required":false,"schema":{"type":"string"}},{"description":"Rate plan code","in":"query","name":"ratePlanCode","required":false,"schema":{"type":"string"}},{"description":"This is the HotelCode of the Block.","in":"query","name":"reservationBlockHotelId","required":false,"schema":{"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"reservationBlockId","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A reference to the type of object defined by the UniqueID element.","explode":true,"in":"query","name":"reservationBlockIdType","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"The Name of the block that is attached to the reservation.","in":"query","name":"blockName","required":false,"schema":{"type":"string"}},{"description":"Booking channel code","in":"query","name":"bookingChannelCode","required":false,"schema":{"type":"string"}},{"description":"Party code","in":"query","name":"linkCode","required":false,"schema":{"type":"string"}},{"description":"Guarantee Code.","in":"query","name":"onHold","required":false,"schema":{"type":"boolean"}},{"description":"The account identification number for this particular member in this particular program.","in":"query","name":"membershipAccountId","required":false,"schema":{"type":"string"}},{"description":"The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.)","in":"query","name":"membershipBonusCode","required":false,"schema":{"type":"string"}},{"description":"The code or name of the membership level and indicates the level of membership (Gold Club, Platinum member, etc.). This is same as the BonusCode.","in":"query","name":"membershipLevel","required":false,"schema":{"type":"string"}},{"description":"Membership ID (Unique ID from the memberships table).","in":"query","name":"membershipId","required":false,"schema":{"type":"number"}},{"description":"Guest's last stay date.","in":"query","name":"lastStayDate","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_cancellationHistory"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get cancellation history","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/cancellations":{"post":{"description":"Use this if a guest would like to cancel their reservation.  You will receive a cancellation number in the response. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003epostCancelReservation\u003c/p\u003e Fixed configured hotel; native status is in upstream_status. Single-target confirmed write. Check status: verified or pending_verification. Known success returns its native HTTP 200/201 even if readback is pending. Exact replay repeats reads only; unknown outcomes require reconciliation. receipt is the original Oracle response on the first successful mutation only, never persisted; save it in the consuming application's approved evidence store.","operationId":"postCancelReservation","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"case_id":"case-test","expected_hotel_id":"HOTEL1","hotel_confirmation_id":"approval-test","idempotency_key":"unique-test-key","payload":{"reason":{"code":"TEST_REASON"},"reservations":[{"hotelId":"HOTEL1","reservationIdList":[{"id":"RES1","type":"Reservation"}]}],"verificationOnly":false},"task_id":"task-test"},"schema":{"allOf":[{"$ref":"#/components/schemas/ConfirmedWriteRequest"},{"properties":{"payload":{"$ref":"#/components/schemas/BookingPayload_postCancelReservation"}},"type":"object"}]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingWriteResult"}}},"description":"Oracle read or confirmed-write outcome; inspect status before continuing business workflow."},"default":{"$ref":"#/components/responses/Error"}},"summary":"确认取消单笔预订","x-capability-group":"reservations.write","x-integration":{"pattern":"confirmed-write","prerequisites":["Approved reservations.write capability and Oracle access for the configured hotel","Use actual target IDs/codes; synthetic examples are not hotel configuration"],"retry":"Never blindly retry mutations. Resubmit identical confirmation and idempotency key to retry readback only; unknown outcomes stay blocked."},"x-oracle-api":"RSV","x-oracle-response-schema":{"$ref":"#/components/schemas/booking_rsv_cancelReservationDetails"},"x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/4bd129b455bc5e3ab0f900ac47983611e58659b4/rest-api-specs/property/v1/rsv.json","x-verification-operation":"getReservation"}},"/api/v1/reservations/{reservationID}/e-coupons":{"get":{"description":"Get the Reservation Ecoupons. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetECoupons\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getECoupons","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Indicates maximum number of records a Web Service should return.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.","in":"query","name":"offset","required":false,"schema":{"default":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_eCoupons"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get Reservation Ecoupons","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/flex-field-values":{"get":{"description":"API to fetch flex field values. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetFlexFieldValue\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getRsvFlexFieldValue","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Flex field ID","in":"query","name":"flexFieldId","required":false,"schema":{"type":"number"}},{"description":"Flex field code","explode":true,"in":"query","name":"flexFieldCode","required":false,"schema":{"items":{"maxItems":50,"type":"string"},"type":"array"},"style":"form"},{"description":"Flex field Value","in":"query","name":"flexFieldValue","required":false,"schema":{"type":"string"}},{"description":"Indicates maximum number of records a Web Service should return. Default is 50","in":"query","name":"limit","required":false,"schema":{"default":50,"maximum":100,"type":"integer"}},{"description":"Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.","in":"query","name":"offset","required":false,"schema":{"default":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_flexFieldsResponse"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Operation to fetch flex field values.","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/guest-locators":{"get":{"description":"Get the Guest locater for a Reservation. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetReservationLocators\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getReservationLocators","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_reservationLocators"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Fetch Reservation Guest Locator","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/inventory-items":{"get":{"description":"Get the Inventory Items reserved for the Reservation. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetReservedInventoryItems\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getReservedInventoryItems","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_inventoryItems"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get Reserved Inventory Items ","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/linked":{"get":{"description":"Get linked Reservations for given Reservation. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetLinkedReservations\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getLinkedReservations","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"additionalReservationId","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A reference to the type of object defined by the UniqueID element.","explode":true,"in":"query","name":"additionalReservationIdType","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Instruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.","explode":true,"in":"query","name":"fetchInstructions","required":false,"schema":{"items":{"enum":["Reservation","Comments","GuestComments","Packages","InventoryItems","ReservationPaymentMethods","RoutingInstructions","Preferences","Memberships","Alerts","Traces","ConfirmationLetters","CallHistory","FixedCharges","GuestMessages","ReservationPolicies","Indicators","LinkedReservations","RevenuesAndBalances","GuestLastStay","ECoupons","TrackItItems","TotalCostOfStay","ReservationAwards","WebRegistrationCards","ServiceRequests","ReservationActivities","ScheduledActivities","PrepaidCards","Shares","Attachments","Locators","ProfileAwards","TransactionDiversions","Tickets","GuestMemberships","ECertificates","UpsellInfo","RoomAssignedByAI","CustomNameValue","CustomChargeExemptions"],"type":"string"},"type":"array","uniqueItems":true},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_linkedHotelReservations"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get linked Reservations ","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/linked-summary":{"get":{"description":"Get Reservation summary for linked Reservation of given Reservation id. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetLinkedReservationsSummary\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getLinkedReservationsSummary","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"additionalReservationId","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A reference to the type of object defined by the UniqueID element.","explode":true,"in":"query","name":"additionalReservationIdType","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Indicates that only reservations marked as Back to Back should be expected in the result. Returned linked Back to Back reservations will belong to the same group of linked Back to Back reservations as the specified reservation with the given reservation name id and hotel code.","in":"query","name":"backToBackOnly","required":false,"schema":{"type":"boolean"}},{"description":"When true indicates that linked reservations with Cancelled status should not be included in search results.","in":"query","name":"excludeCancelledReservations","required":false,"schema":{"type":"boolean"}},{"description":"When true indicates that linked reservations with NoShow status should not be included in search results.","in":"query","name":"excludeNoShowReservations","required":false,"schema":{"type":"boolean"}},{"description":"Indicates maximum number of records this Web Service should return. Minimum is 0. Default is 200.","in":"query","name":"limit","required":false,"schema":{"default":200,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_linkedReservationsInfo"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get Reservation summary for linked Reservation","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/packages":{"get":{"description":"Get the package availability for a hotel code and reservation id \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetPackage\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getPackage","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"in":"query","name":"postingRhythm","required":false,"schema":{"type":"string"}},{"in":"query","name":"productCode","required":true,"schema":{"type":"string"}},{"in":"query","name":"ratePlanCode","required":false,"schema":{"type":"string"}},{"in":"query","name":"reservationTimeSpanStartDate","required":false,"schema":{"format":"date","type":"string"}},{"in":"query","name":"reservationTimeSpanEndDate","required":false,"schema":{"format":"date","type":"string"}},{"in":"query","name":"packageTimeSpanStartDate","required":false,"schema":{"format":"date","type":"string"}},{"in":"query","name":"packageTimeSpanEndDate","required":false,"schema":{"format":"date","type":"string"}},{"in":"query","name":"packageQuantity","required":false,"schema":{"type":"integer"}},{"in":"query","name":"packageExcludedQuantity","required":false,"schema":{"type":"integer"}},{"description":"Defines the number of Adults.","in":"query","name":"reservationAdults","required":false,"schema":{"type":"integer"}},{"description":"Defines the number of Children.","in":"query","name":"reservationChildren","required":false,"schema":{"type":"integer"}},{"description":"Simple type for package instructions that can be used in requests for partial operations.","explode":true,"in":"query","name":"fetchInstructions","required":false,"schema":{"items":{"enum":["Primary","Transaction","Classification","Schedule","InventoryItems"],"type":"string"},"type":"array","uniqueItems":true},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_packages"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get Package","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/payment-methods":{"get":{"description":"This API will return the payment method(s) that exist on a reservation. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetPaymentMethods\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getPaymentMethods","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Flag to notify the operation to also retrieve the outstanding balance, current authorized amount and amount needed to be approved for each folio.","in":"query","name":"includeAmounts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_reservationPaymentMethods"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get a payment method ","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/policies":{"get":{"description":"This API will retrieve the reservation policies for a specified reservation. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetReservationPolicies\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getReservationPolicies","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"A flag which instructs whether the deposit policies needs to be fetched.","in":"query","name":"fetchDepositPolicies","required":false,"schema":{"type":"boolean"}},{"description":"A flag which instructs whether the cancel policies needs to be fetched.","in":"query","name":"fetchCancellationPolicies","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_reservationPolicies"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get Reservation Policies","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/preferences":{"get":{"description":"You can use this API to retrieve the preferences that exist on a reservation. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetReservationPreference\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getReservationPreference","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"explode":true,"in":"query","name":"preferenceTypeCode","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_reservationPreference"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get Reservation Preferences","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/routing-instructions":{"get":{"description":"Use this API to fetch a reservation's routing instructions. It requires a reservation ID, which can be fetched using getReservations. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetRoutingInstructions\u003c/p\u003e \u003cp\u003eThe maximum allowable limit for this API is \u003cstrong\u003e20\u003c/strong\u003e.\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getRoutingInstructions","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Include the window routing instructions to the response.","in":"query","name":"includeWindowRouting","required":false,"schema":{"type":"boolean"}},{"description":"Include the room routing instructions in the response.","in":"query","name":"includeRoomRouting","required":false,"schema":{"type":"boolean"}},{"description":"Include the comp routing instructions in the response.","in":"query","name":"includeCompRouting","required":false,"schema":{"type":"boolean"}},{"description":"Include the comp routing requests in the response.","in":"query","name":"includeCompRoutingRequests","required":false,"schema":{"type":"boolean"}},{"description":"If date is included then the search result should only be valid for dates which includes this date.","in":"query","name":"effectiveOn","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_routingInstructions"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get routing instructions","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/share-candidates":{"get":{"description":"Fetch the reservation that can be shared with an existing reservation. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetReservationsToShareByReservationId\u003c/p\u003e \u003cp\u003eThe maximum allowable limit for this API is \u003cstrong\u003e100\u003c/strong\u003e.\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getReservationsToShareByReservationId","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Indicates maximum number of records a Web Service should return.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Free form text field for searching all reservation fields","in":"query","name":"superSearch","required":false,"schema":{"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","in":"query","name":"reservationGuestId","required":false,"schema":{"type":"string"}},{"description":"A reference to the type of object defined by the UniqueID element.","in":"query","name":"reservationGuestIdType","required":false,"schema":{"type":"string"}},{"description":"Membership ID criteria.","in":"query","name":"membershipId","required":false,"schema":{"type":"string"}},{"explode":true,"in":"query","name":"membershipLevel","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"explode":true,"in":"query","name":"membershipType","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"Family name, last name.","in":"query","name":"surname","required":false,"schema":{"type":"string"}},{"description":"Given name, first name or names","in":"query","name":"givenName","required":false,"schema":{"type":"string"}},{"description":"Room number","in":"query","name":"roomId","required":false,"schema":{"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"cancellationNumberList","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"externalReferenceIds","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Used to identify the source of the identifier (e.g., IATA, ABTA).","explode":true,"in":"query","name":"externalSystemCodes","required":false,"schema":{"default":["External"],"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","explode":true,"in":"query","name":"confirmationNumberList","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Travel Agent Record Locators List.","explode":true,"in":"query","name":"taRecordLocatorList","required":false,"schema":{"items":{"type":"string"},"maxItems":30,"type":"array"},"style":"form"},{"description":"Reservation status list for reservations search.","explode":true,"in":"query","name":"reservationStatuses","required":false,"schema":{"items":{"enum":["Cancelled","CheckedOut","CheckedIn","DueIn","DueOut","InHouse","NoShow","WaitList"],"type":"string"},"type":"array","uniqueItems":true},"style":"form"},{"description":"Name of the group of Linked Reservations to be searched.","in":"query","name":"linkedName","required":false,"schema":{"maxLength":50,"minLength":0,"type":"string"}},{"description":"Instruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.","explode":true,"in":"query","name":"fetchInstructions","required":false,"schema":{"items":{"enum":["Reservation","Comments","GuestComments","Packages","InventoryItems","ReservationPaymentMethods","RoutingInstructions","Preferences","Memberships","Alerts","Traces","ConfirmationLetters","CallHistory","FixedCharges","GuestMessages","ReservationPolicies","Indicators","LinkedReservations","RevenuesAndBalances","GuestLastStay","ECoupons","TrackItItems","TotalCostOfStay","ReservationAwards","WebRegistrationCards","ServiceRequests","ReservationActivities","ScheduledActivities","PrepaidCards","Shares","Attachments","Locators","ProfileAwards","TransactionDiversions","Tickets","GuestMemberships","ECertificates","UpsellInfo","RoomAssignedByAI","CustomNameValue","CustomChargeExemptions","IncludeAllReservations"],"type":"string"},"type":"array","uniqueItems":true},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_fetchReservations"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get Reservations to share by Reservation id","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/shares":{"get":{"description":"This API can be used to retrieve the share reservations that exist on a reservation. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetShareReservations\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getShareReservations","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Instruction on which of the shared reservation's elements are to be returned e.g. DailySummary will return summarized information for each day of the shared reservation. Instructions are cumulative i.e. if multiple instructions are sent in a request, then the combined shared reservation elements would be returned, elements will not be duplicated in the response.","explode":true,"in":"query","name":"fetchInstructions","required":false,"schema":{"items":{"enum":["Reservation","Comments","ReservationMembershipAwards","GuestComments","Packages","TotalCostOfStay","InventoryItems","ReservationPaymentMethods","RoutingInstructions","Preferences","Memberships","Alerts","Traces","ConfirmationLetters","CallHistory","FixedCharges","GuestMessages","ReservationPolicies","Indicators","LinkedReservations","RevenuesAndBalances","GuestLastStay","ECoupons","TrackItItems","ReservationAwards","WebRegistrationCards","ReservationActivities","ScheduledActivities","PrepaidCards","Shares","Attachments","Locators","ProfileAwards","TransactionDiversions","Tickets","GuestMemberships","ECertificates","UpsellInfo","RoomAssignedByAI","AutoCheckInRoomType","Keys","AccompanyingGuestProfile","AccompanyingGuestMembership","AccompanyingGuestRelationship","Voucher","ScheduledRoomMoves","DailySummary","RateInfoDetails","OffshoreRates","FetchChildAges","TotalDepositPaid","ReservationProtection"],"type":"string"},"type":"array","uniqueItems":true},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_shareReservations"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get share Reservations","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/tickets":{"get":{"description":"Get tickets for a reservation. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetTickets\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getTickets","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"Property where the tickets messages belongs to.","in":"query","name":"packageCode","required":false,"schema":{"type":"string"}},{"description":"Flag that specified if only issued tickets will be retrieved.","in":"query","name":"retrieveIssuedOnly","required":false,"schema":{"type":"boolean"}},{"description":"Flag that specified if only not issued tickets will be retrieved.","in":"query","name":"retrieveNotIssuedOnly","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_tickets"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get tickets","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/tickets/inquiry":{"get":{"description":"You can use this API to perform a Inquiry for Reservation tickets. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetTicketsInquiry\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getTicketsInquiry","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","in":"query","name":"ticketId","required":false,"schema":{"type":"string"}},{"description":"A reference to the type of object defined by the UniqueID element.","in":"query","name":"ticketIdType","required":false,"schema":{"type":"string"}},{"description":"Package Code.","explode":true,"in":"query","name":"packageCode","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","in":"query","name":"reservationProductId","required":false,"schema":{"type":"string"}},{"description":"A reference to the type of object defined by the UniqueID element.","in":"query","name":"reservationProductIdType","required":false,"schema":{"type":"string"}},{"description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","in":"query","name":"ticketNumberId","required":false,"schema":{"type":"string"}},{"description":"A reference to the type of object defined by the UniqueID element.","in":"query","name":"ticketNumberIdType","required":false,"schema":{"type":"string"}},{"description":"Tickets issue date.","explode":true,"in":"query","name":"ticketIssueDate","required":false,"schema":{"items":{"format":"date","type":"string"},"type":"array"},"style":"form"},{"description":"Tickets comsumption date.","explode":true,"in":"query","name":"ticketConsumptionDate","required":false,"schema":{"items":{"format":"date","type":"string"},"type":"array"},"style":"form"},{"description":"The Rate Code to which tickets belong to.","explode":true,"in":"query","name":"ticketRateCode","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"The Status Code for outbound WS call.","explode":true,"in":"query","name":"ticketStatus","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_tickets"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Inquiry for Reservation tickets","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/traces":{"get":{"description":"You can use this API to get traces for a Reservation. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetTracesByReservation\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getTracesByReservation","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_traces"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get traces for a Reservation","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/transaction-diversions":{"get":{"description":"You can use this API to get Transaction Diversions. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetTransactionDiversions\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getTransactionDiversions","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}},{"explode":true,"in":"query","name":"transactionDiversionCodes","required":false,"schema":{"items":{"type":"string"},"maxItems":4000,"type":"array"},"style":"form"},{"description":"Flag to check if the the daily details are required to be fetched for a particular transaciton.","in":"query","name":"includeDailyDetails","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_transactionDiversions"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get Transaction Diversions ","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/reservations/{reservationID}/upsell":{"get":{"description":"Use this API to retrieve the available upsell offers for a specific reservation. If no upsell options are configured for this hotel or available for this reservation, an appropriate error will be returned. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetReservationUpsellInfo\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getReservationUpsellInfo","parameters":[{"description":"Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA.","in":"path","name":"reservationID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_reservationUpsellInfo"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get available Upsell offers","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/api/v1/room-types":{"get":{"operationId":"getRoomTypes","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"}},"summary":"Get Room Types","x-capability-group":"hotel.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":"RMCFG"}},"/api/v1/room-types/{roomTypeCode}":{"get":{"operationId":"getRoomTypeInfo","parameters":[{"$ref":"#/components/parameters/RoomTypeCode"}],"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"}},"summary":"Get one Room Type","x-capability-group":"hotel.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":"RMCFG"}},"/api/v1/rooms/{roomID}/traces":{"get":{"description":"This API will fetch the traces for a Room. \u003cp\u003e\u003cstrong\u003eOperationId:\u003c/strong\u003egetTracesByRoom\u003c/p\u003e Edge fixes hotelId to the configured hotel; JSON is preserved without normalization or automatic pagination. Upstream 204 becomes 200 with data {}.","operationId":"getTracesByRoom","parameters":[{"description":"Room Id","in":"path","name":"roomID","required":true,"schema":{"maxLength":2000,"minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OHIPDocument"},{"properties":{"data":{"$ref":"#/components/schemas/rsv_read_traces"}},"type":"object"}]}}},"description":"Original Oracle document in the stable edge envelope; 204 yields empty data."},"default":{"$ref":"#/components/responses/Error"}},"summary":"Get traces for a Room","x-capability-group":"reservations.read","x-integration":{"pattern":"sync-read","prerequisites":["Approved reservations.read capability and upstream RSV access for the configured hotel"],"retry":"Read-only bounded retries for transient upstream failures; honor Retry-After. No automatic pagination."},"x-oracle-api":"RSV","x-oracle-source":"https://github.com/oracle/hospitality-api-docs/blob/dd631fbd5d0fce74a7dbdf96b43f07ce587211f2/rest-api-specs/property/v1/rsv.json"}},"/developer/v1/catalog":{"get":{"operationId":"listIntegrationCatalog","parameters":[{"in":"query","name":"q","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"type":"object"},"type":"array"},"version":{"type":"string"}},"type":"object"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[],"summary":"Discover wrapped operations"}},"/developer/v1/catalog/{operationID}":{"get":{"operationId":"getIntegrationOperation","parameters":[{"in":"path","name":"operationID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[],"summary":"Read operation schemas, prerequisites and retry rules"}},"/developer/v1/openapi":{"get":{"operationId":"getIntegrationOpenAPI","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Successful response"},"default":{"$ref":"#/components/responses/Error"}},"security":[],"summary":"Read the full integration contract"}},"/healthz":{"get":{"operationId":"getHealth","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Status"}}},"description":"Process is alive."}},"security":[],"summary":"Check process liveness"}},"/readyz":{"get":{"operationId":"getReadiness","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Status"}}},"description":"Required schema is reachable."},"default":{"$ref":"#/components/responses/Error"}},"security":[],"summary":"Check PostgreSQL schema readiness"}}},"security":[{"CallerAPIKey":[]}],"servers":[{"url":"/"}],"x-admin-security":[{"AdminAPIKey":[]},{"AdminSession":[]}],"x-document-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"}},"x-job-start-responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAccepted"}}},"description":"Oracle accepted the asynchronous retrieval job.","headers":{"Cache-Control":{"schema":{"const":"no-store","type":"string"}}}},"default":{"$ref":"#/components/responses/Error"}},"x-job-status-responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobStatus"}}},"description":"Current Oracle process status.","headers":{"Cache-Control":{"schema":{"const":"no-store","type":"string"}},"Retry-After":{"description":"Seconds from Oracle Cache-Control max-age before polling again, when supplied.","schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/Error"}},"x-query-allowlists":{"changeGuaranteeCode":[],"changeMarketCode":["forceOverride"],"changeMarketGroup":[],"changeSourceCode":[],"changeSourceGroup":[],"deleteBlockCancellationReasons":[],"deleteBlockLostBookingCodes":[],"deleteBlockRateOverrideReasons":[],"deleteBlockRefusedReasons":[],"deleteBlockStatusCode":[],"deleteBookingTypes":[],"deleteCancellationCodes":[],"deleteDestinationCodes":[],"deleteGuaranteeCode":[],"deleteReservationMethods":[],"deleteRoomClass":[],"deleteRoomTypes":[],"getARStatements":["profileId","profileIdContext","profileType","accountNo","accountName","closeDate","fiscalBillNo","folioDate","folioNo","folioStatus","folioTypeName","invoiceNo","invoiceType","postingDate","revenueDate","statementNo","status","transferDate","transactionDate","transactionNo","reservationId","reservationIdContext","reservationType","guestProfileId","guestProfileIdContext","guestProfileType","guestName","originalAmount","originalAmountCurrencyCode","amount","currencyCode","paymentsAmount","paymentsCurrencyCode","balanceAmount","balanceCurrencyCode","reference","remark","marketCode","marketGroup","roomClassCode","sourceCode","sourceGroup","cashierId","cashierName","transactionDescription","transactionGroup","transactionSubGroup","transactionCode","balanceForwardDate","inclFolios","inclPrinted","inclZero","filterEndDate","filterStartDate","statementText","accountID"],"getARTransactions":["accounts","endDate","startDate","fromAmount","fromCurrencyCode","toAmount","toCurrencyCode","guestName","invoices","folios","fiscalBillNo","accountName","addresseName"],"getAccount":["accountNo","profileId","profileIdContext","profileType","fetchInstructions"],"getAccounts":["balance","batchStatement","limit","offset","profileId","profileIdContext","profileType","type","accountNo","accountName","accountId","accountIdContext","accountType","includeStatementHistoryIndicator","includeReminderHistoryIndicator","superSearch","attributeName","orderType","minimumBalance"],"getAlertNotices":["alertArea","welcomeOffer"],"getAllReportGroups":["id","idContext","type","moduleName"],"getAllReports":["excludeGroup","includeInternalReports","includeRnAReports","includeUnpublished","includeWatermarkDetails","limit","multiPropertyOnly","protectedReportParam","scheduled","name","group","id","idContext","type"],"getAvailabilityRatePlanInfo":["ratePlanCodeList"],"getAvailabilityRatePlanInfoByMultipleRatePlans":["ratePlanCodeList"],"getAwardUpgrades":["profileId","idContext","profileIdType","membershipType","membershipCardNo","membershipPoints","id","reservationTimeSpanStartDate","reservationTimeSpanEndDate","reservationTimeSpanDuration","numberOfRooms","roomType"],"getAwards":["reservationId"],"getBalanceInfo":["id","idContext","type","folioWindowNo","cashierId","transactionCode","articleCode","amount","currencyCode","profileIdId","profileIdIdContext","profileIdType","reservationIdId","reservationIdIdContext","reservationIdType","fiscalBillNo","folioDate","folioNo","folioStatus","folioTypeName","invoiceNo"],"getBankAccountsForReportsLOV":["includeInactiveFlag","parameterName","parameterValue","excludeCodes"],"getBlock":["fetchInstructions","fetchAllocatedRoomTypes","startDate","numberOfDays","roomAllocationCriteria","roomTypes","fetchRoomTypesWithInventory"],"getBlockAvailability":["overrideRateCode","arrivalDate","nights","adults","children","childAge","bucket1Count","bucket2Count","bucket3Count","bucket4Count","bucket5Count","rooms","ratePlanCode","existingReservationId","existingReservationIdType","roomType","fetchAllocatedRoomType","roomTypeCount","detailedAvailability"],"getBlockCancellationReasons":["fetchInactive","codes","wildCard","description"],"getBlockDailyRevenue":["statisticsDate","blockStatus","ownerCode","blockDailyRevenueCategory","revenueType","revenueGroup"],"getBlockLostBookingCodes":["fetchInactive","codes","wildCard","description"],"getBlockPMReservations":["postingmaster"],"getBlockRateOverrideReasons":["fetchInactive","codes","wildCard","description"],"getBlockRefusedReasons":["fetchInactive","codes","wildCard","description"],"getBlockRoomRateGrid":["fetchAllocatedRoomTypes","startDate","numberOfDays","roomAllocationCriteria","roomTypes","limit","offset"],"getBlockStatusCodes":["blockStatusCodes"],"getBookingTypes":["fetchInactive","codes","wildCard","description"],"getCallHistory":[],"getCancellationCodes":["fetchInactive","codes","wildCard","description"],"getCancellationHistory":["hotelName","roomStayStartDate","roomStayEndDate","roomStayDuration","roomClass","roomType","numberOfRooms","roomId","ratePlanCode","reservationBlockHotelId","reservationBlockId","reservationBlockIdType","blockName","bookingChannelCode","linkCode","onHold","membershipAccountId","membershipBonusCode","membershipLevel","membershipId","lastStayDate"],"getConfLetterReportsLOV":["includeInactiveFlag","parameterName","parameterValue","excludeCodes"],"getConfigReportsLOV":["includeInactiveFlag","parameterName","parameterValue","excludeCodes"],"getConfirmationLetters":["notAttached","pending","sent","createdOnEndDate","createdOnStartDate","arrivalEndDate","arrivalStartDate","letterStyleId","letterStyle","letterStyleIdType","reservationGuestId","reservationGuestIdType","membershipId","membershipLevelCode","membershipTypeCode","surname","givenName","blockHotelId","blockId","blockIdType","blockName"],"getDestinationCodes":["fetchInactive","codes","wildCard","description"],"getDistributionReservationsSummary":["enterpriseId","channelCode","startDate","endDate","limit","offset"],"getECoupons":["limit","offset"],"getEndOfDayReportsLOV":["includeInactiveFlag","parameterName","parameterValue","excludeCodes"],"getExternalSystemDeliveryHistory":["reservationId","reservationIdType"],"getFinancialPostings":["limit","offset","startDate","endDate","duration","cashierId","filterTransactionCode","code","filterRoomNumber","referenceNumberWildCard","checkNumberWildCard","supplementWildCard","approvalCode","approvalStatusCode","folioWindowNo","id","idContext","type","amount","currencyCode","closureNo"],"getFolio":["guestPayOnly","includeFolioHistory","reservationBalanceOnly","fetchInstructions","end","folioWindowNo","limit","offset","start","summaryOnly","groupType","exchangeCurrency","calculateCollectingAgentTaxes","vATOffset","includeDepositTaxes","simpleFolio"],"getFolioTransactionDetails":["includeGenerates","transactionNo","includeExchangeInformation"],"getGenericReportsLOV":["includeInactiveFlag","parameterName","parameterValue","excludeCodes"],"getGuaranteeCodes":["limit","pageNumber","guaranteeCodes","inactive"],"getGuestMessages":["limit","offset","reservationId","retrieveDeliveredMessages","room","travelAgent","company","group","source","reservationStatus","retrieveUndeliveredMessages","retrievePrintedMessages","retrieveTextedMessages","blockName","recipientName","confirmationNo"],"getGuestsTransactions":["reservationList","includeGenerates","includeTransactionsWithARInvoiceNo","includeTransactionsWithFolioNo","includeTransactionsWithManualPostingOnly","idContext","type","transactionNo","transactionGroup","transactionSubGroup","billingCode","desc","routingInstructionsId","trxCodeWildCard","trxDescriptionWildCard","checkNumberWildCard","referenceNumberWildCard","supplementWildCard","windowNo","cashieringTransactionType","startDate","endDate","cashierId","code","commissionable","serviceRecoveryAllowed","postedTransactionType","billingSummary"],"getHotelAvailability":["includeLocalRates","includeOffshoreRates","includeClosedRates","includeDefaultRatePlanSet","includeNoRatePlanSet","initialRatePlanSet","limit","pagePointerKey","ratePlanSet","redeemAwards","roomStayStartDate","roomStayEndDate","roomStayQuantity","adults","children","childAge","bucket1Count","bucket2Count","bucket3Count","bucket4Count","bucket5Count","fullStayTimeSpanStartDate","fullStayTimeSpanEndDate","prevailingRate","rateCategory","rateClass","rateGroup","ratePlanCode","promotionCode","roomType","feature","reservationGuestId","reservationGuestIdType","reservationProfileType","attachedProfileId","hotelReservationId","hotelReservationIdType","ratePlanInfo","returnOnlyAvailableRateCodes","resGuaranteeInfo","roomTypeInfo","membershipLevel","membershipType","pointsAvailable","smokingPreference","hotelPackage","ownerType","controlSegment","postingInterval"],"getHotelReservations":["keyTrack2","discrepancy","limit","offset","searchType","text","reservationIdList","confirmationNumberList","cancellationNumberList","externalReferenceIds","externalSystemCodes","externalReferenceLegId","arrivalEndDate","arrivalStartDate","departureEndDate","departureStartDate","stayOnStartDate","createdOnStartDate","expectedArrivalEndTime","expectedArrivalStartTime","depositDueEndDate","depositDueStartDate","expectedReturnEndTime","expectedReturnStartTime","companyNames","sourceNames","travelAgentNames","groupNames","travelAgentIds","companyIds","sourceIds","contactIds","groupIds","billingContactIds","profileId","commissionPaid","vouchersGenerated","membershipCardNumber","membershipLevels","membershipTypes","reservationsWithMembershipType","surname","givenName","fromName","toName","anyVIPStatus","vipCodes","guaranteeCode","paymentMethod","discountApplied","user","createdBy","cancelledByList","cancelledOn","ratePlanCodes","sourceCodes","marketCodes","excludeBlockReservations","blockCriteriaHotelCode","blockName","blockIds","blockCodes","customReference","recordLocator","orderBy","sortOrder","roomAssignedOnly","roomUnassignedOnly","roomId","roomType","roomFeatures","roomSpecials","roomSmokingPreference","roomFloorPreferences","housekeepingRoomStatuses","roomClasses","roomRangeFrom","roomRangeTo","communication","phone","email","profileExternalReferencesToFetch","resvExternalReferencesToFetch","fetchInstructions","allowedReservationActions","allowPreRegistration","excludeNoPost","excludePMRooms","hasDepositBalance","hasOpenBalance","hasOpenFolio","includeScheduledCheckOut","linkedOnly","unlinkedOnly","actualArrivals","actualDepartures","complimentaryReservations","dayOfArrivalCancels","dayUse","earlyDepartures","expectedArrivals","expectedDepartures","extendedStays","houseUseReservations","stayovers","stayDate","roomRoutingId","periodicFolio","folioSettlementTypes","defaultDays","daysSinceLastAutoSettled","dateSinceLastAutoSettled","excludePseudoRoomReservations","excludeReservationIds","excludeVIPStatusCodes","excludeSpecials","excludeFloorPreferences","excludeAdvanceCheckedIn","excludeRoomFeatures","playerId","gamingBalanceFrom","gamingBalanceTo","compAccountingBalanceFrom","compAccountingBalanceTo","searchTypes","reservationStatuses","transportationCodes","roomReadyStatuses","checkoutMessageReceived","optedForCommunication","swapShiftRoomReservationId","roomSmokingPreferences","roomFeaturePreferences","roomsFloorPreferences","contactNames","taRecordLocatorList","packageCodes","inventoryItems","guaranteeCodes","linkedName","backToBackOnly","backToBackDateOn","scheduledRoomMoveDate","scheduledRoomMoveStartTime","scheduledRoomMoveEndTime","scheduledRoomMoveStatus","excludeBackToBackReservations","checkInInitiatedBy","flexChar","flexNum","flexDate","pkgCategoryToFetch","pkgForecastedConsumptionDateToFetch","itineraryLeg","preRegisteredOnly","similaritySearch","includeReviewedPreArrivals"],"getHotelRevenue":["businessDate"],"getLinkedReservations":["additionalReservationId","additionalReservationIdType","fetchInstructions"],"getLinkedReservationsSummary":["additionalReservationId","additionalReservationIdType","backToBackOnly","excludeCancelledReservations","excludeNoShowReservations","limit"],"getManagerReportDetailsLOV":["includeInactiveFlag","parameterName","parameterValue","excludeCodes"],"getManagersReportsLOV":["includeInactiveFlag","parameterName","parameterValue","excludeCodes"],"getMarketCodes":["limit","pageNumber","marketCodes","marketGroupsCodes","includeInactive"],"getMarketGroups":["limit","pageNumber","marketCodes","marketGroupsCodes","includeInactive"],"getNextBlockStatus":["currentStatus","includeCateringStatus"],"getNextBlockStatusCodes":["configuredOnly","blockStatusCodes"],"getOperaSettings":["cROCode","parameterNameWildCard"],"getPackage":["postingRhythm","productCode","ratePlanCode","reservationTimeSpanStartDate","reservationTimeSpanEndDate","packageTimeSpanStartDate","packageTimeSpanEndDate","packageQuantity","packageExcludedQuantity","reservationAdults","reservationChildren","fetchInstructions"],"getPaymentMethods":["includeAmounts"],"getPaymentMethodsLOV":["includeInactiveFlag","parameterName","parameterValue","excludeCodes"],"getPostingSummary":["includeGenerates","postingDate","checkPostings","postingsByExternalSystem","cashierId","currency","postingSummaryType"],"getPreArrivalMemberReservations":["end","start","membershipType","externalReferenceType"],"getPreConfiguredRoutingInstructions":["rateCode","promotionCodes","guestName","guestIds","companyName","companyIds","groupName","groupIds","travelAgentName","travelAgentIds","sourceName","sourceIds","contactName","contactIds","billingContactName","billingContactIds","addresseeName","addresseeIds","reservationId"],"getProfileAging":["currency"],"getProfileRelationships":["relationshipPrimaryProfile"],"getProfiles":["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"],"getRateInfo":["currencyCode","summaryInfo","criteriaStartDate","criteriaEndDate","adults","children","childAge","bucket1Count","bucket2Count","bucket3Count","bucket4Count","bucket5Count","detailDate","blockId","blockIdType","id","idExtension","idContext","type","ratePlanCode","effectiveRateEnd","effectiveRateStart","roomType"],"getRatePlan":["fetchInstructions"],"getRatePlansByHotel":["ratePlanCode","postingInterval","fetchInstructions"],"getRepGroupReportsLOV":["includeInactiveFlag","parameterName","parameterValue","excludeCodes"],"getReportParameters":["id","idContext","type"],"getReports":["excludeGroup","includeInternalReports","includeRnAReports","includeUnpublished","includeWatermarkDetails","limit","multiPropertyOnly","protectedReportParam","scheduled","name","group","id","idContext","type"],"getReportsGenericLOV":["includeInactiveFlag","parameterName","parameterValue","excludeCodes"],"getResStatReportRateCodeLOV":["includeInactiveFlag","parameterName","parameterValue","excludeCodes"],"getReservation":["profileExternalReferencesToFetch","fetchInstructions","allowedActions"],"getReservationActivityLog":["limit","offset","parameterName","parameterValue","activityGroup","activityType","fromDate","toDate","searchText","userByIdsUserId","userForIdsUserId"],"getReservationAttachments":["webRegistrationCard","attachedFileName","description","digitalRegistration"],"getReservationByExtId":["profileExternalReferencesToFetch","fetchInstructions","allowedActions"],"getReservationLocators":[],"getReservationMethods":["fetchInactive","codes","wildCard","description"],"getReservationPolicies":["fetchDepositPolicies","fetchCancellationPolicies"],"getReservationPreference":["preferenceTypeCode"],"getReservationRevenueBucketTotals":["idContext","type","revenueBucketType","compRevenue"],"getReservationUpsellInfo":[],"getReservationsByPackage":["packageCategory","packageCode","date","limit","offset"],"getReservationsSummary":["advancedCheckedIn","limit","offset","preRegistered","arrivalDate","departureDate","createDateTime","cancelledOn","folioClosedOn","lastName","companyId","guestNameId","reservationStatus","confirmationNumber","externalReferenceNumber","cancellationNumber","membershipNumber","registeredCardNumber","balance","roomId"],"getReservationsToShareByProfileId":["limit","superSearch","reservationGuestId","reservationGuestIdType","membershipId","membershipLevel","membershipType","surname","givenName","roomId","fetchInstructions"],"getReservationsToShareByReservationId":["limit","superSearch","reservationGuestId","reservationGuestIdType","membershipId","membershipLevel","membershipType","surname","givenName","roomId","cancellationNumberList","externalReferenceIds","externalSystemCodes","confirmationNumberList","taRecordLocatorList","reservationStatuses","linkedName","fetchInstructions"],"getReservedInventoryItems":[],"getRoomCalendar":["advanceCheckedIn","assignedRooms","componentRooms","connectingRoomsOnly","backToBackOnly","linkedReservationsOnly","linkedName","scheduledRoomMoveOnly","dueOut","endDate","isSortDescending","pageIndex","partiallyAssignedRooms","recordsPerPage","roomConditions","ownerRoomsOnly","ownerExclusiveOnly","sortingBy","includeRoomMoveHistory","includeComponentRoomBlockOutDates","startDate","unassignedRooms","roomId","roomType","roomClass","floor","roomFeature","roomStatus","smokingPreference","bedType","showRoomMoveSegments"],"getRoomClasses":["roomClassCodes"],"getRoomTypes":["accessible","includeInactive","limit","offset","physical","pseudo","summaryInfo","roomTypeCodes","roomClassCodes"],"getRoutingInstructions":["includeWindowRouting","includeRoomRouting","includeCompRouting","includeCompRoutingRequests","effectiveOn"],"getRsvFlexFieldValue":["flexFieldId","flexFieldCode","flexFieldValue","limit","offset"],"getScheduledReportsExportLOV":["includeInactiveFlag","parameterName","parameterValue","excludeCodes"],"getScript":["languageCode","scriptType","reservationId","reservationIdType","displayOffshoreRateInfo"],"getSellMessageConfig":["limit","offset","message","roomType","ratePlanCode","blockId","blockIdType","blockCode","languageCode","croCode","displayDate"],"getShareReservations":["fetchInstructions"],"getShareReservationsByExtId":[],"getShiftReportsLOV":["includeInactiveFlag","parameterName","parameterValue","excludeCodes"],"getShiftReportsNoParamLOV":["includeInactiveFlag","parameterName","parameterValue","excludeCodes"],"getSourceCodes":["limit","pageNumber","sourceCodes","sourceGroupsCodes","includeInactive"],"getSourceGroups":["limit","pageNumber","sourceCodes","sourceGroupsCodes","includeInactive"],"getStatements":["profileId","profileIdContext","profileType","accountNo","accountName","closeDate","fiscalBillNo","folioDate","folioNo","folioStatus","folioTypeName","invoiceNo","invoiceType","postingDate","revenueDate","statementNo","status","transferDate","transactionDate","transactionNo","reservationId","reservationIdContext","reservationType","guestProfileId","guestProfileIdContext","guestProfileType","guestName","originalAmount","originalAmountCurrencyCode","amount","currencyCode","paymentsAmount","paymentsCurrencyCode","balanceAmount","balanceCurrencyCode","reference","remark","marketCode","marketGroup","roomClassCode","sourceCode","sourceGroup","cashierId","cashierName","transactionDescription","transactionGroup","transactionSubGroup","transactionCode","balanceForwardDate","inclFolios","inclPrinted","inclZero","filterEndDate","filterStartDate","statementText"],"getTickets":["packageCode","retrieveIssuedOnly","retrieveNotIssuedOnly"],"getTicketsInquiry":["ticketId","ticketIdType","packageCode","reservationProductId","reservationProductIdType","ticketNumberId","ticketNumberIdType","ticketIssueDate","ticketConsumptionDate","ticketRateCode","ticketStatus"],"getTracesByReservation":[],"getTracesByRoom":[],"getTransactionDiversions":["transactionDiversionCodes","includeDailyDetails"],"pingReportsConfigServiceStatus":[],"postBlockCancellationReasons":[],"postBlockLostBookingCodes":[],"postBlockRateOverrideReasons":[],"postBlockRefusedReasonspostBlo":[],"postBlockStatusCode":[],"postBookingTypes":[],"postCancelReservation":[],"postCancellationCodes":[],"postDestinationCodes":[],"postGuaranteeCode":[],"postMarketCode":[],"postMarketGroup":[],"postProfile":[],"postReservationMethods":[],"postRoomClass":[],"postRoomTypes":[],"postSourceCode":[],"postSourceGroup":[],"putBlockAllocation":[],"putBlockCancellationReasons":[],"putBlockLostBookingCodes":[],"putBlockRateOverrideReasons":[],"putBlockRefusedReasons":[],"putBlockStatus":[],"putBlockStatusCode":[],"putBookingTypes":[],"putCancellationCodes":[],"putDestinationCodes":[],"putNextBlockStatusCodes":[],"putReservationMethods":[],"putRoomClass":[],"putRoomTypes":[],"removeMarketCode":[],"removeMarketGroup":[],"removeSourceCode":[],"removeSourceGroup":[],"searchPreConfiguredRoutingInstructions":[],"searchRateInfo":[],"searchReservationsSummary":[]}}