API and its Documentation
hartville hemp
Some additional info and updates to the api and api docs would be great.
changing "organisationId" to "orgid" would avoid the spelling issue as well as capitalization mistakes.
Use Lowercase Letters:
Whenever possible, use lowercase letters in your API URLs. This is mainly because the RFC 3986 Specification For URI Standards denotes that URIs are case-sensitive (except for the scheme and host components of the URL). Lowercase letters for URIs are in widespread use, and also help avoid confusion about inconsistent capitalization. If you add capital letters, you should be aware that this will cause confusion and result in user error more often than not.
hartville hemp
https://api-docs.edenic.io/v1/device-attributes/#response-1
description is of a "200 OK" but example code is of "400 Bad Request"
having examples of both would be helpful
Bobby Barnes (Edenic Admin)
hartville hemp: Changing 'organisationId' to 'orgid' could be a good idea to help with spelling issues, although, this spelling is only used in the response of getting devices. It will remain the same value per API key and is required to make the device request (so it should not need to be gathered programatically from this response).
For the capitalization issue in the URLs, we do not actually use any capital letters in any of the URLs in this API. The values inside the braces e.g. '{deviceId}' are placeholders which you will have to replace with the actual IDs (see examples below), let us know if need help finding the correct IDs. URLs with example IDs:
https://api.edenic.io/api/v1/device/12345678-1234-1234-1234-123456789012
https://api.edenic.io/api/v1/telemetry/12345678-1234-1234-1234-123456789012
https://api.edenic.io/api/v1/device-attribute/12345678-1234-1234-1234-123456789012
We have updated the docs for this response: https://api-docs.edenic.io/v1/device-attributes/#response-1, thanks for outlining the confusion. For a '200 - Success', there is no body in the response, so no example to show.
hartville hemp
Bobby Barnes (Edenic Admin): thank you for the updates