Database

Accubid Anywhere Database API

Database

The Anywhere Database API is used to retrieve the list of Anywhere Databases that the user has access to.

The retrieved information can then be used as an input to subsequent API calls, such as the Anywhere Project 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).
  • Must be successfully authenticated via Trimble ID.

Use Cases

Retrieve Database List

This API allows you to get a list of databases that the current user has access to

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.

Authorization

In order to use the API the user must have “Full” permission for “API Data Access” setup in Accubid Anywhere Manager.

Example Error message table

Please see below table containing the list of currently used error codes

CodeDescription
200The request was successful
400Parameter(s) are invalid
401Request could not be authorized
403Request was explicitly forbidden, user does not have access to database
404A required reference was not found
409Conflict. Database is locked please try again later