ParrAPI
Online Distributor API Guide
Attributes (/attributes)
The attributes endpoint allows you to obtain information for the attributes. Attributes are associated with attribute types and categories.
Please enter your distributor key here to update the links on the page.
Attribute Types (&types)
Attributes are associated with the attribute types. The attribute types parameter (&types) will filter the attributes by the given attribute types.
OPTIONS :
- Attribute types parameter (&types) is mandatory
- Provide valid attribute type "ID" (e.g. ACTIVITY, ENTITY FAC) in the request to obtain the list of attributes associated with the given attribute type
- To obtain the valid attribute type "ID", make use of the Attribute Types endpoint
- To retrieve the attributes for multiple attribute types, please provide comma separated attribute types in the request
DEFAULT :
-
EXAMPLE :
https://[host]/api/atlas/attributes?key=[key]&types=ENTITY FAC
Get the list of all attributes for the type: ENTITY FAC (property facilities).
https://[host]/api/atlas/attributes?key=[key]&types=ENTITY FAC,ACCREDITN,INTERNET
Get the list of all attributes for the type: property facilities, accreditation and internet.
Get the list of all attributes for the type: ENTITY FAC (property facilities).
https://[host]/api/atlas/attributes?key=[key]&types=ENTITY FAC,ACCREDITN,INTERNET
Get the list of all attributes for the type: property facilities, accreditation and internet.
Categories (&cats)
A list of categories to retrieve the attributes for
OPTIONS :
- Filtering by category is optional
- Provide valid list of categories (e.g. ACCOMM, ATTRACTION) in the request to retrieve the list of attributes associated with the given attribute type and category
- To obtain the valid category "ID", make use of the categories endpoint
- To retrieve attributes for multiple categories, please provide comma separated categories in the request
DEFAULT :
-
EXAMPLE :
https://[host]/api/atlas/attributes?key=[key]&cats=ATTRACTION,EVENT&types=ACTIVITY,ENTITY FAC
Get the list of all attributes for the EVENT and ATTRACTION categories with the ACTIVITY or ENTITY FAC attribute type
Get the list of all attributes for the EVENT and ATTRACTION categories with the ACTIVITY or ENTITY FAC attribute type
Output (&out)
The results can be formatted either in JSON or XML format.
OPTIONS :
xml or json
DEFAULT :
xml
EXAMPLE :
https://[host]/api/atlas/attributes?key=[key]&cats=ATTRACTION,EVENT&types=ACTIVITY,ENTITY FAC&out=JSON
Get the list of all the attributes for the EVENT and ATTRACTION categories with the ACTIVITY or ENTITY FAC attribute type formatted in JSON
Get the list of all the attributes for the EVENT and ATTRACTION categories with the ACTIVITY or ENTITY FAC attribute type formatted in JSON
Market Variant (&mv)
To retrieve the results in different language, use the (market variant) '&mv' parameter.
OPTIONS :
- Filtering by the translated content is optional
- Provide valid list of language code (e.g. FRENCH) in the request to retrieve the list of attributes in the foreign language
- Supported language - FRENCH, ITALIAN and GERMAN
- NOTE:Comma separated languages are NOT allowed. Only specify one language code in the request
DEFAULT :
ENGLISH
EXAMPLE :
https://[host]/api/atlas/attributes?key=[key]&cats=ATTRACTION,EVENT&types=ACTIVITY,ENTITY FAC&mv=FRENCH
Get the list of all the attributes for the EVENT and ATTRACTION categories with the ACTIVITY or ENTITY FAC attribute type in Frecnch language.
Get the list of all the attributes for the EVENT and ATTRACTION categories with the ACTIVITY or ENTITY FAC attribute type in Frecnch language.
Tags (&types=tag)
A list of all the available tags
OPTIONS :
Tags are type of attributes used for additional filtering
DEFAULT :
EXAMPLE :
https://[host]/api/atlas/attributes?key=[key]&types=tag
Get the list of all the attributes of type: tags.
Get the list of all the attributes of type: tags.