Equipment (BETA)
This API facilitates getting equipment associated with devices for Earthworks, Roadworks, Groundworks, Marineworks, or Siteworks by Trimble account. Get basic information about the equipment and the devices used by that equipment. This information includes geo coordinates for the last reported position of the equipment.
Key Features
Section titled “Key Features”- Get equipment and devices assigned to an account.
- Basic information about the equipment and device details.
- Provides geocoordinates for the last reported position of the attached devices.
Use Cases
Section titled “Use Cases”Use for scheduling integrations and reporting dashboards. This API can help allocate and track equipment and company assets and their reported geographical positions.
Associated products
Section titled “Associated products”This API provides data from Earthworks, Roadworks, Groundworks, and Siteworks devices.
News and Updates
Section titled “News and Updates”Version History
Section titled “Version History”This is a BETA version API. Feedback and suggestions are welcomed as we test and prepare for Version 1 release. To qualify for access to this BETA, registration with the BETA program is first required.
How-To Guides
Section titled “How-To Guides”Access
Section titled “Access”During BETA phase, access to this API is by invitation. You can request access to the BETA program here.
Prerequisites to Use
Section titled “Prerequisites to Use”This API will provide data generated from machines that communicate through Worksmanager. It is required that the account using this API has at least one device reporting through WorksManager in order to get data.
Authentication details will be provided to BETA participants as part of the onboarding process to use this API.
Explanation and Concepts
Section titled “Explanation and Concepts”This API is self-navigating, similar to the way you are able to navigate a website by selecting the next link options available to you, to get the available information at that link. With this API design, the next possible steps for getting additional data are always included in the data you receive.
For example, all resources follow the same basic structure. Every response includes a links section, in addition to an array of data properties. The links section informs you where you currently are using the ‘self’ proper and also where you can go next to get additional data.
This API structure is also called HATEOAS (Hypermedia as the Engine of Application State), or fully RESTful. A primary benefit to API users is dynamic discovery and resilience to change.
In simple terms, HATEOAS works like a website for machines: the API response not only provides the data (like an order detail) but also includes hypermedia links (URLs) that tell the client what actions are possible next, based on the current state.
Reference
Section titled “Reference”Glossary
Section titled “Glossary”| Term | Definition |
|---|---|
| Identity | Get data about the user and the associated account making requests with the API. |
| Links | A JSON formatted list with a series of URIs where properties for a resource can be retrieved. |
| Self | The URI currently being viewed. |
| Position | Location in the world using latitude and longitude decimal coordinates reported by a reporting device attached to equipment. |
| Equipment | Machine or asset used for a particular purpose and connected with control and design devices. |
| Device | Trimble sensors and positioning instruments installed on the equipment. There can be multiple devices per a single equipment. |
| Position | Location in the world using latitude and longitude decimal coordinates reported by a reporting device attached to equipment. |
Terms of Use
Section titled “Terms of Use”An API Terms of Use Agreement must be executed prior to the use of this API. The terms will be provided as part of the API beta registration process.