{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"33d1ae04-14a6-4d32-9dfc-800219d86e72","name":"Urchin API","description":"External api for ocean platform\n\n# Authentication\n\nAPI uses basic authentication.  \nUse basic authentication. Use auth at collection level. Requests will inherit authentication settings from collection, so there is no need to setup authentication on every request.\n\nTo get credentials, go to ocean backoffice to access management ([https://yourdomain/#/settings/operators](https://yourdomain/#/settings/operators)). There you can create new api access. Once you have new api access created you will be able to get credentials for authorization (username as username and api key as password)\n\n# Setup your environment variables\n\nURL => [http://yourdomain/urchinwebapi](http://yourdomain/urchinwebapi)\n\nusername => APIACCESS-xyz\n\npassword =>password\n\n# API traffic limitation\n\nspecifies how many request can a user do in a minute before being temporary blocked.  \nx2 number (14) of requests in a minute will result in permanent ban  \nOccasional: 7\n\nspecifies how many request can a user do in a minute before being temporary blocked.  \nx2 number (20) of requests in a minute will result in permanent ban  \nSemiOnline: 10\n\nspecifies how many request can a user do in a minute before being temporary blocked.  \nx2 number (40) of requests in a minute will result in permanent ban  \nOnline: 20\n\nspecifies how many request can a user do in a minute before being temporary blocked.  \nx2 number (320) of requests in a minute will result in permanent ban  \nMass: 160\n\nspecifies how many request can a user do in an hour before being temporary blocked.  \nx2 number (2) of requests in an hour will result in permanent ban  \nRarelyHour: 1\n\nspecifies how many request can a user do in an hour before being temporary blocked.  \nx2 number (140) of requests in an hour will result in permanent ban  \nOccasionalHour: 70\n\nspecifies how many request can a user do in an hour before being temporary blocked.  \nx2 number (200) of requests in an hour will result in permanent ban  \nSemiOnlineHour: 100\n\nspecifies how many request can a user do in an hour before being temporary blocked.  \nx2 number (400) of requests in an hour will result in permanent ban  \nOnlineHour: 200\n\nspecifies how many request can a user do in an hour before being temporary blocked.  \nx2 number (2000) of requests in an hour will result in permanent ban  \nMassHour: 1000\n\n```\nlist of API limitations \n*APIs that are not found in this list have an Mass(MassHour) limitation policy\nmeasurements { PerDay = 1 },\ninvoice { PerMinute = Mass, PerHour = MassHour },\ninvoiceExternal { PerMinute = Mass, PerHour = MassHour },\ninvoiceDocument { PerMinute = Mass, PerHour = MassHour },\nupdatePaymentStatus { PerMinute = Mass, PerHour = MassHour },\nissueMerchantCoupons { PerMinute = Mass, PerHour = MassHour },\nremoteStartTransaction { PerMinute = Mass, PerHour = MassHour },\nremoteStopTransaction { PerMinute = Mass, PerHour = MassHour },\nremoteStartTransaction_noAuth { PerMinute = Mass, PerHour = MassHour },\nremoteStopTransaction_noAuth { PerMinute = Mass, PerHour = MassHour },\nupdateParkingStatus { PerMinute = Mass, PerHour = MassHour },\n#\nchargingSessionsBasic { PerMinute = Online, PerHour = OnlineHour },\ninvoicesBasic { PerMinute = Online, PerHour = OnlineHour },\nuserVehicle { PerMinute = Online, PerHour = OnlineHour },\nuserPayer { PerMinute = Online, PerHour = OnlineHour },\nUserPayerExternal { PerMinute = Online, PerHour = OnlineHour },\nuserContract { PerMinute = Online, PerHour = OnlineHour },\nuser { PerMinute = Online, PerHour = OnlineHour },\nuserExternal { PerMinute = Online, PerHour = OnlineHour },\nuserIdentification { PerMinute = Online, PerHour = OnlineHour },\nuserIdentificationExternal { PerMinute = Online, PerHour = OnlineHour },\nblockUser { PerMinute = Online, PerHour = OnlineHour },\nunblockUser { PerMinute = Online, PerHour = OnlineHour },\nblockUserPayer { PerMinute = Online, PerHour = OnlineHour },\nunblockUserPayer { PerMinute = Online, PerHour = OnlineHour },\nunblockPayment { PerMinute = Online, PerHour = OnlineHour },\nunblockPaymentExternal { PerMinute = Online, PerHour = OnlineHour },\nblockPayment { PerMinute = Online, PerHour = OnlineHour },\nblockUserPayerExternal { PerMinute = Online, PerHour = OnlineHour },\nbusinessPartnerContract { PerMinute = Online, PerHour = OnlineHour },\nbusinessPartnerContractExternal { PerMinute = Online, PerHour = OnlineHour },\nbusinessPartners { PerMinute = Online, PerHour = OnlineHour },\nchargePoint { PerMinute = Online, PerHour = OnlineHour },\ncurrentSessionOnlineData { PerMinute = Online, PerHour = OnlineHour },\nunblockUserIdentification { PerMinute = Online, PerHour = OnlineHour },\nunblockUserIdentificationExternal { PerMinute = Online, PerHour = OnlineHour },\nblockUserIdentification { PerMinute = Online, PerHour = OnlineHour },\nmoveFromIdentificationStock { PerMinute = Online, PerHour = OnlineHour },\nprepaymentCardTopUpMoney { PerMinute = Online, PerHour = OnlineHour },\nconnectorsStatusStatisticsOnlineData { PerMinute = Online, PerHour = OnlineHour },\nparkingStatuses { PerMinute = Online, PerHour = OnlineHour },\ntemporaryLimitLoadAreaPower { PerMinute = Online, PerHour = OnlineHour },\n#\nbusinessPartnerContracts { PerMinute = SemiOnline, PerHour = SemiOnlineHour },\nbusinessPartner { PerMinute = SemiOnline, PerHour = SemiOnlineHour },\nbusinessPartnerExternal { PerMinute = SemiOnline, PerHour = SemiOnlineHour },\nconnectors { PerMinute = SemiOnline, PerHour = SemiOnlineHour },\nroamingChargingSessions { PerMinute = SemiOnline, PerHour = SemiOnlineHour },\nchargingSessions { PerMinute = SemiOnline, PerHour = SemiOnlineHour },\nuserIdentifications { PerMinute = SemiOnline, PerHour = SemiOnlineHour },\nidentifications { PerMinute = SemiOnline, PerHour = SemiOnlineHour },\ninvoices { PerMinute = SemiOnline, PerHour = SemiOnlineHour },\ndownloadInvoiceDocument { PerMinute = SemiOnline, PerHour = SemiOnlineHour },\nlocation { PerMinute = SemiOnline, PerHour = SemiOnlineHour },\nlocations { PerMinute = SemiOnline, PerHour = SemiOnlineHour },\nlocationPhotos { PerMinute = SemiOnline, PerHour = SemiOnlineHour },\nusers { PerMinute = SemiOnline, PerHour = SemiOnlineHour },\nuserContracts { PerMinute = SemiOnline, PerHour = SemiOnlineHour },\nuserPayers { PerMinute = SemiOnline, PerHour = SemiOnlineHour },\ninstanceRoamingTransactions { PerMinute = SemiOnline, PerHour = SemiOnlineHour },\nuserAccountMoneyTransactions { PerMinute = SemiOnline, PerHour = SemiOnlineHour },\n#\nchargePointModels { PerMinute = Occasional, PerHour = OccasionalHour },\ncommProtocolTypes { PerMinute = Occasional, PerHour = OccasionalHour },\nuserIdentificationTypes { PerMinute = Occasional, PerHour = OccasionalHour },\ncardTypes { PerMinute = Occasional, PerHour = OccasionalHour },\nlocationTypes { PerMinute = Occasional, PerHour = OccasionalHour },\ntariffChargePointPrices { PerMinute = Occasional, PerHour = OccasionalHour },\nuserCommunicationChannels { PerMinute = Occasional, PerHour = OccasionalHour },\nuserContractTypes { PerMinute = Occasional, PerHour = OccasionalHour },\nsupportedCurrencies { PerMinute = Occasional, PerHour = OccasionalHour },\nvehicleBrandModelVersions { PerMinute = Occasional, PerHour = OccasionalHour },\ninstanceRoamingActors { PerMinute = Occasional, PerHour = OccasionalHour },\ngeneralConsumptionReport { PerMinute = Occasional, PerHour = OccasionalHour },\ntaxLevelTypes { PerMinute = Occasional, PerHour = OccasionalHour },\naccessInstructions { PerMinute = Occasional, PerHour = OccasionalHour },\ncountries { PerMinute = Occasional, PerHour = OccasionalHour },\ncouponTypes { PerMinute = Occasional, PerHour = OccasionalHour },\nconnectorStatuses { PerMinute = Occasional, PerHour = OccasionalHour },\ntariff { PerMinute = Occasional, PerHour = OccasionalHour },\ntariffs { PerMinute = Occasional, PerHour = OccasionalHour },\nreset { PerMinute = Occasional, PerHour = OccasionalHour },\nunlockConnector { PerMinute = Occasional, PerHour = OccasionalHour },\nchangeAvailability { PerMinute = Occasional, PerHour = OccasionalHour }\nupdateChargePointPrices { PerHour = RarelyHour }\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"230031","team":6159241,"collectionId":"33d1ae04-14a6-4d32-9dfc-800219d86e72","publishedId":"SzYW4LYS","public":true,"publicUrl":"https://documenter-api.postman.tech/view/230031/SzYW4LYS","privateUrl":"https://go.postman.co/documentation/230031-33d1ae04-14a6-4d32-9dfc-800219d86e72","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-06-15T13:26:58.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"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/01b9dd618940bce43ea85490bd8a169460a5cb99581f71f376f61b6a0bc99f5f","favicon":""},"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"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/SzYW4LYS"}