Introduction
Welcome to the CBIS REST API Reference. If you don’t have an API key, visit Citybreak Support to get one.
The API is divided into 2 parts, Raw and Localized. The first one is designed to get all the data we have about something, when the second one is designed to print data in real time.
This documentation is too long? Go play right now with the Swagger UI and come back later.
Authentication
curl --header 'ApiKey: APIKEY132456789EWOK'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api",
{
headers: {
"ApiKey": "APIKEY132456789EWOK"
}
});
Make sure to replace
APIKEY132456789EWOKwith your API key.
If you don’t have an API key, visit Citybreak Support to get one.
CBIS REST API expects for the API key to be included in all API requests to the server in a header that looks like the following:
ApiKey: APIKEY132456789EWOK
Language
Get Languages
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/language'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/language",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
[
"en-us",
"fr-fr",
"sv-se"
]
Get the available languages for the key.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/language
Query Parameters
None
Check If Available
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/language/{culture}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/language/{culture}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
true
Returns true if culture is available, false otherwise.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/language/{culture}
Query Parameters
| Parameter | Description |
|---|---|
| culture | The culture to look for. |
Raw Attribute
Raw Attribute
{
"Id": 102,
"Translations": {
"sv-SE": "Beskrivning",
"en-US": "Description"
},
"Name": "Description",
"Type": "String"
}
All the attributes in use in CBIS for the organization owning the API key, with your own translations as well.
Possible types are:
- String
- Integer
- Boolean
- Double
- DateTime
Get Attribute
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/attribute/{id}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/attribute/{id}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
{
"Id": 102,
"Translations": {
"sv-SE": "Beskrivning",
"en-US": "Description",
"de-DE": "Beschreibung",
"da-DK": "Beskrivelse",
"nb-NO": "Description",
"fr-FR": "Description",
"es-ES": "Description",
"fi-FI": "Kuvaus",
"pl-PL": "Opis",
"en-GB": "Description"
},
"Name": "Description",
"Type": "String"
}
Get a specific attribute and all its translations.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/attribute/{id}
Query Parameters
| Parameter | Description |
|---|---|
| id | The attribute id. |
Get Paged
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/attribute/getpaged/{pageSize}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/attribute/getpaged/{pageSize}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
{
"ContinueToken": "c2NhbjsxOzY4MDQwODYxOkM2a0hnTFpmUUVLeHNlSUhoc0d5clE7MTt0b3RhbF9oaXRzOjI4NzQ7",
"TotalResults": 2874,
"Result": [
{
"Id": 100566,
"Translations": {
"sv-SE": "Bowling",
"en-US": "Bowling"
},
"Name": "bowling",
"Type": "Boolean"
},
{
"Id": 100567,
"Translations": {
"sv-SE": "Cykel till förfogande",
"en-US": "Bikes available"
},
"Name": "cykel",
"Type": "Boolean"
}
]
}
Get a page of raw attributes.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/attribute/getpaged/{pageSize}
Query Parameters
| Parameter | Description |
|---|---|
| pageSize | Should be a page size lower than 50 and greater than 0. |
Continue
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/attribute/getnext/{continueToken}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/attribute/getnext/{continueToken}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
{
"ContinueToken": "c2NhbjsxOzY4MDQwODYxOkM2a0hnTFpmUUVLeHNlSUhoc0d5clE7MTt0b3RhbF9oaXRzOjI4NzQ7",
"TotalResults": 2874,
"Result": [
{
"Id": 100566,
"Translations": {
"sv-SE": "Bowling",
"en-US": "Bowling"
},
"Name": "bowling",
"Type": "Boolean"
},
{
"Id": 100567,
"Translations": {
"sv-SE": "Cykel till förfogande",
"en-US": "Bikes available"
},
"Name": "cykel",
"Type": "Boolean"
}
]
}
Get the next page of raw attributes, you need to provide a token obtained from Get Paged. Tokens are valid for 1 minute, extended for aonother minute each time you use it.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/attribute/getnext/{continueToken}
Query Parameters
| Parameter | Description |
|---|---|
| continueToken | A token to retrieve the next page. |
Search Attributes
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/attribute/search/{search}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/attribute/search/{search}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
[
{
"Id": 100691,
"Translations": {
"sv-SE": "Pentry/Kokvrå",
"en-US": "Kitchenette"
},
"Name": "PentryKokvra",
"Type": "Boolean"
},
{
"Id": 100265,
"Translations": {
"sv-SE": "Pentry",
"en-US": "Kitchenette"
},
"Name": "pentry",
"Type": "Boolean"
}
]
Search for a match or more in attributes translations.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/attribute/search/{search}
Query Parameters
| Parameter | Description |
|---|---|
| search | The string you are looking for. |
Raw POI
Raw POI
{
"Id": 16,
"Name": "Leksand",
"Translation": {
"sv-SE": "Leksand"
},
"Position": {
"Longitude": 15.0032043457031,
"Latitude": 60.7338905334473
}
}
All the POIs in use in CBIS for the organization owning the API key, with your own translations as well.
Get POI
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/poi/{id}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/poi/{id}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
{
"Id": 16,
"Name": "Leksand",
"Translation": {
"sv-SE": "Leksand"
},
"Position": {
"Longitude": 15.0032043457031,
"Latitude": 60.7338905334473
}
}
Get a specific POI and all its translations.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/poi/{id}
Query Parameters
| Parameter | Description |
|---|---|
| id | The POI id. |
Get Paged
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/poi/getpaged/{pageSize}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/poi/getpaged/{pageSize}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
{
"ContinueToken": "c2NhbjsxOzY4MDQwODYxOkM2a0hnTFpmUUVLeHNlSUhoc0d5clE7MTt0b3RhbF9oaXRzOjI4NzQ7",
"TotalResults": 2874,
"Result": [
{
"Id": 100566,
"Translations": {
"sv-SE": "Bowling",
"en-US": "Bowling"
},
"Name": "bowling",
"Type": "Boolean"
},
{
"Id": 100567,
"Translations": {
"sv-SE": "Cykel till förfogande",
"en-US": "Bikes available"
},
"Name": "cykel",
"Type": "Boolean"
}
]
}
Get a page of raw POIs.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/poi/getpaged/{pageSize}
Query Parameters
| Parameter | Description |
|---|---|
| pageSize | Should be a page size lower than 50 and greater than 0. |
Continue
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/poi/getnext/{continueToken}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/poi/getnext/{continueToken}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
{
"ContinueToken": "c2NhbjswOzE7dG90YWxfaGl0czo2Ow==",
"TotalResults": 6,
"Result": [
{
"Id": 18,
"Name": "Borlänge (Dala Airport)",
"Translation": {
"sv-SE": "Borlänge (Dala Airport)"
},
"Position": {
"Longitude": 15.5104637145996,
"Latitude": 60.4233436584473
}
},
{
"Id": 8133,
"Name": "WEQWEQWEQWE",
"Translation": {
"en-US": "WEQWEQWEQWE"
},
"Position": {
"Longitude": 15.2551183700562,
"Latitude": 54.5259628295898
}
},
{
"Id": 8305,
"Name": "Inlandsbanan",
"Translation": {
"sv-SE": "Inlandsbanan"
},
"Position": {
"Longitude": 16.2033634185791,
"Latitude": 64.113899230957
}
}
]
}
Get the next page of raw POIs, you need to provide a token obtained from Get Paged. Tokens are valid for 1 minute, extended for aonother minute each time you use it.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/poi/getnext/{continueToken}
Query Parameters
| Parameter | Description |
|---|---|
| continueToken | A token to retrieve the next page. |
Search POIs
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/poi/search/{search}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/poi/search/{search}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
[
{
"Id": 18,
"Name": "Borlänge (Dala Airport)",
"Translation": {
"sv-SE": "Borlänge (Dala Airport)"
},
"Position": {
"Longitude": 15.5104637145996,
"Latitude": 60.4233436584473
}
}
]
Search for a match or more in POIs translations.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/poi/search/{search}
Query Parameters
| Parameter | Description |
|---|---|
| search | The string you are looking for. |
Raw Geo
Raw Geo
{
"Id": 83745,
"Name": "Göteborg",
"Translations": {
"sv-SE": "Göteborg",
"en-US": "Gothenburg",
"es-ES": "Gotemburgo"
},
"Path": [
4852,
105375,
83745
]
}
All the geos in use in CBIS for the organization owning the API key, with your own translations as well.
Get Geo
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/geo/{id}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/geo/{id}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
{
"Id": 83745,
"Name": "Göteborg",
"Translations": {
"sv-SE": "Göteborg",
"en-US": "Gothenburg",
"es-ES": "Gotemburgo"
},
"Path": [
4852,
105375,
83745
]
}
Get a specific geo and all its translations.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/geo/{id}
Query Parameters
| Parameter | Description |
|---|---|
| id | The geo id. |
Get Paged
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/geo/getpaged/{pageSize}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/geo/getpaged/{pageSize}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
{
"ContinueToken": "c2NhbjswOzE7dG90YWxfaGl0czo2Ow==",
"TotalResults": 6,
"Result": [
{
"Id": 4852,
"Name": "[Visit Group]",
"Translations": {},
"Path": [
4852
]
},
{
"Id": 105375,
"Name": "Sverige",
"Translations": {
"sv-SE": "Sverige",
"en-US": "Sweden",
"es-ES": "Suecia"
},
"Path": [
4852,
105375
]
},
{
"Id": 83745,
"Name": "Göteborg",
"Translations": {
"sv-SE": "Göteborg",
"en-US": "Gothenburg",
"es-ES": "Gotemburgo"
},
"Path": [
4852,
105375,
83745
]
}
]
}
Get a page of raw geos.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/geo/getpaged/{pageSize}
Query Parameters
| Parameter | Description |
|---|---|
| pageSize | Should be a page size lower than 50 and greater than 0. |
Continue
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/geo/getnext/{continueToken}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/geo/getnext/{continueToken}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
{
"ContinueToken": "c2NhbjswOzE7dG90YWxfaGl0czo2Ow==",
"TotalResults": 6,
"Result": [
{
"Id": 4852,
"Name": "[Visit Group]",
"Translations": {},
"Path": [
4852
]
},
{
"Id": 105375,
"Name": "Sverige",
"Translations": {
"sv-SE": "Sverige",
"en-US": "Sweden",
"es-ES": "Suecia"
},
"Path": [
4852,
105375
]
},
{
"Id": 83745,
"Name": "Göteborg",
"Translations": {
"sv-SE": "Göteborg",
"en-US": "Gothenburg",
"es-ES": "Gotemburgo"
},
"Path": [
4852,
105375,
83745
]
}
]
}
Get the next page of raw geos, you need to provide a token obtained from Get Paged. Tokens are valid for 1 minute, extended for aonother minute each time you use it.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/raw/geo/getnext/{continueToken}
Query Parameters
| Parameter | Description |
|---|---|
| continueToken | A token to retrieve the next page. |
Search Geos
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/geo/search/{search}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/geo/search/{search}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
[
{
"Id": 83745,
"Name": "Göteborg",
"Translations": {
"sv-SE": "Göteborg",
"en-US": "Gothenburg",
"es-ES": "Gotemburgo"
},
"Path": [
4852,
105375,
83745
]
}
]
Search for a match or more in geos translations.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/geo/search/{search}
Query Parameters
| Parameter | Description |
|---|---|
| search | The string you are looking for. |
Raw Category
Raw Category
{
"Id": 30701,
"Name": "Thibault",
"Translations": {
"sv-SE": "Thibault",
"en-US": "Thibault"
},
"Path": [
5946,
30701
]
}
All the categories in use in CBIS for the organization owning the API key, with your own translations as well.
Get Category
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/category/{id}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/category/{id}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
{
"Id": 83745,
"Name": "Göteborg",
"Translations": {
"sv-SE": "Göteborg",
"en-US": "Gothenburg",
"es-ES": "Gotemburgo"
},
"Path": [
4852,
105375,
83745
]
}
Get a specific category and all its translations.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/category/{id}
Query Parameters
| Parameter | Description |
|---|---|
| id | The category id. |
Get Paged
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/category/getpaged/{pageSize}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/category/getpaged/{pageSize}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
{
"ContinueToken": "c2NhbjswOzE7dG90YWxfaGl0czo2Ow==",
"TotalResults": 6,
"Result": [
{
"Id": 4852,
"Name": "[Visit Group]",
"Translations": {},
"Path": [
4852
]
},
{
"Id": 105375,
"Name": "Sverige",
"Translations": {
"sv-SE": "Sverige",
"en-US": "Sweden",
"es-ES": "Suecia"
},
"Path": [
4852,
105375
]
},
{
"Id": 83745,
"Name": "Göteborg",
"Translations": {
"sv-SE": "Göteborg",
"en-US": "Gothenburg",
"es-ES": "Gotemburgo"
},
"Path": [
4852,
105375,
83745
]
}
]
}
Get a page of raw categories.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/category/getpaged/{pageSize}
Query Parameters
| Parameter | Description |
|---|---|
| pageSize | Should be a page size lower than 50 and greater than 0. |
Continue
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/category/getnext/{continueToken}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/category/getnext/{continueToken}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
{
"ContinueToken": "c2NhbjswOzE7dG90YWxfaGl0czoxMTs=",
"TotalResults": 11,
"Result": [
{
"Id": 5946,
"Name": "Visit Group",
"Translations": {
"sv-SE": "Visit Group",
"en-US": "Visit Group",
"es-ES": "Visit Group"
},
"Path": [
5946
]
},
{
"Id": 26210,
"Name": "Boende",
"Translations": {
"sv-SE": "Boende",
"en-US": "Boende",
"es-ES": "Hospedaje"
},
"Path": [
5946,
26210
]
},
{
"Id": 26219,
"Name": "b&b",
"Translations": {
"sv-SE": "b&b",
"en-US": "b&b",
"es-ES": "B&B"
},
"Path": [
5946,
26210,
26219
]
}
]
}
Get the next page of raw categories, you need to provide a token obtained from Get Paged. Tokens are valid for 1 minute, extended for aonother minute each time you use it.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/category/getnext/{continueToken}
Query Parameters
| Parameter | Description |
|---|---|
| continueToken | A token to retrieve the next page. |
Search Categories
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/category/search/{search}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/category/search/{search}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
[
{
"Id": 30701,
"Name": "Thibault",
"Translations": {
"sv-SE": "Thibault",
"en-US": "Thibault"
},
"Path": [
5946,
30701
]
}
]
Search for a match or more in categories translations.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/category/search/{search}
Query Parameters
| Parameter | Description |
|---|---|
| search | The string you are looking for. |
Raw Product
Raw Product
{
"Id": "cbis:1245084",
"References": [
"cbis:1245084"
],
"Name": "Ewok",
"GeoReferences": [],
"Categories": [
30701
],
"InformationData": [
{
"Values": {
"en-US": "Ewok"
},
"AttributeId": 99,
"Type": "String"
},
{
"Values": {
"en-US": "Strongest animal ever, by far!"
},
"AttributeId": 101,
"Type": "String"
},
{
"Values": {
"en-US": "Ewoks were a diminutive species of furry bipeds native to the forest moon of Endor.
They were most notable for helping the Rebel Alliance defeat the forces of the Galactic Empire
at the Battle of Endor, allowing the shield generator there to be destroyed, and in turn, the
Death Star II.\r\n\r\nEwoks were individuals that stood about one meter tall; they used spears,
slings, and knives as weapons; they also used hang gliders as vehicles. Although skilled in forest
survival and the construction of primitive technology, the Ewoks had yet to progress past
stone-level technology when discovered by the Empire. They were quick learners, however,
when exposed to advanced technology with simple mechanical processes and concepts."
},
"AttributeId": 102,
"Type": "String"
}
],
"Position": {
"Longitude": 7.1934700012207,
"Latitude": 48.172353561064
},
"ExpiresAt": "2018-07-01T01:00:00",
"PublishAt": null,
"Occasions": [
{
"Start": "2016-06-16T00:00:00",
"End": "2016-06-30T00:00:00",
"StartTime": 0,
"Duration": 864000000000,
"Days": 127,
"IsRecurring": true,
"Monday": true,
"Tuesday": true,
"Wednesday": true,
"Thursday": true,
"Friday": true,
"Saturday": true,
"Sunday": true,
"ArenaId": ""
}
],
"Media": [
{
"Url": "http://images.citybreak.com/image.aspx?ImageId=4161317",
"Type": "MainImage",
"Name": {},
"Description": {},
"Copyright": null
},
{
"Url": "http://images.citybreak.com/image.aspx?ImageId=4223191",
"Type": "Image",
"Name": {},
"Description": {},
"Copyright": null
}
],
"Pois": [],
"Type": "Product"
}
All the info we have about your products.
Get Product
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/product/{id}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/product/{id}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
[
{
"Id": "cbis:1245084",
"References": [
"cbis:1245084"
],
"Name": "Ewok",
"GeoReferences": [],
"Categories": [
30701
],
"InformationData": [
{
"Values": {
"en-US": "Ewok"
},
"AttributeId": 99,
"Type": "String"
},
{
"Values": {
"en-US": "Strongest animal ever, by far!"
},
"AttributeId": 101,
"Type": "String"
},
{
"Values": {
"en-US": "Ewoks were a diminutive species of furry bipeds native to the forest moon of Endor.
They were most notable for helping the Rebel Alliance defeat the forces of the Galactic Empire
at the Battle of Endor, allowing the shield generator there to be destroyed, and in turn, the
Death Star II.\r\n\r\nEwoks were individuals that stood about one meter tall; they used spears,
slings, and knives as weapons; they also used hang gliders as vehicles. Although skilled in forest
survival and the construction of primitive technology, the Ewoks had yet to progress past
stone-level technology when discovered by the Empire. They were quick learners, however, when
exposed to advanced technology with simple mechanical processes and concepts."
},
"AttributeId": 102,
"Type": "String"
}
],
"Position": {
"Longitude": 7.1934700012207,
"Latitude": 48.172353561064
},
"ExpiresAt": "2018-07-01T01:00:00",
"PublishAt": null,
"Occasions": [
{
"Start": "2016-06-16T00:00:00",
"End": "2016-06-30T00:00:00",
"StartTime": 0,
"Duration": 864000000000,
"Days": 127,
"IsRecurring": true,
"Monday": true,
"Tuesday": true,
"Wednesday": true,
"Thursday": true,
"Friday": true,
"Saturday": true,
"Sunday": true,
"ArenaId": ""
}
],
"Medias": [
{
"Url": "http://images.citybreak.com/image.aspx?ImageId=4161317",
"Type": "MainImage",
"Name": {},
"Description": {},
"Copyright": null
},
{
"Url": "http://images.citybreak.com/image.aspx?ImageId=4223191",
"Type": "Image",
"Name": {},
"Description": {},
"Copyright": null
}
],
"Pois": [],
"Type": "Product"
}
]
Search for products answering to the id provided, might be more than 1.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/product/{id}
Query Parameters
| Parameter | Description |
|---|---|
| id | The product id. |
Get Paged
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/product/getpaged/{pageSize}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/Product/getpaged/{pageSize}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
{
"ContinueToken": "c2NhbjswOzE7dG90YWxfaGl0czo0Ow==",
"TotalResults": 4,
"Result": [
{
"Id": "cbis:1245084",
"References": [
"cbis:1245084"
],
"Name": "Ewok",
"GeoReferences": [],
"Categories": [
30701
],
"InformationData": [
{
"Values": {
"en-US": "Ewok"
},
"AttributeId": 99,
"Type": "String"
},
{
"Values": {
"en-US": "Strongest animal ever, by far!"
},
"AttributeId": 101,
"Type": "String"
},
{
"Values": {
"en-US": "Ewoks were a diminutive species of furry bipeds native to the forest moon of Endor.
They were most notable for helping the Rebel Alliance defeat the forces of the Galactic Empire
at the Battle of Endor, allowing the shield generator there to be destroyed, and in turn, the
Death Star II.\r\n\r\nEwoks were individuals that stood about one meter tall; they used spears,
slings, and knives as weapons; they also used hang gliders as vehicles. Although skilled in forest
survival and the construction of primitive technology, the Ewoks had yet to progress past
stone-level technology when discovered by the Empire. They were quick learners, however,
when exposed to advanced technology with simple mechanical processes and concepts."
},
"AttributeId": 102,
"Type": "String"
}
],
"Position": {
"Longitude": 7.1934700012207,
"Latitude": 48.172353561064
},
"ExpiresAt": "2018-07-01T01:00:00",
"PublishAt": null,
"Occasions": [
{
"Start": "2016-06-16T00:00:00",
"End": "2016-06-30T00:00:00",
"StartTime": 0,
"Duration": 864000000000,
"Days": 127,
"IsRecurring": true,
"Monday": true,
"Tuesday": true,
"Wednesday": true,
"Thursday": true,
"Friday": true,
"Saturday": true,
"Sunday": true,
"ArenaId": ""
}
],
"Medias": [
{
"Url": "http://images.citybreak.com/image.aspx?ImageId=4161317",
"Type": "MainImage",
"Name": {},
"Description": {},
"Copyright": null
},
{
"Url": "http://images.citybreak.com/image.aspx?ImageId=4223191",
"Type": "Image",
"Name": {},
"Description": {},
"Copyright": null
}
],
"Pois": [],
"Type": "Product"
}
]
}
Get a page of raw products.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/product/getpaged/{pageSize}
Query Parameters
| Parameter | Description |
|---|---|
| pageSize | Should be a page size lower than 50 and greater than 0. |
Continue
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/product/getnext/{continueToken}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/product/getnext/{continueToken}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
{
"ContinueToken": "c2NhbjswOzE7dG90YWxfaGl0czo0Ow==",
"TotalResults": 4,
"Result": [
{
"Id": "cbis:1245084",
"References": [
"cbis:1245084"
],
"Name": "Ewok",
"GeoReferences": [],
"Categories": [
30701
],
"InformationData": [
{
"Values": {
"en-US": "Ewok"
},
"AttributeId": 99,
"Type": "String"
},
{
"Values": {
"en-US": "Strongest animal ever, by far!"
},
"AttributeId": 101,
"Type": "String"
},
{
"Values": {
"en-US": "Ewoks were a diminutive species of furry bipeds native to the forest moon of Endor.
They were most notable for helping the Rebel Alliance defeat the forces of the Galactic Empire
at the Battle of Endor, allowing the shield generator there to be destroyed, and in turn, the
Death Star II.\r\n\r\nEwoks were individuals that stood about one meter tall; they used spears,
slings, and knives as weapons; they also used hang gliders as vehicles. Although skilled in forest
survival and the construction of primitive technology, the Ewoks had yet to progress past
stone-level technology when discovered by the Empire. They were quick learners, however, when
exposed to advanced technology with simple mechanical processes and concepts."
},
"AttributeId": 102,
"Type": "String"
}
],
"Position": {
"Longitude": 7.1934700012207,
"Latitude": 48.172353561064
},
"ExpiresAt": "2018-07-01T01:00:00",
"PublishAt": null,
"Occasions": [
{
"Start": "2016-06-16T00:00:00",
"End": "2016-06-30T00:00:00",
"StartTime": 0,
"Duration": 864000000000,
"Days": 127,
"IsRecurring": true,
"Monday": true,
"Tuesday": true,
"Wednesday": true,
"Thursday": true,
"Friday": true,
"Saturday": true,
"Sunday": true,
"ArenaId": ""
}
],
"Medias": [
{
"Url": "http://images.citybreak.com/image.aspx?ImageId=4161317",
"Type": "MainImage",
"Name": {},
"Description": {},
"Copyright": null
},
{
"Url": "http://images.citybreak.com/image.aspx?ImageId=4223191",
"Type": "Image",
"Name": {},
"Description": {},
"Copyright": null
}
],
"Pois": [],
"Type": "Product"
}
]
}
Get the next page of raw products, you need to provide a token obtained from Get Paged. Tokens are valid for 1 minute, extended for aonother minute each time you use it.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/product/getnext/{continueToken}
Query Parameters
| Parameter | Description |
|---|---|
| continueToken | A token to retrieve the next page. |
Raw Arena
Raw Arena
{
"Id": "cbis:1245084",
"References": [
"cbis:1245084"
],
"Name": "Ewok",
"GeoReferences": [],
"Categories": [
30701
],
"InformationData": [
{
"Values": {
"en-US": "Ewok"
},
"AttributeId": 99,
"Type": "String"
},
{
"Values": {
"en-US": "Strongest animal ever, by far!"
},
"AttributeId": 101,
"Type": "String"
},
{
"Values": {
"en-US": "Ewoks were a diminutive species of furry bipeds native to the forest moon of Endor.
They were most notable for helping the Rebel Alliance defeat the forces of the Galactic Empire
at the Battle of Endor, allowing the shield generator there to be destroyed, and in turn, the
Death Star II.\r\n\r\nEwoks were individuals that stood about one meter tall; they used spears,
slings, and knives as weapons; they also used hang gliders as vehicles. Although skilled in forest
survival and the construction of primitive technology, the Ewoks had yet to progress past
stone-level technology when discovered by the Empire. They were quick learners, however, when
exposed to advanced technology with simple mechanical processes and concepts."
},
"AttributeId": 102,
"Type": "String"
}
],
"Position": {
"Longitude": 7.1934700012207,
"Latitude": 48.172353561064
},
"ExpiresAt": "2018-07-01T01:00:00",
"PublishAt": null,
"Occasions": [
{
"Start": "2016-06-16T00:00:00",
"End": "2016-06-30T00:00:00",
"StartTime": 0,
"Duration": 864000000000,
"Days": 127,
"IsRecurring": true,
"Monday": true,
"Tuesday": true,
"Wednesday": true,
"Thursday": true,
"Friday": true,
"Saturday": true,
"Sunday": true,
"ArenaId": ""
}
],
"Media": [
{
"Url": "http://images.citybreak.com/image.aspx?ImageId=4161317",
"Type": "MainImage",
"Name": {},
"Description": {},
"Copyright": null
},
{
"Url": "http://images.citybreak.com/image.aspx?ImageId=4223191",
"Type": "Image",
"Name": {},
"Description": {},
"Copyright": null
}
],
"Pois": [],
"Type": "Arena"
}
All the info we have about your arenas.
Get Arena
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/arena/{id}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/arena/{id}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
[
{
"Id": "cbis:1245084",
"References": [
"cbis:1245084"
],
"Name": "Ewok",
"GeoReferences": [],
"Categories": [
30701
],
"InformationData": [
{
"Values": {
"en-US": "Ewok"
},
"AttributeId": 99,
"Type": "String"
},
{
"Values": {
"en-US": "Strongest animal ever, by far!"
},
"AttributeId": 101,
"Type": "String"
},
{
"Values": {
"en-US": "Ewoks were a diminutive species of furry bipeds native to the forest moon of Endor.
They were most notable for helping the Rebel Alliance defeat the forces of the Galactic Empire
at the Battle of Endor, allowing the shield generator there to be destroyed, and in turn, the
Death Star II.\r\n\r\nEwoks were individuals that stood about one meter tall; they used spears,
slings, and knives as weapons; they also used hang gliders as vehicles. Although skilled in forest
survival and the construction of primitive technology, the Ewoks had yet to progress past
stone-level technology when discovered by the Empire. They were quick learners, however, when
exposed to advanced technology with simple mechanical processes and concepts."
},
"AttributeId": 102,
"Type": "String"
}
],
"Position": {
"Longitude": 7.1934700012207,
"Latitude": 48.172353561064
},
"ExpiresAt": "2018-07-01T01:00:00",
"PublishAt": null,
"Occasions": [
{
"Start": "2016-06-16T00:00:00",
"End": "2016-06-30T00:00:00",
"StartTime": 0,
"Duration": 864000000000,
"Days": 127,
"IsRecurring": true,
"Monday": true,
"Tuesday": true,
"Wednesday": true,
"Thursday": true,
"Friday": true,
"Saturday": true,
"Sunday": true,
"ArenaId": ""
}
],
"Medias": [
{
"Url": "http://images.citybreak.com/image.aspx?ImageId=4161317",
"Type": "MainImage",
"Name": {},
"Description": {},
"Copyright": null
},
{
"Url": "http://images.citybreak.com/image.aspx?ImageId=4223191",
"Type": "Image",
"Name": {},
"Description": {},
"Copyright": null
}
],
"Pois": [],
"Type": "Arena"
}
]
Search for arenas answering to the id provided, might be more than 1.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/arena/{id}
Query Parameters
| Parameter | Description |
|---|---|
| id | The arena id. |
Get Paged
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/arena/getpaged/{pageSize}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/Arena/getpaged/{pageSize}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
{
"ContinueToken": "c2NhbjswOzE7dG90YWxfaGl0czo0Ow==",
"TotalResults": 4,
"Result": [
{
"Id": "cbis:1245084",
"References": [
"cbis:1245084"
],
"Name": "Ewok",
"GeoReferences": [],
"Categories": [
30701
],
"InformationData": [
{
"Values": {
"en-US": "Ewok"
},
"AttributeId": 99,
"Type": "String"
},
{
"Values": {
"en-US": "Strongest animal ever, by far!"
},
"AttributeId": 101,
"Type": "String"
},
{
"Values": {
"en-US": "Ewoks were a diminutive species of furry bipeds native to the forest moon of Endor.
They were most notable for helping the Rebel Alliance defeat the forces of the Galactic Empire
at the Battle of Endor, allowing the shield generator there to be destroyed, and in turn, the
Death Star II.\r\n\r\nEwoks were individuals that stood about one meter tall; they used spears,
slings, and knives as weapons; they also used hang gliders as vehicles. Although skilled in forest
survival and the construction of primitive technology, the Ewoks had yet to progress past
stone-level technology when discovered by the Empire. They were quick learners, however, when
exposed to advanced technology with simple mechanical processes and concepts."
},
"AttributeId": 102,
"Type": "String"
}
],
"Position": {
"Longitude": 7.1934700012207,
"Latitude": 48.172353561064
},
"ExpiresAt": "2018-07-01T01:00:00",
"PublishAt": null,
"Occasions": [
{
"Start": "2016-06-16T00:00:00",
"End": "2016-06-30T00:00:00",
"StartTime": 0,
"Duration": 864000000000,
"Days": 127,
"IsRecurring": true,
"Monday": true,
"Tuesday": true,
"Wednesday": true,
"Thursday": true,
"Friday": true,
"Saturday": true,
"Sunday": true,
"ArenaId": ""
}
],
"Medias": [
{
"Url": "http://images.citybreak.com/image.aspx?ImageId=4161317",
"Type": "MainImage",
"Name": {},
"Description": {},
"Copyright": null
},
{
"Url": "http://images.citybreak.com/image.aspx?ImageId=4223191",
"Type": "Image",
"Name": {},
"Description": {},
"Copyright": null
}
],
"Pois": [],
"Type": "Arena"
}
]
}
Get a page of raw arenas.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/arena/getpaged/{pageSize}
Query Parameters
| Parameter | Description |
|---|---|
| pageSize | Should be a page size lower than 50 and greater than 0. |
Continue
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
'https://cbis-rest-api.citybreak.com/v1/api/raw/arena/getnext/{continueToken}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/raw/arena/getnext/{continueToken}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json"
}
});
Example of response:
{
"ContinueToken": "c2NhbjswOzE7dG90YWxfaGl0czo0Ow==",
"TotalResults": 4,
"Result": [
{
"Id": "cbis:1245084",
"References": [
"cbis:1245084"
],
"Name": "Ewok",
"GeoReferences": [],
"Categories": [
30701
],
"InformationData": [
{
"Values": {
"en-US": "Ewok"
},
"AttributeId": 99,
"Type": "String"
},
{
"Values": {
"en-US": "Strongest animal ever, by far!"
},
"AttributeId": 101,
"Type": "String"
},
{
"Values": {
"en-US": "Ewoks were a diminutive species of furry bipeds native to the forest moon of Endor.
They were most notable for helping the Rebel Alliance defeat the forces of the Galactic Empire
at the Battle of Endor, allowing the shield generator there to be destroyed, and in turn, the
Death Star II.\r\n\r\nEwoks were individuals that stood about one meter tall; they used spears,
slings, and knives as weapons; they also used hang gliders as vehicles. Although skilled in forest
survival and the construction of primitive technology, the Ewoks had yet to progress past
stone-level technology when discovered by the Empire. They were quick learners, however, when
exposed to advanced technology with simple mechanical processes and concepts."
},
"AttributeId": 102,
"Type": "String"
}
],
"Position": {
"Longitude": 7.1934700012207,
"Latitude": 48.172353561064
},
"ExpiresAt": "2018-07-01T01:00:00",
"PublishAt": null,
"Occasions": [
{
"Start": "2016-06-16T00:00:00",
"End": "2016-06-30T00:00:00",
"StartTime": 0,
"Duration": 864000000000,
"Days": 127,
"IsRecurring": true,
"Monday": true,
"Tuesday": true,
"Wednesday": true,
"Thursday": true,
"Friday": true,
"Saturday": true,
"Sunday": true,
"ArenaId": ""
}
],
"Medias": [
{
"Url": "http://images.citybreak.com/image.aspx?ImageId=4161317",
"Type": "MainImage",
"Name": {},
"Description": {},
"Copyright": null
},
{
"Url": "http://images.citybreak.com/image.aspx?ImageId=4223191",
"Type": "Image",
"Name": {},
"Description": {},
"Copyright": null
}
],
"Pois": [],
"Type": "Arena"
}
]
}
Get the next page of raw arenas, you need to provide a token obtained from Get Paged. Tokens are valid for 1 minute, extended for aonother minute each time you use it.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/raw/arena/getnext/{continueToken}
Query Parameters
| Parameter | Description |
|---|---|
| continueToken | A token to retrieve the next page. |
Attribute
Attribute
{
"Id": 102,
"Name": "Description",
"Type": "String"
}
Localized version of the attributes for the organization owning the API key.
Possible types are:
- String
- Integer
- Boolean
- Double
- DateTime
Get Attribute
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
'https://cbis-rest-api.citybreak.com/v1/api/attribute/{id}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/attribute/{id}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US"
}
});
Example of response:
{
"Id": 102,
"Name": "Description",
"Type": "String"
}
Get a specific attribute in the specified language.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/attribute/{id}
Query Parameters
| Parameter | Description |
|---|---|
| id | The attribute id. |
| Accept-Language | The language. |
Get Attributes
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
'https://cbis-rest-api.citybreak.com/v1/api/attribute'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/attribute",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US"
}
});
Example of response:
[
{
"Id": 99,
"Name": "Name",
"Type": "String"
},
{
"Id": 101,
"Name": "Introduction",
"Type": "String"
},
{
"Id": 102,
"Name": "Description",
"Type": "String"
},
{
"Id": 103,
"Name": "Directions",
"Type": "String"
},
{
"Id": 104,
"Name": "Opening hours",
"Type": "String"
}
]
Get all the attributes of the organization owning the API key in a specific language.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/attribute
Query Parameters
| Parameter | Description |
|---|---|
| Accept-Language | The language. |
Search Attributes
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
'https://cbis-rest-api.citybreak.com/v1/api/attribute/search/{search}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/attribute/search/{search}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US"
}
});
Example of response:
[
{
"Id": 102569,
"Name": "Lots with drain for waste water",
"Type": "Boolean"
},
{
"Id": 100600,
"Name": "À la carte",
"Type": "Boolean"
},
{
"Id": 100215,
"Name": "Cable TV",
"Type": "Boolean"
}
]
Search attributes, and return the matching ones.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/attribute/search/{search}
Query Parameters
| Parameter | Description |
|---|---|
| search | The string to look for. |
| Accept-Language | The language. |
Attributes in use
curl -X POST
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
--header 'Content-Type: application/json'
-d '{
"Search":"Ewok"
}'
'https://cbis-rest-api.citybreak.com/v1/api/attribute/product'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/attribute/product",
{
method: "POST",
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US",
"Content-Type": "application/json"
},
body: JSON.stringify({
Search: "Ewok"
})
});
Example of response:
[
{
"Id": 101,
"Name": "Introduction",
"References": 1
},
{
"Id": 102,
"Name": "Description",
"References": 1
},
{
"Id": 103,
"Name": "Directions",
"References": 0
},
{
"Id": 104,
"Name": "Opening hours",
"References": 0
},
{
"Id": 105,
"Name": "Entrence",
"References": 1
},
{
"Id": 106,
"Name": "Price information",
"References": 1
},
{
"Id": 107,
"Name": "Phone number",
"References": 0
}
]
Filters products matching the supplied filter and return the attributes with a counter of references, telling how many products matching the filter are using the attribute. The filter is passed through the body part of the request. You can supply an empty filter to get all the attributes and the number of products using each one.
HTTP Request
POST https://cbis-rest-api.citybreak.com/v1/api/attribute/product
Query Parameters
| Parameter | Description |
|---|---|
| filter | The product filter. |
| Accept-Language | The language. |
POI
POI
{
"Position": {
"Longitude": 15.2551183700562,
"Latitude": 54.5259628295898
},
"Name": "WEQWEQWEQWE",
"Id": 8133
}
Localized version of the POI for the organization owning the API key.
Get POI
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
'https://cbis-rest-api.citybreak.com/v1/api/poi/{id}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/poi/{id}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US"
}
});
Example of response:
{
"Position": {
"Longitude": 15.2551183700562,
"Latitude": 54.5259628295898
},
"Name": "WEQWEQWEQWE",
"Id": 8133
}
Get a specific POI in the specified language.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/poi/{id}
Query Parameters
| Parameter | Description |
|---|---|
| id | The POI id. |
| Accept-Language | The language. |
Get POIs
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: sv-SE'
'https://cbis-rest-api.citybreak.com/v1/api/poi'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/poi",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "sv-SE"
}
});
Example of response:
[
{
"Position": {
"Longitude": 15.0032043457031,
"Latitude": 60.7338905334473
},
"Name": "Leksand",
"Id": 16
},
{
"Position": {
"Longitude": 14.5049390792847,
"Latitude": 60.958568572998
},
"Name": "Mora (Mora-Siljan flygplats)",
"Id": 17
},
{
"Position": {
"Longitude": 15.5104637145996,
"Latitude": 60.4233436584473
},
"Name": "Borlänge (Dala Airport)",
"Id": 18
},
{
"Position": {
"Longitude": 15.2551183700562,
"Latitude": 54.5259628295898
},
"Name": "WEQWEQWEQWE",
"Id": 8133
}
]
Get all the POIs of the organization owning the API key in a specific language.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/poi
Query Parameters
| Parameter | Description |
|---|---|
| Accept-Language | The language. |
Search POIs
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
'https://cbis-rest-api.citybreak.com/v1/api/poi/search/{search}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/poi/search/{search}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US"
}
});
Example of response:
[
{
"Position": {
"Longitude": 15.5104637145996,
"Latitude": 60.4233436584473
},
"Name": "Borlänge (Dala Airport)",
"Id": 18
}
]
Search POIs, and return the matching ones.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/poi/search/{search}
Query Parameters
| Parameter | Description |
|---|---|
| search | The string to look for. |
| Accept-Language | The language. |
POIs in use
curl -X POST
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
--header 'Content-Type: application/json'
-d '{
"Search":"Ewok"
}'
'https://cbis-rest-api.citybreak.com/v1/api/poi/product'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/poi/product",
{
method: "POST",
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US",
"Content-Type": "application/json"
},
body: JSON.stringify({
Search: "Ewok"
})
});
Example of response:
[
{
"Id": 17,
"Name": "Mora (Mora-Siljan flygplats)",
"References": 2
},
{
"Id": 18,
"Name": "Borlänge (Dala Airport)",
"References": 0
},
{
"Id": 8133,
"Name": "WEQWEQWEQWE",
"References": 1
},
]
Filters products matching the supplied filter and return the POIs with a counter of references, telling how many products matching the filter are using the POI. The filter is passed through the body part of the request. You can supply an empty filter to get all the POIs and the number of products using each one.
HTTP Request
POST https://cbis-rest-api.citybreak.com/v1/api/poi/product
Query Parameters
| Parameter | Description |
|---|---|
| filter | The product filter. |
| Accept-Language | The language. |
Geo
Geo
{
"Children": [],
"Id": 83745,
"Name": "Gothenburg"
}
Localized version of the geos tree for the organization owning the API key.
Get Geo Tree
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
'https://cbis-rest-api.citybreak.com/v1/api/geo'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/geo",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US"
}
});
Example of response:
{
"Children": [
{
"Children": [
{
"Children": [],
"Id": 83745,
"Name": "Gothenburg"
},
{
"Children": [],
"Id": 105270,
"Name": "Linköping"
},
{
"Children": [],
"Id": 104662,
"Name": "Malmö"
},
{
"Children": [],
"Id": 94466,
"Name": "Stockholm"
}
],
"Id": 105375,
"Name": "Sweden"
}
],
"Id": 4852,
"Name": "Visit Group"
}
Get the geo tree in the specified language.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/geo
Query Parameters
| Parameter | Description |
|---|---|
| Accept-Language | The language. |
Search Geos
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
'https://cbis-rest-api.citybreak.com/v1/api/geo/search/{search}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/geo/search/{search}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US"
}
});
Example of response:
[
{
"Id": 83745,
"Name": "Gothenburg"
}
]
Search geos, and return the matching ones.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/geo/search/{search}
Query Parameters
| Parameter | Description |
|---|---|
| search | The string to look for. |
| Accept-Language | The language. |
Geos in use
curl -X POST
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
--header 'Content-Type: application/json'
-d '{
"Search":"Ewok"
}'
'https://cbis-rest-api.citybreak.com/v1/api/geo/product'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/geo/product",
{
method: "POST",
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US",
"Content-Type": "application/json"
},
body: JSON.stringify({
Search: "Ewok"
})
});
Example of response:
{
"Children": [
{
"Children": [
{
"Children": [],
"References": 1,
"Id": 83745,
"Name": "Gothenburg"
},
{
"Children": [],
"References": 0,
"Id": 105270,
"Name": "Linköping"
},
{
"Children": [],
"References": 0,
"Id": 104662,
"Name": "Malmö"
},
{
"Children": [],
"References": 1,
"Id": 94466,
"Name": "Stockholm"
}
],
"References": 2,
"Id": 105375,
"Name": "Sweden"
}
],
"References": 2,
"Id": 4852,
"Name": "Visit Group"
}
Filters products matching the supplied filter and return the geos with a counter of references, telling how many products matching the filter are using the geo. The filter is passed through the body part of the request. You can supply an empty filter to get the geo tree and the number of products using each one.
HTTP Request
POST https://cbis-rest-api.citybreak.com/v1/api/geo/product
Query Parameters
| Parameter | Description |
|---|---|
| filter | The product filter. |
| Accept-Language | The language. |
Category
Category
{
"Children": [],
"Id": 83745,
"Name": "Gothenburg"
}
Localized version of the category tree for the organization owning the API key.
Get Category Tree
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
'https://cbis-rest-api.citybreak.com/v1/api/category'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/category",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US"
}
});
Example of response:
{
"Children": [
{
"Children": [
{
"Children": [
{
"Children": [],
"Id": 26218,
"Name": "Hotel"
}
],
"Id": 26219,
"Name": "B&B"
},
{
"Children": [],
"Id": 26217,
"Name": "Husvagnscamping"
},
{
"Children": [
{
"Children": [],
"Id": 30610,
"Name": "Test"
}
],
"Id": 26220,
"Name": "vandrarhem"
}
],
"Id": 26210,
"Name": "Accommodation"
},
{
"Children": [
{
"Children": [
{
"Children": [],
"Id": 32541,
"Name": "Grill"
}
],
"Id": 32540,
"Name": "Activities"
}
],
"Id": 32538,
"Name": "To-do"
},
{
"Children": [],
"Id": 30701,
"Name": "Thibault"
}
],
"Id": 5946,
"Name": "Visit Group"
}
Get the category tree in the specified language.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/category
Query Parameters
| Parameter | Description |
|---|---|
| Accept-Language | The language. |
Search Categories
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
'https://cbis-rest-api.citybreak.com/v1/api/category/search/{search}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/category/search/{search}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US"
}
});
Example of response:
[
{
"Id": 30701,
"Name": "Thibault"
}
]
Search categories, and return the matching ones.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/category/search/{search}
Query Parameters
| Parameter | Description |
|---|---|
| search | The string to look for. |
| Accept-Language | The language. |
Categories in use
curl -X POST
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
--header 'Content-Type: application/json'
-d '{
"Search":"Ewok"
}'
'https://cbis-rest-api.citybreak.com/v1/api/category/product'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/category/product",
{
method: "POST",
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US",
"Content-Type": "application/json"
},
body: JSON.stringify({
Search: "Ewok"
})
});
Example of response:
{
"Children": [
{
"Children": [
{
"Children": [
{
"Children": [],
"References": 0,
"Id": 26218,
"Name": "Hotel"
}
],
"References": 0,
"Id": 26219,
"Name": "B&B"
},
{
"Children": [],
"References": 0,
"Id": 26217,
"Name": "Husvagnscamping"
},
{
"Children": [
{
"Children": [],
"References": 0,
"Id": 30610,
"Name": "Test"
}
],
"References": 0,
"Id": 26220,
"Name": "vandrarhem"
}
],
"References": 0,
"Id": 26210,
"Name": "Accommodation"
},
{
"Children": [
{
"Children": [
{
"Children": [],
"References": 0,
"Id": 32541,
"Name": "Grill"
}
],
"References": 0,
"Id": 32540,
"Name": "Activities"
}
],
"References": 0,
"Id": 32538,
"Name": "To-do"
},
{
"Children": [],
"References": 1,
"Id": 30701,
"Name": "Thibault"
}
],
"References": 1,
"Id": 5946,
"Name": "Visit Group"
}
Filters products matching the supplied filter and return the categories with a counter of references, telling how many products matching the filter are using the category. The filter is passed through the body part of the request. You can supply an empty filter to get the category tree and the number of products using each one.
HTTP Request
POST https://cbis-rest-api.citybreak.com/v1/api/category/product
Query Parameters
| Parameter | Description |
|---|---|
| filter | The product filter. |
| Accept-Language | The language. |
Product
Product
{
"Relations": [],
"RelationsContent": [],
"Id": "cbis:1245084",
"References": [
"cbis:1245084"
],
"Name": "Ewok",
"Geos": [],
"Categories": [
{
"Path": [
{
"Id": 5946,
"Section": "Visit Group"
},
{
"Id": 30701,
"Section": "Thibault"
}
]
}
],
"ExpiresAt": "2018-07-01T01:00:00",
"PublishAt": "2000-01-01T00:00:00",
"Information": [
{
"Id": 101,
"Name": "Introduction",
"Value": "Strongest animal ever, by far!",
"Type": "String"
},
{
"Id": 102,
"Name": "Description",
"Value": "Ewoks were a diminutive species of furry bipeds native to the forest moon of Endor. They were most notable for helping the Rebel Alliance defeat the forces of the Galactic Empire at the Battle of Endor, allowing the shield generator there to be destroyed, and in turn, the Death Star II.\r\n\r\nEwoks were individuals that stood about one meter tall; they used spears, slings, and knives as weapons; they also used hang gliders as vehicles. Although skilled in forest survival and the construction of primitive technology, the Ewoks had yet to progress past stone-level technology when discovered by the Empire. They were quick learners, however, when exposed to advanced technology with simple mechanical processes and concepts.",
"Type": "String"
},
{
"Id": 105,
"Name": "Entrance",
"Value": "In an animal? Really?",
"Type": "String"
},
{
"Id": 106,
"Name": "Price information",
"Value": "Priceless",
"Type": "String"
}
],
"Position": null,
"Media": [
{
"Name": null,
"Copyright": null,
"Description": null,
"Type": "MainImage",
"Url": "http://images.citybreak.com/image.aspx?ImageId=4161317"
},
{
"Name": null,
"Copyright": null,
"Description": null,
"Type": "Image",
"Url": "http://images.citybreak.com/image.aspx?ImageId=4223191"
}
],
"Occasions": [],
"Pois": [],
"Type": "Product"
}
Localized version of a product.
Get Product
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
'https://cbis-rest-api.citybreak.com/v1/api/product/{id}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/product/{id}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US"
}
});
Example of response:
[
{
"Relations": [],
"RelationsContent": [],
"Id": "cbis:1245084",
"References": [
"cbis:1245084"
],
"Name": "Ewok",
"Geos": [],
"Categories": [
{
"Path": [
{
"Id": 5946,
"Section": "Visit Group"
},
{
"Id": 30701,
"Section": "Thibault"
}
]
}
],
"ExpiresAt": "2018-07-01T01:00:00",
"PublishAt": "2000-01-01T00:00:00",
"Information": [
{
"Id": 101,
"Name": "Introduction",
"Value": "Strongest animal ever, by far!",
"Type": "String"
},
{
"Id": 102,
"Name": "Description",
"Value": "Ewoks were a diminutive species of furry bipeds native to the forest moon of Endor. They were most notable for helping the Rebel Alliance defeat the forces of the Galactic Empire at the Battle of Endor, allowing the shield generator there to be destroyed, and in turn, the Death Star II.\r\n\r\nEwoks were individuals that stood about one meter tall; they used spears, slings, and knives as weapons; they also used hang gliders as vehicles. Although skilled in forest survival and the construction of primitive technology, the Ewoks had yet to progress past stone-level technology when discovered by the Empire. They were quick learners, however, when exposed to advanced technology with simple mechanical processes and concepts.",
"Type": "String"
},
{
"Id": 105,
"Name": "Entrance",
"Value": "In an animal? Really?",
"Type": "String"
},
{
"Id": 106,
"Name": "Price information",
"Value": "Priceless",
"Type": "String"
}
],
"Position": null,
"Media": [
{
"Name": null,
"Copyright": null,
"Description": null,
"Type": "MainImage",
"Url": "http://images.citybreak.com/image.aspx?ImageId=4161317"
},
{
"Name": null,
"Copyright": null,
"Description": null,
"Type": "Image",
"Url": "http://images.citybreak.com/image.aspx?ImageId=4223191"
}
],
"Occasions": [],
"Pois": [],
"Type": "Product"
}
]
Search for products responding to the id supplied, might be more than 1.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/product/{id}
Query Parameters
| Parameter | Description |
|---|---|
| id | The id you are looking for. |
| Accept-Language | The language. |
Get Paged
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
'https://cbis-rest-api.citybreak.com/v1/api/product/getpaged/{pagesize}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/product/getpaged/{pagesize}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US"
}
});
Example of response:
{
"ContinueToken": "c2NhbjswOzE7dG90YWxfaGl0czozOw==",
"TotalResults": 3,
"Result": [
{
"Product 1"
},
{
"Product 2"
},
{
"Product 3"
}
]
}
Get a page of localized product, and a token to fetch the next page.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/product/getpaged/{pagesize}
Query Parameters
| Parameter | Description |
|---|---|
| pagesize | Should be a page size lower than 50 and greater than 0. |
| Accept-Language | The language. |
Continue
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
'https://cbis-rest-api.citybreak.com/v1/api/product/getnext/{continueToken}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/product/getnext/{continueToken}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US"
}
});
Example of response:
{
"ContinueToken": "c2NhbjswOzE7dG90YWxfaGl0czozOw==",
"TotalResults": 3,
"Result": [
{
"Product 1"
},
{
"Product 2"
},
{
"Product 3"
}
]
}
Get a page of localized product, and a token to fetch the next page.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/product/getnext/{continueToken}
Query Parameters
| Parameter | Description |
|---|---|
| continueToken | The token obtained from a getpaged request. |
| Accept-Language | The language. |
Filter Products
curl -X POST
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
--header 'Content-Type: application/json'
-d '{
"Search":"Ewok",
"Page": 0,
"PageSize": 10
}'
'https://cbis-rest-api.citybreak.com/v1/api/product'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/product",
{
method: "POST",
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US",
"Content-Type": "application/json"
},
body: JSON.stringify({
Search: "Ewok",
"Page": 0,
"PageSize": 10
})
});
Example of response:
{
"Page": 0,
"PageSize": 10,
"TotalResults": 1,
"Result": [
{
"Relations": [],
"RelationsContent": [],
"Id": "cbis:1245084",
"References": [
"cbis:1245084"
],
"Name": "Ewok",
"Geos": [],
"Categories": [
{
"Path": [
{
"Id": 5946,
"Section": "Visit Group"
},
{
"Id": 30701,
"Section": "Thibault"
}
]
}
],
"ExpiresAt": "2018-07-01T01:00:00",
"PublishAt": "2000-01-01T00:00:00",
"Information": [
{
"Id": 101,
"Name": "Introduction",
"Value": "Strongest animal ever, by far!",
"Type": "String"
},
{
"Id": 102,
"Name": "Description",
"Value": "Ewoks were a diminutive species of furry bipeds native to the forest moon of Endor. They were most notable for helping the Rebel Alliance defeat the forces of the Galactic Empire at the Battle of Endor, allowing the shield generator there to be destroyed, and in turn, the Death Star II.\r\n\r\nEwoks were individuals that stood about one meter tall; they used spears, slings, and knives as weapons; they also used hang gliders as vehicles. Although skilled in forest survival and the construction of primitive technology, the Ewoks had yet to progress past stone-level technology when discovered by the Empire. They were quick learners, however, when exposed to advanced technology with simple mechanical processes and concepts.",
"Type": "String"
},
{
"Id": 105,
"Name": "Entrance",
"Value": "In an animal? Really?",
"Type": "String"
},
{
"Id": 106,
"Name": "Price information",
"Value": "Priceless",
"Type": "String"
}
],
"Position": null,
"Media": [
{
"Name": null,
"Copyright": null,
"Description": null,
"Type": "MainImage",
"Url": "http://images.citybreak.com/image.aspx?ImageId=4161317"
},
{
"Name": null,
"Copyright": null,
"Description": null,
"Type": "Image",
"Url": "http://images.citybreak.com/image.aspx?ImageId=4223191"
}
],
"Occasions": [],
"Pois": [],
"Type": "Product"
}
]
}
Filter products using a filter, see POST Fitler for more information about it.
HTTP Request
POST https://cbis-rest-api.citybreak.com/v1/api/product
Query Parameters
| Parameter | Description |
|---|---|
| filter | The filter. |
| Accept-Language | The language. |
Arena
Arena
{
"Relations": [],
"RelationsContent": [],
"Id": "cbis:1245084",
"References": [
"cbis:1245084"
],
"Name": "Ewok",
"Geos": [],
"Categories": [
{
"Path": [
{
"Id": 5946,
"Section": "Visit Group"
},
{
"Id": 30701,
"Section": "Thibault"
}
]
}
],
"ExpiresAt": "2018-07-01T01:00:00",
"PublishAt": "2000-01-01T00:00:00",
"Information": [
{
"Id": 101,
"Name": "Introduction",
"Value": "Strongest animal ever, by far!",
"Type": "String"
},
{
"Id": 102,
"Name": "Description",
"Value": "Ewoks were a diminutive species of furry bipeds native to the forest moon of Endor. They were most notable for helping the Rebel Alliance defeat the forces of the Galactic Empire at the Battle of Endor, allowing the shield generator there to be destroyed, and in turn, the Death Star II.\r\n\r\nEwoks were individuals that stood about one meter tall; they used spears, slings, and knives as weapons; they also used hang gliders as vehicles. Although skilled in forest survival and the construction of primitive technology, the Ewoks had yet to progress past stone-level technology when discovered by the Empire. They were quick learners, however, when exposed to advanced technology with simple mechanical processes and concepts.",
"Type": "String"
},
{
"Id": 105,
"Name": "Entrance",
"Value": "In an animal? Really?",
"Type": "String"
},
{
"Id": 106,
"Name": "Price information",
"Value": "Priceless",
"Type": "String"
}
],
"Position": null,
"Media": [
{
"Name": null,
"Copyright": null,
"Description": null,
"Type": "MainImage",
"Url": "http://images.citybreak.com/image.aspx?ImageId=4161317"
},
{
"Name": null,
"Copyright": null,
"Description": null,
"Type": "Image",
"Url": "http://images.citybreak.com/image.aspx?ImageId=4223191"
}
],
"Occasions": [],
"Pois": [],
"Type": "Arena"
}
Localized version of a arena.
Get Arena
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
'https://cbis-rest-api.citybreak.com/v1/api/arena/{id}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/arena/{id}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US"
}
});
Example of response:
[
{
"Relations": [],
"RelationsContent": [],
"Id": "cbis:1245084",
"References": [
"cbis:1245084"
],
"Name": "Ewok",
"Geos": [],
"Categories": [
{
"Path": [
{
"Id": 5946,
"Section": "Visit Group"
},
{
"Id": 30701,
"Section": "Thibault"
}
]
}
],
"ExpiresAt": "2018-07-01T01:00:00",
"PublishAt": "2000-01-01T00:00:00",
"Information": [
{
"Id": 101,
"Name": "Introduction",
"Value": "Strongest animal ever, by far!",
"Type": "String"
},
{
"Id": 102,
"Name": "Description",
"Value": "Ewoks were a diminutive species of furry bipeds native to the forest moon of Endor. They were most notable for helping the Rebel Alliance defeat the forces of the Galactic Empire at the Battle of Endor, allowing the shield generator there to be destroyed, and in turn, the Death Star II.\r\n\r\nEwoks were individuals that stood about one meter tall; they used spears, slings, and knives as weapons; they also used hang gliders as vehicles. Although skilled in forest survival and the construction of primitive technology, the Ewoks had yet to progress past stone-level technology when discovered by the Empire. They were quick learners, however, when exposed to advanced technology with simple mechanical processes and concepts.",
"Type": "String"
},
{
"Id": 105,
"Name": "Entrance",
"Value": "In an animal? Really?",
"Type": "String"
},
{
"Id": 106,
"Name": "Price information",
"Value": "Priceless",
"Type": "String"
}
],
"Position": null,
"Media": [
{
"Name": null,
"Copyright": null,
"Description": null,
"Type": "MainImage",
"Url": "http://images.citybreak.com/image.aspx?ImageId=4161317"
},
{
"Name": null,
"Copyright": null,
"Description": null,
"Type": "Image",
"Url": "http://images.citybreak.com/image.aspx?ImageId=4223191"
}
],
"Occasions": [],
"Pois": [],
"Type": "Arena"
}
]
Search for arenas responding to the id supplied, might be more than 1.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/arena/{id}
Query Parameters
| Parameter | Description |
|---|---|
| id | The id you are looking for. |
| Accept-Language | The language. |
Get paged
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
'https://cbis-rest-api.citybreak.com/v1/api/arena/getpaged/{pagesize}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/arena/getpaged/{pagesize}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US"
}
});
Example of response:
{
"ContinueToken": "c2NhbjswOzE7dG90YWxfaGl0czozOw==",
"TotalResults": 3,
"Result": [
{
"Arena"
},
{
"Arena"
},
{
"Arena"
}
]
}
Get a page of localized arena, and a token to fetch the next page.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/arena/getpaged/{pagesize}
Query Parameters
| Parameter | Description |
|---|---|
| pagesize | Should be a page size lower than 50 and greater than 0. |
| Accept-Language | The language. |
Continue
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
'https://cbis-rest-api.citybreak.com/v1/api/arena/getnext/{continueToken}'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/arena/getnext/{continueToken}",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US"
}
});
Example of response:
{
"ContinueToken": "c2NhbjswOzE7dG90YWxfaGl0czozOw==",
"TotalResults": 3,
"Result": [
{
"Arena"
},
{
"Arena"
},
{
"Arena"
}
]
}
Get a page of localized arena, and a token to fetch the next page.
HTTP Request
GET https://cbis-rest-api.citybreak.com/v1/api/arena/getnext/{continueToken}
Query Parameters
| Parameter | Description |
|---|---|
| continueToken | The token obtained from a getpaged request. |
| Accept-Language | The language. |
Filter Arenas
curl -X POST
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
--header 'Content-Type: application/json'
-d '{
"Search":"Ewok",
"Page": 0,
"PageSize": 10
}'
'https://cbis-rest-api.citybreak.com/v1/api/arena'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/arena",
{
method: "POST",
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US",
"Content-Type": "application/json"
},
body: JSON.stringify({
Search: "Ewok",
"Page": 0,
"PageSize": 10
})
});
Example of response:
{
"Page": 0,
"PageSize": 10,
"TotalResults": 1,
"Result": [
{
"Relations": [],
"RelationsContent": [],
"Id": "cbis:1245084",
"References": [
"cbis:1245084"
],
"Name": "Ewok",
"Geos": [],
"Categories": [
{
"Path": [
{
"Id": 5946,
"Section": "Visit Group"
},
{
"Id": 30701,
"Section": "Thibault"
}
]
}
],
"ExpiresAt": "2018-07-01T01:00:00",
"PublishAt": "2000-01-01T00:00:00",
"Information": [
{
"Id": 101,
"Name": "Introduction",
"Value": "Strongest animal ever, by far!",
"Type": "String"
},
{
"Id": 102,
"Name": "Description",
"Value": "Ewoks were a diminutive species of furry bipeds native to the forest moon of Endor. They were most notable for helping the Rebel Alliance defeat the forces of the Galactic Empire at the Battle of Endor, allowing the shield generator there to be destroyed, and in turn, the Death Star II.\r\n\r\nEwoks were individuals that stood about one meter tall; they used spears, slings, and knives as weapons; they also used hang gliders as vehicles. Although skilled in forest survival and the construction of primitive technology, the Ewoks had yet to progress past stone-level technology when discovered by the Empire. They were quick learners, however, when exposed to advanced technology with simple mechanical processes and concepts.",
"Type": "String"
},
{
"Id": 105,
"Name": "Entrance",
"Value": "In an animal? Really?",
"Type": "String"
},
{
"Id": 106,
"Name": "Price information",
"Value": "Priceless",
"Type": "String"
}
],
"Position": null,
"Media": [
{
"Name": null,
"Copyright": null,
"Description": null,
"Type": "MainImage",
"Url": "http://images.citybreak.com/image.aspx?ImageId=4161317"
},
{
"Name": null,
"Copyright": null,
"Description": null,
"Type": "Image",
"Url": "http://images.citybreak.com/image.aspx?ImageId=4223191"
}
],
"Occasions": [],
"Pois": [],
"Type": "Arena"
}
]
}
Filter arenas using a filter, see POST Fitler for more information about it.
HTTP Request
POST https://cbis-rest-api.citybreak.com/v1/api/arena
Query Parameters
| Parameter | Description |
|---|---|
| filter | The filter. |
| Accept-Language | The language. |
Filter
Filter
{
"Sorts": [],
"Page": 0,
"PageSize": 0,
"Fields": [],
"Relations": {},
"Search": "",
"Position": {},
"GeoBox": {},
"ProductIds": [],
"ReferencePrefix": "",
"Categories": [],
"Geos": [],
"Pois": [],
"Occasions": {},
"Information": {},
"PublishAt": {},
"ExpiresAt": {}
}
Filter used to query products.
Categories, Geonodes, Pois
curl -X POST
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
--header 'Content-Type: application/json'
-d '{
"Page": 0,
"PageSize": 20,
"Categories": [
123, 124
],
"Geos": [
123, 124
],
"Pois": [
123, 124
]
}'
'https://cbis-rest-api.citybreak.com/v1/api/product'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/product",
{
method: "POST",
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US",
"Content-Type": "application/json"
},
body: JSON.stringify({
"Page": 0,
"PageSize": 20,
"Categories": [
123, 124
],
"Geos": [
123, 124
],
"Pois": [
123, 124
]
})
});
Categories, Geonodes and Pois are list of integers. The example query can be translated to products (in category 123 OR 124) AND (in geonode 123 OR 124) AND (in poi 123 OR 124).
Parameters
| Parameter | Type | Description |
|---|---|---|
| Categories | int[] | List of categories Ids. |
| Geos | int[] | List of geonodes Ids. |
| Pois | int[] | List of pois Ids. |
Expires and Publish
curl -X POST
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
--header 'Content-Type: application/json'
-d '{
"Page": 0,
"PageSize": 20,
"PublishAt": {
"After": "2016-09-08T07:09:44.042Z",
"Before": "2016-09-08T07:09:44.042Z"
},
"ExpiresAt": {
"After": "2016-09-08T07:09:44.042Z",
"Before": "2016-09-08T07:09:44.042Z"
}
}'
'https://cbis-rest-api.citybreak.com/v1/api/product'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/product",
{
method: "POST",
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US",
"Content-Type": "application/json"
},
body: JSON.stringify({
"Page": 0,
"PageSize": 20,
"Publish": {
"After": "2016-09-08T07:09:44.042Z",
"Before": "2016-09-08T07:09:44.042Z"
},
"Expires": {
"After": "2016-09-08T07:09:44.042Z",
"Before": "2016-09-08T07:09:44.042Z"
}
})
});
Allow you to override the default filters on ExpiresAt and PublishAt.
If not supplied, the default value will be "PublishAt": {"After": "NOW"}, and "ExpiresAt": {"After": "NOW"}.
Parameters
| Parameter | Type | Description |
|---|---|---|
| Before | DateTime | Before which date. |
| After | DateTime | After which date. |
Search in Name
curl -X POST
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
--header 'Content-Type: application/json'
-d '{
"Page": 0,
"PageSize": 20,
"Search": "string"
}'
'https://cbis-rest-api.citybreak.com/v1/api/product'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/product",
{
method: "POST",
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US",
"Content-Type": "application/json"
},
body: JSON.stringify({
"Page": 0,
"PageSize": 20,
"Search": "string"
})
});
Shorthand to search in products name.
Parameters
| Parameter | Type | Description |
|---|---|---|
| Search | string | String you are looking for, handles typos. |
Position
curl -X POST
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
--header 'Content-Type: application/json'
-d '{
"Page": 0,
"PageSize": 20,
"Position": {
"Latitude": 0,
"Longitude": 0,
"Distance": 0
}
}'
'https://cbis-rest-api.citybreak.com/v1/api/product'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/product",
{
method: "POST",
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US",
"Content-Type": "application/json"
},
body: JSON.stringify({
"Page": 0,
"PageSize": 20,
"Position": {
"Latitude": 0,
"Longitude": 0,
"Distance": 0
}
})
});
Filter products by their position. You need to supply a reference point and a Distance (radius in Km).
Parameters
| Parameter | Type | Description |
|---|---|---|
| Latitude | double | Latitude of reference point. |
| Longitude | double | Longitude of reference point. |
| Distance | int | Distance from reference point (km). |
GeoBox
curl -X POST
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
--header 'Content-Type: application/json'
-d '{
"Page": 0,
"PageSize": 20,
"GeoBox": {
"TopLeftLat": 0,
"TopLeftLng": 0,
"BottomRightLat": 0,
"BottomRightLng": 0
}
}'
'https://cbis-rest-api.citybreak.com/v1/api/product'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/product",
{
method: "POST",
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US",
"Content-Type": "application/json"
},
body: JSON.stringify({
"Page": 0,
"PageSize": 20,
"GeoBox": {
"TopLeftLat": 0,
"TopLeftLng": 0,
"BottomRightLat": 0,
"BottomRightLng": 0
}
})
});
Filter products by their position. You need to supply the coordinates of the top left point and the bottom right one. Products included in the geographic box will be returned.
Parameters
| Parameter | Type | Description |
|---|---|---|
| TopLeftLat | double | Latitude of the top left point. |
| TopLeftLng | double | Longitude of the top left point. |
| BottomRightLat | double | Latitude of the bottom right point. |
| BottomRightLng | double | Longitude of the bottom right point. |
ProductIds
curl -X POST
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
--header 'Content-Type: application/json'
-d '{
"Page": 0,
"PageSize": 20,
"ProductIds": [
"cbis:123456", "cbis:987654"
]
}'
'https://cbis-rest-api.citybreak.com/v1/api/product'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/product",
{
method: "POST",
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US",
"Content-Type": "application/json"
},
body: JSON.stringify({
"Page": 0,
"PageSize": 20,
"ProductIds": [
"cbis:123456", "cbis:987654"
]
})
});
Only return the products matching the ids supplied in ProductIds.
Parameters
| Parameter | Type | Description |
|---|---|---|
| ProductIds | string[] | The productIds. |
ReferencePrefix
curl -X POST
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
--header 'Content-Type: application/json'
-d '{
"Page": 0,
"PageSize": 20,
"ReferencePrefix": "ewok:"
}'
'https://cbis-rest-api.citybreak.com/v1/api/product'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/product",
{
method: "POST",
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US",
"Content-Type": "application/json"
},
body: JSON.stringify({
"Page": 0,
"PageSize": 20,
"ReferencePrefix": "ewok:"
})
});
Only return the products having a reference that starts with ReferencePrefix.
Parameters
| Parameter | Type | Description |
|---|---|---|
| ReferencePrefix | string | The prefix. |
Occasions
curl -X POST
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
--header 'Content-Type: application/json'
-d '{
"Page": 0,
"PageSize": 20,
"Occasions": {
"After": "2016-09-08T07:09:44.042Z",
"Before": "2016-09-08T07:09:44.042Z",
"ArenaIds": [
"cbis:12345"
]
}
}'
'https://cbis-rest-api.citybreak.com/v1/api/product'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/product",
{
method: "POST",
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US",
"Content-Type": "application/json"
},
body: JSON.stringify({
"Page": 0,
"PageSize": 20,
"Occasions": {
"After": "2016-09-08T07:09:44.042Z",
"Before": "2016-09-08T07:09:44.042Z",
"ArenaIds": [
"cbis:12345"
]
}
})
});
Filter products by their occasions. Supply the fields you need.
Parameters
| Parameter | Type | Description |
|---|---|---|
| After | DateTime | Occasion is after this date. |
| Before | DateTime | Occasion is after this date. |
| ArenaIds | string[] | Occasion occurs in one of the arenas. |
Information
curl -X POST
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
--header 'Content-Type: application/json'
-d '{
"Page": 0,
"PageSize": 20,
"Information": {
"Operator": "AND",
"Queries": [
{
"Id": 0,
"Type": "Value",
"Value": "string",
"SubQuery": {
"Operator": "OR",
"Queries": [
{
"Id": 100059,
"Type": "Value",
"Value": "true"
},
"SubQuery": {}
}
}
]
}
}'
'https://cbis-rest-api.citybreak.com/v1/api/product'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/product",
{
method: "POST",
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US",
"Content-Type": "application/json"
},
body: JSON.stringify({
"Page": 0,
"PageSize": 20,
"Information": {
"Operator": "AND",
"Queries": [
{
"Id": 0,
"Type": "Value",
"Value": "string",
"SubQuery": {
"Operator": "OR",
"Queries": [
{
"Id": 100059,
"Type": "Value",
"Value": "true"
},
"SubQuery": {}
}
}
]
}
})
});
Filter products by the content of the Information they carry, by having an attribute or not having.
Operator
- AND
- OR
MatchType
- Value (exact match, requires
Value) - Fuzzy (approx match, requires
Value) - Range (mathematical range, requires
Value: [1:10], ]1;10[, >3, <10 etc…) - Has (has the attribute)
- Hasnt (has not the attribute)
Information & SubQuery objects
| Parameter | Type | Description |
|---|---|---|
| Operator | Operator | The operator to apply between the queries. |
| Queries | Query[] | A list of query. |
Query object
| Parameter | Type | Description |
|---|---|---|
| Id | int | Attribute Id. |
| Type | MatchType | See above. |
| Value | string | The value. |
| SubQuery | SubQuery | See above. |
Relations
curl -X POST
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
--header 'Content-Type: application/json'
-d '{
"Page": 0,
"PageSize": 20,
"Relations": {
"Operator": "AND",
"Queries": [
{
"Type": "Has",
"RelationType": "Parent",
"Filter": {
},
"SubQuery": {
"Operator": "AND",
"Queries": [
{
"Type": "Value",
"RelationType": "None",
"Filter": {
"Occasions": {
"After": "2016-09-08T07:09:44.042Z",
"Before": "2016-09-08T07:09:44.042Z",
"ArenaIds": [
"cbis:12345"
]
}
},
"SubQuery": {}
}
]
}
}
}
]
}'
'https://cbis-rest-api.citybreak.com/v1/api/product'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/product",
{
method: "POST",
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US",
"Content-Type": "application/json"
},
body: JSON.stringify({
"Page": 0,
"PageSize": 20,
"Relations": {
"Operator": "AND",
"Queries": [
{
"Type": "Has",
"RelationType": "Parent",
"Filter": {
},
"SubQuery": {
"Operator": "AND",
"Queries": [
{
"Type": "Value",
"RelationType": "None",
"Filter": {
"Occasions": {
"After": "2016-09-08T07:09:44.042Z",
"Before": "2016-09-08T07:09:44.042Z",
"ArenaIds": [
"cbis:12345"
]
}
},
"SubQuery": {}
}
]
}
}
}
})
});
Filter products by the products related to the product, apply filters to related products.
Operator
- AND
- OR
MatchType
- Value (relation match the filter)
- Has (has the relation)
- Hasnt (has not the relation)
RelationType
- Child
- Parent
- None (products matching filter in subqueries)
Relations & SubQuery objects
| Parameter | Type | Description |
|---|---|---|
| Operator | Operator | The operator to apply between the queries. |
| Queries | Query[] | A list of query. |
Query object
| Parameter | Type | Description |
|---|---|---|
| Type | MatchType | See above. |
| RelationType | RelationType | See above. |
| Filter | Filter | The product filter. |
| SubQuery | SubQuery | See above. |
Fields
curl -X POST
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
--header 'Content-Type: application/json'
-d '{
"Page": 0,
"PageSize": 20,
"Fields": ["Id", "Name"]
}'
'https://cbis-rest-api.citybreak.com/v1/api/product'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/product",
{
method: "POST",
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US",
"Content-Type": "application/json"
},
body: JSON.stringify({
"Page": 0,
"PageSize": 20,
"Fields": ["Id", "Name"]
})
});
Only populate a subset of fields.
Parameters
| Parameter | Type | Description |
|---|---|---|
| Fields | string[] | Name of the fields you want populated, required if pagesize >= 50. |
Sorting & Paging
curl -X POST
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
--header 'Content-Type: application/json'
-d '{
"Page": 0,
"PageSize": 20,
"Sorts": [{
"Field": "Name",
"Order": "Asc"
}],
}'
'https://cbis-rest-api.citybreak.com/v1/api/product'
var r = fetch("https://cbis-rest-api.citybreak.com/v1/api/product",
{
method: "POST",
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US",
"Content-Type": "application/json"
},
body: JSON.stringify({
"Page": 0,
"PageSize": 20,
"Sorts": [{
"Field": "Name",
"Order": "Asc"
}],
})
});
Order products by the supplied fields. Optionally, you can provide multiple sorting objects to sort by multiple levels in decreasing order of importance. Supported fields are:
- Name
- Id
- ExpiresAt
- PublishAt
- ProductIds (follow order from array of ids in ProductIds field)
- Occasions
- Information (need to supply AttributeId)
- Position (need to supply Latitude & Longitude)
- Random (provide a RandomSeed to ensure consistent results & paging)
Sort Object
| Parameter | Type | Description |
|---|---|---|
| Field | string | Name of the field you want to order by. |
| Order | Order | Either Asc or Desc |
| AttributeId | int | The attribute id of the information field you want to sort on |
| Latitude | double | The latitude of the reference point to sort on position |
| Longitude | double | The longitude of the reference point to sort on position |
| RandomSeed | string | The seed to use for Random sorting to ensure consistent results & paging |
Paging
| Parameter | Type | Description |
|---|---|---|
| Page | int | The page, starting at 0. |
| PageSize | int | The size of the page. |
Webhooks
We provide Webhooks (Wikipedia) for your API keys on demand. Contact our support if you wish to use this option.
We support the following authentication methods:
- Basic Authentication
- Cusom Header Authentication
- No authentication
We also handle automatic retries if your endpoint is unavailable.
{
"Key" : "APIKEY132456789EWOK",
"HasLog" : true,
"Attribute" : {
"AffectedProducts" : ["cbis:355699", "cbis:1245084", "cbis:1268500", "cbis:1270889"],
"AffectedArenas" : ["cbis:12345"],
"Date" : "2016-11-03T12:38:09.7400589Z",
"Changes" : {
"99" : "Updated",
"102727" : "Created",
"102728" : "Deleted"
}
},
"Cat" : null,
"Geo" : null,
"Poi" : null,
"Product" : {
"AffectedProducts" : ["cbis:355699", "cbis:1245084", "cbis:1268500", "cbis:1270889"],
"AffectedArenas" : [],
"Date" : "2016-11-03T12:38:08.1485162Z",
"Changes" : {
"cbis:355699" : "Created",
"cbis:1245084" : "Created",
"cbis:1268500" : "Created",
"cbis:1270889" : "Created"
}
},
"Arena" : null
}
Errors
CBIS REST API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 400 | Bad Request – Could not understand your request |
| 401 | Unauthorized – Your API key is wrong, see Authentication, or you are out of calls |
| 404 | Not Found – Could not find what you are looking for |
| 405 | Method Not Allowed – Method not supported for this request |
| 500 | Internal Server Error – Server trouble, try again later. If recurring, contact us. |
| 503 | Service Unavailable – Offline for maintanance. Please try again later. |