v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve the memberships associated with classes

This API helps you to retrieve the memberships that have a benefit associated with the specified class.

You must provide the appropriate details in the API request for the search_type and item_ids parameters. Optionally, you can also specify the required details in the API request for several other parameters to filter the search results in the API response. Refer to the Request Parameters table for more information.

get/v1/classes/memberships?search_type={search_type}&page_number={page_number}&page_size={page_size}&item_ids={item_ids}

Query parameters

search_type'' required

Mandatory Item type to list membership details. You can specify any one of these values: Class = 0, Category = 1, and Center = 2.

page_numberinteger

Optional Current page to be viewed. Returns all records if no value is specified.

page_sizeinteger

Optional Number of records to be listed per page. It returns all records if no value is specified.

item_idsstring[] required

Mandatory You can specify the IDs of multiple items separated by commas: Class - int values, Category - guid values, and Center - guid values.

Response

200

{"stackTrail":"paths:/v1/classes/memberships?search_type={search_type}&page_number={page_number}&page_size={page_size}&item_ids={item_ids}:get:responses:200:content:application/json:schema:properties:Error","oasType":"schema","type":"unknown"}

totalinteger

Example response

{
  "Memberships": [
    {
      "Id": "7c60a517-c54f-44db-b2d6-350811d227e5",
      "VersionId": "15da86b0-d2d4-4f1e-88e5-60c07e27df60",
      "Name": "- Premium Membership",
      "Price": {
        "CurrencyId": 148,
        "Sales": 1000,
        "Final": 1000,
        "Final1": 1000
      },
      "CanBook": true
    }
  ],
  "total": 6
}