openapi: 3.2.0 info: title: OPERA Cloud CRM Configuration Membership Config API description: APIs for Customer Relationship Management (profile) configuration, such as creating preferences, or address types. It also includes Membership Configuration, where you can retrieve membership levels that are configured for a property, or create new membership enrollment codes .

Compatible with OPERA Cloud release 26.2.0.0.

This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2026 Oracle and/or its affiliates.

version: 26.2.0.0 termsOfService: https://www.oracle.com/legal/terms.html contact: email: hospitality_apis_ww_grp@oracle.com license: name: UPL url: https://opensource.org/licenses/upl servers: - url: /crm/config/v1 tags: - name: MembershipConfig description: These APIs will allow you to configure membership configuration such as membership rates, levels, groups, benefit programs and membership awards. paths: /membershipAwards: get: summary: Get Membership Awards description: You can use this API to get Membership Awards.

OperationId:getMembershipAwards

The maximum allowable limit for this API is 200.

operationId: getMembershipAwards parameters: - name: membershipType in: query required: false description: Membership type for which awards are defined. schema: type: string - name: awardCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description for the membership award. schema: type: string - name: validForDate in: query required: false description: Date when membership award is valid. schema: type: string format: date - name: includeInactive in: query required: false description: Flag to decide whether or not to include inactive records in search result set. schema: type: boolean - name: includeDetails in: query required: false description: Fetch operation will return only Membership Award records by default. If Include Details is true, then it will return associated child records like Membership Award Rate/Product/Upgrade/FT as well. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response to fetch Membership Awards. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipAwardsInfo' '204': description: MembershipAwards not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig post: summary: Create Membership Awards description: You can use this API to create Membership Awards.

OperationId:postMembershipAwards

operationId: postMembershipAwards parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipAwards' description: Request object for creating new membership awards. required: true /membershipAwards/{membershipAwardsId}: put: summary: Change Membership Awards description: You can use this API to change Membership Awards.

OperationId:putMembershipAwards

operationId: putMembershipAwards parameters: - name: membershipAwardsId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipAwards' description: Request object for modifying membership awards. required: true delete: summary: Delete Membership Awards description: You can use this API to delete Membership Awards.

OperationId:deleteMembershipAwards

operationId: deleteMembershipAwards parameters: - name: membershipAwardsId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - name: membershipType in: query description: Membership type for which awards are defined. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /upsert/membershipAwards/{membershipAwardsId}: put: summary: Create/Change Membership Awards description: You can use this API to create/change Membership Awards.

OperationId:putUpsertMembershipAwards

operationId: putUpsertMembershipAwards parameters: - name: membershipAwardsId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipAwards' description: Request object for modifying membership awards. required: true /membershipBenefitPrograms: get: summary: Retrieve a Membership Benefit Program description: This API allows you to fetch Membership Benefit Programs of Membership Type. A Benefit Program is configurable for a Membership Type when OCIS or ORS license is active and Membership Type meets following criteria - primary central setup, not externally controlled and point calculation method is Manual Batch.

OperationId:getMembershipBenefitPrograms

This API allows a time span of 90 days.

operationId: getMembershipBenefitPrograms parameters: - name: membershipType in: query required: false description: Membership type schema: type: string - name: code in: query required: false description: Benefit Code schema: type: string - name: end in: query required: false description: The ending value of the date range. schema: type: string format: date - name: start in: query required: false description: The starting value of the date range. schema: type: string format: date - name: minimumLevel in: query required: false description: Min value for membership level. This is the minimum membership level member gets for enrolling into this program. schema: type: string - name: includeInactive in: query required: false description: Flag to decide whether or not to include inactive records in search result set. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching membership benefit programs. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipBenefitProgramsInfo' '204': description: MembershipBenefitPrograms not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig post: summary: Create Membership Benefit Program description: This API is used to create Membership Benefit Programs of a Membership Type. A Benefit Program is configurable for a Membership Type when OCIS or ORS license is active and Membership Type meets following criteria - primary central setup, not externally controlled and point calculation method is Manual Batch.

OperationId:postMembershipBenefitPrograms

operationId: postMembershipBenefitPrograms parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipBenefitPrograms' description: Request object for creating new membership benefit programs. required: true /membershipBenefitPrograms/{membershipBenefitProgramsId}: put: summary: Change Membership Benefit Program description: This API allows you to modify Membership Benefit Programs of Membership Type. A Benefit Program is configurable for a Membership Type when OCIS or ORS license is active and Membership Type meets following criteria - primary central setup, not externally controlled and point calculation method is Manual Batch.

OperationId:putMembershipBenefitPrograms

operationId: putMembershipBenefitPrograms parameters: - name: membershipBenefitProgramsId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipBenefitPrograms' description: Request object for modifying membership benefit programs. required: true delete: summary: Delete Membership Benedict Program description: This API will allow you to delete s Membership Benefit Programs of a Membership Type.

OperationId:deleteMembershipBenefitPrograms

operationId: deleteMembershipBenefitPrograms parameters: - name: membershipBenefitProgramsId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - name: membershipType in: query description: Membership type required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /upsert/membershipBenefitPrograms/{membershipBenefitProgramsId}: put: summary: Create/Change Membership Benefit Program description: This API allows you to create/modify Membership Benefit Programs of Membership Type. A Benefit Program is configurable for a Membership Type when OCIS or ORS license is active and Membership Type meets following criteria - primary central setup, not externally controlled and point calculation method is Manual Batch.

OperationId:putUpsertMembershipBenefitPrograms

operationId: putUpsertMembershipBenefitPrograms parameters: - name: membershipBenefitProgramsId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipBenefitPrograms' description: Request object for modifying membership benefit programs. required: true /membershipClasses: get: summary: Get Membership classes description: Retrieve a list of membership classes that are configured.

OperationId:getMembershipClasses

operationId: getMembershipClasses parameters: - name: fetchInactive in: query required: false description: Determines wether to fetch inactive records or not. schema: type: boolean - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Membership Class. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipClassesInfo' '204': description: MembershipClasses not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig post: summary: Create Membership classes description: Create a new membership class.

OperationId:postMembershipClasses

operationId: postMembershipClasses parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipClasses' description: Request object for creating Membership Class required: true /membershipClasses/{membershipClassId}: put: summary: Change Membership classes description: Update an existing membership class

OperationId:putMembershipClasses

operationId: putMembershipClasses parameters: - name: membershipClassId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response object for changing Membership Class. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipClassesInfo' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipClasses' description: Request object for changing Membership Class. required: true delete: summary: Delete Membership classes description: Delete an existing membership class.

OperationId:deleteMembershipClasses

operationId: deleteMembershipClasses parameters: - name: membershipClassId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /membershipEnrollmentGroups: get: summary: Get Membership enrollment groups description: Retrieve a list of membership Enrollment Groups that are configured.

OperationId:getMembershipEnrollmentGroups

The maximum allowable limit for this API is 200.

operationId: getMembershipEnrollmentGroups parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false 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. schema: type: integer default: 0 - name: enrollmentCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the enrollment group to be fetched. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching membership enrollment groups. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipEnrollmentGroupsInfo' '204': description: MembershipEnrollmentGroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig post: summary: Create Membership enrollment groups description: Create a new membership enrollment group.

OperationId:postMembershipEnrollmentGroups

operationId: postMembershipEnrollmentGroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipEnrollmentGroups' description: Request object for creating new membership enrollment groups. required: true /membershipEnrollmentGroups/{membershipEnrollmentGroupsId}: put: summary: Change Membership enrollment groups description: Update an existing membership group.

OperationId:putMembershipEnrollmentGroups

operationId: putMembershipEnrollmentGroups parameters: - name: membershipEnrollmentGroupsId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipEnrollmentGroups' description: Request object for changing new membership enrollment groups. required: true delete: summary: Remove Membership enrollment groups description: delete an existing membership group.

OperationId:deleteMembershipEnrollmentGroups

operationId: deleteMembershipEnrollmentGroups parameters: - name: membershipEnrollmentGroupsId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /membershipFolioTexts: post: summary: Set Membership folio texts description: You can use this API to Set Membership folio texts.

OperationId:postMembershipFolioTexts

operationId: postMembershipFolioTexts parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipFolioTexts' description: Collection of FolioTexts to be inserted at MembershipLevel. required: true /membershipLevelRules: get: summary: Get Membership Level Rules description: You can use this API to get Membership Level Rules.

OperationId:getMembershipLevelRules

operationId: getMembershipLevelRules parameters: - name: membershipType in: query required: false description: Membership Type. schema: type: string - name: membershipLevel in: query required: false description: Membership Level. schema: type: string - name: ruleNo in: query required: false description: Membership Level Rule Number. schema: type: number - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Membership Level Rules. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipLevelRulesInfo' '204': description: MembershipLevelRules not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig post: summary: Create Membership Level Rules description: You can use this API to create Membership Level Rules.

OperationId:postMembershipLevelRules

operationId: postMembershipLevelRules parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipLevelRules' description: Request object for creating new Membership Level Rules. required: true /membershipLevelRules/{membershipLevelRulesID}: put: summary: Change Membership Level Rules description: You can use this API to change Membership Level Rules.

OperationId:putMembershipLevelRules

operationId: putMembershipLevelRules parameters: - name: membershipLevelRulesID in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipLevelRules' description: Request object for modifying Membership Level Rules. required: true /membershipLevels: get: summary: Get Membership levels description: You can use this API to get Membership levels.

OperationId:getMembershipLevels

operationId: getMembershipLevels parameters: - name: membershipTypeCode in: query required: true description: Type of membership that the levels belong to. schema: type: string - name: includeInactive in: query required: false description: Inactive flag - whether or not to display inactive records. schema: type: boolean default: 'false' - name: includeFolioTexts in: query required: false description: Boolean flag to fetch membership type levels with/without folio text. 'True' indicates including folio texts for corresponding membership type level. schema: type: boolean - name: hotelIds in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching membership levels. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipLevelsInfo' '204': description: MembershipLevels not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig post: summary: Create Membership levels description: You can use this API to create Membership levels.

OperationId:postMembershipLevels

operationId: postMembershipLevels parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipLevels' description: Request object for creating new membership levels. required: true /membershipLevels/{membershipLevelsId}: put: summary: Change Membership levels description: You can use this API to change Membership levels.

OperationId:putMembershipLevels

operationId: putMembershipLevels parameters: - name: membershipLevelsId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipLevels' description: Request object for modifying membership levels. required: true delete: summary: Delete Membership levels description: You can use this API to delete Membership levels.

OperationId:deleteMembershipLevels

operationId: deleteMembershipLevels parameters: - name: membershipLevelsId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - name: type in: query description: Membership type required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /upsert/membershipLevels/{membershipLevelsId}: put: summary: Create/Change Membership levels description: You can use this API to create/change Membership levels.

OperationId:putUpsertMembershipLevels

operationId: putUpsertMembershipLevels parameters: - name: membershipLevelsId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipLevels' description: Request object for modifying membership levels. required: true /membershipMarketGroups: get: summary: Get Membership market groups description: You can use this API to get Membership market groups.

OperationId:getMembershipMarketGroups

operationId: getMembershipMarketGroups parameters: - name: fetchInactive in: query required: false description: Determines wether to fetch inactive records or not. schema: type: boolean - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Membership Market Groups configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipMarketGroupsInfo' '204': description: MembershipMarketGroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig post: summary: Create Membership market groups description: You can use this API to create Membership market groups.

OperationId:postMembershipMarketGroups

operationId: postMembershipMarketGroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipMarketGroups' description: Request object for creating new Membership Market Group Configurations. required: true /membershipMarketGroups/{membershipMarketGroupId}: put: summary: Change Membership market groups description: You can use this API to change Membership market groups.

OperationId:putMembershipMarketGroups

operationId: putMembershipMarketGroups parameters: - name: membershipMarketGroupId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipMarketGroups' description: Request object for changing existing Membership Market Groups Configurations. required: true delete: summary: Delete Membership market groups description: You can use this API to delete Membership market groups.

OperationId:deleteMembershipMarketGroups

operationId: deleteMembershipMarketGroups parameters: - name: membershipMarketGroupId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /upsert/membershipMarketGroups/{membershipMarketGroupId}: put: summary: Create/Change Membership market groups description: You can use this API to create/change Membership market groups.

OperationId:putUpsertMembershipMarketGroups

operationId: putUpsertMembershipMarketGroups parameters: - name: membershipMarketGroupId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipMarketGroups' description: Request object for changing existing Membership Market Groups Configurations. required: true /membershipOriginGroups: get: summary: Get Membership origin groups description: You can use this API to get Membership origin groups.

OperationId:getMembershipOriginGroups

operationId: getMembershipOriginGroups parameters: - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: description in: query required: false description: Description of the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Membership Origin Groups configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipOriginGroupsDetails' '204': description: MembershipOriginGroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig post: summary: Create a Membership origin group description: You can use this API to create Membership origin group.

OperationId:postMembershipOriginGroup

operationId: postMembershipOriginGroup parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resource content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipOriginGroupDetails' description: Request object for creating new Membership origin Group Configurations. required: true /membershipOriginGroups/{membershipOriginGroupId}: put: summary: Change Membership origin group description: You can use this API to change Membership origin group.

OperationId:putMembershipOriginGroup

operationId: putMembershipOriginGroup parameters: - name: membershipOriginGroupId in: path required: true description: Membership origin group code which will be changed. schema: type: string maxLength: 20 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipOriginGroupDetails' description: Request object for changing existing Membership Origin Group Configurations. required: true delete: summary: Delete Membership origin group description: You can use this API to delete Membership origin group.

OperationId:deleteMembershipOriginGroup

operationId: deleteMembershipOriginGroup parameters: - name: membershipOriginGroupId in: path required: true description: Delete delete Membership Origin Group based on given membershipOriginGroupId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /membershipPropertyGroups: get: summary: Get Membership property groups description: You can use this API to get Membership property groups.

OperationId:getMembershipPropertyGroups

operationId: getMembershipPropertyGroups parameters: - name: fetchInactive in: query required: false description: Determines wether to fetch inactive records or not. schema: type: boolean - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Membership Property Groups configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipPropertyGroupsInfo' '204': description: MembershipPropertyGroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig post: summary: Create Membership property groups description: You can use this API to create Membership property groups.

OperationId:postMembershipPropertyGroups

operationId: postMembershipPropertyGroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipPropertyGroups' description: Request object for creating new Membership Property Groups Configurations. required: true /membershipPropertyGroups/{membershipPropertyGroupsId}: put: summary: Change Membership property groups description: You can use this API to change Membership property groups.

OperationId:putMembershipPropertyGroups

operationId: putMembershipPropertyGroups parameters: - name: membershipPropertyGroupsId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipPropertyGroups' description: Request object for changing existing Membership Property Groups Configurations. required: true delete: summary: Delete Membership property groups description: You can use this API to delete Membership property groups.

OperationId:deleteMembershipPropertyGroups

operationId: deleteMembershipPropertyGroups parameters: - name: membershipPropertyGroupsId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /membershipRateGroups: get: summary: Get Membership rate groups description: You can use this API to get Membership rate groups.

OperationId:getMembershipRateGroups

operationId: getMembershipRateGroups parameters: - name: fetchInactive in: query required: false description: Determines wether to fetch inactive records or not. schema: type: boolean - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Membership Rate Groups. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipRateGroupsInfo' '204': description: MembershipRateGroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig post: summary: Create Membership rate groups description: You can use this API to create Membership rate groups.

OperationId:postMembershipRateGroups

operationId: postMembershipRateGroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipRateGroups' description: Request object for creating new Membership Rate Groups. required: true /membershipRateGroups/{membershipRateGroupId}: put: summary: Change Membership rate groups description: You can use this API to change Membership rate groups.

OperationId:putMembershipRateGroups

operationId: putMembershipRateGroups parameters: - name: membershipRateGroupId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipRateGroups' description: Request object for modifying Membership Rate Groups. required: true delete: summary: Delete Membership rate groups description: You can use this API to delete Membership rate groups.

OperationId:deleteMembershipRateGroups

operationId: deleteMembershipRateGroups parameters: - name: membershipRateGroupId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /membershipRates: get: summary: 'Get Membership rates ' description: You can use this API to get Membership rates.

OperationId:getMembershipRates

operationId: getMembershipRates parameters: - name: hotelIds in: query description: Hotel code of membership rates to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: membershipTypes in: query description: Membership type to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: ratePlanCodes in: query description: Rate code of the membership rule rate. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: description in: query required: false description: Description of the Membership Rate. schema: type: string - name: includeInactive in: query required: false description: Indicates whether search includes inactive membership rates. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching membership rates. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipRatesInfo' '204': description: MembershipRates not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig post: summary: Create Membership rates description: You can use this API to create Membership rates.

OperationId:postMembershipRates

operationId: postMembershipRates parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipRates' description: Request object for creating new membership rate code rules. required: true /membershipRates/{membershipRatesId}: put: summary: Change Membership rates description: You can use this API to change Membership rates.

OperationId:putMembershipRates

operationId: putMembershipRates parameters: - name: membershipRatesId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipRates' description: Request object for changing membership rate rules. required: true delete: summary: Delete Membership rates description: You can use this API to delete Membership rates.

OperationId:deleteMembershipRates

operationId: deleteMembershipRates parameters: - name: membershipRatesId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: query description: Hotel code of membership rate. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /membershipRevenueTypes: get: summary: Get Membership revenue types description: You can use this API to get Membership revenue types.

This API is deprecated.

OperationId:getMembershipRevenueTypes

operationId: getMembershipRevenueTypes parameters: - name: fetchInactive in: query required: false description: Determines wether to fetch inactive records or not. schema: type: boolean - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching membership revenue types. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipRevenueTypesInfo' '204': description: MembershipRevenueTypes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig post: summary: Create Membership revenue types description: You can use this API to create Membership revenue types.

This API is deprecated.

OperationId:postMembershipRevenueTypes

operationId: postMembershipRevenueTypes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipRevenueTypes' description: Request object for creating new membership revenue types. required: true /membershipRevenueTypes/{membershipRevenueTypesId}: put: summary: Change Membership revenue types description: You can use this API to change Membership revenue types.

This API is deprecated.

OperationId:putMembershipRevenueTypes

operationId: putMembershipRevenueTypes parameters: - name: membershipRevenueTypesId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipRevenueTypes' description: Request object for changing new membership revenue types. required: true delete: summary: Delete Membership revenue types description: You can use this API to delete Membership revenue types.

This API is deprecated.

OperationId:deleteMembershipRevenueTypes

operationId: deleteMembershipRevenueTypes parameters: - name: membershipRevenueTypesId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /membershipRoomGroups: get: summary: 'Get Membership room groups ' description: You can use this API to get Membership room groups.

This API is deprecated.

OperationId:getMembershipRoomGroups

operationId: getMembershipRoomGroups parameters: - name: roomGroupCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: description in: query required: false description: Description of the room groups. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching membership room groups. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipRoomGroupsInfo' '204': description: MembershipRoomGroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig post: summary: Create Membership room groups description: You can use this API to create Membership room groups.

This API is deprecated.

OperationId:postMembershipRoomGroups

operationId: postMembershipRoomGroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipRoomGroups' description: Request object for creating new membership room groups. required: true /membershipRoomGroups/{membershipRoomGroupsId}: put: summary: Change Membership room groups description: You can use this API to change Membership room groups.

This API is deprecated.

OperationId:putMembershipRoomGroups

operationId: putMembershipRoomGroups parameters: - name: membershipRoomGroupsId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipRoomGroups' description: Request object for changing membership room groups. required: true delete: summary: Delete Membership room groups description: You can use this API to delete Membership room groups.

This API is deprecated.

OperationId:deleteMembershipRoomGroups

operationId: deleteMembershipRoomGroups parameters: - name: membershipRoomGroupsId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /membershipSourceGroups: get: summary: Get Membership source groups description: You can use this API to get Membership source groups.

OperationId:getMembershipSourceGroups

operationId: getMembershipSourceGroups parameters: - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: description in: query required: false description: Description of the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Membership Source Groups configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipSourceGroupsDetails' '204': description: MembershipSourceGroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig post: summary: Create a Membership source group description: You can use this API to create Membership source group.

OperationId:postMembershipSourceGroup

operationId: postMembershipSourceGroup parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resource content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipSourceGroupDetails' description: Request object for creating new Membership source Group Configurations. required: true /membershipSourceGroups/{membershipSourceGroupId}: put: summary: Change Membership source group description: You can use this API to change Membership source group.

OperationId:putMembershipSourceGroup

operationId: putMembershipSourceGroup parameters: - name: membershipSourceGroupId in: path required: true description: Membership source group code which will be changed. schema: type: string maxLength: 20 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipSourceGroupDetails' description: Request object for changing existing Membership Source Group Configurations. required: true delete: summary: Delete Membership Source group description: You can use this API to delete Membership Source group.

OperationId:deleteMembershipSourceGroup

operationId: deleteMembershipSourceGroup parameters: - name: membershipSourceGroupId in: path required: true description: Delete delete Membership Source Group based on given membershipSourceGroupId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /membershipTypeRules: get: summary: Get Membership type rules description: get Membership type rules based on criteria

OperationId:getMembershipTypeRules

operationId: getMembershipTypeRules parameters: - name: membershipTypesCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: programType in: query required: false description: Membership Type/Program rule types. schema: type: string enum: - All - Points - Tier uniqueItems: true - name: ruleCode in: query required: false description: Rule code of the membership type rule. schema: type: string - name: ruleBasedOn in: query required: false description: Indicates Membership upgrades/downgrades to the next tier level uses RFM (Recency, Frequency, Monetary Value) score. schema: type: string enum: - Revenue - Stay - Nights - Enrollment - TierUpgrade - Renewal - Rfm uniqueItems: true - name: includeInactive in: query required: false description: Indicates whether search includes inactive membership type rules. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching membership type rules. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipTypeRulesInfo' '204': description: MembershipTypeRules not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig post: summary: Create Membership type rules description: You can use this API to create Membership type rules.

OperationId:postMembershipTypeRules

operationId: postMembershipTypeRules parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response object for creating membership type rules. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipTypeRulesDetails' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipTypeRules' description: Request object for creating new membership type rules. required: true /membershipTypeRules/{membershipTypeRulesId}: get: summary: Get Membership type rule details description: You can use this API to get Membership type rule details.

OperationId:getMembershipTypeRule

operationId: getMembershipTypeRule parameters: - name: membershipTypeRulesId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - name: membershipType in: query required: false description: Membership type of the Rule. schema: type: string - name: membershipPointsSequence in: query required: false description: Sequence number of the membership type rule. schema: type: integer - name: fetchInstructions in: query description: To include type rule filters information. required: false style: form explode: true schema: type: array items: type: string enum: - RuleDefinition - PointsDefinition - RuleConditions uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching membership type rule. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipTypeRule' '204': description: MembershipTypeRule not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig put: summary: Change Membership type rules description: You can use this API to change Membership type rules.

OperationId:putMembershipTypeRules

operationId: putMembershipTypeRules parameters: - name: membershipTypeRulesId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipTypeRules' description: Request object for changing membership type rules. required: true delete: summary: Delete Membership type rules description: You can use this API to delete Membership type rules.

OperationId:deleteMembershipTypeRules

operationId: deleteMembershipTypeRules parameters: - name: membershipTypeRulesId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - name: membershipPointsSequence in: query description: Sequence number of the membership type rule. required: false style: form explode: true schema: type: array items: type: integer - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /upsert/membershipTypeRules/{membershipTypeRulesId}: put: summary: Create/Change Membership type rules description: You can use this API to create/change Membership type rules.

OperationId:putMembershipTypeRules

operationId: putUpsertMembershipTypeRules parameters: - name: membershipTypeRulesId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipTypeRules' description: Request object for changing membership type rules. required: true /membershipTypes: get: summary: Get Membership types description: Membership types enable you to identify, organize, and manage the membership programs on a profile. For example, your property might have a guest loyalty program that awards guests based on the amount of revenue generated or the number of stays per year. You would create a specific membership type for this program. This API will retrieve all configured Membership Types configured.

OperationId:getMembershipTypes

operationId: getMembershipTypes parameters: - name: includeInactive in: query required: false description: Search criteria for fetching inactive memberships. When set to true, inactive records will be included. schema: type: boolean - name: membershipTypesCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: membershipTypesWildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: membershipClassesCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: membershipClassesWildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Membership Types. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipTypes' '204': description: MembershipTypes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig post: summary: Create Membership types description: Membership types enable you to identify, organize, and manage the membership programs on a profile. For example, your property might have a guest loyalty program that awards guests based on the amount of revenue generated or the number of stays per year. You would create a specific membership type for this program.

OperationId:postMembershipTypes

operationId: postMembershipTypes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipTypes' description: Request object to create Membership types. Includes instructions for information which needs to be returned. required: true /membershipTypes/{membershipTypeId}: get: summary: Get a Membership type description: Use this API to get a specific Membership Type and its details.

OperationId:getMembershipType

operationId: getMembershipType parameters: - name: membershipTypeId in: path required: true description: Fetch membershipTypes values based on given membershipTypeId schema: type: string maxLength: 2000 minLength: 1 - name: membershipTypeCode in: query required: false description: Membership type code. schema: type: string - name: fetchInstructions in: query description: Membership levels. required: false style: form explode: true schema: type: array items: type: string enum: - PrimaryDetails - CardNumberDetails - PointsDetails - ExceptionCriteriaDetails - AdditionalDetails - EnrollmentDetails - Levels uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Membership Type. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipTypesDetails' '204': description: MembershipType not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig put: summary: Change Membership type description: Use this API to update an existing Membership Type

OperationId:putMembershipType

operationId: putMembershipType parameters: - name: membershipTypeId in: path required: true description: Fetch membershipTypes values based on given membershipTypeId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipTypes' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipTypeChangeInstructions' description: Request object for changing membership type. required: true delete: summary: Delete Membership type description: Use this API to delete an existing Membership Type

OperationId:deleteMembershipTypes

operationId: deleteMembershipTypes parameters: - name: membershipTypeId in: path required: true description: Fetch membershipTypes values based on given membershipTypeId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /membershipTypes/{membershipType}/membershipLevels/{membershipLevel}/membershipLevelRules/{membershipLevelRulesID}: delete: summary: Delete Membership Level Rules description: You can use this API to delete Membership Level Rules.

OperationId:deleteMembershipLevelRules

operationId: deleteMembershipLevelRules parameters: - name: membershipLevelRulesID in: path required: true description: Membership Level Rule Number for which Tier Management Level rules needs to be deleted. schema: type: string maxLength: 2000 minLength: 1 - name: membershipType in: path required: true description: Membership Type for which Tier Management Level rules needs to be deleted. schema: type: string maxLength: 20 minLength: 1 - name: membershipLevel in: path required: true description: Membership Level for which Tier Management Level rules needs to be deleted. schema: type: string maxLength: 20 minLength: 0 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /processTierManagement: post: summary: Process Tier Management description: Use this API to process Tier Management.

OperationId:processTierManagement

operationId: processTierManagement parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/tierManagement' description: Request object for processing membership tier level changes. required: true /profiles/profileRegion: get: summary: Get profile regions description: You can use this API to get the profile regions.

OperationId:getProfileRegions

operationId: getProfileRegions parameters: - name: region in: query required: false description: Region to filter based on the profile region setup. schema: type: string - name: type in: query required: false description: Type to filter profile region. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for Profile Regions Configuration. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/profileRegionsInfo' '204': description: ProfileRegions not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig put: summary: Update Profile Region description: You can use this API to update profile region.

OperationId:putProfileRegion

operationId: putProfileRegion parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/profileRegionType' description: Request object for updating Profile Region. required: true post: summary: Create Profile Region description: You can use this API to create profile region.

OperationId:postProfileRegion

operationId: postProfileRegion parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/profileRegionInfo' description: Request object for creating Profile Region Configuration. required: true delete: summary: Delete Profile Region. description: You can use this API to delete profile region.

OperationId:deleteProfileRegion

. operationId: deleteProfileRegion parameters: - name: region in: query required: true description: Delete profile region based on region. schema: type: string maxLength: 2000 minLength: 1 - name: type in: query required: true description: Delete profile region based on name type. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /profiles/suspendedMatchRules: get: summary: Get profile suspended match rules description: You can use this API to get suspended profile match rules.

OperationId:getSuspendedMatchRules

operationId: getSuspendedMatchRules parameters: - name: region in: query required: false description: Region to filter rules based on the profile region setup schema: type: string - name: nameType in: query required: false description: Name type to filter match rules schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for Suspended Profile Match Rules Configuration. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/suspendedMatchRulesInfo' '204': description: SuspendedMatchRules not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig put: summary: Update suspended match rules description: You can use this API to update suspended match rules.

OperationId:putSuspendedMatchRules

operationId: putSuspendedMatchRules parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/updateSuspendedMatchRuleType' description: Request object for updating Suspended Profile Match Rules Configuration. required: true post: summary: Create suspended match rules description: You can use this API to create suspended profile match rules.

OperationId:postSuspendedMatchRules

operationId: postSuspendedMatchRules parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/suspendedMatchRulesInfo' description: Request object for creating Suspended Profile Match Rules Configuration. required: true /profiles/suspendedMatchRules/copy: post: summary: Copy suspended match rule description: You can use this API to copy suspended profile match rule.

OperationId:copySuspendedMatchRule

operationId: copySuspendedMatchRule parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copySuspendedMatchRuleType' description: Request object for copying Suspended Profile Match Rules Configuration. required: true /profiles/suspendedMatchRules/{region}/{nameType}/{validationItem}: delete: summary: Delete suspended match rules description: You can use this API to delete suspended profile match rule.

OperationId:deleteSuspendedMatchRules

operationId: deleteSuspendedMatchRules parameters: - name: region in: path required: true description: Delete match rule based on region. schema: type: string maxLength: 2000 minLength: 1 - name: nameType in: path required: true description: Delete match rule based on name type. schema: type: string maxLength: 2000 minLength: 1 - name: validationItem in: path required: true description: Delete match rule based on validation item. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /services/membershipConfig/status: get: summary: ' ping' description: Ping Membership Configuration Service

OperationId:pingMembershipConfigService

operationId: pingMembershipConfigService parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for Ping operation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/operaVersion' '204': description: pingMembershipConfigService not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /tierManagementBatchProcesses: get: summary: Get Tier Management Batch Processes description: You can use this API to get Tier Management Batch Processes.

OperationId:getTierManagementBatchProcesses

operationId: getTierManagementBatchProcesses parameters: - name: reportId in: query required: false 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. schema: type: string - name: reportIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: recordType in: query required: false description: Fetches the data for all the membership level rules. schema: type: string enum: - Downgrade - Renewal - Upgrade - All uniqueItems: true - name: evaluationDateFrom in: query required: false description: Evaluation From Date to fetch the tier processing jobs schema: type: string format: date - name: evaluationDateTo in: query required: false description: Evaluation To Date to fetch the tier processing jobs. schema: type: string format: date - name: processDateFrom in: query required: false description: Process From Date to fetch the tier processing jobs based on insert date. schema: type: string format: date - name: processDateTo in: query required: false description: Process To Date to fetch the tier processing jobs based on insert date. schema: type: string format: date - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer default: 20 - name: offset in: query required: false 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. schema: type: integer default: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Tier Management Batch Reports. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/tierManagementBatchProcesses' '204': description: TierManagementBatchProcesses not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /tierManagementBatchRecords: get: summary: Get Tier Management Batch Records description: You can use this API to get Tier Management Batch Records.

OperationId:getTierManagementBatchRecords

operationId: getTierManagementBatchRecords deprecated: true parameters: - name: name in: query required: false description: Display name of the member. schema: type: string - name: recordStatus in: query required: false description: Record locked. schema: type: string enum: - New - Complete - Delete - Error - Locked uniqueItems: true - name: level in: query required: false description: Old membership level before upgrade or downgrade. schema: type: string - name: levelDifference in: query required: false description: Level Difference. schema: type: integer - name: membershipCardNumber in: query required: false description: Member Card no. schema: type: string - name: reportId in: query required: false 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. schema: type: string - name: reportIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer default: 20 - name: offset in: query required: false 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. schema: type: integer default: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Tier Management Batch Records. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/tierManagementBatchRecords' '204': description: TierManagementBatchRecords not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /tierManagementBatchRecords/searches: post: summary: Get Tier Management Batch Records description: You can use this API to get Tier Management Batch Records.

OperationId:searchTierManagementBatchRecords

operationId: searchTierManagementBatchRecords parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Tier Management Batch Records. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/tierManagementBatchRecords' '204': description: TierManagementBatchRecords not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/searchTierManagementBatchRecordsRequest' /tierManagementBatchRecords/{tierManagementBatchRecordsID}: delete: summary: Delete Tier Management Batch Record description: You can use this API to delete Tier Management Batch Record.

OperationId:deleteTierManagementBatchRecords

operationId: deleteTierManagementBatchRecords parameters: - name: tierManagementBatchRecordsID in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - name: idExtension in: query required: false description: Additional identifying value assigned by the creating system. schema: type: integer - name: idContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: type in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: id in: query required: false 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. schema: type: string - name: membershipIdIdExtension in: query required: false description: Additional identifying value assigned by the creating system. schema: type: integer - name: membershipIdIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: membershipIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /tierManagementChanges: post: summary: Apply Tier Management Changes description: Apply Tier Management changes calculated by batch process.

OperationId:applyTierManagementChanges

operationId: applyTierManagementChanges parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/tierManagementChanges' description: Request object for applying membership changes calculated by Tier Management process. required: true /tierManagementChanges/{tierManagementChangesID}: delete: summary: 'Delete Tier Management ' description: Delete Tier Management changes calculated by batch process.

OperationId:deleteTierManagementChanges

operationId: deleteTierManagementChanges parameters: - name: tierManagementChangesID in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - name: idExtension in: query required: false description: Additional identifying value assigned by the creating system. schema: type: integer - name: idContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: type in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: overrideWarning in: query required: false description: If true, overrides the warning "Previous batch(es) ran but update not completed." and proceeds update. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig /upsert/membershipOriginGroups/{membershipOriginGroupId}: put: summary: Create/Change Membership origin group description: You can use this API to create/change Membership origin group.

OperationId:putUpsertMembershipOriginGroup

operationId: putUpsertMembershipOriginGroup parameters: - name: membershipOriginGroupId in: path required: true description: Membership origin group code which will be changed. schema: type: string maxLength: 20 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipOriginGroupDetails' description: Request object for changing existing Membership Origin Group Configurations. required: true /upsert/membershipPropertyGroups/{membershipPropertyGroupsId}: put: summary: Create/Change Membership property groups description: You can use this API to create/change Membership property groups.

OperationId:putUpsertMembershipPropertyGroups

operationId: putUpsertMembershipPropertyGroups parameters: - name: membershipPropertyGroupsId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipPropertyGroups' description: Request object for changing existing Membership Property Groups Configurations. required: true /upsert/membershipRateGroups/{membershipRateGroupId}: put: summary: Create/Change Membership rate groups description: You can use this API to create/change Membership rate groups.

OperationId:putUpsertMembershipRateGroups

operationId: putUpsertMembershipRateGroups parameters: - name: membershipRateGroupId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipRateGroups' description: Request object for modifying Membership Rate Groups. required: true /upsert/membershipRates/{membershipRatesId}: put: summary: Create/Change Membership rates description: You can use this API to create/change Membership rates.

OperationId:putUpsertMembershipRates

operationId: putUpsertMembershipRates parameters: - name: membershipRatesId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipRates' description: Request object for changing membership rate rules. required: true /upsert/membershipRevenueGroups/{membershipRevenueGroupId}: put: summary: Create/Change Membership revenue groups description: You can use this API to create/change Membership revenue groups.

This API is deprecated.

OperationId:putUpsertMembershipRevenueGroups

operationId: putUpsertMembershipRevenueGroups deprecated: true parameters: - name: membershipRevenueGroupId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipRevenueGroups' description: Request object for changing new membership revenue groups. required: true /upsert/membershipRevenueTypes/{membershipRevenueTypesId}: put: summary: Create/Change Membership revenue types description: You can use this API to create/change Membership revenue types.

This API is deprecated.

OperationId:putUpsertMembershipRevenueTypes

operationId: putUpsertMembershipRevenueTypes parameters: - name: membershipRevenueTypesId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipRevenueTypes' description: Request object for changing new membership revenue types. required: true /upsert/membershipRoomGroups/{membershipRoomGroupsId}: put: summary: Create/Change Membership room groups description: You can use this API to create/change Membership room groups.

This API is deprecated.

OperationId:putUpsertMembershipRoomGroups

operationId: putUpsertMembershipRoomGroups parameters: - name: membershipRoomGroupsId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipRoomGroups' description: Request object for changing membership room groups. required: true /upsert/membershipSourceGroups/{membershipSourceGroupId}: put: summary: Create/Change Membership source group description: You can use this API to create/change Membership source group.

OperationId:putUpsertMembershipSourceGroup

operationId: putUpsertMembershipSourceGroup parameters: - name: membershipSourceGroupId in: path required: true description: Membership source group code which will be changed. schema: type: string maxLength: 20 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipSourceGroupDetails' description: Request object for changing existing Membership Source Group Configurations. required: true /upsert/qualifyingRates/{qualifyingRatesId}: put: summary: Upsert Qualifying Rates description: You can use this API to upsert Qualifying Rates.

This API is deprecated.

OperationId:putUpsertQualifyingRates

operationId: putUpsertQualifyingRates deprecated: true parameters: - name: qualifyingRatesId in: path required: true description: Fetch membershipClasses values based on given membershipClassId schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - MembershipConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/qualifyingRates' description: Request object for changing qualifying rate rules. required: true components: schemas: membershipRevenueTypeType: type: object description: Base type provides information about Membership Market/Property Groups Configuration. properties: code: description: Code is used to identify a Membership Market/Resort Group. type: string minLength: 0 maxLength: 20 description: description: Description of the Membership Market/Propety Group. type: string minLength: 0 maxLength: 2000 displaySequence: description: Membership Market/Property Groups display sequence Number type: number label: description: Label of the membership revenue type. type: string minLength: 0 maxLength: 20 exportBucketCode: description: Revenue bucket code that is associated to the membership revenue type. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' membershipLevels: type: object description: Request object for modifying membership levels. properties: membershipLevels: description: Collection of membership levels to be changed. $ref: '#/components/schemas/membershipLevelsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipRevenueTypesInfoType: type: array description: Membership revenue type code and description. maxItems: 4000 items: $ref: '#/components/schemas/codeDescriptionType' membershipLevelRules: type: object description: Request object for modifying Membership Level Rules. properties: membershipLevelRules: description: Collection of Membership Level Rules to be changed. $ref: '#/components/schemas/membershipLevelRulesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cardRangeType: type: object description: Card number start and end range. properties: from: description: Starting range of the card. type: string minLength: 0 maxLength: 50 to: description: End range of the card. type: string minLength: 0 maxLength: 50 membershipFolioTexts: type: object description: Collection of FolioTexts to be inserted at MembershipLevel. properties: membershipFolioTexts: type: array items: $ref: '#/components/schemas/membershipFolioTextsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' upgradeDowngradeForCalendarPeriodType: type: string description: Calculate points from five Years enum: - ThisYear - LastYear - TwoYears - ThreeYears - FourYears - FiveYears suspendedMatchRuleType: type: object description: Provides information about the Suspended Profile Match Rule Configuration. properties: region: description: Region to filter by based on the profile region setup type: string nameType: description: Name type to filter match rules type: string validationItem: description: Validation item for the rule type: string validationType: description: Validation type for the rule type: string validationValue: description: Validation value for the rule type: string applyRuleYn: description: The activation flag for the match rule type: boolean userMaintainable: description: Whether the rule is maintainable by users type: boolean membershipTypeRulePrimaryDetailsType: type: object description: Membership Type rule primary information. properties: membershipTypeRuleId: description: Membership type rule ID details. $ref: '#/components/schemas/membershipTypeRuleIDType' description: description: Description of the rule. type: string minLength: 0 maxLength: 2000 ruleBasedOn: description: Calculation rule name of the type rule. Determines whether this Membership generates points based on guest Revenue, Stays, Nights, Enrolment. $ref: '#/components/schemas/membershipTypeRuleBasedOnType' ruleStartDate: description: Start date indicates the begin date for this points calculation rule. type: string format: date maxLength: 8 ruleEndDate: description: End date for this points calculation rule. type: string format: date maxLength: 8 pointsType: description: Specifies if points are BASE or BONUS. $ref: '#/components/schemas/rulePointsTypeType' inactiveDate: description: The date that Membership type rule is marked as inactive. type: string format: date maxLength: 8 transactionCode: description: Tranaction code for membership type rule. e.g. Resident, Non Resident $ref: '#/components/schemas/membershipTypeRuleTransactionCodeType' membershipEnrollmentCodesInfoType: type: array description: Membership enrollment code code and description. maxItems: 4000 items: $ref: '#/components/schemas/codeDescriptionType' profileRegionType: type: object description: Provides information about the Profile Regions Configuration. properties: region: description: Region to filter by based on the profile region setup type: string type: description: Type to filter profile regions type: string description: description: Description for the profile region type: string hotelIds: description: Resorts to be created for the corresponding Profile Region. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 membershipRoomGroups: type: object description: Request object for changing membership room groups. properties: membershipRoomGroups: description: Collection of membership room groups to be changed. $ref: '#/components/schemas/membershipRoomGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' colorType: type: string description: Color configuration type. This color configuration provides a visual category of entities. enum: - Red - DarkRed - Green - DarkGreen - LightGreen - Orange - White - Yellow - DarkYellow - Purple - Brown - Gray - Aqua - Chocolate - Blue - LightBlue - DarkBlue - Cyan - DarkCyan - Magenta - DarkMagenta - Black - Deepteal - Sunsetorange - Aquasky - Mochabrown - Mossgreen - Rosewood - Claybrown - Softlavender - Olivegold - Plumpurple - Mistblue - Forestgreen - Dustyviolet - Oceanblue - Copper membershipLevelType: type: object description: A Type that holds key values, that uniquely identifies a membership level properties: type: description: Membership type type: string minLength: 0 maxLength: 20 code: description: Membership level type: string minLength: 0 maxLength: 20 description: description: Description of the Membership level. type: string minLength: 0 maxLength: 2000 label: description: Label of the Membership level. type: string minLength: 0 maxLength: 40 rank: description: Rank of Membership level. type: number vip: description: VIP level associated to the Membership level. type: string minLength: 0 maxLength: 20 displayColor: description: Display Colour of Membership level. $ref: '#/components/schemas/colorType' inactive: description: Inactive flag for a Membership level. type: boolean folioTexts: description: Folio text for a specific membership type level for hotels in the chain. $ref: '#/components/schemas/hotelFolioTextsType' fulfillment: description: Indicates whether memberships upgraded or downgraded to or from this level will be included in the Membership Export. type: boolean changesRestricted: description: Indicates whether memberships level is restricted to prevent users from making changes to it. type: boolean autoRenewGrace: description: Select the number of graces the member will be allowed before the membership level auto-renews based on the member current points. It is available when the Tier Management Reset option is selected on Membership Type. type: integer cardValidYears: description: Specify the time limit (from 1 to 5 years) for membership card expiration for this level type: integer restrictedLevel: description: Indicates whether memberships level is restricted to prevent users from making changes to it. It is available when the Advanced Enrollment option is selected on Membership Type. type: boolean renewCard: description: Indicates whether membership has expired by the time the membership record is uploaded, the members card will be renewed and updated with a new expiration date. type: boolean feeRequired: description: Indicates whether membership fee payment is required upon upgrade to this membership level. type: boolean maxDowngradeLevel: description: The lowest level in which this level can be downgraded to. type: string minLength: 0 maxLength: 20 numberOfTransactions: description: Number of transaction(s) for each stay. Value will be 2 in case of double dipping otherwise it will be null or 1. type: integer managedBy: $ref: '#/components/schemas/managedByOptions' cardRangesType: type: array description: Card number start and end range. maxItems: 4000 items: $ref: '#/components/schemas/cardRangeType' profileRegionInfo: type: object description: Object for Profile Region Configuration. properties: profileRegion: description: Profile Region Info for a singular Region. $ref: '#/components/schemas/profileRegionType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipMarketGroupType: type: object description: Base type provides information about Membership Market/Property Groups Configuration. properties: code: description: Code is used to identify a Membership Market/Resort Group. type: string minLength: 0 maxLength: 20 description: description: Description of the Membership Market/Propety Group. type: string minLength: 0 maxLength: 2000 displaySequence: description: Membership Market/Property Groups display sequence Number type: number marketCodes: description: Collection of Market codes which associated for a Membership Market Group. $ref: '#/components/schemas/membershipMarketCodesType' managedBy: $ref: '#/components/schemas/managedByOptions' membershipRateGroupsType: type: array description: Details for Membership Rate Group. maxItems: 4000 items: $ref: '#/components/schemas/membershipRateGroupType' membershipRateGroupsInfo: type: object description: Response object for fetching Membership Rate Groups. properties: membershipRateGroups: description: Collection of Membership Rate Group. $ref: '#/components/schemas/membershipRateGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipTypeRulesInfo: type: object description: Response object for fetching membership type rules. properties: membershipTypeRules: description: Collection of membership type rules summary. $ref: '#/components/schemas/membershipTypeRulesSummariesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipMarketGroups: type: object description: Request object for changing existing Membership Market Groups Configurations. properties: membershipMarketGroups: description: Membership Market Groups Configurations to be changed. $ref: '#/components/schemas/membershipMarketGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipAwardsInfo: type: object description: Response to fetch Membership Awards. properties: membershipAwards: description: Collection of Membership Awards. $ref: '#/components/schemas/membershipAwardsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipEnrollmentGroupsType: type: array description: Details of membership enrollment group type. maxItems: 4000 items: $ref: '#/components/schemas/membershipEnrollmentGroupType' membershipTypeChangeInstructions: type: object description: Request object for changing membership type. properties: membershipTypeChangeInstructions: description: A collection of MembershipTypes with information that needs to be changed. type: array items: $ref: '#/components/schemas/membershipTypeChangeInstructionType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipAwardBasedOnType: type: string description: This award allows a guest to apply available membership points towards the balance of his or her bill. enum: - Rate - Product - Upgrade - Other - Ft - Discount membershipTypeRuleRateConditionsType: type: object description: Membership Type Rules rate Conditions. properties: rateCode: description: Rate code for which the rule is applied. type: string minLength: 0 maxLength: 20 rateGroup: description: Rate group for which the rule is applied. type: string minLength: 0 maxLength: 20 revenueGroup: description: Revenue group for which the rule is applied. type: string minLength: 0 maxLength: 20 averageRateAmount: description: Average rate amount of the reservations for which rule will be applied. type: number minimumRevenue: description: Minimum revenue on which rule will be applied. type: number transactionGroup: description: Transaction group for which the rule is applied. type: string minLength: 0 maxLength: 20 qualifyingRates: description: Points ratio is expressed in terms of %. type: boolean excludeRateGroup: description: To specify the exclusion of rate group. type: boolean excludeRevenueGroup: description: To specify the exclusion of revenue group while applying rule. type: boolean includeTransactionGroup: description: To specify the inclusion of Transaction group. type: boolean allMembershipRates: description: Points Calculation will be based on all rate codes when specify All Membership Rates. type: boolean allMembershipTrx: description: Points Calculation will be based on all transaction codes when specify All Membership Transactions. type: boolean membershipPropertyGroupsType: type: array description: Details for Membership Property Group along with associated property codes. maxItems: 4000 items: $ref: '#/components/schemas/membershipPropertyGroupType' userDefinedEnrollmentFieldType: type: object description: User Defined Enrollment Field/Attribute. properties: fieldName: description: Name of the Field/Attribute such as comunication, birthdate etc. $ref: '#/components/schemas/userDefinedEnrollmentFieldNameType' fieldType: description: Type of the Field/Attribute such as phone, fax, email etc. type: string minLength: 0 maxLength: 2000 requiredField: description: Indicates if the Field/Attribute is required for Membership Type. type: boolean active: description: Indicates if the Field/Attribute is active for Membership Type. type: boolean membershipTypeRuleDetailType: type: object description: Membership type Rule details. properties: rulePrimaryDetails: description: Membership type rule summary information. $ref: '#/components/schemas/membershipTypeRulePrimaryDetailsType' ruleDefinition: description: Membership type rule definition details. $ref: '#/components/schemas/membershipTypeRuleDefinitionType' rulePointsDefinition: description: Membership Type rule points definition details. $ref: '#/components/schemas/membershipTypeRulePointsDefinitionType' ruleConditions: description: Membership Type rule conditions details. $ref: '#/components/schemas/membershipTypeRuleConditionsType' managedBy: $ref: '#/components/schemas/managedByOptions' membershipTypeRuleReservationConditionsType: type: object description: Membership Type Rules reservation conditions. properties: reservationStartDate: description: Reservations with start date for which the rule is applied. type: string format: date maxLength: 8 reservationEndDate: description: Reservations with end date for which the rule is applied. type: string format: date maxLength: 8 minimumNights: description: Minimum length of stay required to receive points if membership type is based on STAY. type: integer maximumNights: description: Maximum length of stay required to receive points if membership type is based on NIGHTS. type: integer daysFromEnrollment: description: Number of days from enrolment. type: integer sunday: type: boolean monday: type: boolean tuesday: type: boolean wednesday: type: boolean thursday: type: boolean friday: type: boolean saturday: type: boolean warningsType: type: array description: Used in conjunction with the Success element to define a business error. maxItems: 4000 items: $ref: '#/components/schemas/warningType' membershipTypesDetails: type: object description: Response object for fetching Membership Type. properties: membershipTypes: description: List of Membership types fetched. $ref: '#/components/schemas/membershipTypesType' masterInfoList: description: Refer to Generic common types document. type: array items: $ref: '#/components/schemas/masterInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cardNumberDetailsType: type: object description: Card Number of membership type. properties: membershipCardValidationRule: description: ValidationRules for credit card. $ref: '#/components/schemas/membershipCardValidationRuleType' cardNumberBasedOn: description: Indicates new membership card numbers, either based on the enrollment code or on the next available number in the card sequence. $ref: '#/components/schemas/cardNumberGenerationModeType' database: description: Indicates External System from which card number will be generated. type: string minLength: 0 maxLength: 20 allowDuplicateCardNumbers: description: Indicates if the multiple membership cards may be issued with the same membership number. type: boolean expirationDateRequired: description: Indicates if the membership expiration date is required for validation of the profile membership information. type: boolean chipAndPin: description: Indicates is there a microchip that stores information which can be used to verify the validity of the membership and authenticate the customer based on a personal identification number (PIN). type: boolean validationByInterface: description: Indicates is the membership card is validated through the interface. type: boolean addtionalCodeInfoType: type: array description: Holds name of additional code information maxItems: 4000 items: type: object properties: name: description: Holds name of additional code information $ref: '#/components/schemas/masterInfoCodeDetailType' value: description: Holds value of additional code information type: string minLength: 0 maxLength: 2000 membershipOriginGroupType: type: object description: Details for Membership Origin Group along with associated Origin codes. properties: code: description: Code is used to identify a Membership Origin Group. type: string minLength: 0 maxLength: 20 description: description: Description of the Membership Origin Group. type: string minLength: 0 maxLength: 2000 displaySequence: description: Membership Origin Groups display sequence Number type: number originCodes: type: array description: Membership Origin code and Description. maxItems: 4000 items: $ref: '#/components/schemas/codeDescriptionType' managedBy: $ref: '#/components/schemas/managedByOptions' membershipTypeAdditionalInfoType: type: object description: Membership Type miscellanous settings. properties: enrollmentLetter: description: When enrolling new members, this is the default letter to be sent. type: string minLength: 0 maxLength: 80 adhocStatement: description: Default membership statement to be sent ad hoc. type: string minLength: 0 maxLength: 80 batchStatement: description: Batch process statement. type: string minLength: 0 maxLength: 80 autoWebEnrollment: description: Automatically open to allow a web user account to be created. type: boolean autoUpdateWebLogin: description: Automatically update web login. type: boolean membershipMarketGroupsType: type: array description: Details for Membership Market Group along with associated Market codes. maxItems: 4000 items: $ref: '#/components/schemas/membershipMarketGroupType' rateRuleMembershipsType: type: array description: Rate rule membership type details. maxItems: 4000 items: $ref: '#/components/schemas/rateRuleMembershipType' uniqueID_Type: type: object description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). properties: id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 tierManagement: type: object description: Request object for processing membership tier level changes. properties: tierManagementProcess: description: Details required to start Tier Management process. $ref: '#/components/schemas/tierManagementProcessType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' tierManagementBatchProcessType: type: object description: Base details of Tier Management Batch Process. properties: reportId: description: Unique ID of the report generated by the batch process. $ref: '#/components/schemas/uniqueID_Type' recordType: description: Record created for process type Upgrade(UP)/Downgrade(DN)/Renewal(RE). $ref: '#/components/schemas/membershipLevelRuleTypeType' evaluationDate: description: Date for which routine was run. type: string format: date maxLength: 8 processDate: description: Date when routine was run. type: string format: date maxLength: 8 membershipType: description: Membership type type: string minLength: 0 maxLength: 20 insertUser: description: User who requested the batch process. type: integer insertUserName: description: UserName who requested the batch process. type: string tMRApplied: description: Indicates if TMR (Tier Management Reset) setup was applied while running the batch process. type: boolean pendingCount: description: Count of records with status NEW. type: integer completedCount: description: Count of records with status COMPLETE. type: integer deletedCount: description: Count of records with status DELETE. type: integer errorCount: description: Count of records with status ERROR. type: integer lockedCount: description: Count of records with status LOCKED. type: integer membershipTypeRuleGeneralConditionsType: type: object description: Membership Type Rules general Conditions. properties: reservationChannel: description: Reservation Channel for which the rule is applied. This attribute is deprecated would not be used further. type: string minLength: 0 maxLength: 20 property: description: Property for which the rule is applied. type: string minLength: 0 maxLength: 20 propertyGroup: description: Property group for which the rule is applied. type: string minLength: 0 maxLength: 20 enrollmentCode: description: Enrollment Code for which the rule is applied. type: string minLength: 0 maxLength: 20 enrollmentGroup: description: Enrollment Group for which the rule is applied. type: string minLength: 0 maxLength: 20 promotionCode: description: Promotion Code for which the rule is applied. type: string minLength: 0 maxLength: 20 membershipLevel: description: Membership Level for which the rule is applied. type: string minLength: 0 maxLength: 20 originCode: description: Origin Code for which the rule is applied. type: string minLength: 0 maxLength: 20 originGroup: description: Origin group for which the rule is applied. type: string minLength: 0 maxLength: 20 excludeOriginGroup: description: To specify the exclusion of origin group while applying rule. type: boolean membershipAwardGenerationMethodType: type: string description: Type of action that generates membership award points. enum: - Batch - Manual - System membershipAwardOtherInfoType: type: object description: Information related to Other Award. properties: pointsRequired: description: Points required to avail/redeem this award. type: number awardValue: description: The actual value of the award, in the amount of currency. type: number messageLine1: description: Message for Other awards. type: string minLength: 0 maxLength: 4000 messageLine2: description: Message for Other awards. type: string minLength: 0 maxLength: 4000 messageLine3: description: Message for Other awards. type: string minLength: 0 maxLength: 4000 messageLine4: description: Message for Other awards. type: string minLength: 0 maxLength: 4000 displaySet: description: Display set for other type of awards for export purpose. type: string minLength: 0 maxLength: 40 membershipTypeRuleIDType: type: object description: Membership type rule ID. properties: membershipType: description: Membership type of the Rule. type: string minLength: 0 maxLength: 20 membershipPointsSequence: description: Sequence number of the membership type rule. type: integer membershipLevelsInfo: type: object description: Response object for fetching membership levels. properties: membershipLevels: description: Collection of membership levels. $ref: '#/components/schemas/membershipLevelsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipTypeRuleConditionsType: type: object description: Membership Type Rule Conditions. properties: generalConditions: description: Specifies the General Conditions to apply the rules. $ref: '#/components/schemas/membershipTypeRuleGeneralConditionsType' rateConditions: description: Specifies the Rate code Conditions to apply the rules. $ref: '#/components/schemas/membershipTypeRuleRateConditionsType' roomConditions: description: Specifies the Room Conditions to apply the rules. $ref: '#/components/schemas/membershipTypeRuleRoomConditionsType' segmentationConditions: description: Specifies the Segmentation Conditions to apply the rules. $ref: '#/components/schemas/membershipTypeRuleSegmentationConditionsType' reservationConditions: description: Specifies the Reservation Conditions to apply the rules. $ref: '#/components/schemas/membershipTypeRuleReservationConditionsType' userDefinedEnrollmentFieldsType: type: array description: Type that holds the User Defined Enrollment field/Attribute such as Communication, First Name , Last Name etc. maxItems: 4000 items: $ref: '#/components/schemas/userDefinedEnrollmentFieldType' numberOfYearsType: type: string description: Five Year period enum: - One - Two - Three - Four - Five membershipTypeRuleSegmentationConditionsType: type: object description: Membership Type Rules segmentation conditions. properties: marketCode: description: Market Code for which the rule is applied. type: string minLength: 0 maxLength: 20 marketGroup: description: Market group for which the rule is applied. type: string minLength: 0 maxLength: 20 excludeMarketGroup: description: To specify the exclusion of market group while applying rule. type: boolean sourceCode: description: Source Code for which the rule is applied. type: string minLength: 0 maxLength: 20 sourceGroup: description: Source group for which the rule is applied. type: string minLength: 0 maxLength: 20 excludeSourceGroup: description: To specify the exclusion of source group while applying rule. type: boolean qualifyingRatesType: type: array description: Qualifying Rate information. maxItems: 4000 items: $ref: '#/components/schemas/qualifyingRateType' qualifyingRateType: type: object description: Qualifying Rate information. Only Qualifying field is considered while updating record. properties: hotelId: description: Qualifying Rate hotel code. type: string minLength: 0 maxLength: 20 ratePlanCode: description: Qualifying rate code. type: string minLength: 0 maxLength: 20 description: description: Description of the Qualifying rate. type: string minLength: 0 maxLength: 2000 marketCode: description: Qualifying rate market code. type: string minLength: 0 maxLength: 20 qualifying: description: Indicates whether the Rate code is Qualifying or not. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' membershipClassType: type: object description: Base type provides information about Membership Market/Property Groups Configuration. properties: code: description: Code is used to identify a Membership Market/Resort Group. type: string minLength: 0 maxLength: 20 description: description: Description of the Membership Market/Propety Group. type: string minLength: 0 maxLength: 2000 displaySequence: description: Membership Market/Property Groups display sequence Number type: number loyaltyProgram: description: This flag indicates whether the membership class is eligible for loyalty program or not. type: boolean frequentFlyer: description: This flag indicates whether the membership class is eligible for frequent flyer or not. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' tierManagementBatchProcessesType: type: array description: Tier Management Batch Process details. maxItems: 4000 items: $ref: '#/components/schemas/tierManagementBatchProcessType' codeListType: type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 awardsExceptionCriteriaType: type: object description: Criteria for detecting exceptions in points calculation properties: multipleRooms: description: Enter the number of multiple rooms that should be flagged as an exception for same stay dates. type: integer bBSingleProperty: description: Back to Back stay at a Single Property type: boolean bBSingleGroup: description: Back to back stay at a Single Group type: boolean bBCrossMembership: description: Cross Membership Back to Back Stays type: boolean externalProcessingException: description: Number of days while awaiting an external accept/reject response file. type: integer membershipAwardRateInfoType: type: object description: Membership Award cancel related details. properties: cancelPenaltyDays: description: If a reservation is booked using award points, this is the number of days before the arrival date by which the reservation may be cancelled without penalty. Zero indicates that the reservation may be cancelled any time up to and including the arrival date without incurring a penalty. type: number cancelPenaltyCharge: description: The flat number of award points, or the percentage of the award points, that are forfeited if the guest cancels the reservation fewer than the number of days specified in Cancel Penalty Days before the arrival date. type: number cancelPenaltyType: description: Cancel Penalty type POINTS/PERCENT. $ref: '#/components/schemas/membershipAwardCancelPenaltyType' cancelPolicyType: description: Type of cancel policy - All/Nights. $ref: '#/components/schemas/membershipAwardCancelPolicyType' numberOfNights: description: Number of nights cancel policy is applicable. type: integer instanceLink: type: object description: Metadata describing link description objects that MAY appear in the JSON instance representation. properties: href: description: URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true. type: string rel: description: Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile. type: string templated: description: Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false. type: boolean default: false method: description: HTTP method for requesting the target of the link. type: string enum: - GET - POST - PUT - DELETE - PATCH - OPTIONS - HEAD targetSchema: description: Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.. type: string operationId: description: The operationId of the path you can call to follow this link. This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply. type: string title: description: Exact copy of the "summary" field on the linked operation. type: string membershipHandlingType: type: object description: Represents the way a membership type has to be processed. properties: externalDatabase: description: Indicates database for external system (if applicable). type: string minLength: 0 maxLength: 20 externalPointsAndRedemptionDatabase: description: Indicates database for external points & redemption system (if applicable). type: string minLength: 0 maxLength: 20 levelRequired: description: Indicates whether to include membership level for validation or not , when profile membership information is send from External System to ORS/OCIS. type: boolean fulfillment: description: True if you wish to be able to select this membership type when creating an export file for fulfillment. type: boolean allowCardNumberOverride: description: Indicates whether to perform profile merge or not. type: boolean enrollmentCodeRequired: description: Indicates whether Enrollment Code required of not. type: boolean saveCardNumberHistory: description: Indicates whether to store discard membership number or not.Membership Number will be discarded during profile merge. type: boolean statementUDFSet: description: Represents Membership Statement UDF Set. Selected Statement UDF template will be attached to Membership. type: string minLength: 0 maxLength: 40 defaultMembershipStatus: description: Represents Membership status.This status will be assigned to Guest's profile with membership type. type: string minLength: 0 maxLength: 40 nameProtected: description: Prevent profile name change. type: boolean alternateNameProtected: description: Prevent profile alternate name change. type: boolean autoGenerateReferenceNo: description: Automatically generate the reference number for the primary membership. type: boolean autoPopulateNumberFromName: description: Automatically populate number from name. type: boolean nameOnCardFromAltName: description: Membership card name using the alternate name. type: boolean moveMemPromotions: description: Move the membership promotions to the active membership. type: boolean calendarPeriodType: type: string description: 12 month period based on starting month. enum: - Calendar - Rolling membershipTypeInstructionType: type: string description: Membership levels. enum: - PrimaryDetails - CardNumberDetails - PointsDetails - ExceptionCriteriaDetails - AdditionalDetails - EnrollmentDetails - Levels hotelFolioTextsType: type: array description: Collection of hotel folio texts maxItems: 4000 items: $ref: '#/components/schemas/hotelFolioTextType' membershipBenefitProgramType: type: object description: Type that holds key values, that uniquely identifies a membership benefit program properties: membershipType: description: Membership type type: string minLength: 0 maxLength: 20 code: description: Benefit Code type: string minLength: 0 maxLength: 40 dateRange: description: Begin date and End date of this membership benefit program. $ref: '#/components/schemas/dateRangeType' minimumLevel: description: Min value for membership level. This is the minimum membership level member gets for enrolling into this program. type: string minLength: 0 maxLength: 20 description: description: Description of the Membership Benefit Program. type: string minLength: 0 maxLength: 4000 inactive: description: Flag indicates whether the Membership Benefit Program is active or not. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' membershipBenefitPrograms: type: object description: Request object for modifying membership benefit programs. properties: membershipBenefitPrograms: description: Collection of membership benefit programs to be changed. $ref: '#/components/schemas/membershipBenefitProgramsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' masterInfoCodeDetailType: type: string enum: - LongDescription - ShortDescription membershipTypeRuleBasedOnType: type: string description: Indicates Membership upgrades/downgrades to the next tier level uses RFM (Recency, Frequency, Monetary Value) score. enum: - Revenue - Stay - Nights - Enrollment - TierUpgrade - Renewal - Rfm - EnrollmentReferral tierManagementChanges: type: object description: Request object for applying membership changes calculated by Tier Management process. properties: reportId: description: Unique ID of the report generated by the batch process. $ref: '#/components/schemas/uniqueID_Type' overrideWarning: description: If true, overrides the warning "Previous batch(es) ran but update not completed." and proceeds update. type: boolean links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipTypeRules: type: object description: Request object for changing membership type rules. properties: membershipTypeRules: description: Collection of membership type rules to be changed. $ref: '#/components/schemas/membershipTypeRuleDetailsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipActionType: type: string description: Type of action that the user wants to attach membership information to the reservation . enum: - AutoPopulate - PromptToPopulate - AlwaysPrompt - NoAction membershipAwardDetailType: type: object description: Values by which membership award is uniquely identied. properties: membershipType: description: Membership type for which awards are defined. type: string minLength: 0 maxLength: 20 awardCode: description: Membership Award Code. type: string minLength: 0 maxLength: 40 hotelId: description: Hotel code to which the record belongs. type: string minLength: 0 maxLength: 20 code: description: Membership Award Detail Code. type: string minLength: 0 maxLength: 20 upgradeId: description: Value to uniquely identify Room/Room Group upgrade record. $ref: '#/components/schemas/uniqueID_Type' groupUpgrade: description: Identify whether Room or Room Group upgrade record. type: boolean inactive: description: Inactive flag for Membership Award detail (Rate/Product/upgrade). type: boolean dateRange: description: Begin date and End date of this membership award upgrade. $ref: '#/components/schemas/dateRangeType' pointsRequired: description: Points required to upgrade. type: number fromRoom: description: Upgrade from Room. type: string minLength: 0 maxLength: 20 toRoom: description: Upgrade to Room. type: string minLength: 0 maxLength: 20 fromRoomGroup: description: Upgrade from Room Group. type: string minLength: 0 maxLength: 20 toRoomGroup: description: Upgrade to Room Group. type: string minLength: 0 maxLength: 20 membershipTypeRulesSummariesType: type: array description: List of Membership type rules summary information. maxItems: 4000 items: $ref: '#/components/schemas/membershipTypeRuleSummaryType' status: type: object description: Response Body. properties: warnings: $ref: '#/components/schemas/warningsType' links: $ref: '#/components/schemas/links' masterInfoType: type: object properties: codeInfo: type: array maxItems: 4000 items: $ref: '#/components/schemas/codeInfoType' codeType: $ref: '#/components/schemas/masterType' qualifyingRates: type: object description: Request object for changing qualifying rate rules. properties: qualifyingRates: description: Collection of qualifying rates to be changed. $ref: '#/components/schemas/qualifyingRatesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipAwardCancelPolicyType: type: string description: Cancel policy is applicable only on Nights. enum: - All - Nights tierManagementBatchRecordStatusType: type: string description: Record locked. enum: - New - Complete - Delete - Error - Locked membershipRatesInfo: type: object description: Response object for fetching membership rates. properties: membershipRates: description: Collection of membership rates summary. $ref: '#/components/schemas/membershipRatesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipTypeRuleType: type: string description: Membership Type/Program rule types, Points is the only valid value for non primary membership types. enum: - All - Points - Tier recordStatusEnum: type: string enum: - New - Complete - Delete - Error - Locked membershipTypeRuleRoomConditionsType: type: object description: Membership Type Rules room conditions. properties: roomType: description: Room type/label for which the rule is applied. type: string minLength: 0 maxLength: 20 roomGroup: description: Membership room group for which the rule is applied. type: string minLength: 0 maxLength: 20 roomClass: description: Room class for the room for which the rule is applied. type: string minLength: 0 maxLength: 20 roomsToCharge: description: Indicates whether to use Room Type or Booked Room Type for the rule. If Y then Booked Room Type will be used for points calculation otherwise Room Type to be used. type: boolean membershipTypeRulePointsDefinitionType: type: object description: Membership Program Rule points details. properties: points: description: Specifies the ratio of the points accumulated per Stay or Night or Revenue. This ratio multiplied by the actual Stays or Nights or Revenue will give the Total points accumulated. type: integer costPerPoint: description: Indicates the cost per point for this membership program. type: integer revenueUnits: description: Specifies the minimum units needed. type: integer pointsRoundingFlag: description: This flag tells if the total amount computed will be rounded, rounded up or rounded down. $ref: '#/components/schemas/pointsRoundingFlagType' percentagePoints: description: Points ratio is expressed in terms of %. type: boolean excludePointProjection: description: Determines while calculating points projection should the rule be excluded or included. Default is included(N). type: boolean membershipRateCodesType: type: array description: Membership Rates code and Description. maxItems: 4000 items: $ref: '#/components/schemas/codeDescriptionType' membershipSourceGroupDetails: type: object description: Request object for adding/changing existing Membership Source Group Configurations. properties: membershipSourceGroup: description: Membership Source Groups Configurations to be changed. $ref: '#/components/schemas/membershipSourceGroupType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipRoomGroupType: type: object description: Membership room group details. properties: roomGroup: description: Room group code. type: string minLength: 0 maxLength: 20 description: description: Description of the room group. type: string minLength: 0 maxLength: 2000 roomTypes: description: Room types selected for the group. $ref: '#/components/schemas/codeListType' sequence: description: Sequence of the room group. type: integer managedBy: $ref: '#/components/schemas/managedByOptions' membershipEnrollmentGroupType: type: object description: Base type provides information about Membership Market/Property Groups Configuration. properties: code: description: Code is used to identify a Membership Market/Resort Group. type: string minLength: 0 maxLength: 20 description: description: Description of the Membership Market/Propety Group. type: string minLength: 0 maxLength: 2000 displaySequence: description: Membership Market/Property Groups display sequence Number type: number enrollmentCodes: description: Collection of code and description of enrollment codes that are associated to the membership enrollment group. $ref: '#/components/schemas/membershipEnrollmentCodesInfoType' managedBy: $ref: '#/components/schemas/managedByOptions' membershipRevenueTypes: type: object description: Request object for changing new membership revenue types. properties: membershipRevenueTypes: description: Collection of membership revenue types. $ref: '#/components/schemas/membershipRevenueTypesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' ruleAppliesOnType: type: string description: Applies on restricted dates. enum: - Arrival - Departure - Any - Restricted updateSuspendedMatchRuleType: type: object description: Provides information for updating the Suspended Profile Match Rule Configuration. properties: region: description: Region to filter by based on the profile region setup type: string nameType: description: Name type to filter match rules type: string validationItem: description: Validation item for the existing rule type: string newValidationItem: description: Validation item for the existing rule type: string validationType: description: Validation type for the rule type: string validationValue: description: Validation value for the rule type: string applyRuleYn: description: The activation flag for the match rule type: boolean userMaintainable: description: Whether the rule is maintainable by users type: boolean tierManagementBatchProcesses: type: object description: Response object for fetching Tier Management Batch Reports. properties: tierManagementBatchProcesses: description: Tier Management Batch Reports Type. $ref: '#/components/schemas/tierManagementBatchProcessesType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipLevelRulesInfo: type: object description: Response object for fetching Membership Level Rules. properties: membershipLevelRules: description: Collection of Membership Level Rules. $ref: '#/components/schemas/membershipLevelRulesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipRateGroups: type: object description: Request object for modifying Membership Rate Groups. properties: membershipRateGroups: description: Collection of Membership Rate Groups to be changed. $ref: '#/components/schemas/membershipRateGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' userDefinedEnrollmentFieldNameType: type: string description: Date of birth field of Membership Type. enum: - Communication - LastName - FirstName - Address - Fee - BirthDate membershipYearlyTransactionsSummaryType: type: array description: Yearly membership transaction summary. maxItems: 4000 items: $ref: '#/components/schemas/membershipYearlyTransactionSummaryType' membershipOriginGroupDetails: type: object description: Request object for adding/changing existing Membership Origin Group Configurations. properties: membershipOriginGroup: description: Membership Origin Groups Configurations to be changed. $ref: '#/components/schemas/membershipOriginGroupType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' calendarGracePeriodType: type: string description: Five Year period enum: - NoGracePeriod - OneYear - TwoYears - ThreeYears - FourYears - FiveYears codeDescriptionType: type: object description: This contains a generic code and description information. properties: code: description: Code. type: string minLength: 0 maxLength: 20 description: description: description. type: string minLength: 0 maxLength: 2000 membershipRevenueGroups: type: object description: Request object for changing new membership revenue groups. properties: membershipRevenueGroups: description: Collection of membership revenue groups. $ref: '#/components/schemas/membershipRevenueGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipGracePeriodStatusType: type: string description: Member is a candidate for downgrade as per level rules. enum: - Period - NotEver - Grace - Blank tierManagementBatchRecordsType: type: array description: Tier Management Batch Record details. maxItems: 4000 items: $ref: '#/components/schemas/tierManagementBatchRecordType' membershipPropertyCodesType: type: array description: Membership Property code and Description. maxItems: 4000 items: $ref: '#/components/schemas/codeDescriptionType' managedByOptions: description: Describes of the Configuration is Managed by Enterprise or Property. type: string enum: - EnterpriseManaged - PropertyManaged - EnterpriseEnforced - PropertyOverridden membershipMarketGroupsInfo: type: object description: Response object for fetching Membership Market Groups configurations. properties: membershipMarketGroups: description: Collection of Membership Market Groups configurations. $ref: '#/components/schemas/membershipMarketGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipLevelRulesType: type: array description: Membership Level Rule details. maxItems: 4000 items: $ref: '#/components/schemas/membershipLevelRuleType' membershipAwardUpgradeInfoType: type: object description: Membership Award cancel related details. properties: cancelPenaltyDays: description: If a reservation is booked using award points, this is the number of days before the arrival date by which the reservation may be cancelled without penalty. Zero indicates that the reservation may be cancelled any time up to and including the arrival date without incurring a penalty. type: number cancelPenaltyCharge: description: The flat number of award points, or the percentage of the award points, that are forfeited if the guest cancels the reservation fewer than the number of days specified in Cancel Penalty Days before the arrival date. type: number cancelPenaltyType: description: Cancel Penalty type POINTS/PERCENT. $ref: '#/components/schemas/membershipAwardCancelPenaltyType' cancelPolicyType: description: Type of cancel policy - All/Nights. $ref: '#/components/schemas/membershipAwardCancelPolicyType' numberOfNights: description: Number of nights cancel policy is applicable. type: integer basedOnRoomGroup: description: Indicates if the membership award upgrade is based on room category (N) or room category group (Y). type: boolean membershipRoomGroupsType: type: array description: Membership room group information. maxItems: 4000 items: $ref: '#/components/schemas/membershipRoomGroupType' membershipAwardType: type: object description: Values by which membership award is uniquely identied. properties: membershipType: description: Membership type for which awards are defined. type: string minLength: 0 maxLength: 20 awardCode: description: Membership Award Code. type: string minLength: 0 maxLength: 20 shortDescription: description: Short description of Award. type: string minLength: 0 maxLength: 80 longDescription: description: Detailed description and specification of the Award. type: string minLength: 0 maxLength: 2000 ruleScheduleCode: description: Rule Schedule applied to this Award. type: string minLength: 0 maxLength: 20 billingGroup: description: The billing group that represents a billing rule schedule for the membership award. type: string minLength: 0 maxLength: 20 membershipLevel: description: Membership level required for eligibility to receive this award. Other membership levels are not eligible for this award. type: string minLength: 0 maxLength: 20 dateRange: description: Begin date and End date of this membership award. $ref: '#/components/schemas/dateRangeType' inactive: description: Inactive flag for Membership Award. The award record cannot be deleted. type: boolean displaySequence: description: Display sequence of Award. type: number awardQuantity: description: Number of awards to be given. type: integer autoConsume: description: Indicates if award consumtion is tracked by the system. If value is Y, then system keeps track of availability of award after it is issued. type: boolean forceVerification: description: Force verification whether Rate or Product for the Award is valid at reservation. type: boolean awardBasedOn: description: Indicates if the Award is based on RATE, PRODUCT,UPGRADE,FT or OTHER. $ref: '#/components/schemas/membershipAwardBasedOnType' rateInfo: description: Information related to Rate based Award. $ref: '#/components/schemas/membershipAwardRateInfoType' productInfo: description: Information related to Product based Award. $ref: '#/components/schemas/membershipAwardProductInfoType' upgradeInfo: description: Information related to Upgrade based Award. $ref: '#/components/schemas/membershipAwardUpgradeInfoType' otherInfo: description: Information related to Other Award. $ref: '#/components/schemas/membershipAwardOtherInfoType' financialTransactionInfo: description: Information related to FT based Award. $ref: '#/components/schemas/membershipAwardFinancialTransactionInfoType' rateDiscountInfo: description: Information related to discount based Award. $ref: '#/components/schemas/membershipAwardRateDiscountInfoType' awardDetails: description: Membership Award Rate/Product/FT/Upgrade records associated with this Award. $ref: '#/components/schemas/membershipAwardDetailsType' managedBy: $ref: '#/components/schemas/managedByOptions' membershipPropertyGroupType: type: object description: Base type provides information about Membership Market/Property Groups Configuration. properties: code: description: Code is used to identify a Membership Market/Resort Group. type: string minLength: 0 maxLength: 20 description: description: Description of the Membership Market/Propety Group. type: string minLength: 0 maxLength: 2000 displaySequence: description: Membership Market/Property Groups display sequence Number type: number hotels: description: Collection of property codes which associated for a Membership Property Group. $ref: '#/components/schemas/membershipPropertyCodesType' managedBy: $ref: '#/components/schemas/managedByOptions' warningType: type: object description: Used when a message has been successfully processed to report any warnings or business errors that occurred. properties: value: type: string description: Property Value shortText: description: An abbreviated version of the error in textual format. type: string maxLength: 2000 code: description: If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. type: string minLength: 0 maxLength: 20 docURL: description: If present, this URL refers to an online description of the error that occurred. type: string maxLength: 2000 status: description: If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration. type: string maxLength: 2000 tag: description: If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing]. type: string maxLength: 2000 recordId: description: If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction. type: string maxLength: 2000 type: description: The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown". type: string minLength: 0 maxLength: 20 language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' rph: description: Reference Place Holder used as an index for this warning. type: string minLength: 1 maxLength: 8 membershipAwardProductInfoType: type: object description: Membership Award cancel related details. properties: cancelPenaltyDays: description: If a reservation is booked using award points, this is the number of days before the arrival date by which the reservation may be cancelled without penalty. Zero indicates that the reservation may be cancelled any time up to and including the arrival date without incurring a penalty. type: number cancelPenaltyCharge: description: The flat number of award points, or the percentage of the award points, that are forfeited if the guest cancels the reservation fewer than the number of days specified in Cancel Penalty Days before the arrival date. type: number cancelPenaltyType: description: Cancel Penalty type POINTS/PERCENT. $ref: '#/components/schemas/membershipAwardCancelPenaltyType' cancelPolicyType: description: Type of cancel policy - All/Nights. $ref: '#/components/schemas/membershipAwardCancelPolicyType' numberOfNights: description: Number of nights cancel policy is applicable. type: integer exceptionDetailType: title: Error Detail description: Complex type that contains error details for a REST call. type: object properties: type: type: string description: Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML). title: type: string description: Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization. status: type: integer description: HTTP status code for this occurrence of the problem, set by the origin server. detail: type: string description: Human-readable description specific to this occurrence of the problem. instance: type: string description: Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced. o:errorCode: type: string description: Application error code, which is different from HTTP error code. o:errorPath: type: string description: Path to the problem at the resource or property level. o:errorDetails: description: Details of the error message, consisting of a hierarchical tree structure. type: array items: $ref: '#/components/schemas/errorInstance' links: $ref: '#/components/schemas/links' required: - type - title membershipSourceGroupType: type: object description: Details for Membership Source Group along with associated Source codes. properties: code: description: Code is used to identify a Membership Source Group. type: string minLength: 0 maxLength: 20 description: description: Description of the Membership Source Group. type: string minLength: 0 maxLength: 2000 displaySequence: description: Membership Source Groups display sequence Number type: number sourceCodes: type: array description: Membership Source code and Description. maxItems: 4000 items: $ref: '#/components/schemas/codeDescriptionType' managedBy: $ref: '#/components/schemas/managedByOptions' membershipCardValidationRuleTypeType: type: string description: Defines rules to be used for card validation. enum: - Mod7 - Mod10 - Udef - Novalid - Internal - External membershipAwardRateDiscountInfoType: type: object description: Membership Award Rate Discount related details. properties: cancelPenaltyDays: description: If a reservation is booked using award points, this is the number of days before the arrival date by which the reservation may be cancelled without penalty. Zero indicates that the reservation may be cancelled any time up to and including the arrival date without incurring a penalty. type: number cancelPenaltyCharge: description: The flat number of award points, or the percentage of the award points, that are forfeited if the guest cancels the reservation fewer than the number of days specified in Cancel Penalty Days before the arrival date. type: number cancelPenaltyType: description: Cancel Penalty type POINTS/PERCENT. $ref: '#/components/schemas/membershipAwardCancelPenaltyType' cancelPolicyType: description: Type of cancel policy - All/Nights. $ref: '#/components/schemas/membershipAwardCancelPolicyType' numberOfNights: description: Number of nights cancel policy is applicable. type: integer pointsRequired: description: Points required to avail/redeem this award. type: number awardValue: description: The actual value of the award, in the amount of currency. type: number maxPercentAllowed: description: Max percent of total value to be allowed to convert money to points. type: number membershipYearlyTransactionSummaryType: type: object description: Yearly membership transaction summary. properties: membershipId: description: Membership ID. $ref: '#/components/schemas/uniqueID_Type' year: description: Year of the transactions. type: string minLength: 4 maxLength: 4 nights: description: Number of nights the member has stayed. type: number revenue: description: Amount of revenue generated by the member. type: number stays: description: Number of individual stays. type: number transactions: description: Number of award points transactions. type: number masterType: type: string enum: - Country - State - AddressType - PhoneType - RateCategory - CalculationRule - PostingRythym - BillingInstruction - TransactionCode - DisplaySet - MailingActions - DistanceType - District - Territory - FiscalRegion - InventoryItem - Package - RoomFeaturePreference - SpecialPreference - Promotion - Department - ReservationPreference - FacilityTask - RoomType - RateCode - OutOfOrderReason - Block translationTextType2000: type: object description: Contains Multiple translated texts and language codes. properties: defaultText: description: Default text with Character length from 0 to 2000. type: string minLength: 0 maxLength: 2000 translatedTexts: description: List of translated text and language codes. $ref: '#/components/schemas/translationsTextType' membershipRateGroupType: type: object description: Base type provides information about Membership Market/Property Groups Configuration. properties: code: description: Code is used to identify a Membership Market/Resort Group. type: string minLength: 0 maxLength: 20 description: description: Description of the Membership Market/Propety Group. type: string minLength: 0 maxLength: 2000 displaySequence: description: Membership Market/Property Groups display sequence Number type: number rateCodes: description: Collection of Rate codes associated with this Rate Group. $ref: '#/components/schemas/membershipRateCodesType' managedBy: $ref: '#/components/schemas/managedByOptions' membershipAwards: type: object description: Request object for modifying membership awards. properties: membershipAwards: description: Collection of membership awards to be changed. $ref: '#/components/schemas/membershipAwardsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipTypeRulesIDType: type: array description: List of membership type rule ID's. maxItems: 4000 items: $ref: '#/components/schemas/membershipTypeRuleIDType' membershipClassesType: type: array description: List of the Membership Class to be configured or fetched maxItems: 4000 items: $ref: '#/components/schemas/membershipClassType' membershipTypes: type: object description: Response object for fetching Membership Types. properties: membershipTypes: description: Collection of Membership types fetched. $ref: '#/components/schemas/membershipTypesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipRevenueTypesInfo: type: object description: Response object for fetching membership revenue types. properties: membershipRevenueTypes: description: Collection of membership revenue types. $ref: '#/components/schemas/membershipRevenueTypesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipAwardCancelPenaltyType: type: string description: Penalty charge is in percentage. enum: - Points - Percent membershipRatesType: type: array description: Membership Rate summary information. maxItems: 4000 items: $ref: '#/components/schemas/membershipRateType' membershipOriginGroupsDetails: type: object description: Response object for fetching Membership Origin Groups configurations. properties: membershipOriginGroups: type: array maxItems: 4000 description: Collection of Membership Origin Groups configurations. items: $ref: '#/components/schemas/membershipOriginGroupType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipEnrollmentGroupsInfo: type: object description: Response object for fetching membership enrollment groups. properties: membershipEnrollmentGroups: description: Collection of membership enrollment groups. $ref: '#/components/schemas/membershipEnrollmentGroupsType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipClassesInfo: type: object description: Response object for fetching Membership Class. properties: membershipClasses: description: Collection of Membership Classes. $ref: '#/components/schemas/membershipClassesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipRevenueGroupsType: type: array description: Details of membership revenue group type. maxItems: 4000 items: $ref: '#/components/schemas/membershipRevenueGroupType' membershipTypeRuleDefinitionType: type: object description: Membership Type Rule definition details. properties: ruleCode: description: Rule code of the membership type rule. type: string minLength: 0 maxLength: 20 programType: description: Program(Points/Tier) type of the rule. $ref: '#/components/schemas/membershipTypeRuleType' ruleAppliesOn: description: Rule applies on Reservation Arrival Date, Reservation Departure Date, Any date during stay or RestrictedDates. $ref: '#/components/schemas/ruleAppliesOnType' noOfTimesEligible: description: Specifies total number of times program rule is eligible . type: integer ruleExportLabel: description: This field will be used to store export label and will be used only for exporting purposes. type: string minLength: 0 maxLength: 40 ruleExpirationDate: description: Date on which the rule will be expired. type: string format: date maxLength: 8 membershipLevelRuleType: type: object description: Membership Level Rule ID type. properties: membershipType: description: Membership Type. type: string minLength: 0 maxLength: 20 membershipLevel: description: Membership Level. type: string minLength: 0 maxLength: 20 ruleNo: description: Membership Level Rule Number. type: number ruleType: description: Specifies whether Downgrade/Upgrade type rule. $ref: '#/components/schemas/membershipLevelRuleTypeType' recordType: description: RESIDENT/RFM. $ref: '#/components/schemas/membershipLevelRuleRecordType' ruleBasedOn: description: Factor on which the upgrade or downgrade rule is based ( Revenue, Stays, Nights ). $ref: '#/components/schemas/membershipTypeRuleBasedOnType' requiredUnits: description: Minimum number of tier points required for an upgrade or tier points below which downgrade will be effected. type: number overrideUnits: description: An "interim" tier point value used to override the Required Points value for an upgrade/downgrade batch run. This value remains in-effect until it is manually changed or deleted. type: number brandCount: description: Specifies the minimum number of brands (for membership stay) required for the level upgrade or downgrade rule. type: integer rulePointsTypeType: type: string description: Possible membership points types. enum: - Base - Bonus membershipLevelRuleRecordType: type: string description: Used when Membership upgrades/downgrades to the next tier level uses RFM (Recency, Frequency, Monetary Value) score. enum: - Resident - All membershipBenefitProgramsInfo: type: object description: Response object for fetching membership benefit programs. properties: membershipBenefitPrograms: description: Collection of membership benefit programs. $ref: '#/components/schemas/membershipBenefitProgramsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' attachMembershipToReservationRuleType: type: string description: Indicates when the membership information should get attach to the reservation. enum: - NewReservation - UpdateReservation - Checkin - Checkout profileRegionsInfo: type: object description: Object for Profile Regions Configuration. properties: profileRegions: description: Collection of Profile Regions. type: array maxItems: 4000 items: $ref: '#/components/schemas/profileRegionType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipTypesType: type: array description: Membership Type maxItems: 4000 items: $ref: '#/components/schemas/membershipTypeType' autoGenerateCardNumberType: type: object description: Holds the configuration to generate membership card number. properties: cardRangeStart: description: Card number auto generation range. type: string minLength: 0 maxLength: 80 cardRangeEnd: description: Card number auto generation range. type: string minLength: 0 maxLength: 80 cardNumberPrefix: description: Valid card number prefix. type: string minLength: 0 maxLength: 20 cardNumberFormat: description: Indicates what format the random generation card number should follow, Format we support are - 9 for Numbers, X for Alphanumeric mixed, and A for Alpha only. For example, 32093K. type: string minLength: 0 maxLength: 20 operaVersionNumberType: type: string description: Current Opera Version Number minLength: 0 maxLength: 40 membershipRoomGroupsInfo: type: object description: Response object for fetching membership room groups. properties: membershipRoomGroups: description: Collection of membership room groups summary. $ref: '#/components/schemas/membershipRoomGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipRates: type: object description: Request object for changing membership rate rules. properties: membershipRates: description: Collection of membership rate rules to be changed. $ref: '#/components/schemas/membershipRatesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' tierManagementProcessType: type: object description: Details required to start Tier Management process. properties: membershipType: description: Membership type type: string minLength: 0 maxLength: 20 evaluationDate: description: Date for which routine is run. type: string format: date maxLength: 8 upgrade: description: True indicates to run the batch process for membership upgrade. type: boolean downgrade: description: True indicates to run the batch process for membership downgrade. type: boolean renewal: description: True indicates to run the batch process for membership renewal. type: boolean applyChangesImmediately: description: True indicates to run the batch process and apply changes immediately without reviewing the proposed changes to memberships. type: boolean membershipClasses: type: object description: Request object for changing Membership Class. properties: membershipClasses: description: Details of the Membership Classes to be edited. $ref: '#/components/schemas/membershipClassesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipTypeRuleTransactionCodeType: type: string description: Determines the Transaction Code for Membership program rule. enum: - Resident - NonResident codeInfoType: type: object description: '' properties: description: type: string minLength: 0 maxLength: 80 addtionalCodeInfo: $ref: '#/components/schemas/addtionalCodeInfoType' hotelId: type: string minLength: 0 maxLength: 20 code: type: string minLength: 0 maxLength: 20 awardPointsType: type: object description: Base parent type for membership points comprising common elements between award points and tier points. properties: nonMemberPoints: description: Indicates if points will be displayed for guests who are not members. type: boolean delayInDays: description: Award points will be recognized in this number of days following the guest's check out date. The minimum number of days is 3 and the maximum number of days is 60. This delay provides a period of time during which adjustments can be made at the PMS level before awards are uploaded to ORS/OCIS. type: integer yearsToExpire: description: Indicates Membership card will be expired if there is no activity on the card for this number of years. type: integer calendarPeriod: description: Period of points calculation. $ref: '#/components/schemas/calendarPeriodType' expiryPeriod: description: Membership card expiration period. If no value is provided it will be defaulted to 1 year. $ref: '#/components/schemas/numberOfYearsType' expiryMonth: description: Month of Expiry for Calendar type: string minLength: 0 maxLength: 10 monthsToAwardPointsExpiry: description: Months for which the Points accumulated can be redeemed for Rolling period. type: integer awardPointsExpiryDate: description: Months for which the Points accumulated can be redeemed for Calendar period. $ref: '#/components/schemas/awardPointsValidityDurationType' awardRedeemThreshold: description: Award redemption threshold type: integer activityPeriodMonths: description: Activity Period in months for Rolling. type: integer activityPeriodYears: description: Activity Period in years for Calendar. $ref: '#/components/schemas/numberOfYearsType' gracePeriodMonths: description: Grace Period in months used for Rolling. type: integer gracePeriodYear: description: Grace Period in years used for Calendar. $ref: '#/components/schemas/calendarGracePeriodType' requiredOnStayPeriod: description: Calculate stay points even if the loyalty membership card is not attached. type: boolean exceptionCriteria: description: Criteria for detecting exceptions in points calculation. $ref: '#/components/schemas/awardsExceptionCriteriaType' referralPeriod: description: Number of days from new member's join date when referral can be added. type: integer membershipEnrollmentGroups: type: object description: Request object for changing new membership enrollment groups. properties: membershipEnrollmentGroups: description: Collection of membership enrollment groups. $ref: '#/components/schemas/membershipEnrollmentGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' awardPointsValidityDurationType: type: string description: Five Year period enum: - DoNotExpire - SameYear - OneYear - TwoYears - ThreeYears - FourYears - FiveYears translationsTextType: type: array description: Language code for the translation. maxItems: 4000 items: type: object properties: value: type: string description: Used for Character Strings, length 0 to 2000. minLength: 0 maxLength: 2000 language: description: Language identification. type: string minLength: 0 maxLength: 20 description: Language code for the translation. enrollmentMatchRuleType: type: object description: Represent Enrollment Match Rule and User Defined Enrollment fields/Attribute configuration for membership type. properties: membershipEnrollmentMatchRule: description: Enrollment Match Rule for Membership Type. type: string minLength: 0 maxLength: 4000 userDefinedEnrollmentFields: description: User Defined Enrollment fields/Attributes for membership type. $ref: '#/components/schemas/userDefinedEnrollmentFieldsType' advancedEnrollment: description: Indicates if the Advanced Enrollment is enabled for Membership Type. Advanced Enrollment is required tp apply Membership Enrollment Match Rule and User Defined Enrollment Fields/Attributes. type: boolean tierManagementBatchRecords: type: object description: Response object for fetching Tier Management Batch Records. properties: tierManagementBatchRecords: description: Tier Management Batch Records Type. $ref: '#/components/schemas/tierManagementBatchRecordsType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipTypeRulesDetails: type: object description: Response object for creating membership type rules. properties: membershipTypeRules: description: Membership type rule primary details on successful creation. $ref: '#/components/schemas/membershipTypeRulesIDType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipMarketCodesType: type: array description: Membership Markets code and Description. maxItems: 4000 items: $ref: '#/components/schemas/codeDescriptionType' tierPointsType: type: object description: Base parent type for membership points comprising common elements between award points and tier points. properties: nonMemberPoints: description: Indicates if points will be displayed for guests who are not members. type: boolean basedOn: description: Date on which the tier management is based. $ref: '#/components/schemas/pointsCalculationDateType' tierExpirationMonth: description: Month for Upgrade/Downgrade in a Calendar Period. type: string minLength: 0 maxLength: 10 requalifyOnUpgrade: description: Requalify on Upgrade type: boolean downgradeRenewalInAutoJob: description: Downgrade/Renew the membership level automatically. type: boolean upgradePeriodRolling: description: Upgrade period of points for Rolling period. $ref: '#/components/schemas/numberOfYearsType' downgradePeriodRolling: description: Downgrade period of points for Rolling period. $ref: '#/components/schemas/numberOfYearsType' upgradePeriodCalendar: description: Upgrade period of points for Calendar period. $ref: '#/components/schemas/upgradeDowngradeForCalendarPeriodType' downgradePeriodCalendar: description: Downgrade period of points for Calendar period. $ref: '#/components/schemas/upgradeDowngradeForCalendarPeriodType' enableTierManagementReset: description: TMR (Tier Management Reset) Level Rules configuration enabled or not. type: boolean tierManagementBatchRecordType: type: object description: Base details of records processed by Tier Management Batch process. properties: name: description: Display name of the member. type: string minLength: 0 maxLength: 200 recordStatus: description: Status of the record. like (NEW, ERROR). $ref: '#/components/schemas/tierManagementBatchRecordStatusType' level: description: Old membership level before upgrade or downgrade. type: string minLength: 0 maxLength: 100 levelDifference: description: Level Difference. type: integer membershipCardNumber: description: Member Card no. type: string minLength: 0 maxLength: 100 id: description: Key to uniquely identify a Tier Management batch record. $ref: '#/components/schemas/tierManagementBatchRecordIDType' newLevel: description: The level to which the membership will be upgraded or downgraded. type: string minLength: 0 maxLength: 100 gracePeriodStatus: description: Current grace period status. $ref: '#/components/schemas/membershipGracePeriodStatusType' newGracePeriodStatus: description: The status of the membership after the upgrade or downgrade. $ref: '#/components/schemas/membershipGracePeriodStatusType' evaluationPeriod: description: Period for which member transactions were evaluated. $ref: '#/components/schemas/dateRangeType' joinedDate: description: Date when the member joined the membership program. type: string format: date maxLength: 8 expirationDate: description: Membership card expiration date before and after upgrade,downgrade or renewal. $ref: '#/components/schemas/dateRangeType' customRule: description: Custom Rule that needs to be applied from tier rules. type: string minLength: 0 maxLength: 4000 yearlyTransactions: description: Collection of Yearly membership transactions. $ref: '#/components/schemas/membershipYearlyTransactionsSummaryType' log: description: Log of how and what was evaluated for the member. type: string minLength: 0 maxLength: 2000 error: description: Errors if any while processing for a member. type: string minLength: 0 maxLength: 2000 profileId: description: OPERA Profile ID that associated with the record. $ref: '#/components/schemas/profileId' membershipCardValidationRuleType: type: object description: Payment method card validation rules. properties: length: description: Valid lengths of card number. type: string minLength: 0 maxLength: 50 prefix: description: Valid card number prefix. type: string minLength: 0 maxLength: 20 ranges: description: Collection of card number ranges. $ref: '#/components/schemas/cardRangesType' formula: description: Formula used for card validation. Only valid in case of user defined validation. type: string minLength: 0 maxLength: 2000 rule: description: Defines rules to be used for membership card validation. $ref: '#/components/schemas/membershipCardValidationRuleTypeType' errorInstance: title: Error Instance Details description: Complex type that contains error instance details for a REST call. type: object properties: type: type: string description: Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML). title: type: string description: Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization. status: type: integer description: HTTP status code for this occurrence of the problem, set by the origin server. detail: type: string description: Human-readable description specific to this occurrence of the problem. instance: type: string description: Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced. o:errorCode: type: string description: Application error code, which is different from HTTP error code. o:errorPath: type: string description: Path to the problem at the resource or property level. required: - type - title cardNumberGenerationModeType: type: string description: Card Number is generated using Enrollment Code. enum: - DefaultSequence - EnrollmentCode membershipFolioTextsType: type: object description: A type which is used to insert Membership FolioTexts. properties: membershipType: description: Membership Type code. type: string minLength: 0 maxLength: 20 membershipLevel: description: Membership Level code. type: string minLength: 0 maxLength: 20 folioTexts: description: Folio Texts. type: array maxItems: 4000 items: $ref: '#/components/schemas/hotelFolioTextsType' membershipAwardsType: type: array description: Membership Award details. maxItems: 4000 items: $ref: '#/components/schemas/membershipAwardType' membershipBenefitProgramsType: type: array description: Membership Benefit Program details. maxItems: 4000 items: $ref: '#/components/schemas/membershipBenefitProgramType' hotelFolioTextType: type: object description: Folio text properties: folioText1: type: string minLength: 0 maxLength: 400 folioText2: type: string minLength: 0 maxLength: 400 folioText3: type: string minLength: 0 maxLength: 400 folioText4: type: string minLength: 0 maxLength: 400 hotelId: description: Signifies folio text for a specific hotel. type: string minLength: 0 maxLength: 20 dateRangeType: type: object description: Date Range with Start and End dates. properties: start: description: The starting value of the date range. type: string format: date maxLength: 8 end: description: The ending value of the date range. type: string format: date maxLength: 8 membershipRateType: type: object description: Membership Rate summary information. properties: hotelId: description: Membership Rate hotel code. type: string minLength: 0 maxLength: 20 ruleCode: description: Membership Rate rule code. type: string minLength: 0 maxLength: 20 description: description: Description of the rule. type: string minLength: 0 maxLength: 2000 beginDate: description: Date for which the rule will be affective. type: string format: date maxLength: 8 endDate: description: Date for which the rule will end being affective. type: string format: date maxLength: 8 ratePlanCodes: description: List of Membership rate code rates. $ref: '#/components/schemas/codeListType' memberships: description: List of Membership rate code memberships. $ref: '#/components/schemas/rateRuleMembershipsType' latestTOB: description: Latest time of booking for guaranteed availability. Only Time part is used. type: string format: date-time daysToDOA: description: Number of days to day of arrival for guaranteed availability. type: integer inactive: description: Indicates whether the Membership Rate is Active/Inactive. type: boolean guaranteed: description: Indicates whether the rule is used for member guaranteed availability. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' membershipTypeRuleDetailsType: type: array description: Collection of Membership type rule details. maxItems: 4000 items: $ref: '#/components/schemas/membershipTypeRuleDetailType' suspendedMatchRulesInfo: type: object description: Object for Suspended Profile Match Rules Configuration. properties: suspendedMatchRules: description: Collection of Suspended Match Rules. type: array maxItems: 4000 items: $ref: '#/components/schemas/suspendedMatchRuleType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipPropertyGroups: type: object description: Request object for changing existing Membership Property Groups Configurations. properties: membershipPropertyGroups: description: Membership Property Groups Configurations to be changed. $ref: '#/components/schemas/membershipPropertyGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipLevelsType: type: array description: Collection of membership levels maxItems: 4000 items: $ref: '#/components/schemas/membershipLevelType' pointsCalculationDateType: type: string description: Tier Management based on date of transaction enum: - ArrivalDate - DepartureDate - PostingDate - TransactionDate profileId: type: object description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). properties: url: description: URL that identifies the location associated with the record identified by the UniqueID. type: string type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 20 instance: description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated. type: string minLength: 0 maxLength: 80 idContext: description: Used to identify the source of the identifier (e.g., IATA, ABTA). type: string minLength: 0 maxLength: 80 id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 idExtension: description: Additional identifying value assigned by the creating system. type: integer membershipSourceGroupsDetails: type: object description: Response object for fetching Membership Source Groups configurations. properties: membershipSourceGroups: type: array maxItems: 4000 description: Collection of Membership Source Groups configurations. items: $ref: '#/components/schemas/membershipSourceGroupType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipAwardFinancialTransactionInfoType: type: object description: Information related to Other Award. properties: pointsRequired: description: Points required to avail/redeem this award. type: number awardValue: description: The actual value of the award, in the amount of currency. type: number messageLine1: description: Message for Other awards. type: string minLength: 0 maxLength: 4000 messageLine2: description: Message for Other awards. type: string minLength: 0 maxLength: 4000 messageLine3: description: Message for Other awards. type: string minLength: 0 maxLength: 4000 messageLine4: description: Message for Other awards. type: string minLength: 0 maxLength: 4000 displaySet: description: Display set for other type of awards for export purpose. type: string minLength: 0 maxLength: 40 exchangeRate: description: Exchange rate type to be used. type: string minLength: 0 maxLength: 20 maxPercentAllowed: description: Max percent of total value to be allowed to convert money to points. type: number ignoreFinancialTransaction: description: Ignore Financial transactions in OPERA or not? If true, Financial transaction is not required in OPERA while giving award as it may be recorded in some external system and only points accounting is done in OCIS. type: boolean membershipTypeType: type: object description: A representation of the information contained by a membership type. properties: membershipType: description: Membership Type code. type: string minLength: 0 maxLength: 20 membershipClass: description: Membership Class code. type: string minLength: 0 maxLength: 20 description: description: Description of the membership type. type: string minLength: 0 maxLength: 2000 pointsLabel: description: Label used to refer to points for this membership type type: string minLength: 0 maxLength: 20 hasPointCalculationRule: description: Indicates if this membership type has a point calculation rule. type: boolean ranking: description: Defines the priority order of this membership type. type: integer sequence: description: Sequence number that controls the position of the membership type when displayed in lists. type: integer cardDetails: description: Membership card details. $ref: '#/components/schemas/cardNumberDetailsType' cardNumberAutoGenerateDetails: description: Membership auto card number generation details. $ref: '#/components/schemas/autoGenerateCardNumberType' cardNumberAutoGenerateDetailsForOWS: description: Membership auto card number generation details for OWS. $ref: '#/components/schemas/autoGenerateCardNumberType' currency: description: The currency in which user would like to calculate the membership points. type: string minLength: 0 maxLength: 20 membershipAction: description: '"Type of action that the user wants to attach membership information to the reservation.' $ref: '#/components/schemas/membershipActionType' exchangeType: description: Exchange type to be used in the currency conversion. type: string minLength: 0 maxLength: 20 pointCost: description: The cost per point. type: string minLength: 1 maxLength: 5 attachMembershipToReservationRule: description: Indicates when the membership action to be taken . type: array maxItems: 4000 items: $ref: '#/components/schemas/attachMembershipToReservationRuleType' memberFolioMessage: description: Folio message for member. $ref: '#/components/schemas/translationTextType2000' nonMemberFolioMessage: description: Folio message for non-member. $ref: '#/components/schemas/translationTextType2000' folioMessageFBAPosting: description: Folio Message FBA Posting. $ref: '#/components/schemas/translationTextType2000' awardGenerationMethod: description: Award Generation Method. $ref: '#/components/schemas/membershipAwardGenerationMethodType' awardPointsDetail: description: Detail on award points for membership award upgrades/downgrades. $ref: '#/components/schemas/awardPointsType' tierPointsDetails: description: Detail on award points for membership tier management. $ref: '#/components/schemas/tierPointsType' additionalDetails: description: Membership Type additional settings. $ref: '#/components/schemas/membershipTypeAdditionalInfoType' handlingDetails: description: Membership Handling Details $ref: '#/components/schemas/membershipHandlingType' membershipLevels: description: Membership levels associated with this membership. $ref: '#/components/schemas/membershipLevelsType' enrollmentMatchRule: description: Detail on Enrollment Match Rule and User Defined Enrollment fields for membership type. $ref: '#/components/schemas/enrollmentMatchRuleType' inactive: description: Indicates if the membership type is inactive. type: boolean excludeProfileFromPurge: description: Indicates exclude profiles with an active membership of this type from the automatic purge utility. type: boolean allowShares: description: Indicates that the award points to each membership holder attached to the shared reservation. type: boolean sendCheckoutToInterface: description: Indicates that the reservation that is eligible for points would have its data processed by the End of Day procedures and transferred to the interface. type: boolean multiplier: description: Allows the user to input a value by which the base number of points is multiplied. type: boolean centralSetup: description: Indicates how the award points for this membership type will be managed. type: boolean isLoyaltyProgram: description: This flag indicates whether the membership class attached to the membership type is eligible for loyalty program or not. type: boolean enrollmentCodeRequiredYn: description: Indicates whether enrollment code is required or not. type: boolean bookerProgramYn: description: Indicates the membership type is for a Booker. type: boolean companyYn: description: Add the booker membership to company profile type. type: boolean travelAgentYn: description: Add the booker membership to travel agent profile type. type: boolean sourceYn: description: Add the booker membership to source profile type. type: boolean groupYn: description: Add the booker membership to group profile type. type: boolean contactYn: description: Add the booker membership to contact profile type. type: boolean externallyControlled: description: Flag that affects how a Membership Type is added, edited or deleted from a profile. type: boolean enrollmentAddressAllowed: description: Flag that indicates Profile Address is editable during Enrollment. type: boolean enrollmentCommunicationAllowed: description: Flag that indicates Profile Communication is editable during Enrollment. type: boolean enrollmentFeeAllowed: description: Flag that indicates Fee is editable during Enrollment. type: boolean enrollmentBirthdateAllowed: description: Flag that indicates Birthdate field is editable during Enrollment. type: boolean reIssueNewCard: description: Indicates whether to re-issue the membership card or not, when it is lost / stolen. type: boolean primaryMembership: description: Indicates whether primary membership or not. type: boolean printFolioMsgOnConfirmation: description: Print Folio Message on confirmation. type: boolean externalDatabase: description: Indicates database for external system for Membership Type. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' tierManagementBatchRecordIDType: type: object description: Key to uniquely identify a batch record. properties: reportId: description: Unique ID of the report generated by the batch process. $ref: '#/components/schemas/uniqueID_Type' membershipId: description: Membership ID. $ref: '#/components/schemas/uniqueID_Type' searchTierManagementBatchRecordsRequest: type: object properties: name: type: string description: Display name of the member. recordStatus: $ref: '#/components/schemas/recordStatusEnum' description: Record locked. level: type: string description: Old membership level before upgrade or downgrade. levelDifference: type: integer description: Level Difference. membershipCardNumber: type: string description: Member Card no. reportId: type: string description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. reportIdType: type: string description: A reference to the type of object defined by the UniqueID element. limit: type: integer description: Indicates maximum number of records a Web Service should return. default: 20 offset: type: integer description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. default: 1 membershipAwardDetailsType: type: array description: Membership Award Rate details. maxItems: 4000 items: $ref: '#/components/schemas/membershipAwardDetailType' membershipRevenueTypesType: type: array description: Details of membership revenue type. maxItems: 4000 items: $ref: '#/components/schemas/membershipRevenueTypeType' membershipRevenueGroupType: type: object description: Base type provides information about Membership Market/Property Groups Configuration. properties: code: description: Code is used to identify a Membership Market/Resort Group. type: string minLength: 0 maxLength: 20 description: description: Description of the Membership Market/Propety Group. type: string minLength: 0 maxLength: 2000 displaySequence: description: Membership Market/Property Groups display sequence Number type: number revenueTypes: description: Collection of code and description of revenue types that are associated to the membership revenue group. $ref: '#/components/schemas/membershipRevenueTypesInfoType' managedBy: $ref: '#/components/schemas/managedByOptions' membershipPropertyGroupsInfo: type: object description: Response object for fetching Membership Property Groups configurations. properties: membershipPropertyGroups: description: Collection of Membership Property Groups configurations. $ref: '#/components/schemas/membershipPropertyGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' rateRuleMembershipType: type: object description: Rate Rule Membership types. properties: membershipType: description: Rate rule membership type. type: string minLength: 0 maxLength: 20 membershipLevel: description: Rate rule membership levels. $ref: '#/components/schemas/codeListType' operaVersion: type: object description: Response for Ping operation. properties: operaVersion: description: Opera version number. $ref: '#/components/schemas/operaVersionNumberType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' links: type: array items: $ref: '#/components/schemas/instanceLink' membershipLevelRuleTypeType: type: string description: Fetches the data for all the membership level rules. enum: - Downgrade - Renewal - Upgrade - All copySuspendedMatchRuleType: type: object description: Copy object for Suspended Profile Match Rules Configuration. properties: region: description: New Region to copy the match rules type: string nameType: description: Region of the match rule to copy from type: string copyToRegion: description: Name type of the match rule to copy from type: string copyToNameType: description: Validation item of the match rule to copy from type: string links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipTypeChangeInstructionType: type: object description: Represents the membership type under change . properties: membershipType: description: Membership type details. $ref: '#/components/schemas/membershipTypeType' responseInstructions: description: Collection of instructions to be returned as a set of membership type information. type: object properties: responseInstruction: type: array maxItems: 4000 items: $ref: '#/components/schemas/membershipTypeInstructionType' confirmationOnly: description: If this value is set to TRUE, then the operation will only return for a Success or Failed flag. type: boolean membershipTypeRuleSummaryType: type: object description: Membership Type rule summary information. properties: membershipTypeRulePrimaryDetails: description: Membership type rule primary information. $ref: '#/components/schemas/membershipTypeRulePrimaryDetailsType' ruleCode: description: Rule code of the membership type rule. type: string minLength: 0 maxLength: 20 programType: description: Program(Points/Tier) type of the rule. $ref: '#/components/schemas/membershipTypeRuleType' managedBy: $ref: '#/components/schemas/managedByOptions' pointsRoundingFlagType: type: string description: This flag tells if the total points computed will be rounded based on the rounding option selected. enum: - Round - Ceil - Floor - Roundupnd - Rounddownnd - Universalroundnd membershipTypeRule: type: object description: Response object for fetching membership type rule. properties: membershipTypeRule: description: Membership type rule detailed information. $ref: '#/components/schemas/membershipTypeRuleDetailType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' responses: '406': description: Not acceptable. '414': description: Request URI Too Large '503': description: Service Unavailable '413': description: Request Entity Too Large '500': description: System Error content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '502': description: Bad Gateway '403': description: Forbidden '415': description: Unsupported Media Type '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '401': description: Unauthorized '405': description: Method not allowed parameters: x-hotelid: name: x-hotelid description: Mandatory parameter to identify the hotel code where the end user is logged in in: header required: true schema: type: string authKey: name: authorization description: Bearer token that needs to be passed which is generated post user authentication in: header required: true schema: type: string externalData: name: externalData description: Pass this header as true, if payload needs DVM in: header schema: type: string Accept-Language: name: Accept-Language description: Language code in: header schema: type: string x-app-key: name: x-app-key description: Client or Partner's Application Key in: header required: true schema: type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$ x-externalsystem: name: x-externalsystem description: External system code. in: header x-example: EXTERNALSYSTEMCODE schema: type: string maxLength: 40 x-originating-application: name: x-originating-application description: Customer's Integration Application Id in: header schema: type: string x-request-id: name: x-request-id description: Request Id of an incoming request in: header schema: type: string pattern: ~*[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} externalDocs: description: Find out more about Oracle Hospitality url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html