Introduction
Welcome to the Visit Documentation Template.
Check out the readme to get started: visit-doc-template
Example
This is an example section.
Example
curl -X GET
--header 'ApiKey: APIKEY132456789EWOK'
--header 'Accept: application/json'
--header 'Accept-Language: en-US'
'https://example.citybreak.com/v1/example'
var r = fetch("https://example.citybreak.com/v1/example",
{
headers: {
"ApiKey:" "APIKEY132456789EWOK",
"Accept": "application/json",
"Accept-Language": "en-US"
}
});
Example of response:
{
"Examples": [
"Hello World",
"Ewoks are the best"
]
}
An example.
HTTP Request
POST https://example.citybreak.com/v1/example
Query Parameters
Parameter | Type | Description |
---|---|---|
Accept-Language | Header | The language. |
Errors
The 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 |
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. |