ChangeOrder

Accubid Anywhere ChangeOrder API

ChangeOrder

The Anywhere ChangeOrder API is used to retrieve PCOs and Contracts details.

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.

Use Cases

Retrieve Contract List

This API allows you to get a list of contracts that the current user has access to within a specific project.

Retrieve PCO List

This API allows you to get a list of PCOs that the current user has access to within a specific Contract.

Retrieve Contract Quote Label List

This API allows you to get a list of contract quote labels that the current user has access to within a specific Contract.

Retrieve Contract Subcontract Label List

This API allows you to get a list of contract subcontract labels that the current user has access to within a specific Contract.

Retrieve PCO Details

This API allows you to get details of a specific PCO that the user has access to.

Retrieve Contract Status List

This API allows you to get a list of contract statuses that the current user has access to within a specific Contract.

Retrieve Contract Cost Distribution List

This API allows you to get a list of cost distributions that the current user has access to within a specific Contract.

Retrieve PCO Extension Data for a specific PCO

This API allows you to get the Extension data of a specific pco that the user has access to.

Concepts

  • Database - The user requires a database token in order to use the closeout 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 Changeorder API you will require database tokens from the Anywhere Database API.
  • Anywhere Project API - In order to use the Changeorder 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.
  • Call the contract list API to return a list of contract names and IDs. Call the PCO list API to return a list of PCO names and IDs Note - Contract and PCO 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

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
429TooManyRequests. User sent too many requests

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