Estimate
Accubid Anywhere Estimate API
Estimate
The Anywhere Estimate API is used to retrieve the list of Anywhere Estimates that the user has access to, retrieve details of individual estimates, and retrieve the Extension details of an estimate.
The Extension return requires a SignalR implementation.
Pre-requisites
In order to use the API the user:
-
Must be permissioned in the Accubid Anywhere Manager for “API Data Access” (“Full” permission).
-
Must be successfully authenticated via Trimble ID.
-
Retrieve a database token from the Anywhere Database API.
-
Be able to understand and process SignalR notifications for the Extension detail return.
Use Cases
Retrieve Estimate List
This API allows you to get a list of estimates that the current user has access to within a specific project.
Retrieve Estimate Details
This API allows you to get details of a specific estimate that the user has access to.
Retrieve Estimate Extension Data
This API allows you to get the Extension data of a specific estimate that the user has access to.
Retrieve Estimate Extension Data for a specific Bid Summary
This API allows you to get the Extension data of a specific estimate that the user has access to filtered to a specific Bid Summary
Concepts
- Database - The user requires a database token in order to use the estimate API
- Project - The user requires a project ID in order to retrieve a list of estimates (for that project)
Dependencies
- Anywhere Database API - In order to use the Estimate API you will require database tokens from the Anywhere Database API.
- Anywhere Project API - In order to use the Estimate API you will require Project IDs from the Anywhere Project API.
Getting Started
- Follow the below instructions regarding authorization
- Follow the instructions regarding authenticating with Trimble Identity.
- Call the database list API to return a list of database names and tokens. Note - database tokens do not change, so they can be saved for future use.
- Call the project list API to return a list of project names and IDs. Note - Project IDs do not change, so they can be saved for future use.
- Review the SignalR code sample mentioned in “Code Samples” below, in order to understand how to implement this for your own needs, if Extension data is required
Code Samples
Example source code is available for interacting with SignalR. This can be found in GitHib here: https://github.com/Anywheregit/api-tools
Example Error message table
Please see below table containing the list of currently used error codes
Code | Description |
---|---|
200 | The request was successful |
400 | Parameter(s) are invalid |
401 | Request could not be authorized |
403 | Request was explicitly forbidden, user does not have access to database |
404 | A required reference was not found |
409 | Conflict. Database is locked please try again later |
Limitations
Extension data is returned in imperial measurements regardless of whether the estimate is set to imperial or metric. This represents how the data is stored in the database and any conversion to metric, if needed, must be performed by the consuming application