Metadata

Metadata is used for configuring several activity properties.

Get languages

Get all languages which may be used for an activity timeslot.

Request
header Parameters
X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
Responses
200

Languages

401

Unauthorized: token is not valid

503

Service unavailable

get/activity-languages
Request samples
curl -i -X GET \
  https://sandbox.musement.com/api/v3/activity-languages \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Search taxonomy exclusions

Taxonomies provide information about an activity's highlights, inclusions and exclusions.

Request
query Parameters
taxonomy_category_code
string

Limit results to taxonomies which match the requested category.

Enum: ACCOMMODATION ADDITIONAL-FEES-AND-COSTS ART EQUIPMENT EXPLORE-THE-AREA FAMILY-FRIENDLY FOOD-AND-DRINK GUIDE-OPTIONS MEALS
header Parameters
Accept-Language
string (Language code)
Default: en-US

The value of this parameter might affect the language of the content in the response, provided a translation in the requested language is available.

X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
Responses
200

Taxonomy exclusions

default

Error

get/activity-taxonomies/exclusions
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activity-taxonomies/exclusions?taxonomy_category_code=ACCOMMODATION' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Search taxonomy highlights

Taxonomies provide information about an activity's highlights, inclusions and exclusions.

Request
query Parameters
taxonomy_category_code
string

Limit results to taxonomies which match the requested category.

Enum: ACCOMMODATION ADDITIONAL-FEES-AND-COSTS ART EQUIPMENT EXPLORE-THE-AREA FAMILY-FRIENDLY FOOD-AND-DRINK GUIDE-OPTIONS MEALS
header Parameters
Accept-Language
string (Language code)
Default: en-US

The value of this parameter might affect the language of the content in the response, provided a translation in the requested language is available.

X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
Responses
200

Taxonomy highlights

default

Error

get/activity-taxonomies/highlights
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activity-taxonomies/highlights?taxonomy_category_code=ACCOMMODATION' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Search taxonomy inclusions

Taxonomies provide information about an activity's highlights, inclusions and exclusions.

Request
query Parameters
taxonomy_category_code
string

Limit results to taxonomies which match the requested category.

Enum: ACCOMMODATION ADDITIONAL-FEES-AND-COSTS ART EQUIPMENT EXPLORE-THE-AREA FAMILY-FRIENDLY FOOD-AND-DRINK GUIDE-OPTIONS MEALS
header Parameters
Accept-Language
string (Language code)
Default: en-US

The value of this parameter might affect the language of the content in the response, provided a translation in the requested language is available.

X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
Responses
200

Taxonomy inclusions

default

Error

get/activity-taxonomies/inclusions
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activity-taxonomies/inclusions?taxonomy_category_code=ACCOMMODATION' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Get currencies

Request
header Parameters
Accept-Language
string (Language code)
Default: en-US

The value of this parameter might affect the language of the content in the response, provided a translation in the requested language is available.

X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
Responses
200

Currencies

default

Error

get/currencies
Request samples
curl -i -X GET \
  https://sandbox.musement.com/api/v3/currencies \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Search flavours

This endpoint returns all available flavours, a type of tag for activities.

Request
query Parameters
group
string

Filter results by group. When this parameter is absent, only flavours with no group are returned.

header Parameters
Accept-Language
string (Language code)
Default: en-US

The value of this parameter might affect the language of the content in the response, provided a translation in the requested language is available.

X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
Responses
200

Flavours

400

Bad request: there are errors in the request

503

Service unavailable

get/flavours
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/flavours?group=string' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Get features

Get a complete list of feature metadata items that can be used for activities.

Request
header Parameters
Accept-Language
string (Language code)
Default: en-US

The value of this parameter might affect the language of the content in the response, provided a translation in the requested language is available.

X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
Responses
200

Features

401

Bad request: there are errors in the request

503

Service unavailable

get/features
Request samples
curl -i -X GET \
  https://sandbox.musement.com/api/v3/features \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Get services

Get a complete list of service metadata items that can be used for activities.

Request
header Parameters
Accept-Language
string (Language code)
Default: en-US

The value of this parameter might affect the language of the content in the response, provided a translation in the requested language is available.

X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
Responses
200

Services

401

Bad request: there are errors in the request

503

Service unavailable

get/services
Request samples
curl -i -X GET \
  https://sandbox.musement.com/api/v3/services \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]