Reference
Date Format
Section titled “Date Format”All dates in the API use UTC and are strings in the ISO 8601 “combined date and time representation” format.
Example 2015-05-15T15:50:38Z
Error Codes
Section titled “Error Codes”HTTP status codes indicate whether an operation is successful or not.
A response code of 2xx indicates that the operation was successful. Other error codes indicate either a client error (4xx) or a server error (5xx).
The error table lists the errors returned by the service. Some errors are resolved if you retry the same request. As a general rule, the timeout errors, network errors, throttling errors, and 5xx errors may be retried. The 401 error code usually indicates expired credentials and should be retried after refreshing the access token. The error table indicates which errors are likely to be resolved with successive retries. If the value of the Retry column is
- Yes - Submit the same request again.
- Yes if idempotent - Submit the same request again, but only if the given method has been implemented with idempotence.
- No - Fix the problem on the client-side before submitting a new request.
For more information about retrying requests, see Retrying and Exponential Backoff.
| HTTP Status Code | Error code | Retry |
|---|---|---|
| 400 | Bad Request Exception | No |
| 401 | Unauthorized Exception | No, could be retried after acquiring a new token |
| 403 | Access Denied Exception | No |
| 404 | Not Found Exception | No |
| 409 | Conflict Exception | No |
| 422 | Unprocessable Entity Exception | No |
| 429 | Too Many Requests Exception | Yes |
| 500 | Internal Service Failure Exception | Yes |
| 502 | Bad Gateway Exception | Yes if idempotent |
| 503 | Service Unavailable Exception | Yes |
| 504 | Endpoint Request Timed-out Exception | Yes if idempotent |
Deprecation Policy
Section titled “Deprecation Policy”API Versioning
Section titled “API Versioning”The Trimble Connect APIs are versioned.
Trimble reserves the right to add new parameters, properties, or objects to the API without prior notice. These updates are non-breaking, and existing integrations will continue to work without modifications.
Major or breaking changes, or new versions of the APIs may be released. These type of changes are announced ahead of time on the Integrator Community.
Multiple API versions can be supported in parallel to allow smooth transition for integrators.