OperationId:getAddress
" }, { "info": { "name": "Delete certificate", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/certificates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "This API will allow you to delete a certificate.OperationId:deleteCertificate
" }, { "info": { "name": "This API facilitates creation of a company/agent/group/source profile in OPERA.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/companies", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "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.OperationId:postCompanyProfile
" }, { "info": { "name": "Get company profile by corporate ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/companies/:corporateID", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "corporateID", "value": "", "type": "path", "description": "Unique OPERA Corporate ID used to find company/agent/group/source profile in OPERA." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Room Ownership information associated with the profile." } ] }, "docs": "Use this to retrieve a specific Company, Travel Agent, Group or Source profile. You must know the corporate ID of the profile for the request API.OperationId:getCompanyProfile
" }, { "info": { "name": "Get profiles with duplicate external subscriptions ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/duplicateExternalSubscriptions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." }, { "name": "databaseId", "value": "", "type": "query", "description": "Code identifying the external database record which is linked to external systems." }, { "name": "profileId", "value": "", "type": "query", "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." }, { "name": "profileContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "Fetch profile subscriptions where the same OPERA Cloud profile is linked to multiple external profiles, within the same external system.OperationId:getDuplicateExternalSubscriptions
The maximum allowable limit for this API is 200.
" }, { "info": { "name": "Get profiles with duplicate OPERA Cloud subscriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/duplicateOPERASubscriptions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." }, { "name": "databaseId", "value": "", "type": "query", "description": "Code identifying the external database record which is linked to external systems." }, { "name": "profileId", "value": "", "type": "query", "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." }, { "name": "profileContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "Fetch subscriptions where an external profile within a particular external system is linked to multiple OPERA Cloud profiles.OperationId:getDuplicateOPERASubscriptions
The maximum allowable limit for this API is 200.
" }, { "info": { "name": "Get e-certificate", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecertificates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "query", "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." }, { "name": "profileContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "hotelId", "value": "", "type": "query", "description": "Property for which preferences are to be fetched." }, { "name": "code", "value": "", "type": "query", "description": "Ecertificates search criteria" }, { "name": "groupCode", "value": "", "type": "query", "description": "Ecertificates search criteria" }, { "name": "status", "value": "", "type": "query", "description": "Indicates that OPERA E-Certificate is reserved." }, { "name": "includeInactive", "value": "", "type": "query", "description": "Include or not include inactive E-certificate." }, { "name": "voucherNo", "value": "", "type": "query", "description": "System generated unique voucher number." }, { "name": "excludeVoucherNumbers", "value": "", "type": "query", "description": "List of System generated unique voucher numbers to be excluded." }, { "name": "availableECertificates", "value": "", "type": "query", "description": "Search criteria to limit Ecertificates that are available for reservation consumption." } ] }, "docs": "This API allows you to retrieve eCertificates which exist on a profile in OPERA Cloud.OperationId:getECertificates
" }, { "info": { "name": "Create e-certificate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ecertificates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "This API allows you to create a new eCertificates onto a profile in OPERA Cloud.OperationId:postECertificate
" }, { "info": { "name": "Consume an E-Certificate", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ecertificates/:certificateId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "certificateId", "value": "", "type": "path" } ] }, "docs": "Use this API to consume (use) an E-Certificate.OperationId:consumeECertificate
" }, { "info": { "name": "Delete e-certificate", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ecertificates/:certificateId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "certificateId", "value": "", "type": "path" } ] }, "docs": "This API allows you to delete an eCertificates which exist on a profile in OPERA Cloud.OperationId:deleteECertificate
" }, { "info": { "name": "Verify E-Certificate Number", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ecertificates/:certificateId/action/validate", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "certificateId", "value": "", "type": "path" } ] }, "docs": "Use this API to verify an ng E-Certificate Number.OperationId:verifyECertificate
" }, { "info": { "name": "Extend E-Certificate Expiry date", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ecertificates/:certificateId/extensions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "certificateId", "value": "", "type": "path" } ] }, "docs": "Use this API to extend the date of an existing E-Certificate.OperationId:extendECertificate
" }, { "info": { "name": "Get profile by external ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/externalSystems/:extSystemCode/profiles/:profileExternalId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileExternalId", "value": "", "type": "path", "description": "External System's ID used to get the profile." }, { "name": "extSystemCode", "value": "", "type": "path", "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." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel Code used to filter hotel specific information regarding the profile." }, { "name": "logViewProfile", "value": "", "type": "query", "description": "This element tells when the view profile should be logged." }, { "name": "showInactiveRoomOwners", "value": "", "type": "query", "description": "Flag to show inactive Room Owners." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Room Ownership information associated with the profile." }, { "name": "instructionParameterType", "value": "", "type": "query", "description": "Simple type enumerating the different parameters accepted by a profile Instructions. Parameter names have the name of the instruction expecting it, and the parameter name itself." }, { "name": "value", "value": "", "type": "query", "description": "Value of Profile Instruction Parameter" }, { "name": "allowedAction", "value": "", "type": "query", "description": "Flag indicating whether Profile is Enrolled to Primary Membership Program." } ] }, "docs": "When a reservation is booked via an external system, you would use this API to retrieve a reservation using the external ID in the requestOperationId:getProfileByExtId
" }, { "info": { "name": "Update by external ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/externalSystems/:extSystemCode/profiles/:profileExternalId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileExternalId", "value": "", "type": "path", "description": "External System's ID used to get the profile." }, { "name": "extSystemCode", "value": "", "type": "path", "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." } ] }, "docs": "Use this API to update guests details on profile. You will need to know the External Profile ID and external system code to use this API.OperationId:putProfileByExtId
" }, { "info": { "name": "Create a guest, contact or employee profile in OPERA", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/guests", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "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.OperationId:postGuestProfile
" }, { "info": { "name": "Get guest profile by guest ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/guests/:guestId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "guestId", "value": "", "type": "path", "description": "Unique OPERA internal ID used to find guest/contact/employee profile in OPERA." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel Code used to filter hotel specific information regarding the profile." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Room Ownership information associated with the profile." } ] }, "docs": "Use this API to retrieve all data stored for a guest Profile, such as their address, phone number, preferences. You must already know the guests Profile ID. If you don't know the profile ID, first use the API getGuests to find the profile ID.OperationId:getGuestProfile
" }, { "info": { "name": "Copy profile commission account", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/profiles/:profileId/commissionAccount", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "You can use this API to copy the commission account on a profileOperationId:copyProfileCommissionAccount
" }, { "info": { "name": "Operation to delete a flex field.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/profiles/:profileId/flexFieldCode/:flexFieldCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "flexFieldCode", "value": "", "type": "path", "description": "Flex field code" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel in OPERA" }, { "name": "profileId", "value": "", "type": "path", "description": "Unique OPERA internal profile ID which is used to find any type of profile from OPERA. This ID is a primary identification of a profile in OPERA." } ] }, "docs": "Operation to delete a flex field Value.OperationId:deleteFlexFieldValue
" }, { "info": { "name": "Operation to fetch flex field values.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/profiles/:profileId/flexFieldValues", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel in OPERA" }, { "name": "profileId", "value": "", "type": "path", "description": "Unique OPERA internal profile ID which is used to find any type of profile from OPERA. This ID is a primary identification of a profile in OPERA." }, { "name": "flexFieldId", "value": "", "type": "query", "description": "Flex field ID" }, { "name": "flexFieldCode", "value": "", "type": "query", "description": "Flex field code" }, { "name": "flexFieldValue", "value": "", "type": "query", "description": "Flex field Value" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return. Default is 50" }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "API to fetch flex field values.OperationId:getFlexFieldValue
" }, { "info": { "name": "Operation to create a flex field with value for a module.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/profiles/:profileId/flexFieldValues", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel in OPERA" }, { "name": "profileId", "value": "", "type": "path", "description": "Unique OPERA internal profile ID which is used to find any type of profile from OPERA. This ID is a primary identification of a profile in OPERA." } ] }, "docs": "Operation to create a flex field Value.OperationId:postFlexFieldValue
" }, { "info": { "name": "Operation to update flex field value.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/profiles/:profileId/flexFieldValues", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel in OPERA" }, { "name": "profileId", "value": "", "type": "path", "description": "Unique OPERA internal profile ID which is used to find any type of profile from OPERA. This ID is a primary identification of a profile in OPERA." } ] }, "docs": "Operation to update flex field value.OperationId:putFlexFieldValue
" }, { "info": { "name": "Re-Process a single Stage Record", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/profiles/:profileId/reprocess", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Resort for the stage record to reprocess or rematch" }, { "name": "profileId", "value": "", "type": "path", "description": "Resort Name Id for the stage record to reprocess or rematch" } ] }, "docs": "Use this API to Re-Process a single Stage Record.OperationId:reProcessStageRecord
" }, { "info": { "name": "Get Membership Tier Projection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/membershipTierProjections", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "query", "description": "Membership Card Number." }, { "name": "membershipType", "value": "", "type": "query", "description": "Type of the Membership." }, { "name": "id", "value": "", "type": "query", "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." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "projectionDate", "value": "", "type": "query", "description": "Date for which Tier projections is fetched." }, { "name": "projectionType", "value": "", "type": "query", "description": "Upgrade And Downgrade" } ] }, "docs": "Retrieve a list of membership Tier Projection such as upgrades and downgrades.OperationId:getMembershipTierProjections
The maximum allowable limit for this API is 200.
" }, { "info": { "name": "Get Fulfillment Export Logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/memberships/:membershipId/fullfillmentExportLogs", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "query", "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." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "idType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "membershipType", "value": "", "type": "query", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." } ] }, "docs": "Use this API to Get Fulfillment Export Logs.OperationId:getFulfillmentExportLogs
" }, { "info": { "name": "Generate membership number", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/memberships/:membershipType/membershipNumbers", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipType", "value": "", "type": "path" } ] }, "docs": "This API will generate a new membership number.OperationId:postMembershipNumber
" }, { "info": { "name": "Process a staged profile", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/processStagedProfile", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to process one profile that has been staged.OperationId:processStagedProfile
" }, { "info": { "name": "Fetch the profile Id if a unique guest profile Exists", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profileMatch", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "lastName", "value": "", "type": "query", "description": "Last Name for the profile that needs to be matched." }, { "name": "firstName", "value": "", "type": "query", "description": "First Name for the profile that needs to be matched." }, { "name": "membershipType", "value": "", "type": "query", "description": "Membership Type for the profile that needs to be matched." }, { "name": "membershipCardNumber", "value": "", "type": "query", "description": "Membership Card Number for the profile that needs to be matched." }, { "name": "identificationType", "value": "", "type": "query", "description": "Identification Type for the profile that needs to be matched." }, { "name": "identificationNumber", "value": "", "type": "query", "description": "Identification Number for the profile that needs to be matched." }, { "name": "email", "value": "", "type": "query", "description": "Email for the profile that needs to be matched." }, { "name": "subscriptionType", "value": "", "type": "query", "description": "Subscription Type for the profile that needs to be matched." }, { "name": "subscriptionId", "value": "", "type": "query", "description": "Subscription Id for the profile that needs to be matched." }, { "name": "clientId", "value": "", "type": "query", "description": "Client Id for the profile that needs to be matched." } ] }, "docs": "Use this operation to fetch guest profile (profile Id). This operation can be integrated with createReservation API, to prevent creation of duplicate profiles.OperationId:getProfileMatch
" }, { "info": { "name": "Fetch the profile Id if a unique guest profile Exists", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/profileMatch/searches", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this operation to fetch guest profile (profile Id). This operation can be integrated with createReservation API, to prevent creation of duplicate profiles.OperationId:searchProfileMatch
" }, { "info": { "name": "Get Profile Transactions ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profileTransactions/:profileId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Profile Id for which we want to fetch transactions" }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "transactionDate", "value": "", "type": "query" }, { "name": "hotelId", "value": "", "type": "query", "description": "Stay Record or Membership transaction belongs to which Hotel." }, { "name": "confirmationNumber", "value": "", "type": "query", "description": "Confirmation Number of the stay Record or Membership Transaction." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." }, { "name": "reference", "value": "", "type": "query", "description": "User-defined reference field for the Membership Transaction Adjustment." } ] }, "docs": "Retrieve the Transactions associated to a profile related to Stay Records or Membership Adjustments.OperationId:getProfileTransactions
This API allows a time span of 90 days.
" }, { "info": { "name": "Search for profile(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "excludeInactive", "value": "", "type": "query", "description": "Indicates whether to exclude Inactive Profiles, when true indicates that only profiles with active status will be displayed." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel Code, It is used to filter hotel specific children to this specific hotel code." }, { "name": "includeHasHierarchyOnly", "value": "", "type": "query", "description": "Include profiles that have one or more relationships in the search." }, { "name": "includePrimaryOwnersOnly", "value": "", "type": "query", "description": "Include primary owners in the search." }, { "name": "includePurgeProfiles", "value": "", "type": "query", "description": "Include purged profiles in the search." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." }, { "name": "searchType", "value": "", "type": "query", "description": "When search type is PatronTrackingSystemMemberProfiles, the FetchProfiles will return the Membership Number of the searched Membership Type regardless of primary flag or sequence of the profile memberships." }, { "name": "summaryInfo", "value": "", "type": "query", "description": "When true response will return summary information otherwise detailed information." }, { "name": "searchString", "value": "", "type": "query", "description": "Search string to be used for super search." }, { "name": "includeAnonymized", "value": "", "type": "query", "description": "Indicates whether to include Anonymized Profiles." }, { "name": "profileType", "value": "", "type": "query", "description": "The types of Profile handled by the web service." }, { "name": "profileIds", "value": "", "type": "query", "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." }, { "name": "externalReferenceIds", "value": "", "type": "query", "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." }, { "name": "externalSystemCodes", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "corporateIds", "value": "", "type": "query", "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." }, { "name": "profileName", "value": "", "type": "query", "description": "Family name, last name or Company Name." }, { "name": "givenName", "value": "", "type": "query", "description": "Given name, first name or names." }, { "name": "incognitoName", "value": "", "type": "query", "description": "Family name, last name or Company Name." }, { "name": "incognitoGivenName", "value": "", "type": "query", "description": "Given name, first name or names." }, { "name": "city", "value": "", "type": "query", "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address)." }, { "name": "postalCode", "value": "", "type": "query", "description": "Post Office Code number." }, { "name": "state", "value": "", "type": "query", "description": "State or Province name (e.g., Texas)." }, { "name": "countryCode", "value": "", "type": "query", "description": "Code for a country or a nationality." }, { "name": "streetAddress", "value": "", "type": "query", "description": "First Line of Street Address. For profile search it matches the first Address line." }, { "name": "keyword", "value": "", "type": "query", "description": "Keyword associated to the profile." }, { "name": "communication", "value": "", "type": "query", "description": "Any communication method associated to the profile such as phone, fax, email address." }, { "name": "membership", "value": "", "type": "query", "description": "Membership number associated to the profile." }, { "name": "membershipType", "value": "", "type": "query", "description": "Member Type of searching profile." }, { "name": "ownerCodes", "value": "", "type": "query" }, { "name": "membershipLevel", "value": "", "type": "query", "description": "Membership level associated to the profile." }, { "name": "aRNumber", "value": "", "type": "query", "description": "Account Receivable associated to the profile." }, { "name": "taxID", "value": "", "type": "query", "description": "Tax ID associated to the profile" }, { "name": "businessSegment", "value": "", "type": "query", "description": "Business/Market Segment associated to the profile." }, { "name": "accountsReceivables", "value": "", "type": "query", "description": "When true indicates that only profiles with AR account fetched." }, { "name": "corporateProfiles", "value": "", "type": "query", "description": "When true indicates that only profiles with client id are searched for." }, { "name": "excludeIncompleteProfiles", "value": "", "type": "query", "description": "When true indicates that only profiles with an Address Line 1 and Country or at least one Communications Type will be displayed." }, { "name": "negotiatedRates", "value": "", "type": "query", "description": "When true indicates that this option has to be included in advanced search." }, { "name": "relatedProfileExcludeInactive", "value": "", "type": "query", "description": "Indicates whether to exclude Inactive Profiles, when true indicates that only profiles with active status will be displayed." }, { "name": "realtedProfileIncludeHasHierarchyOnly", "value": "", "type": "query", "description": "Include profiles that have one or more relationships in the search." }, { "name": "relatedProfileNegotiatedRates", "value": "", "type": "query", "description": "When true indicates that this option has to be included in advanced search." }, { "name": "relatedProfileType", "value": "", "type": "query", "description": "The types of Profile handled by the web service." }, { "name": "relatedProfileName", "value": "", "type": "query", "description": "Family name, last name or Company Name." }, { "name": "protectedProfiles", "value": "", "type": "query", "description": "Indicates whether to exclude Protected Profiles." }, { "name": "excludedProfilesId", "value": "", "type": "query", "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." }, { "name": "idExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system. This query parameter is deprecated." }, { "name": "excludedProfilesIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA). This query parameter is deprecated." }, { "name": "excludedProfilesIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. This query parameter is deprecated." }, { "name": "identificationNo", "value": "", "type": "query", "description": "Any identification number associated with the profile such as Passport Number, StateID." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Room Ownership information associated with the profile." }, { "name": "allowedAction", "value": "", "type": "query", "description": "Flag indicating whether Profile is Enrolled to Primary Membership Program." }, { "name": "vipCodes", "value": "", "type": "query" }, { "name": "prioritieCodes", "value": "", "type": "query" }, { "name": "birthDate", "value": "", "type": "query", "description": "Date of birth" }, { "name": "phone", "value": "", "type": "query", "description": "The phone number associated to the profile." }, { "name": "email", "value": "", "type": "query", "description": "The email address associated to the profile." }, { "name": "lastStayBefore", "value": "", "type": "query", "description": "Date to filter profiles with stays before." } ] }, "docs": "Use this API when you want to search for a profile. The response will include a list of profiles that exist in OPERA, based on your search criteria. For example, you want to see if a profile for Mr David Smith exists - you can search by various criteria, such as first, last name, email. The response will include a list of any profiles that exist for Mr Davis Smith. If a profile matches the criteria, and you want to get more details of that profile, proceed to use getProfile with the profileI" }, { "info": { "name": "Create a profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/profiles", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "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.OperationId:postProfile
" }, { "info": { "name": "Validate and check profiles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/action/validate", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "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." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "idType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "checkProfileInstruction", "value": "", "type": "query", "description": "Simple type that corresponds to check profile instructions." } ] }, "docs": "This API validates/checks allowed actions, the existence of attached records and/or indicators of a profile.OperationId:checkProfileType
" }, { "info": { "name": "Fetch profile activity log", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/activityLog", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." }, { "name": "activityParamsHotelId", "value": "", "type": "query", "description": "Hotel code." }, { "name": "module", "value": "", "type": "query", "description": "Activity module." }, { "name": "parameterName", "value": "", "type": "query", "description": "Name of the parameter." }, { "name": "parameterValue", "value": "", "type": "query", "description": "Value of the parameter." }, { "name": "activityGroup", "value": "", "type": "query" }, { "name": "activityType", "value": "", "type": "query" }, { "name": "fromDate", "value": "", "type": "query", "description": "Search from date for the user activity log." }, { "name": "toDate", "value": "", "type": "query", "description": "Search to date for the user activity log." }, { "name": "searchText", "value": "", "type": "query", "description": "Search text for the user activity log." }, { "name": "userByIDs", "value": "", "type": "query" }, { "name": "userForIDs", "value": "", "type": "query" } ] }, "docs": "Use this API to fetch the activity log for a specific profile. This will allow you to see the changes that have occurred on this profile.OperationId:getProfileActivityLog
The maximum allowable limit for this API is 200.
" }, { "info": { "name": "Get potential profile matches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/profileMatches", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "lastName", "value": "", "type": "query", "description": "Last name of the user" }, { "name": "firstName", "value": "", "type": "query", "description": "First name of the user" }, { "name": "AddressLine1", "value": "", "type": "query", "description": "First Line of Street Address. For profile search it matches the first Address line." }, { "name": "AddressLine2", "value": "", "type": "query", "description": "Second Line of Street Address. For profile search it matches the first Address line." }, { "name": "city", "value": "", "type": "query", "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address)." }, { "name": "state", "value": "", "type": "query", "description": "State or Province name (e.g., Texas)." }, { "name": "postalCode", "value": "", "type": "query", "description": "Post Office Code number." }, { "name": "country", "value": "", "type": "query", "description": "Country Address" }, { "name": "email", "value": "", "type": "query", "description": "Email linked to the user." }, { "name": "phone", "value": "", "type": "query", "description": "Telephone linked to the user." }, { "name": "matchPercentage", "value": "", "type": "query", "description": "match percentage criteria will exceed." }, { "name": "legalCompany", "value": "", "type": "query", "description": "Name Of the company the individual is associated with." } ] }, "docs": "This API will provide a list of potential profiles matching the given criteria.OperationId:getProfileMatches
" }, { "info": { "name": "Get potential profile matches", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/profiles/profileMatches/searches", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "This API will provide a list of potential profiles matching the given criteria.OperationId:searchProfileMatches
" }, { "info": { "name": "Search for profile(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/profiles/searches", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API when you want to search for a profile. The response will include a list of profiles that exist in OPERA, based on your search criteria. For example, you want to see if a profile for Mr David Smith exists - you can search by various criteria, such as first, last name, email. The response will include a list of any profiles that exist for Mr Davis Smith. If a profile matches the criteria, and you want to get more details of that profile, proceed to use getProfile with the profileI" }, { "info": { "name": "Get potential stage profile matches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/stageProfileMatches", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "query", "description": "The resort to which the profile belongs" }, { "name": "resortNameId", "value": "", "type": "query", "description": "Profile's external ID" } ] }, "docs": "This API provides a list of potential profiles matching the given stage profile.OperationId:getStagedProfileMatches
" }, { "info": { "name": "Get profile by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Unique OPERA internal profile ID which is used to find any type of profile from OPERA. This ID is a primary identification of a profile in OPERA." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel Code used to filter hotel specific information regarding the profile." }, { "name": "logViewProfile", "value": "", "type": "query", "description": "This element tells when the view profile should be logged." }, { "name": "systemCode", "value": "", "type": "query", "description": "This element will be used to store external database." }, { "name": "showInactiveRoomOwners", "value": "", "type": "query", "description": "Flag to show inactive Room Owners." }, { "name": "markAsRecentlyAccessed", "value": "", "type": "query", "description": "Providing this flag marks the profile as recently accessed." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Room Ownership information associated with the profile." }, { "name": "instructionParameterType", "value": "", "type": "query", "description": "Simple type enumerating the different parameters accepted by a profile Instructions. Parameter names have the name of the instruction expecting it, and the parameter name itself." }, { "name": "value", "value": "", "type": "query", "description": "Value of Profile Instruction Parameter" }, { "name": "allowedAction", "value": "", "type": "query", "description": "Flag indicating whether Profile is Enrolled to Primary Membership Program." } ] }, "docs": "You would use this to retrieve any type of profile, whether it is a company, travel agent, individual, source or groupOperationId:getProfile
" }, { "info": { "name": "Update a profile by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/profiles/:profileId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "OPERA internal profile ID which is used to uniquely identify the profile in OPERA. This ID is a primary identification of a profile in OPERA." } ] }, "docs": "Use this to update a guests details on their profile. You will need to know the OPERA Profile ID to use this API, and you will also need to know the List of Values for profile fields, such as AddressType, PhoneType, Title.OperationId:putProfile
" }, { "info": { "name": "Forget or delete a profile by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/profiles/:profileId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "OPERA internal profile ID which is used to uniquely identify the profile in OPERA. This ID is a primary identification of a profile in OPERA." } ] }, "docs": "Use this to anonymize a guest or contact profile in OPERA.OperationId:deleteProfile
" }, { "info": { "name": "Get profile accounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/accounts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "hotelIds", "value": "", "type": "query" } ] }, "docs": "You can find the accounts that are listed on a profile with this API.OperationId:getProfileAccounts
" }, { "info": { "name": "Get profile attachments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/attachments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "attachedFileName", "value": "", "type": "query", "description": "File name used to filter final list of attachments. For example, Document.txt." }, { "name": "description", "value": "", "type": "query", "description": "Description used to filter final list of attachments. For example, Offical guest ID. (This parameter does not require wildcard characters like * or % )." } ] }, "docs": "This API will provide the attachments on a profile in OPERA Cloud.OperationId:getProfileAttachments
" }, { "info": { "name": "Delete profile attachment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/profiles/:profileId/attachments/:attachmentId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "attachmentId", "value": "", "type": "path" }, { "name": "profileId", "value": "", "type": "path" }, { "name": "idExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "uniqueIdIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "uniqueIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "uniqueIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "This API will delete an attachment on a profile in OPERA Cloud.OperationId:deleteProfileAttachment
" }, { "info": { "name": "Get Profile awards and certificates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/awardsAndCertificates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" }, { "name": "profileContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel Code for which the routing instructions are provided for a profile." } ] }, "docs": "Get Profile awards and certificates that exist on a profile.OperationId:getAwards
" }, { "info": { "name": "Get cashiering details for a profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/cashieringDetails", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" }, { "name": "fetchPaymentMethod", "value": "", "type": "query", "description": "Boolean flag that indicates whether the payment method has to be fetched or not." }, { "name": "fetchRoutingInstruction", "value": "", "type": "query", "description": "Boolean flag that indicates whether the routing instruction has to be fetched or not." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "idType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "hotelIds", "value": "", "type": "query", "description": "List of Hotel Codes." } ] }, "docs": "Retrieve any profile Financial details that exists on a profile (typically Company or Travel Agent profiles). This includes Routing Instructions on the profile.OperationId:getCashieringDetails
" }, { "info": { "name": "Change cashiering details for a profile", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/profiles/:profileId/cashieringDetails", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" } ] }, "docs": "Update a profiles Financial details, such as billing, routing instructions.OperationId:changeProfileCashieringDetails
" }, { "info": { "name": "Get commission account on a profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/commissionAccount", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" }, { "name": "hotelIds", "value": "", "type": "query" } ] }, "docs": "Retrieve Commission Account details from a specified profile.OperationId:getProfileCommissionAccount
" }, { "info": { "name": "Add a commission account on a profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/profiles/:profileId/commissionAccount", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" } ] }, "docs": "Add a commission account on a profile. You can only add commission accounts onto a Travel Agent or Source Profile type in OPERA Cloud.OperationId:postProfileCommissionAccount
" }, { "info": { "name": "Set profile commission account", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/profiles/:profileId/commissionAccount", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" } ] }, "docs": "Apply a commission account to an existing profile. You can add commission accounts to Travel Agent profile types.OperationId:setProfileCommissionAccount
" }, { "info": { "name": "Delete a commission account from a profile", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/profiles/:profileId/commissionAccount", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" }, { "name": "validatePending", "value": "", "type": "query", "description": "Used in CRUD operations. When set to true, proceed validating pending commissions" }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel code from which the profile bank account and code belongs to" }, { "name": "profileIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "profileContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "bankAccountId", "value": "", "type": "query", "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." }, { "name": "bankAccountIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "bankAccountIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "bankAccountIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "commissionCode", "value": "", "type": "query", "description": "Code." }, { "name": "description", "value": "", "type": "query", "description": "description." } ] }, "docs": "Delete a Commission Account from a specified profile.OperationId:deleteProfileCommissionAccount
" }, { "info": { "name": "Create an Email.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/profiles/:profileId/emails", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Profile ID linked to an Email." } ] }, "docs": "Use this API to create a new Email in OPERA. You would need to know the Profile Id such as Contact or Account.OperationId:storeEmail
" }, { "info": { "name": "Operation to fetch flex field values.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/flexFieldValues", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Unique OPERA internal profile ID which is used to find any type of profile from OPERA. This ID is a primary identification of a profile in OPERA." }, { "name": "hotelIds", "value": "", "type": "query", "description": "Hotel code" }, { "name": "flexFieldId", "value": "", "type": "query", "description": "Flex field ID" }, { "name": "flexFieldCode", "value": "", "type": "query", "description": "Flex field code" }, { "name": "flexFieldValue", "value": "", "type": "query", "description": "Flex field Value" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return. Default is 50" }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "API to fetch flex field values.OperationId:getAllFlexFieldValues
" }, { "info": { "name": "Fetch Account Forecasts by hotel", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/hotels/:hotelId/forecasts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Code" }, { "name": "profileId", "value": "", "type": "path", "description": "Unique OPERA internal account profile ID" }, { "name": "fromPeriodCode", "value": "", "type": "query", "description": "Specifies the From Fiscal or Calendar Period Code" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "You can use this API to retrieve account forecasts for a hotelOperationId:getAccountForecasts
The maximum allowable limit for this API is 200.
" }, { "info": { "name": "Create account forecast in a hotel", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/profiles/:profileId/hotels/:hotelId/forecasts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "profileId", "value": "", "type": "path", "description": "Unique OPERA internal account profile ID" } ] }, "docs": "Use postAccountForecast to create a new account forecast for a hotel.OperationId:postAccountForecast
" }, { "info": { "name": "Delete multiple account forecasts", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/profiles/:profileId/hotels/:hotelId/forecasts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "profileId", "value": "", "type": "path", "description": "Unique OPERA internal account profile ID" }, { "name": "periodCodes", "value": "", "type": "query", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." } ] }, "docs": "Use this API to delete multiple account forecasts.OperationId:deleteMultipleAccountForecasts
" }, { "info": { "name": "Update account forecast in a hotel by period code", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/profiles/:profileId/hotels/:hotelId/forecasts/periodCodes/:periodCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "periodCode", "value": "", "type": "path", "description": "Period Code" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel." }, { "name": "profileId", "value": "", "type": "path", "description": "Unique Account Profile ID." } ] }, "docs": "Use this to update an existing account Forecast for a hotel. You must know the period code for this API.OperationId:putAccountForecast
" }, { "info": { "name": "Delete account forecast in a hotel by period code", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/profiles/:profileId/hotels/:hotelId/forecasts/periodCodes/:periodCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "periodCode", "value": "", "type": "path", "description": "Period Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel." }, { "name": "profileId", "value": "", "type": "path", "description": "Unique Account Profile ID." }, { "name": "periodCodes", "value": "", "type": "query", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." } ] }, "docs": "Use this to delete an existing account Forecast for a hotel. You must know the period code for this API.OperationId:deleteAccountForecast
" }, { "info": { "name": "Delete a preference from a profile", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/profiles/:profileId/hotels/:hotelId/preferenceType/:preferenceType/preferences/:preferenceCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "preferenceCode", "value": "", "type": "path" }, { "name": "preferenceType", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" }, { "name": "profileId", "value": "", "type": "path" }, { "name": "registeredProperty", "value": "", "type": "query", "description": "Profiles Registered Property" } ] }, "docs": "This will allow you to delete a preference code from a profile. For example the guest no longer has a preference for High Floor Room, so you would go ahead and delete this preference from their profile.OperationId:deletePreference
" }, { "info": { "name": "Delete a staged profile", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/profiles/:profileId/hotels/:hotelId/stagedProfile", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Profile id of staged profile." }, { "name": "hotelId", "value": "", "type": "path", "description": "Hotel id of staged profile." } ] }, "docs": "This API can be used to delete a staged profile.OperationId:deleteStagedProfile
" }, { "info": { "name": "Get linked profiles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/links", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "idType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "profileTypes", "value": "", "type": "query", "description": "The types of Profile handled by the web service." }, { "name": "accountsReceivables", "value": "", "type": "query", "description": "When true indicates that only profiles with AR account fetched." }, { "name": "corporateProfiles", "value": "", "type": "query", "description": "When true indicates that only profiles with client id are searched for." }, { "name": "excludeInactive", "value": "", "type": "query", "description": "Indicates whether to exclude Inactive Profiles, when true indicates that only profiles with active status will be displayed." }, { "name": "excludeIncompleteProfiles", "value": "", "type": "query", "description": "When true indicates that only profiles with an Address Line 1 and Country or at least one Communications Type will be displayed." }, { "name": "includeHasHierarchyOnly", "value": "", "type": "query", "description": "Include profiles that have one or more relationships in the search." }, { "name": "negotiatedRates", "value": "", "type": "query", "description": "When true indicates that this option has to be included in advanced search." }, { "name": "linkedProfileAdditionalCriteriaProfileType", "value": "", "type": "query", "description": "The types of Profile handled by the web service." }, { "name": "linkedProfileid", "value": "", "type": "query", "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." }, { "name": "linkedProfileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "linkedProfileIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "name", "value": "", "type": "query", "description": "Family name, last name or Company Name." }, { "name": "givenName", "value": "", "type": "query", "description": "Given name, first name or names." }, { "name": "excludeNoCity", "value": "", "type": "query", "description": "When true indicates that only profiles with city will be fetched." }, { "name": "cityName", "value": "", "type": "query", "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address)." }, { "name": "postalCode", "value": "", "type": "query", "description": "Post Office Code number." }, { "name": "state", "value": "", "type": "query", "description": "State or Province name (e.g., Texas)." }, { "name": "countryCode", "value": "", "type": "query", "description": "Code for a country or a nationality." }, { "name": "streetAddress", "value": "", "type": "query", "description": "First Line of Street Address. For profile search it matches the first Address line." }, { "name": "ownerCode", "value": "", "type": "query" }, { "name": "aRNumber", "value": "", "type": "query", "description": "Account Receivable associated to the profile." }, { "name": "prioritiesCode", "value": "", "type": "query" } ] }, "docs": "Retrieves profiles that are linked to an existing profile in OPERA Cloud, and maximum 1000 matching records can be fetched even if the matching records equal to or greater than 1000.OperationId:getLinkedProfiles
" }, { "info": { "name": "Get profile matches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/matches", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel Code for the profile." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "idType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "Retrieve profiles that match another profile.OperationId:getMatchProfiles
" }, { "info": { "name": "Change membership information on a profile", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/profiles/:profileId/membershipType/:membershipType/membershipId/:membershipId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path" }, { "name": "membershipType", "value": "", "type": "path" }, { "name": "profileId", "value": "", "type": "path" } ] }, "docs": "Use this API to update membership details on a profile.OperationId:changeMembership
" }, { "info": { "name": "Delete membership information from a profile", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/profiles/:profileId/membershipType/:membershipType/membershipId/:membershipId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path" }, { "name": "membershipType", "value": "", "type": "path" }, { "name": "profileId", "value": "", "type": "path" } ] }, "docs": "Use this API to delete membership details on a profile.OperationId:deleteMembership
" }, { "info": { "name": "Create membership on a profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/profiles/:profileId/memberships", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" } ] }, "docs": "A guest might be a member of your hotel loyalty program and/or a member of multiple airline frequent flier programs. Use this API to add membership details onto a guests profile.OperationId:postMembership
" }, { "info": { "name": "Get profile owners", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/owners", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "query", "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." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "Retrieve the Owners listed on a profile.OperationId:getProfileOwners
" }, { "info": { "name": "Assign profile owners", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/profiles/:profileId/owners", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" } ] }, "docs": "Assign an Owner to a profile.OperationId:postProfileOwners
" }, { "info": { "name": "Change profile owners", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/profiles/:profileId/owners", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" } ] }, "docs": "Update an Owner on a profileOperationId:changeProfileOwners
" }, { "info": { "name": "Delete a global preference from a profile", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/profiles/:profileId/preferenceType/:preferenceType/preferences/:preferenceCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "preferenceCode", "value": "", "type": "path" }, { "name": "preferenceType", "value": "", "type": "path" }, { "name": "profileId", "value": "", "type": "path" }, { "name": "registeredProperty", "value": "", "type": "query", "description": "Profiles Registered Property" } ] }, "docs": "This will allow you to delete a global preference code from a profile. For example the guest no longer has a preference for High Floor Room, so you would go ahead and delete this preference from their profile.OperationId:deleteGlobalPreference
" }, { "info": { "name": "Get preferences on a profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/preferences", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "query", "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." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "hotelId", "value": "", "type": "query", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "name": "codes", "value": "", "type": "query" } ] }, "docs": "Use this API to retrieve all preferences that a profile has stored on it. Preferences are configured codes by a property, examples are usually High Floor, Non smoking room, Room with a View, soft pillow etc.OperationId:getPreferenceForProfile
" }, { "info": { "name": "Add preferences to a profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/profiles/:profileId/preferences", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" } ] }, "docs": "You can add new preferences to a profile to personalize or enhance your guest services. You will need to know the profile ID, and the properties pre-configured preference codes.OperationId:postPreference
" }, { "info": { "name": "Distribute preferences on a profile", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/profiles/:profileId/preferences", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" } ] }, "docs": "With this API you can distribute preferences on a profile.OperationId:distributePreference
" }, { "info": { "name": "FetchProfileRelationships method provides the ability to retrieve a profile relationships for a profile based on the unique internal profile ID specified.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/relationships", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" }, { "name": "relationshipPrimaryProfile", "value": "", "type": "query", "description": "Type of Profile to be fetched from OPERA." } ] }, "docs": "OperationId:getProfileRelationships
" }, { "info": { "name": "Check future past bookings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/profiles/:profileId/reservations/action/validate", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" } ] }, "docs": "Validate if a profile has future and past bookings on a specific profile.OperationId:validateReservationsForProfile
" }, { "info": { "name": "FetchStayHistory method provides stay history and future reservations of a profile based on the unique internal ID specified.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/stayHistory", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel Code used to filter hotel specific information regarding the profile." }, { "name": "includePurgeProfiles", "value": "", "type": "query", "description": "Providing this flag includes purged profiles in the result." }, { "name": "markAsRecentlyAccessed", "value": "", "type": "query", "description": "Providing this flag marks the profile as recently accessed." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Simple type for instructions that can be used in requests for partial operations to fetch past and future reservation." } ] }, "docs": "OperationId:getStayHistory
The maximum allowable limit for this API is 200.
" }, { "info": { "name": "CreateProfileRelationship method provides the ability to create profile relationship based on the request criteria of SourceProfileID,TargetProfileID and SourceRelationType specified.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/profiles/:sourceProfileId/relationships/:targetProfileId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "targetProfileId", "value": "", "type": "path" }, { "name": "sourceProfileId", "value": "", "type": "path" } ] }, "docs": "OperationId:postProfileRelationship
" }, { "info": { "name": "ChangeProfileRelationship method provides the ability to update(delete and add) profile relationship based on the request criteria of SourceProfileID , TargetProfileID, To Be ChangedProfileID and SourceProfileRelationType specified.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/profiles/:sourceProfileId/relationships/:targetProfileId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "targetProfileId", "value": "", "type": "path" }, { "name": "sourceProfileId", "value": "", "type": "path" } ] }, "docs": "OperationId:putProfileRelationship
" }, { "info": { "name": "DeleteProfileRelationship method provides the ability to delete profile relationship based on the request criteria of SourceProfileID,TargetProfileID and SourceRelationType specified.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/profiles/:sourceProfileId/relationships/:targetProfileId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "targetProfileId", "value": "", "type": "path" }, { "name": "sourceProfileId", "value": "", "type": "path" }, { "name": "sourceRelation", "value": "", "type": "query", "description": "Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile)." }, { "name": "targetRelation", "value": "", "type": "query", "description": "Indicates the type of relationship the related profile(Target Profile) has with the current profile(Source Profile)." }, { "name": "primary", "value": "", "type": "query", "description": "Indicates if this relationship is the primary relationship." }, { "name": "sourceRelationDescription", "value": "", "type": "query", "description": "Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).This needs to be passed if the attribute primary is sent as true." }, { "name": "targetRelationDescription", "value": "", "type": "query", "description": "Displays the description of relationship the related profile(Target Profile) has with the current profile(Source Profile)." } ] }, "docs": "OperationId:removeProfileRelationship
" }, { "info": { "name": "Merge two profiles by ID", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/profiles/:survivorProfileId/merges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "survivorProfileId", "value": "", "type": "path", "description": "Original Profile ID to which profiles will be merged in OPERA." } ] }, "docs": "When you need to merge 2 guest profiles into 1 profile, use this API.OperationId:mergeProfiles
" }, { "info": { "name": "Get merge profiles snapshot", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:survivorProfileId/merges/snapshot", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "survivorProfileId", "value": "", "type": "path" }, { "name": "originalId", "value": "", "type": "query", "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." }, { "name": "originalIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "originalIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "toBeMergedId", "value": "", "type": "query", "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." }, { "name": "toBeMergedIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "toBeMergedIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "centralOriginalId", "value": "", "type": "query", "description": "A unique identifying value for a central system. The ID attribute may be used to reference a primary-key value within a central database.." }, { "name": "centralOriginalIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "centralOriginalIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "centralToBeMergedId", "value": "", "type": "query", "description": "A unique identifying value for a central system. The ID attribute may be used to reference a primary-key value within a central database." }, { "name": "centralToBeMergedIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "centralToBeMergedIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "This API will provide you with a snapshot of the to be merged profile. In the request you will pass the survivor profile, along with the profile ID of the profile which it to be merged into the survivor profile. The response will provide you with the combined profile data of both profiles which are being merged.OperationId:getMergeProfilesSnapshot
" }, { "info": { "name": "Get merge stage profile snapshot", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:survivorProfileId/stageProfiles/snapshot", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "survivorProfileId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel Code for the profile." }, { "name": "resortProfileId", "value": "", "type": "query", "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." }, { "name": "resortProfileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "resortProfileIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "profileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "This API will provide you with a snapshot of the to be merged profile in staging.OperationId:getMergeStageProfileSnapshot
" }, { "info": { "name": "Search for profile(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profilesByIds", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileIds", "value": "", "type": "query", "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." }, { "name": "corporateIds", "value": "", "type": "query", "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." }, { "name": "externalReferenceIds", "value": "", "type": "query", "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." }, { "name": "externalSystemCodes", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Room Ownership information associated with the profile." }, { "name": "instructionParameterType", "value": "", "type": "query", "description": "Simple type enumerating the different parameters accepted by a profile Instructions. Parameter names have the name of the instruction expecting it, and the parameter name itself." }, { "name": "instructionParameterValue", "value": "", "type": "query", "description": "Value of Profile Instruction Parameter" }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel Code, It is used to filter hotel specific." } ] }, "docs": "Use this API when you want to search for a profile. The response will include a list of profiles that exist in OPERA, based on your search criteria. For example, you want to see if a profile for Mr David Smith exists - you can search by various criteria, such as first, last name, email. The response will include a list of any profiles that exist for Mr Davis Smith. If a profile matches the criteria, and you want to get more details of that profile, proceed to use getProfile with the profileI" }, { "info": { "name": "Updates a list of matchIds to skip or don't skip profile match.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/profilesMatchList", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to update a list of records of profiles match to skip or don't skip profile match" }, { "info": { "name": "Get profiles match list.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profilesMatchList/profileType/:profileType", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileType", "value": "", "type": "path", "description": "Profile type of the matched profiles." }, { "name": "registeredProperty", "value": "", "type": "query", "description": "Property this profile is registered with." }, { "name": "computedDate", "value": "", "type": "query", "description": "Specific Date when the weighing points were computed for the profiles." }, { "name": "status", "value": "", "type": "query", "description": "Status of the match. It can be one of these 3 options: Match Points Computed, Do Not Merge, Can Not Merge." }, { "name": "clientID", "value": "", "type": "query", "description": "Corporate id of the profile." }, { "name": "surname", "value": "", "type": "query", "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." }, { "name": "givenName", "value": "", "type": "query", "description": "Given name, first name or names." }, { "name": "doNotMerge", "value": "", "type": "query", "description": "If this value is true, then the response will return profiles that have been selected as Do Not Merge." }, { "name": "aboveUpperThreshold", "value": "", "type": "query", "description": "If this value is true, then the response will return profiles with weighing points that are higher than the upper threshold." }, { "name": "belowUpperThreshold", "value": "", "type": "query", "description": "If this value is true, then the response will return profiles with weighing points that are below the upper threshold." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "This API provides list of matching profiles based on the profile match configuration. These profiles are matched based on address, Postal codes, Last Name etc.OperationId:getProfilesMatchList
The maximum allowable limit for this API is 200.
" }, { "info": { "name": "Re-Process all Stage Records", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/reProcessStageRecords", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to Re-Process all Stage Records.OperationId:reProcessStageRecords
" }, { "info": { "name": "Get reProcess stage records logs.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reProcessStageRecords/logs", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "fromDate", "value": "", "type": "query", "description": "Fetch logs from this date (inclusive)." }, { "name": "users", "value": "", "type": "query", "description": "User(s) who initiated the process. Can be comma separated or supplied as multiple params." }, { "name": "jobId", "value": "", "type": "query", "description": "Job ID to fetch logs for a specific process/job." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records this api should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Use this API to fetch logs for reProcess and rematch operations. The log can be filtered by date, users, and job ID.OperationId:getReProcessStageRecordsLogs
" }, { "info": { "name": "Fetch recently accessed profiles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/recentlyAccessedProfiles", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "accessDate", "value": "", "type": "query", "description": "Indicates which date reservations to be returned" } ] }, "docs": "Use this API to fetch the profiles that have recently been accessed by an application user.OperationId:getRecentlyAccessedProfiles
" }, { "info": { "name": "Operation to delete cache for Profile service", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/service/profileService/cache", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "OperationId:clearProfileServiceCache
" }, { "info": { "name": "Operation to check the status of profile service", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/services/profile/status", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "OperationId:pingProfileService
" }, { "info": { "name": "Get a staged profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/stagedProfile/:id", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "query", "description": "The hotel code that the stage profile belongs to." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "If selected, only invalid details of the staged profile will be retrieved." } ] }, "docs": "The system suspends / stages a profile with a point value between the upper and lower thresholds. When a profile is staged, you must review the suspended profile and determine if it should be merged with an internal profile or added as a new profile. This API will get a specific profile that has been staged.OperationId:getStagedProfile
" }, { "info": { "name": "Change a staged profile", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/stagedProfile/:id", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "This API can be used to update the staged Profile.OperationId:changeStagedProfile
" }, { "info": { "name": "Get staged profiles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/stagedProfiles", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." }, { "name": "hotelIds", "value": "", "type": "query" }, { "name": "stagedReasons", "value": "", "type": "query", "description": "This can be used to fetch staged profiles based on the reason why it got staged Ex : NameChange" }, { "name": "id", "value": "", "type": "query", "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." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "name", "value": "", "type": "query", "description": "Family name, last name or Company Name." }, { "name": "givenName", "value": "", "type": "query", "description": "Given name, first name or names." }, { "name": "region", "value": "", "type": "query", "description": "The profile region for which the staged profiles shall be fetched." }, { "name": "countryCode", "value": "", "type": "query", "description": "Code for a country or a nationality." }, { "name": "profileType", "value": "", "type": "query", "description": "Profile type to be included in the search." }, { "name": "importDate", "value": "", "type": "query", "description": "The date on which the staged profiles have been received. This parameter is deprecated. " }, { "name": "stageStatus", "value": "", "type": "query", "description": "The status of the staged profiles." }, { "name": "applyTo", "value": "", "type": "query", "description": "Membership filter of staged profiles." }, { "name": "membershipCodes", "value": "", "type": "query" }, { "name": "insertDateFrom", "value": "", "type": "query", "description": "Accepts a date value and retrieves all the suspended profiles inserted on or after the provided date." }, { "name": "insertDateTo", "value": "", "type": "query", "description": "Accepts a date value and retrieves all the suspended profiles inserted up to and including the specified date." }, { "name": "membershipNumber", "value": "", "type": "query", "description": " Accepts a membership number and retrieves the suspended profile(s) associated with the provided code." }, { "name": "clientID", "value": "", "type": "query", "description": "Accepts a client ID number and retrieves the suspended profile(s) associated with the provided code." }, { "name": "errorDescription", "value": "", "type": "query", "description": "The error description for the staged profile." } ] }, "docs": "The system suspends / stages a profile with a point value between the upper and lower thresholds. When a profile is staged, you must review the suspended profile and determine if it should be merged with an internal profile or added as a new profile.OperationId:getStagedProfiles
The maximum allowable limit for this API is 200.
" }, { "info": { "name": "Get staged profiles", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/stagedProfiles/searches", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "The system suspends / stages a profile with a point value between the upper and lower thresholds. When a profile is staged, you must review the suspended profile and determine if it should be merged with an internal profile or added as a new profile.OperationId:searchStagedProfiles
The maximum allowable limit for this API is 200.
" }, { "info": { "name": "This API facilitates attaching or replacing a membership to a given stayRecord.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/stayMembership", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "A user can add a new membership or substitute an existing membership for a stay record by providing the relevant membership information in the request.OperationId:addReplaceStayMembership
" }, { "info": { "name": "This API facilitates uploading stage records to LCS.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/stayRecord", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "A user can upload stay record to OPERA by specifying stay record column details in the request.OperationId:postStayRecord
" }, { "info": { "name": "Get Stay Record Detail.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/stayRecord/:stayRecordId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "stayRecordId", "value": "", "type": "path", "description": "A unique identifying value of the stay record, assigned by the creating system." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Fetch instructions that can be used to fetch required stay record details." } ] }, "docs": "This API is used to retrieve details of a given stay record (including UDFs, Daily Rates and Revenue).OperationId:getStayRecordDetail
" }, { "info": { "name": "Ability to edit Orphan Stay Records", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/stayRecords/:stayRecordId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "stayRecordId", "value": "", "type": "path", "description": "Unique OPERA internal Orphan Stay Record Id which is used to find the Orphan Stay Record." } ] }, "docs": "This API allows user to edit Orphan Stay Record fields.OperationId:putOrphanStayRecords
" }, { "info": { "name": "Fetch Suspended Profile Addresses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/suspendedAddresses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "query", "description": "Last Name of the Profile against which the Suspended Addresses are fetched." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel Code, It is used to filter hotel specific children to this specific hotel code." }, { "name": "firstName", "value": "", "type": "query", "description": "First Name of the Profile against which the Suspended Addresses are fetched." }, { "name": "profileType", "value": "", "type": "query", "description": "ProfileT ype of the Profile against which the Suspended Addresses are fetched.." }, { "name": "matchCode", "value": "", "type": "query", "description": "Match Code of the Address Validation Performed from the batch processing" }, { "name": "countryCode", "value": "", "type": "query", "description": "Code for a country or a nationality." }, { "name": "validateDate", "value": "", "type": "query", "description": "Validate Date." } ] }, "docs": "Fetch Suspended Profile AddressesOperationId:getSuspendedAddresses
The maximum allowable limit for this API is 200.
" }, { "info": { "name": "Get suspended profiles errors summary details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/suspendedProfiles/errorsSummary", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "insertDate", "value": "", "type": "query", "description": "Fetch the statistics from this date." }, { "name": "hotelIds", "value": "", "type": "query", "description": "Hotel codes of the profile's origin." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records this api should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Retrieve the suspended profiles errors summary detailsOperationId:getSuspendedProfilesErrorsSummary
" }, { "info": { "name": "Get suspended profiles match errors summary information grouped by profile type.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/suspendedProfiles/errorsSummary/profileType", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "insertDate", "value": "", "type": "query", "description": "Fetch the statistics from this date." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records this api should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Use this api to get the profiles match errors summary grouped by profile typeOperationId:getSuspendedProfilesErrorsSummaryByProfileType
" }, { "info": { "name": "Get suspended profiles match errors summary information grouped by property.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/suspendedProfiles/errorsSummary/property", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "insertDate", "value": "", "type": "query", "description": "Fetch the statistics from this date." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records this api should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Use this api to get the profiles match errors summary to see the count of errors appears in each property.OperationId:getSuspendedProfilesErrorsStatByProperty
" }, { "info": { "name": "Get suspended profiles match errors summary information grouped by property.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/suspendedProfiles/errorsSummary/property", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this api to get the profiles match errors summary for a specific error and see the number of times it appears in each property.OperationId:getSuspendedProfilesErrorsSummaryByProperty
" }, { "info": { "name": "Get suspended profile match statistics information.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/suspendedProfiles/matchStats", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "query", "description": "Hotel code of the profile's origin." }, { "name": "profileType", "value": "", "type": "query", "description": "Profile type of the profile matched." }, { "name": "insertDateFrom", "value": "", "type": "query", "description": "Fetch the statistics from this date." }, { "name": "insertDateTo", "value": "", "type": "query", "description": "Fetch the statistics up to this date." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records this api should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Retrieve the suspended profile match statistics information.OperationId:getSuspendedProfilesMatchStats
" }, { "info": { "name": "Get suspended profiles match statistics information grouped by match criteria.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/suspendedProfiles/matchStats/matchCriteria", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records this api should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Use this api to get the profile match statistics grouped by match criteria.OperationId:getSuspendedProfilesMatchStatsByMatchCriteria
" }, { "info": { "name": "Get suspended profiles match statistics information grouped by profile type.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/suspendedProfiles/matchStats/profileType", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "insertDate", "value": "", "type": "query", "description": "Fetch the statistics from this date." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records this api should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Use this api to get the profiles match statistics grouped by profile type.OperationId:getSuspendedProfilesMatchStatsByProfileType
" }, { "info": { "name": "Get suspended profiles match statistics information grouped by property.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/suspendedProfiles/matchStats/property", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "insertDate", "value": "", "type": "query", "description": "Fetch the statistics from this date." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records this api should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Use this api to get the profiles match statistics grouped by property.OperationId:getSuspendedProfilesMatchStatsByProperty
" }, { "info": { "name": "Get suspended profiles match statistics information grouped by property and profile type.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/suspendedProfiles/matchStats/propertyAndProfileType", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "insertDate", "value": "", "type": "query", "description": "Fetch the statistics from this date." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records this api should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Use this api to get the profiles match statistics grouped by property and profile type.OperationId:getSuspendedProfilesMatchStatsByPropertyAndProfileType
" }, { "info": { "name": "Get suspended profiles match statistics summary information filtering by threshold type.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/suspendedProfiles/matchStats/threshold", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "regionCode", "value": "", "type": "query", "description": "Profile region." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel id of the profile's origin." }, { "name": "threshold", "value": "", "type": "query", "description": "Returns the matches that are either upper, lower or between the threshold." }, { "name": "profileType", "value": "", "type": "query", "description": "Name type of the profile matched." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records this api should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Use this api to get the profiles match statistics filtered by region, name type and threshold type.OperationId:getSuspendedProfilesMatchStatsByThreshold
" }, { "info": { "name": "Synchronize profile subscriptions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/synchronizeProfileSubscriptions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Synchronize profile subscriptionsOperationId:synchronizeProfileSubscriptions
" }, { "info": { "name": "Validate forget profiles", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/validateForgetProfiles", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Validate forget profiles.OperationId:validateForgetProfiles
" } ] }, { "info": { "name": "ProfileMembership", "type": "folder" }, "items": [ { "info": { "name": "Get airline transactions status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/airline/transactions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." }, { "name": "batchId", "value": "", "type": "query", "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." }, { "name": "batchIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "importDate", "value": "", "type": "query", "description": "The date when this batch was imported into OPERA" } ] }, "docs": "Request for fetching membership transactions processed by the airline.OperationId:getAirlineTransactionsStatus
The maximum allowable limit for this API is 200.
" }, { "info": { "name": "Get Available Awards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/availableAwardsBasedOnType", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "awardBasedOn", "value": "", "type": "query", "description": "This award allows a guest to apply available membership points towards the balance of his or her bill." }, { "name": "membershipType", "value": "", "type": "query", "description": "Membership type for which awards are defined." }, { "name": "rateCriteriaHotelId", "value": "", "type": "query", "description": "Hotel name where the award will be consumed." }, { "name": "arrivalDate", "value": "", "type": "query", "description": "Arrival date of the reservation associated with the award." }, { "name": "departureDate", "value": "", "type": "query", "description": "Departure date of the reservation associated with the award." }, { "name": "bookingDate", "value": "", "type": "query", "description": "Booking date of the reservation associated with the award." }, { "name": "pointsBelow", "value": "", "type": "query", "description": "Minimum number of points the member is willing to redeem." }, { "name": "pointsAbove", "value": "", "type": "query", "description": "Maximum number of points the member is willing to redeem." }, { "name": "rateCode", "value": "", "type": "query", "description": "Indicates rate code for the room type." }, { "name": "roomCategory", "value": "", "type": "query", "description": "Indicates which room category it belongs." }, { "name": "rooms", "value": "", "type": "query", "description": "Number of rooms that the member will be using." }, { "name": "awardType", "value": "", "type": "query", "description": "Indicates the award type or code." }, { "name": "productCriteriaMembershipType", "value": "", "type": "query", "description": "Membership type for which awards are defined." }, { "name": "productCriteriaHotelId", "value": "", "type": "query", "description": "Hotel name where the award will be consumed." }, { "name": "productCriteriaArrivalDate", "value": "", "type": "query", "description": "Arrival date of the reservation associated with the award." }, { "name": "productCriteriaDepartureDate", "value": "", "type": "query", "description": "Departure date of the reservation associated with the award." }, { "name": "productCriteriaBookingDate", "value": "", "type": "query", "description": "Booking date of the reservation associated with the award." }, { "name": "productCriteriaPointsBelow", "value": "", "type": "query", "description": "Minimum number of points the member is willing to redeem." }, { "name": "productCriteriaPointsAbove", "value": "", "type": "query", "description": "Maximum number of points the member is willing to redeem." }, { "name": "packageCode", "value": "", "type": "query", "description": "Package/Product code for the award to check availability." }, { "name": "upgradeCriteriaMembershipType", "value": "", "type": "query", "description": "Membership type for which awards are defined." }, { "name": "upgradeCriteriaHotelId", "value": "", "type": "query", "description": "Hotel name where the award will be consumed." }, { "name": "upgradeCriteriaArrivalDate", "value": "", "type": "query", "description": "Arrival date of the reservation associated with the award." }, { "name": "upgradeCriteriaDepartureDate", "value": "", "type": "query", "description": "Departure date of the reservation associated with the award." }, { "name": "upgradeCriteriaBookingDate", "value": "", "type": "query", "description": "Booking date of the reservation associated with the award." }, { "name": "upgradeCriteriaPointsBelow", "value": "", "type": "query", "description": "Minimum number of points the member is willing to redeem." }, { "name": "upgradeCriteriaPointsAbove", "value": "", "type": "query", "description": "Maximum number of points the member is willing to redeem." }, { "name": "fromRoomCategory", "value": "", "type": "query", "description": "Indicates availability of upgrade awards based on the room type(range of room types )" }, { "name": "toRoomCategory", "value": "", "type": "query", "description": "Indicates availability of upgrade awards based on the room type(range of room types )" }, { "name": "upgradeCriteriaRooms", "value": "", "type": "query", "description": "Number of rooms that the member will be using." }, { "name": "upgradeCriteriaAwardType", "value": "", "type": "query", "description": "Indicates the award type or code." }, { "name": "awardCode", "value": "", "type": "query", "description": "Unique code identifying the Award." }, { "name": "totalBillingAmount", "value": "", "type": "query", "description": "Total amount for the bill." }, { "name": "currencyCode", "value": "", "type": "query", "description": "The currency code for the member." }, { "name": "fTPaymentCriteriaPointsBelow", "value": "", "type": "query", "description": "Minimum number of points the member is willing to redeem." }, { "name": "fTPaymentCriteriaPointsAbove", "value": "", "type": "query", "description": "Maximum number of points the member is willing to redeem." }, { "name": "otherCriteriaAwardCode", "value": "", "type": "query", "description": "Unique code identifying the award." }, { "name": "otherCriteriaMembershipType", "value": "", "type": "query", "description": "Membership type for which awards are defined." }, { "name": "membershipLevel", "value": "", "type": "query", "description": "Level of this Membership Type." }, { "name": "shortDescription", "value": "", "type": "query", "description": "Name or code identifying the award." }, { "name": "valueBelow", "value": "", "type": "query", "description": "Amount of currency of the worth of the other award,below or actual value." }, { "name": "valueAbove", "value": "", "type": "query", "description": "Amount of currency of the worth of the other award,above or actual value." }, { "name": "otherCriteriaPointsBelow", "value": "", "type": "query", "description": "Minimum number of points the member is willing to redeem." }, { "name": "otherCriteriaPointsAbove", "value": "", "type": "query", "description": "Maximum number of points the member is willing to redeem." } ] }, "docs": "Get available awards based on type of award selected like Rates, products or services, room type upgrades, and other gifts.OperationId:getAvailableAwardsBasedOnType
This API allows a time span of 90 days.
" }, { "info": { "name": "Delete Awards", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/awards", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "awardNumber", "value": "", "type": "query", "description": "An identifying number of the award, assigned by the system when the award was issued." }, { "name": "reservationCancellationNumber", "value": "", "type": "query", "description": "Identifies reservation cancellation number." }, { "name": "actualCancelPoints", "value": "", "type": "query", "description": "The amount of points that will be deducted for cancelling the award, from the total guest award points." } ] }, "docs": "Operation to cancel an award already been granted to a member.OperationId:deleteAwards
" }, { "info": { "name": "Get Awards to Grant", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/awardsToGrant", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "awardBasedOn", "value": "", "type": "query", "description": "This award allows a guest to apply available membership points towards the balance of his or her bill." }, { "name": "totalPointsRequired", "value": "", "type": "query", "description": "The number of points that must be redeemed for this award." }, { "name": "rooms", "value": "", "type": "query", "description": "Number of rooms that the member will be using." }, { "name": "membershipId", "value": "", "type": "query", "description": "Unique Membership ID to get award info." }, { "name": "membershipType", "value": "", "type": "query", "description": "Membership type for which awards are defined." }, { "name": "awardType", "value": "", "type": "query", "description": "Indicates the award type or code." }, { "name": "grantAwardInfoHotelId", "value": "", "type": "query", "description": "HotelCode where the award will be consumed." }, { "name": "rateCode", "value": "", "type": "query", "description": "Rate code associated with the award." }, { "name": "roomCategory", "value": "", "type": "query", "description": "Indicates which room category it belongs." }, { "name": "fromRoom", "value": "", "type": "query", "description": "Indicates room type code for the room prior to the upgrade." }, { "name": "toRoom", "value": "", "type": "query", "description": "Indicates room type code of the upgrade room." } ] }, "docs": "Fetch awards list to be able to grant the award to a memberOperationId:getAwardsToGrant
" }, { "info": { "name": "Create an Enrollment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/enrollments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API when you have a guest profile and you want to enroll that guest profile into a membership program in an external system.OperationId:postEnrollment
" }, { "info": { "name": "Get Membership Issued awards points ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/memberships/:membershipId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "Get a memberships issued awards points per property.OperationId:getMembershipAwardPointsByHotel
" }, { "info": { "name": "Issue an OTHER type award ", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issueOtherAwards", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "This API will allow you to issue OTHER type award based on membership id or membership type and membership card numberOperationId:issueOtherAwards
" }, { "info": { "name": "Get primary membership history details of a guest.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/memberHistory", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "query", "description": "Membership Id of the member required to fetch the member history." }, { "name": "actionType", "value": "", "type": "query", "description": "Type of action related to changes in a profile's primary membership." }, { "name": "fromDate", "value": "", "type": "query", "description": "The date from which we want to see changes to membership" }, { "name": "toDate", "value": "", "type": "query", "description": "The date till which we want to see changes to membership" }, { "name": "user", "value": "", "type": "query", "description": "The user who modified profile's primary membership." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Use this API to retrieve primary membership history details of a profile.OperationId:getMembershipCardHistory
" }, { "info": { "name": "Get membership claims", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/membershipClaims", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "query", "description": "Id to get the claims." }, { "name": "profileId", "value": "", "type": "query", "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." }, { "name": "profileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "name", "value": "", "type": "query", "description": "Family name, last name or Company Name." }, { "name": "givenName", "value": "", "type": "query", "description": "Given name, first name or names." }, { "name": "membershipType", "value": "", "type": "query", "description": "Membership Type code." }, { "name": "claimType", "value": "", "type": "query", "description": "Type of user-definable claim to be searched." }, { "name": "source", "value": "", "type": "query", "description": "Source of the membership claim." }, { "name": "owner", "value": "", "type": "query", "description": "Unique application user ID of the person responsible for handling the claim." }, { "name": "claimNumber", "value": "", "type": "query", "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." }, { "name": "claimNoContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "claimNoType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "hotelId", "value": "", "type": "query", "description": "Property where the stay took place." }, { "name": "confirmationNo", "value": "", "type": "query", "description": "Reservation confirmation or booking reference number." }, { "name": "submitter", "value": "", "type": "query", "description": "Application user ID of the user who entered the claim." }, { "name": "claimStatus", "value": "", "type": "query", "description": "Status of the claim.(Open, Waiting for Manager, etc.)" }, { "name": "closeDateEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "closeDateStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "claimDateEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "claimDateStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "replyByEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "replyByStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "arrivalEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "arrivalStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "departureEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "departureStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "approvalStatus", "value": "", "type": "query", "description": "Claim approve or reject status." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Retrieve available membership claims without specifying the membership ID.OperationId:getAllMembershipClaims
This API allows a time span of 90 days.
" }, { "info": { "name": "Create membership Claim", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/membershipClaims", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "This will create membership claim details based on the claim number and instructions provided in the request.OperationId:postMembershipClaim
" }, { "info": { "name": "Get membership claim ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/membershipClaims/:claimId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "claimId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "query", "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." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Simple type for membership claim instructions that can be used in requests for partial operations." } ] }, "docs": "Get membership claim details based on the claim number and instructions provided in the request.OperationId:getMembershipClaim
" }, { "info": { "name": "Change membership Claim", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/membershipClaims/:claimId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "claimId", "value": "", "type": "path" } ] }, "docs": "Change membership claim details based on the claim number and instructions provided in the request.OperationId:changeMembershipClaim
" }, { "info": { "name": "Calculate Membership Points", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/membershipPoints/calculations", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Start Membership Points Calculation processOperationId:calculateMembershipPoints
" }, { "info": { "name": "Get membership points exception details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/membershipPointsExceptions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "query", "description": "Membership transaction belongs to which Hotel." }, { "name": "profileId", "value": "", "type": "query", "description": "Profile Id of the guest." }, { "name": "arrivalFrom", "value": "", "type": "query", "description": "Arrival From Date to fetch the reservations flagged for Membership Points Exception" }, { "name": "departureTo", "value": "", "type": "query", "description": "Departure To Date to fetch the reservation flagged for Membership Points Exception" }, { "name": "membershipType", "value": "", "type": "query", "description": "The type of the membership." }, { "name": "membershipLevel", "value": "", "type": "query", "description": "The current level of the membership." }, { "name": "membershipCardNo", "value": "", "type": "query", "description": "The card number associated with this membership." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." }, { "name": "exceptionStatus", "value": "", "type": "query", "description": "Indicates the type of Exception like Exception not resolved,Points Rejected on Exception etc.," } ] }, "docs": "Use this API to get membership points exceptions.OperationId:getMembershipPointsExceptions
OperationId:putMembershipPointsExceptions
" }, { "info": { "name": "Get Membership Reservation Activity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/membershipReservationActivity", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelIds", "value": "", "type": "query", "description": "Unique ID of the hotels to fetch the membership reservation activity." }, { "name": "propertyDate", "value": "", "type": "query", "description": "Business Date of the property selected." }, { "name": "roomClasses", "value": "", "type": "query", "description": "Room Classes required to fetch the membership reservation activity." }, { "name": "membershipType", "value": "", "type": "query", "description": "Membership Type required to fetch the membership reservation activity." } ] }, "docs": "This API is useful to retrieve membership reservation activity for the day(ExpectedArrival, ExpectedDepartures, InHouse, Projected Room Revenue)OperationId:getMembershipReservationActivity
" }, { "info": { "name": "Get a membership transaction", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/membershipTransactions/:membershipTransactionId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipTransactionId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "query", "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." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "Retrieve membership transactions.OperationId:getMembershipTransaction
" }, { "info": { "name": "Fetch the Award Points Accrued for the current points transaction.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/membershipTransactions/:membershipTransactionId/awardPoints", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipTransactionId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Retrieves the validated rule used to generate award points, the type of points, number of points, cost per point, rule code for the award points, billing group the points belong.OperationId:getMembershipTransactionAwardPoints
The maximum allowable limit for this API is 200.
" }, { "info": { "name": "Fetch the reason points were not awarded for a given points transaction.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/membershipTransactions/:membershipTransactionId/pointRejectionReasons", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipTransactionId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Retrieves the rule used to generate points and the reason the points were not awarded (validation failure, for e.g.'Membership level requirements not met').OperationId:getMembershipTransactionPointsRejectionReasons
The maximum allowable limit for this API is 200.
" }, { "info": { "name": "Fetch the rate details associated to current points transaction.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/membershipTransactions/:membershipTransactionId/rates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipTransactionId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Retrieves the dates of the stay, the rate code, the PMS rate amount, the central rate amount, the central currency and the market code associated with the stay.OperationId:getMembershipTransactionRates
The maximum allowable limit for this API is 200.
" }, { "info": { "name": "Fetch the revenue details for the stay associated with current point transaction.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/membershipTransactions/:membershipTransactionId/revenue", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipTransactionId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Retrieves the date the revenue was recognized, the revenue type (PMS revenue buckets are seen as revenue types in ORS), PMS revenue and centralOperationId:getMembershipTransactionRevenue
The maximum allowable limit for this API is 200.
" }, { "info": { "name": "Fetch the Tier Points Accrued for the current points transaction", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/membershipTransactions/:membershipTransactionId/tierPoints", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipTransactionId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Retrieves the validated rule used to generate tier points, the type of points, number of points, cost per point, rule code for the award points, billing group the points belong.OperationId:getMembershipTransactionTierPoints
The maximum allowable limit for this API is 200.
" }, { "info": { "name": "Export Membership Award", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/memberships/:membershipId/award", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path" }, { "name": "rateInfoHotelId", "value": "", "type": "query", "description": "HotelCode where the award will be consumed." }, { "name": "totalAvailablePoints", "value": "", "type": "query", "description": "Total award points available for redemption." }, { "name": "pointsRequired", "value": "", "type": "query", "description": "The number of points that must be redeemed for this award." }, { "name": "cancelPenaltyPoints", "value": "", "type": "query", "description": "The award points that will be forfeited if the cancel penalty charge is applied." }, { "name": "cancelPenaltyDays", "value": "", "type": "query", "description": "Number of days before arrival when a reservation may be cancelled without an award points penalty." }, { "name": "cancelPenaltyCharge", "value": "", "type": "query", "description": "The cancel penalty charge." }, { "name": "cancelPenaltyType", "value": "", "type": "query", "description": "The penalty charge is either a percentage or a flat number of points." }, { "name": "rawIssueKey", "value": "", "type": "query", "description": "Issue key in format of Raw data." }, { "name": "awardNumber", "value": "", "type": "query", "description": "An identifying number of the award, assigned by the system when the award was issued." }, { "name": "rateCode", "value": "", "type": "query", "description": "Rate code associated with the award." }, { "name": "rateDescription", "value": "", "type": "query", "description": "Rate code description associated with the award." }, { "name": "roomLabel", "value": "", "type": "query", "description": "Code for the room type in which the award was issued." }, { "name": "roomDescription", "value": "", "type": "query", "description": "Description of the Room." }, { "name": "roomCategory", "value": "", "type": "query", "description": "Indicates which room category it belongs." }, { "name": "stayDate", "value": "", "type": "query", "description": "The date of the reservation associated with the award. There may be more than one date (multiple nights) associated with award." }, { "name": "awardType", "value": "", "type": "query", "description": "Unique code that identifies this award." }, { "name": "productInfoHotelId", "value": "", "type": "query", "description": "HotelCode where the award will be consumed." }, { "name": "productInfoTotalAvailablePoints", "value": "", "type": "query", "description": "Total award points available for redemption." }, { "name": "productInfoPointsRequired", "value": "", "type": "query", "description": "The number of points that must be redeemed for this award." }, { "name": "productInfoCancelPenaltyPoints", "value": "", "type": "query", "description": "The award points that will be forfeited if the cancel penalty charge is applied." }, { "name": "productInfoCancelPenaltyDays", "value": "", "type": "query", "description": "Number of days before arrival when a reservation may be cancelled without an award points penalty." }, { "name": "productInfoCancelPenaltyCharge", "value": "", "type": "query", "description": "The cancel penalty charge." }, { "name": "productInfoCancelPenaltyType", "value": "", "type": "query", "description": "The penalty charge is either a percentage or a flat number of points." }, { "name": "productInfoRawIssueKey", "value": "", "type": "query", "description": "Issue key in format of Raw data." }, { "name": "productInfoAwardNumber", "value": "", "type": "query", "description": "An identifying number of the award, assigned by the system when the award was issued." }, { "name": "packageCode", "value": "", "type": "query", "description": "Package/Product code for the award ." }, { "name": "packageDescription", "value": "", "type": "query", "description": "Description of the product." }, { "name": "awardValidFrom", "value": "", "type": "query", "description": "The valid time period from when the award can be issued." }, { "name": "awardValidTo", "value": "", "type": "query", "description": "The valid time to an issued award." }, { "name": "upgradeInfoAwardType", "value": "", "type": "query", "description": "Unique code that identifies this award." }, { "name": "upgradeInfoHotelId", "value": "", "type": "query", "description": "HotelCode where the award will be consumed." }, { "name": "upgradeInfoTotalAvailablePoints", "value": "", "type": "query", "description": "Total award points available for redemption." }, { "name": "upgradeInfoPointsRequired", "value": "", "type": "query", "description": "The number of points that must be redeemed for this award." }, { "name": "upgradeInfoCancelPenaltyPoints", "value": "", "type": "query", "description": "The award points that will be forfeited if the cancel penalty charge is applied." }, { "name": "upgradeInfoCancelPenaltyDays", "value": "", "type": "query", "description": "Number of days before arrival when a reservation may be cancelled without an award points penalty." }, { "name": "upgradeInfoCancelPenaltyCharge", "value": "", "type": "query", "description": "The cancel penalty charge." }, { "name": "upgradeInfoCancelPenaltyType", "value": "", "type": "query", "description": "The penalty charge is either a percentage or a flat number of points." }, { "name": "upgradeInfoRawIssueKey", "value": "", "type": "query", "description": "Issue key in format of Raw data." }, { "name": "upgradeInfoAwardNumber", "value": "", "type": "query", "description": "An identifying number of the award, assigned by the system when the award was issued." }, { "name": "fromRoomCategory", "value": "", "type": "query", "description": "Indicates room type code for the room prior to the upgrade." }, { "name": "toRoomCategory", "value": "", "type": "query", "description": "Indicates room type code of the upgrade room." }, { "name": "fromRoomDescription", "value": "", "type": "query", "description": "Indicates room type Description for the room prior to the upgrade." }, { "name": "toRoomDescription", "value": "", "type": "query", "description": "Indicates room type Description of the upgrade room." }, { "name": "fromRoom", "value": "", "type": "query", "description": "Indicates room type code for the room prior to the upgrade." }, { "name": "toRoom", "value": "", "type": "query", "description": "Indicates room type code of the upgrade room." }, { "name": "upgradeInfoStayDate", "value": "", "type": "query", "description": "The date of the reservation associated with the award. There may be more than one date (multiple nights) associated with award." }, { "name": "otherInfoAwardType", "value": "", "type": "query", "description": "Unique code that identifies this award." }, { "name": "sellBeginDate", "value": "", "type": "query", "description": "Beginning date of the award." }, { "name": "sellEndDate", "value": "", "type": "query", "description": "End date that the award will be available." }, { "name": "shortDescription", "value": "", "type": "query", "description": "Descriptive name of the award." }, { "name": "awardValue", "value": "", "type": "query", "description": "The actual value of the award, in the amount of currency." }, { "name": "otherInfoTotalAvailablePoints", "value": "", "type": "query", "description": "Total award points available for redemption." }, { "name": "otherInfoPointsRequired", "value": "", "type": "query", "description": "The number of points that must be redeemed for this award." }, { "name": "longDescription", "value": "", "type": "query", "description": "Detail description of the award." }, { "name": "otherInfoAwardNumber", "value": "", "type": "query", "description": "An identifying number of the award, assigned by the system when the award was issued." }, { "name": "issueAwardsHotelId", "value": "", "type": "query", "description": "HotelCode where the award will be consumed." }, { "name": "externalReservationNumber", "value": "", "type": "query", "description": "PMS Reservation number." }, { "name": "confirmationBookingNumber", "value": "", "type": "query", "description": "ORS Booking number." }, { "name": "awardSource", "value": "", "type": "query", "description": "The source for the reservation associated with the award." }, { "name": "arrivalDate", "value": "", "type": "query", "description": "Arrival date of the reservation associated with the award." }, { "name": "departureDate", "value": "", "type": "query", "description": "Departure date of the reservation associated with the award." }, { "name": "exportInfoAwardNumber", "value": "", "type": "query", "description": "Award Number to identify member's information." }, { "name": "nameType", "value": "", "type": "query", "description": "Person's name in an external system." }, { "name": "name", "value": "", "type": "query", "description": "Family name, last name or Company Name." }, { "name": "fullName", "value": "", "type": "query", "description": "Full display Name." }, { "name": "namePrefix", "value": "", "type": "query", "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)" }, { "name": "givenName", "value": "", "type": "query", "description": "Given name, first name or names." }, { "name": "middleName", "value": "", "type": "query", "description": "The middle name of the person name." }, { "name": "nameSuffix", "value": "", "type": "query", "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)" }, { "name": "nameTitle", "value": "", "type": "query", "description": "Degree or honors (e.g., Ph.D., M.D.)" }, { "name": "phoneNumber", "value": "", "type": "query", "description": "Phone number" }, { "name": "companyName", "value": "", "type": "query", "description": "It returns a Company Name,If the member is associated with a company." }, { "name": "id", "value": "", "type": "query", "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." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "idType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "barCode", "value": "", "type": "query", "description": "The postal barcode for the address." }, { "name": "createDateTime", "value": "", "type": "query", "description": "Time stamp of the creation." }, { "name": "creatorId", "value": "", "type": "query", "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation." }, { "name": "lastModifierId", "value": "", "type": "query", "description": "Identifies the last software system or person to modify a record." }, { "name": "lastModifyDateTime", "value": "", "type": "query", "description": "Time stamp of last modification." }, { "name": "primaryInd", "value": "", "type": "query", "description": "When true, indicates a primary information." }, { "name": "purgeDate", "value": "", "type": "query", "description": "Date an item will be purged from a database (e.g., from a live database to an archive)." }, { "name": "type", "value": "", "type": "query", "description": "Defines the type of address (e.g. home, business, other)." }, { "name": "typeDescription", "value": "", "type": "query", "description": "Describes the type code" }, { "name": "updateReservations", "value": "", "type": "query", "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." }, { "name": "addressLine", "value": "", "type": "query", "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." }, { "name": "cityName", "value": "", "type": "query", "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address)." }, { "name": "postalCode", "value": "", "type": "query", "description": "Post Office Code number." }, { "name": "cityExtension", "value": "", "type": "query", "description": "Post Office City Extension Code number. City Extension mainly used for UK addresses." }, { "name": "county", "value": "", "type": "query", "description": "County or District Name (e.g., Fairfax). Currently this attribute is not used." }, { "name": "state", "value": "", "type": "query", "description": "State or Province name (e.g., Texas)." }, { "name": "code", "value": "", "type": "query", "description": "Code for a country or a nationality." }, { "name": "language", "value": "", "type": "query", "description": "Language code associated with the address" }, { "name": "characterUDFsAltName", "value": "", "type": "query", "description": "Label of user defined field used by vendors or customers." }, { "name": "characterUDFsName", "value": "", "type": "query", "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." }, { "name": "characterUDFsValue", "value": "", "type": "query", "description": "Value of user defined field." }, { "name": "NumericUDFsAltName", "value": "", "type": "query", "description": "Label of user defined field used by vendors or customers." }, { "name": "NumericUDFsName", "value": "", "type": "query", "description": "Name of user defined field." }, { "name": "NumericUDFsValue", "value": "", "type": "query", "description": "Value of user defined field." }, { "name": "DateUDFsAltname", "value": "", "type": "query", "description": "Label of user defined field used by vendors or customers." }, { "name": "DateUDFsName", "value": "", "type": "query", "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." }, { "name": "DateUDFsValue", "value": "", "type": "query", "description": "Value of user defined field." } ] }, "docs": "Export members information for Fulfillment house processingOperationId:exportMembershipAward
This API allows a time span of 90 days.
" }, { "info": { "name": "Get Membership Award Export Information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/memberships/:membershipId/awardExports", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path" }, { "name": "awardNumber", "value": "", "type": "query", "description": "Award Number to identify member's information." } ] }, "docs": "Get members information for Fulfillment house processingOperationId:getMembershipAwardExportInfo
" }, { "info": { "name": "Get Membership Award list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/memberships/:membershipId/awards", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path" }, { "name": "membershipType", "value": "", "type": "query", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "name": "hotelBookingNumber", "value": "", "type": "query", "description": "Confirmation Number attached " }, { "name": "hotelId", "value": "", "type": "query", "description": "Award Code belongs to which Hotel." }, { "name": "awardCode", "value": "", "type": "query", "description": "Unique code identifying the award." }, { "name": "awardNumber", "value": "", "type": "query", "description": "Award Id for identifying the award." }, { "name": "awardBasedOn", "value": "", "type": "query", "description": "Award Type for identifying the award." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Retrieve a list of member issued awards.OperationId:getMembershipIssueAwardsList
The maximum allowable limit for this API is 200.
" }, { "info": { "name": "Get membership claims", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/memberships/:membershipId/claims", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path", "description": "Id to get the claims." }, { "name": "profileId", "value": "", "type": "query", "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." }, { "name": "profileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "name", "value": "", "type": "query", "description": "Family name, last name or Company Name." }, { "name": "givenName", "value": "", "type": "query", "description": "Given name, first name or names." }, { "name": "membershipType", "value": "", "type": "query", "description": "Membership Type code." }, { "name": "claimType", "value": "", "type": "query", "description": "Type of user-definable claim to be searched." }, { "name": "source", "value": "", "type": "query", "description": "Source of the membership claim." }, { "name": "owner", "value": "", "type": "query", "description": "Unique application user ID of the person responsible for handling the claim." }, { "name": "claimNumber", "value": "", "type": "query", "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." }, { "name": "claimNoContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "claimNoType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "hotelId", "value": "", "type": "query", "description": "Property where the stay took place." }, { "name": "confirmationNo", "value": "", "type": "query", "description": "Reservation confirmation or booking reference number." }, { "name": "submitter", "value": "", "type": "query", "description": "Application user ID of the user who entered the claim." }, { "name": "claimStatus", "value": "", "type": "query", "description": "Status of the claim.(Open, Waiting for Manager, etc.)" }, { "name": "closeDateEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "closeDateStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "claimDateEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "claimDateStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "replyByEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "replyByStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "arrivalEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "arrivalStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "departureEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "departureStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "approvalStatus", "value": "", "type": "query", "description": "Claim approve or reject status." } ] }, "docs": "Retrieve available membership claims by specifying the membership ID.OperationId:getMembershipClaims
This API allows a time span of 90 days.
" }, { "info": { "name": "Get membership points to expire ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/memberships/:membershipId/pointsToExpire", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Use this API to retrieve your Points To Expire by membershipId.OperationId:getMemberPointsToExpire
" }, { "info": { "name": "Extend Member Points set to Expire", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/memberships/:membershipId/pointsToExpire", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path" } ] }, "docs": "This will allow you to extend the expiration date based on the rule defined in the Grace Period in months.OperationId:extendMemberPointsToExpire
" }, { "info": { "name": "Fetch membership promotions of a guest", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/memberships/:membershipId/promotions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path" }, { "name": "includeInactive", "value": "", "type": "query", "description": "Search criteria for fetching inactive membership promotions. When set to true, inactive records will be included." } ] }, "docs": "Use this API to retrieve your available promotions by membershipId.OperationId:getMembershipPromotions
" }, { "info": { "name": "Create membership promotion of a guest", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/memberships/:membershipId/promotions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path" } ] }, "docs": "Create a new membership promotion .OperationId:postMembershipPromotion
" }, { "info": { "name": "Change membership promotion of a guest", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/memberships/:membershipId/promotions/:promotionCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path" }, { "name": "promotionCode", "value": "", "type": "path", "description": "An alphanumeric code for the promotion." } ] }, "docs": "Update an existing membership promotion code in the database.OperationId:putMembershipPromotion
" }, { "info": { "name": "Delete membership promotion of a guest", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/memberships/:membershipId/promotions/:promotionCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path" }, { "name": "promotionCode", "value": "", "type": "path", "description": "An alphanumeric code for the promotion." }, { "name": "membershipPromotionId", "value": "", "type": "query", "description": "The ID of a promotion owned by a membership." } ] }, "docs": "Delete a Membership promotion for a guest. This will inactivate the membership promotion.OperationId:deleteMembershipPromotion
" }, { "info": { "name": "Get membership transactions ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/memberships/:membershipId/transactions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path" } ] }, "docs": "Get membership transactions summary information by specifying membership IDOperationId:getMembershipTransactionsSummary
" }, { "info": { "name": "Post a membership transaction", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/memberships/:membershipId/transactions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipId", "value": "", "type": "path" } ] }, "docs": "Create a new membership transaction .OperationId:postMembershipTransaction
" }, { "info": { "name": "Get membership points to expire ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/membershipsCard/:membershipCardNo/membershipType/:membershipCardType/pointsToExpire", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipCardNo", "value": "", "type": "path", "description": "The card number associated to the membership" }, { "name": "membershipCardType", "value": "", "type": "path", "description": "The type of card the membership belongs to" } ] }, "docs": "Use this API to retrieve your Points To Expire by by specifying membership card number and membership card type. This operation can return more than one membership points to expire if duplicate card numbers are allowed in the configuration.OperationId:getMemberPointsToExpireByCardNo
" }, { "info": { "name": "Get membership transactions ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/membershipsCard/:membershipCardNo/membershipType/:membershipCardType/transactions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "membershipCardNo", "value": "", "type": "path" }, { "name": "membershipCardType", "value": "", "type": "path" } ] }, "docs": "Get membership transactions summary information by specifying membership card number and membership card type, this operation can return more than one membership transactions if duplicate card numbers allowed in the configuration.OperationId:getMembershipTransactionsSummaryByCardNo
" }, { "info": { "name": "Get Profiles for Enrollment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profileForEnrollment", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "externalDatabaseID", "value": "", "type": "query", "description": "Enrollment details will be fetched from this External database." }, { "name": "matchedProfileType", "value": "", "type": "query", "description": "The types of Profile handled by the web service." }, { "name": "language", "value": "", "type": "query", "description": "Language code associated with an alternate name." }, { "name": "givenName", "value": "", "type": "query", "description": "Given name, first name or names." }, { "name": "surname", "value": "", "type": "query", "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." }, { "name": "nameTitle", "value": "", "type": "query", "description": "Degree or honors (e.g., Ph.D., M.D.)" }, { "name": "addressId", "value": "", "type": "query", "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." }, { "name": "addressIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "addressIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "primaryInd", "value": "", "type": "query", "description": "When true, indicates a primary information." }, { "name": "type", "value": "", "type": "query", "description": "Defines the type of address (e.g. home, business, other)." }, { "name": "addressLine", "value": "", "type": "query", "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." }, { "name": "cityName", "value": "", "type": "query", "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address)." }, { "name": "postalCode", "value": "", "type": "query", "description": "Post Office Code number." }, { "name": "county", "value": "", "type": "query", "description": "County or District Name (e.g., Fairfax). Currently this attribute is not used." }, { "name": "state", "value": "", "type": "query", "description": "State or Province name (e.g., Texas)." }, { "name": "countryCode", "value": "", "type": "query", "description": "Code for a country or a nationality." }, { "name": "languageCode", "value": "", "type": "query", "description": "Language code associated with the address" }, { "name": "businessSegment", "value": "", "type": "query", "description": "Business/Market Segment associated to the profile." }, { "name": "territory", "value": "", "type": "query", "description": "Territory associated to the profile." }, { "name": "traceCode", "value": "", "type": "query", "description": "Trace Code associated to the profile." }, { "name": "ownerCode", "value": "", "type": "query", "description": "Owner Code associated to the profile." }, { "name": "influenceCode", "value": "", "type": "query", "description": "Influence Code associated to the profile." }, { "name": "hasMore", "value": "", "type": "query", "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." }, { "name": "totalResults", "value": "", "type": "query", "description": "Total number of rows queried" }, { "name": "telephoneId", "value": "", "type": "query", "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." }, { "name": "telephoneIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "telephoneIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "phoneNumber", "value": "", "type": "query", "description": "Telephone number assigned to a single location." }, { "name": "phoneTechType", "value": "", "type": "query", "description": "Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc." }, { "name": "phoneUseType", "value": "", "type": "query", "description": "Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening)." }, { "name": "phoneUseTypeDescription", "value": "", "type": "query", "description": "Description of the PhoneUseType code" }, { "name": "telephonePrimaryInd", "value": "", "type": "query", "description": "When true, indicates a primary information." }, { "name": "emailInfoId", "value": "", "type": "query", "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." }, { "name": "emailInfoIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "emailInfoIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "emailAddress", "value": "", "type": "query", "description": "Defines the e-mail address." }, { "name": "emailPrimaryInd", "value": "", "type": "query", "description": "When true, indicates a primary information." }, { "name": "emailType", "value": "", "type": "query", "description": "Defines the purpose of the e-mail address (e.g. personal, business, listserve)." }, { "name": "urlId", "value": "", "type": "query", "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." }, { "name": "urlIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "urlIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "urlPrimaryInd", "value": "", "type": "query", "description": "When true, indicates a primary information." }, { "name": "urlType", "value": "", "type": "query", "description": "Defines the purpose of the URL address, such as personal, business, public, etc." }, { "name": "membershipId", "value": "", "type": "query", "description": "Card Number of the membership." }, { "name": "nameOnCard", "value": "", "type": "query", "description": "Name to be displayed on the membership card." }, { "name": "membershipLevel", "value": "", "type": "query", "description": "Indicates the membership level." }, { "name": "profileId", "value": "", "type": "query", "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." }, { "name": "profileContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "paymentMethodCode", "value": "", "type": "query", "description": "Code." }, { "name": "amount", "value": "", "type": "query", "description": "Amount/Fee to enroll to membership Program." }, { "name": "amountCode", "value": "", "type": "query", "description": "Code." }, { "name": "comments", "value": "", "type": "query", "description": "Payment Comments." } ] }, "docs": "Get detailed information regarding match profilesOperationId:getEnrollmentMatchProfiles
" }, { "info": { "name": "Redeem an award", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/profiles/:profileId/awards/redeem", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" } ] }, "docs": "Redeem an award that exists on a profile.OperationId:redeemAward
" }, { "info": { "name": "Get membership transaction exception details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/membershipTransactionExceptions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "query", "description": "Membership belongs to which Hotel." }, { "name": "end", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "start", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "id", "value": "", "type": "query", "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." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "membershipType", "value": "", "type": "query", "description": "The type of the membership." }, { "name": "membershipLevel", "value": "", "type": "query", "description": "The current level of the membership." }, { "name": "membershipCardNo", "value": "", "type": "query", "description": "The card number associated with this membership." }, { "name": "includeEPE", "value": "", "type": "query", "description": "Indicates to Include External Processing Exception" }, { "name": "exceptionType", "value": "", "type": "query", "description": "Indicates the type of Exception like Exception not resolved,Points Rejected on Exception etc.," } ] }, "docs": "Use this API to get membership transaction exceptions on a profile.OperationId:getMembershipTransactionExceptions
This API allows a time span of 90 days.
" }, { "info": { "name": "Get membership card history information on a profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/memberships/history", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Profile Id of the guest." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Use this API to retrieve membership card history on a profile.OperationId:getMembershipCardHistory
" }, { "info": { "name": "Get membership information on a profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/memberships/info", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "query", "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." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "idType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "membershipType", "value": "", "type": "query", "description": "The type of the membership." }, { "name": "membershipId", "value": "", "type": "query", "description": "The card number associated with this membership." }, { "name": "hotelId", "value": "", "type": "query", "description": "Property from which the membership stay information was received." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "mode", "value": "", "type": "query", "description": "Whether member info search will pertain to transaction dates/ stay dates/ points credit dates." } ] }, "docs": "Use this API to retrieve membership details on a profile.OperationId:getMembershipDetails
This API allows a time span of 90 days.
" }, { "info": { "name": "Operation to check status of ProfileMembership service", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/services/profileMembership/status", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "OperationId:pingMembershipService
" } ] }, { "info": { "name": "SuspendedStay", "type": "folder" }, "items": [ { "info": { "name": "Process Suspended Stays", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/processSuspendedStays", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "This API processes Suspended Stay. If no Suspended Stay Record IDs are sent in the body all suspended stays will be processed.OperationId:putProcessSuspendedStays
" }, { "info": { "name": "Get a Suspended Stay by the Suspended Stay Record ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/suspendedStayRecordId/:suspendedStayRecordId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "suspendedStayRecordId", "value": "", "type": "path", "description": "Suspended Stay Record ID." } ] }, "docs": "This API provides Suspended Stay information including Revenue, Rate, Membership and Error details.OperationId:getSuspendedStay
" }, { "info": { "name": "Update a Suspended Stay by the Suspended Stay Record ID.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/suspendedStayRecordId/:suspendedStayRecordId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "suspendedStayRecordId", "value": "", "type": "path", "description": "Suspended Stay Record ID." } ] }, "docs": "Use this to update a Suspended Stay information including Revenue, Rate and Membership details.OperationId:putSuspendedStay
" }, { "info": { "name": "Delete a suspended stay by the Suspended Stay Record ID.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/suspendedStayRecordId/:suspendedStayRecordId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "suspendedStayRecordId", "value": "", "type": "path", "description": "Suspended Stay Record ID." } ] }, "docs": "Use this to remove a Suspended Stay from OPERA including all its details like Revenue, Rate, Membership, Errors.OperationId:deleteSuspendedStay
" }, { "info": { "name": "Get Suspended Stays", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/suspendedStays", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "query", "description": "Hotel code." }, { "name": "reservationStatus", "value": "", "type": "query", "description": "Status of reservation." }, { "name": "importDate", "value": "", "type": "query", "description": "Date of creation or import of stay." }, { "name": "importDateFrom", "value": "", "type": "query", "description": "From date of creation or import of stay." }, { "name": "importDateTo", "value": "", "type": "query", "description": "To date of creation or import of stay." }, { "name": "arrivalDateFrom", "value": "", "type": "query", "description": "From date of arrival of reservation." }, { "name": "arrivalDateTo", "value": "", "type": "query", "description": "To date of arrival of reservation." }, { "name": "departureDateFrom", "value": "", "type": "query", "description": "From date of departure of reservation." }, { "name": "departureDateTo", "value": "", "type": "query", "description": "To date of departure of reservation." }, { "name": "pmsResvConfNo", "value": "", "type": "query", "description": "Reservation confirmation number in PMS." }, { "name": "clientID", "value": "", "type": "query", "description": "Client ID/Corp/IATA of the profile in central." }, { "name": "pmsNameID", "value": "", "type": "query", "description": "Profile number in PMS." }, { "name": "membershipType", "value": "", "type": "query", "description": "Membership type of the profile." }, { "name": "membershipNo", "value": "", "type": "query", "description": "Membership number of the profile." }, { "name": "errorDescription", "value": "", "type": "query", "description": "Suspended reason description." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "This API provides Suspended Stay information. Suspended stays are records that need to be manually processed, as they have been suspended during an upload to OPERA Cloud.OperationId:getSuspendedStays
" }, { "info": { "name": "Get suspended stays errors summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/suspendedStaysErrorsSummary", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "getByProperty", "value": "", "type": "query", "description": "Indicates whether to fetch errors summary by property" }, { "name": "hotelId", "value": "", "type": "query", "description": "Filter by specific property" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Use this API to fetch the suspended stays errors summary." } ] }, { "info": { "name": "ProfileLOV", "type": "folder" }, "items": [ { "info": { "name": "Get available AR Addresses ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profileListOfValues/availableARAddresses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "query", "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." }, { "name": "hotelId", "value": "", "type": "query", "description": "The property where the AR Account exists or is being created." }, { "name": "accountId", "value": "", "type": "query", "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." }, { "name": "accountIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "accountType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "accountNo", "value": "", "type": "query", "description": "The Account Number of the AR Account of the Profile." } ] }, "docs": "Use this API to fetch the available AR Addresses List Of Values for profilesOperationId:getAvailableARAddresses
" }, { "info": { "name": "Get available preferences", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profileListOfValues/availablePreferences", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "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." }, { "name": "hotelId", "value": "", "type": "query", "description": "Property for which preferences are to be fetched." }, { "name": "maxFetchSize", "value": "", "type": "query", "description": "Maximum records to be fetched." } ] }, "docs": "Use this API to fetch the available preferences List Of Values for profilesOperationId:getAvailablePreferences
" } ] }, { "info": { "name": "ProfileStatistics", "type": "folder" }, "items": [ { "info": { "name": "Get Membership statistics ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profileMembershipStatistics", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "query", "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." }, { "name": "membershipCardNo", "value": "", "type": "query", "description": "Number of the membership card." }, { "name": "membershipType", "value": "", "type": "query", "description": "Type of membership." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "transactionDate", "value": "", "type": "query" }, { "name": "hotelId", "value": "", "type": "query", "description": "Membership transaction belongs to which Hotel." }, { "name": "confirmationNumber", "value": "", "type": "query", "description": "Confirmation Number of the membership transaction." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." }, { "name": "duration", "value": "", "type": "query" }, { "name": "transactionDetail", "value": "", "type": "query", "description": "Flag indicating whether to fetch detailed membership points information or just a summary of the total of the points." }, { "name": "reference", "value": "", "type": "query", "description": "User-defined reference field for the Membership Transaction Adjustment." } ] }, "docs": "Retrieve the summary statistics and/or the details of each of the membership transactions and its points. You can filter by membership Type, or Membership Number.OperationId:getProfileMembershipStatistics
This API allows a time span of 90 days.
" }, { "info": { "name": "Get Profile Statistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profileStatistics", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "query", "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." }, { "name": "hotelIds", "value": "", "type": "query", "description": "Hotel code." }, { "name": "reportType", "value": "", "type": "query", "description": "Indicate to get revenue of Stay Records." }, { "name": "stayFrom", "value": "", "type": "query", "description": "Stay from date for report" }, { "name": "stayTo", "value": "", "type": "query", "description": "Stay to date for report" }, { "name": "summary", "value": "", "type": "query", "description": "Flag to indicate whether summary/detail report is requested." }, { "name": "passerBy", "value": "", "type": "query", "description": "Flag to include passerBy records." }, { "name": "contactProfileRoleType", "value": "", "type": "query", "description": "Profile Role Type All." }, { "name": "stayRecordId", "value": "", "type": "query", "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." }, { "name": "stayRecordIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "stayRecordIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "reservationId", "value": "", "type": "query", "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." }, { "name": "reservationIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Indicates currency in which the stay revenue must be rendered." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "This API provides summary/detail/revenue statistics informationOperationId:getProfileStatistics
This API allows a time span of 90 days.
" }, { "info": { "name": "Operation to check the status of ProfileStats service", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/services/profileStats/status", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "OperationId:pingProfileStatsService
" } ] }, { "info": { "name": "ProfileExternal", "type": "folder" }, "items": [ { "info": { "name": "Operation to check status of ProfileExternal service", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/services/profileExternal/status", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "OperationId:pingProfileExternalService
" }, { "info": { "name": "Validate email Id from a third party vendor.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/validateEmail", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API when you want to validate email Id from a third party vendor.OperationId:validateEmail
" }, { "info": { "name": "Validate phone number from a third party vendor.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/validatePhone", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API when you want to validate phone number from a third party vendor.OperationId:validatePhone
" } ] } ], "bundled": true }