Documentation\n
TMH API can only be accessed over an encrypted connection (HTTPS).\nTMH requires authentication to access the resources. In each request, header x-api-key should have a value provided by TMH.
\nThe error codes listed in the following table may be returned by an operation on any of the Fleet API services. Error codes not part of the list will not be returned.
Code | Reason | http errors description |
|---|---|---|
400 | Bad Request | A required HTTP header was not specified. |
400 | Bad Request | A required query parameter was not specified for this request. |
400 | Bad Request | An invalid value was specified for one of the query parameters in the request URI. |
400 | Bad Request | The url in the request could not be parsed. |
401 | Unauthorized | The request requires user authentication. |
403 | Forbidden | Access to the specified resource (Forbidden) has been forbidden. |
404 | Not Found | The requested resource does not exist. |
500 | Internal Server Error | The server encountered an internal error. |
502 | Bad Gateway | The server received an invalid response from an upstream server. |
503 | Service Unavailable | The server is currently unable to receive requests. Please retry your request. |
504 | Gateway Timeout | The server did not receive a timely response from an upstream server |
\nPurpose of this endpoint: set departure time and preconditioning settings of a vehicle.\n\n
It is not possible to update only one specific schedule. TMH is always replacing whole schedules object for specific ev.
\nExample:
\nYou added 2 schedules for monday and friday. After some time, you decide to change departure_time for monday schedule. TMH expects to receive all schedules again of this specific EV. If TMH will receive only monday schedule, all the other schedules will be deleted.
\nHow to delete schedules?
\nAn empty schedule object is required in order to remove all schedules of a specific EV.
\n\n{\n schedules:[]\n}\n\n\n\nAttention\nIt is only allowed to either provide target_soc_percentage OR energy_demand_next_route_wh. If both parameter are provided, request is rejected.
\n","urlObject":{"path":["api","v1","evs","{{vin}}","schedules"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3075fff2-a396-4df8-965a-6face93f1f28","name":"Set time and preconditioning","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","type":"text","value":"{{secretapikey}}"}],"body":{"mode":"raw","raw":"{\n \"schedules\": [\n {\n \"departure_time\": \"17:00:00\",\n \"energy_demand_next_route_wh\": 20000, \n \"weekdays\": [1], \n \"preconditioning\": { \n \t\"active\": \"true\",\n \t\"time_seconds\": 4500,\n \t\"energy_demand_wh\": 70000 \n }\n \n },\n {\n \"departure_time\": \"06:11:00\",\n \"target_soc_percentage\": 10,\n \"weekdays\": [3,4],\n \"preconditioning\": {\n \t\"active\": \"false\" \n },\n {\n \"departure_time\": \"08:00:00\",\n \"target_soc_percentage\": 10,\n \"weekdays\": [3,4],\n }\n }\n ]}"},"url":"{{url}}/api/v1/evs/{{vin}}/schedules"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"schedules\": [\n {\n \"departure_time\": \"17:00:00\",\n \"energy_demand_next_route_wh\": 20000, \n \"weekdays\": [1], \n \"preconditioning\": { \n \t\"active\": \"true\",\n \t\"time_seconds\": 4500,\n \t\"energy_demand_wh\": 70000 \n \t\"type\": 1\n }\n \n },\n {\n \"departure_time\": \"06:11:00\",\n \"target_soc_percentage\": 10,\n \"weekdays\": [3,4],\n \"preconditioning\": {\n \t\"active\": \"false\" \n },\n {\n \"departure_time\": \"08:00:00\",\n \"target_soc_percentage\": 10,\n \"weekdays\": [3,4],\n }\n }\n ]}"}],"_postman_id":"18b8c9cd-b884-49f7-b366-a76ba4cc6fe0"},{"name":"Update ev, set soc","id":"3c44560e-2184-4af6-b3b8-b80cae7b92b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-api-key","type":"text","value":"{{secretapikey}}"}],"body":{"mode":"raw","raw":"{\n \"soc_percentage\": 30,\n \"free_energy_capacity_wh\": 20000\n}"},"url":"{{url}}/api/v1/evs/{{vin}}","description":"Purpose of this endpoint: provide EV related details
\nFollowing parameters are allowed in this request:
\nAttention\nPlease provide either soc OR energy related parameter.\nIt is not allowed to provide soc AND energy_state, free_energy_capacity within the same request. If all are provided, request will be rejected.
\n","urlObject":{"path":["api","v1","evs","{{vin}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"b3d9a59d-ae73-4186-baed-407b20e54ae3","name":"Update ev, set soc","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"energy_state_wh\": 50000,\n \"free_energy_capacity_wh\": 20000 \n}"},"url":"{{url}}/api/v1/evs/{{vin}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"energy_state_wh\": 50000, \n \"free_energy_capacity_wh\": 20000 \n}"}],"_postman_id":"3c44560e-2184-4af6-b3b8-b80cae7b92b8"},{"name":"Ping","id":"ed54d94f-f6c7-4764-9f17-b8d2b4c00d5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/api/v1/ping","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{secretapikey}}"}]},"isInherited":true,"source":{"_postman_id":"ab64b044-6a76-47dc-972f-b1591b5fc3ae","id":"ab64b044-6a76-47dc-972f-b1591b5fc3ae","name":"TMH-API","type":"collection"}},"urlObject":{"path":["api","v1","ping"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ed54d94f-f6c7-4764-9f17-b8d2b4c00d5d"}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{secretapikey}}"}]}},"event":[{"listen":"prerequest","script":{"id":"d8ea221a-fe3b-4ea1-a017-d304e0ebbd1a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2126076e-1eb1-4b64-bafb-f57ee9d7d4b5","type":"text/javascript","exec":[""]}}]}