What is it?
This set of APIs is used to retrieve system level data supported by the SynXis Platform.
Why use it?
This API would be used to get lists of reference data that is defined at system level in SynXis and cannot be configured by users.
For example:
- Supported country codes
- Supported currency codes
- Supported time zone codes
How to use
Retrieve a list of System-level Amenities
[GET] /lists/amenities
"amenities": [
{
"category": {
"id": 2,
"name": "Hotel Amenity"
},
"code": "169",
"id": 668,
"name": "24-hour food & beverage kiosk"
},
{
"category": {
"id": 2,
"name": "Hotel Amenity"
},
"code": "1",
"id": 500,
"name": "24-hour front desk"
}
]
Retrieve a list of System-level Currencies
The response contains a list of currencies with the associated code, description, symbol, decimalPlaces and conversionRate.
Note: The conversionRate is from the listed currency to USD.
[GET] /lists/currencies
{
"currencies": [
{
"code": "AFN",
"description": "Afghanischer Afghani",
"symbol": "؋",
"conversionRate": 66.1506475156,
"decimalPlaces": 2
},
{
"code": "ALL",
"description": "Albanischer Lek",
"symbol": "Lek",
"conversionRate": 123.7629889257,
"decimalPlaces": 2
},
{
"code": "DZD",
"description": "Algerian Dinar",
"symbol": "دج",
"conversionRate": 132.26,
"decimalPlaces": 2
}
]
}
Retrieve a list of System-level Countries
[GET] /lists/geographicalLocations/countries
{
"countries": [
{
"code": "AU",
"name": "Australia",
"phonePrefix": 61.0,
"stateProvs": {
"stateProvs": [
{
"code": "ACT",
"name": "Australian Capital Territory"
},
{
"code": "NSW",
"name": "New South Wales"
},
{
"code": "NT",
"name": "Northern Territory"
},
{
"code": "QLD",
"name": "Queensland"
},
{
"code": "SA",
"name": "South Australia"
},
{
"code": "TAS",
"name": "Tasmania"
},
{
"code": "VIC",
"name": "Victoria"
},
{
"code": "WA",
"name": "Western Australia"
}
]
}
}
]
}
Retrieve a list of System-level Countries by country code
[GET] /lists/geographicalLocations/countries/{code}
{
"countries": [
{
"code": "AU",
"name": "Australia",
"phonePrefix": 61.0,
"stateProvs": {
"stateProvs": [
{
"code": "ACT",
"name": "Australian Capital Territory"
},
{
"code": "NSW",
"name": "New South Wales"
},
{
"code": "NT",
"name": "Northern Territory"
},
{
"code": "QLD",
"name": "Queensland"
},
{
"code": "SA",
"name": "South Australia"
},
{
"code": "TAS",
"name": "Tasmania"
},
{
"code": "VIC",
"name": "Victoria"
},
{
"code": "WA",
"name": "Western Australia"
}
]
}
}
]
}
Retrieve a list of System-level Tax Types
[GET] /lists/tax/types
{
"taxTypes": [
{
"taxtype": "Tax",
"code": "BT",
"otaCode": "1",
"description": "Bed Tax"
},
{
"taxtype": "Fee",
"code": "CH",
"otaCode": "2",
"description": "City Hotel Fee"
}
]
}
Retrieve a list of System-level languages
[GET] /lists/languages
{
"languages": [
{
"code": "ar",
"cultureCode": "EG",
"name": "Arabe"
},
{
"code": "id",
"cultureCode": "ID",
"name": "Bahasa indonésien"
}
]
}
Retrieve a list of System-level Spoken Languages
[GET] /lists/spokenLanguages
{
"spokenLanguages": [
{
"name": "Abkhazian",
"alternateName": "Abkhazian",
"isoCode6391": "ab",
"isoCode6392": "abk"
},
{
"name": "Albanian",
"alternateName": "Albanian",
"isoCode6391": "sq",
"isoCode6392": "alb"
}
]
}