{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"aa0fcb5d-7689-4848-a618-e998af26fac7","name":"Camping.care V2.1","description":"## API Reference\n\nThe Camping.care API V2 is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.\n\n### API Keys\n\nThe Camping.care API uses API keys to authenticate requests. You can view and manage your API keys in the Camping.care V2 Dashboard. Each API key can have it's own set of rights, these rights can be setup from the API section in the camping.care dashboard.\n\nEach API key belongs to a specific Admnistration.\n\n**Single API Key for multiple administrations**\n\nThis can be achieved in a group account or as an OTA. Ask camping.care if you can setup multipark access.\n\nCamping.care can also manages multiple administrations with a single API key, therefore you must be setup as an OTA. In the documentation we also reference special **OTA parameters. These parameters have to be ignored by the normal API usage or user the X-Admin-Id as header parameters\n\nYour API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.\n\nAll API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.\n\n### OAuth2\n\nApps in the appstore use the OAuth2 flow to access the api. For more information about the OAuth flow:\n\n[https://developer.camping.care/docs/appstore/authentication](https://developer.camping.care/docs/appstore/authentication)\n\nThe admin id should be added as a header parameter: X-Admin-Id\n\n## **Rate Limiter**\n\nCamping.care API version 2.1.3 has included a rate limiter. It is now limited on 120 request per minute.\n\nThe rate limiter will send you a Status code: 429 error when you reached your rate limit.\n\nYou can also see how many request are done in the last minute by checking thee response headers:\n\nX-Ratelimit-Limit: The amount of requests which can be done\n\nX-Ratelimit-Remaining: The amount of requests you still have remaining\n\n## Errors\n\nCamping.care uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Camping.care servers (these are rare).\n\nSome 4xx errors that could be handled programmatically\n\n#### Code response\n\n``` json\n{\n    \"error\": {\n        \"code\": 1,\n        \"message\": \"No accommodation found Accommodation::get\"\n    }\n}\n\n ```\n\n#### Attributes\n\n| attribute / type | description |\n| --- | --- |\n| _code_ | The error code is not used at the moment and can be ignored. |\n| **int** |  |\n\n| attribute / type | description |\n| --- | --- |\n| _message_ | The error message contains the error which occured. The message contains information about the error, if a error message is unexpected and cannot logically being solved, you could contact support with the error information you get. |\n| **string** |  |\n\n### Pagination\n\nThe system uses limit and offset to run through all \"pages\" of lised data. The limit is the amount of records which will be returned. The offset is the page number.\n\nFor example: If the total number of retreivable items is 25 and you set a limit of 10 and an offset of 1 the first 10 records are returned. If you have a limit of 10 and an offset of 2 you wil get the records 11 untill and including record 20. If you set the limit to 10 and the offset to 3 you will retrieve the last 5 records.\n\nThe total number off retreivable records can be requested by the count parameter.\n\nBased on the records you can define how many \"pages\" you can get by increasing the offset.\n\n## Date and Times\n\nDats and times are stored in the database in UTC time format. If you communicate directly to the database the database will respond in UTC time and not convert dates and times to you timezone. In the userinterface the dates and times are converted to the local time zone depending on the setting in the administration settings.  \n  \nIf you get data from the api it is required to convert in the your own timezone. Same thing on filters, if you want to filter data you should convert the filter from your current time to utc date and time\n\n### Examples\n\nWe have prepared examples for all calls, sometimes there are multiple examples available per call. We also provide examples which are going wrong and this shows the response in case of an error.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"9467805","team":578512,"collectionId":"aa0fcb5d-7689-4848-a618-e998af26fac7","publishedId":"VUjQkj1d","public":true,"publicUrl":"https://documenter-api.postman.tech/view/9467805/VUjQkj1d","privateUrl":"https://go.postman.co/documentation/9467805-aa0fcb5d-7689-4848-a618-e998af26fac7","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.6","publishDate":"2022-08-10T17:36:11.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Camping.care V21 Production","id":"9dc2fda3-ef14-46ba-8f15-5cdeb0fd66eb","owner":"9467805","values":[{"key":"api_endpoint","value":"https://api.camping.care/v21","enabled":true},{"key":"api_endpoint_v1","value":"https://api.camping.care/v1","enabled":true,"type":"default"},{"key":"api_key","value":"","enabled":true},{"key":"admin_id","value":"1234","enabled":true},{"key":"draft_id","value":"xxxxaabbccxxxx","enabled":true},{"key":"public_key","value":"1234","enabled":true},{"key":"ota_id","value":"1234","enabled":true},{"key":"administration_meta_key","value":"currency","enabled":true},{"key":"administration_meta_value","value":"EUR","enabled":true},{"key":"reservation_id","value":"1940","enabled":true},{"key":"voucher_id","value":"2","enabled":true},{"key":"contact_id","value":"340","enabled":true},{"key":"invoice_id","value":"123","enabled":true},{"key":"user_id","value":"43554","enabled":true},{"key":"payment_id","value":"1234","enabled":true},{"key":"accommodation_id","value":"7343","enabled":true},{"key":"age_table_id","value":"1234","enabled":true},{"key":"custom_field_id","value":"1234","enabled":true},{"key":"option_id","value":"1234","enabled":true},{"key":"rights_id","value":"1234","enabled":true},{"key":"api_key_id","value":"1234","enabled":true},{"key":"vat_table_id","value":"1234","enabled":true},{"key":"installed_app_id","value":"1234","enabled":true},{"key":"app_id","value":"1234","enabled":true},{"key":"widget_id","value":"1234","enabled":true},{"key":"webhook_id","value":"1234","enabled":true},{"key":"price_id","value":"1234","enabled":true},{"key":"discount_id","value":"1234","enabled":true},{"key":"guest_id","value":"1234","enabled":true},{"key":"tax_id","value":"1234","enabled":true},{"key":"place_id","value":"1234","enabled":true},{"key":"invoice_row_id","value":"1234","enabled":true},{"key":"version_id","value":"1234","enabled":true},{"key":"energy_id","value":"1234","enabled":true},{"key":"accommodation_hash","value":"1234","enabled":true},{"key":"rate_id","value":"1234","enabled":true},{"key":"admin_slug","value":"test","enabled":true},{"key":"product_id","value":"1","enabled":true,"type":"default"},{"key":"tag_id","value":"1","enabled":true,"type":"default"},{"key":"taglookup_id","value":"1","enabled":true,"type":"default"},{"key":"review_id","value":"1","enabled":true,"type":"default"},{"key":"article_id","value":"1","enabled":true,"type":"default"},{"key":"notification_id","value":"1214","enabled":true,"type":"default"},{"key":"reservation_field_id","value":"1234","enabled":true,"type":"default"},{"key":"contact_field_id","value":"1234","enabled":true,"type":"default"},{"key":"cron_key","value":"secret","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/f9e760bb5005ce18e79c475b2ca7946d91a3c52318b80d50dd173c13ece82a04","favicon":"https://res.cloudinary.com/postman/image/upload/v1655968679/team/j4p3chyt3efcrtryzgac.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Camping.care V21 Production","value":"9467805-9dc2fda3-ef14-46ba-8f15-5cdeb0fd66eb"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/VUjQkj1d"}