Project
Accubid Anywhere - Project
Project
The Anywhere Project API is used to retrieve the list of Anywhere Projects that the user has access to and retrieve details of individual projects where required.
The retrieved information can then be used as an input to subsequent API calls, such as the Anywhere Estimate API.
Pre-requisites
In order to use the API the user must:
- Must be permissioned in the Accubid Anywhere Manager for ‘API Data Access’ (‘Full’ permission).
- Be successfully authenticated via Trimble ID.
- Retrieve a database token from the Anywhere Database API.
Use Cases
Retrieve Project List
This API allows you to get a list of projects that the current user has access to within a specific database.
Retrieve Project Details
This API allows you to get details of a specific project that the user has access to.
Concepts
- Database - The user requires a database token in order to retrieve a list of projects (for that database).
Dependencies
- Anywhere Database API - In order to use the Projects API you will require database tokens from the Anywhere Database 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.
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 |