API Documentation

Buildings

GET Buildings

URL:

GET /3.0/pub/buildings?apiKey={apiKey}

Response:

Building

GET Building

URL:

GET /3.0/pub/building/{id}?apiKey={apiKey}

Response:

PUT Building

URL:

PUT /3.0/pub/building/{id}?apiKey={apiKey}

Example:

Response:

POST Building

URL:

POST /3.0/pub/building?apiKey={apiKey}

Example:

Response:

Projects

GET Projects

URL:

GET /3.0/pub/jobs?apiKey={apiKey}

Response:

Project

GET project via job_id

URL:

GET /3.0/pub/job/{id}?apiKey={apiKey}

Response:

PUT Project

URL:

PUT /3.0/pub/job/{id}?apiKey={apiKey}

Example:

Response:

POST Project

URL:

POST /3.0/pub/job?apiKey={apiKey}

Example:

Response:

Bid Room

GET Bid Room

URL:

GET /3.0/pub/bidroom/{id}?apiKey={apiKey}

Response:

 

Paremeter Description
bidroom_id Unique ID of the bid room in Honest Buildings will be returned
bidroom_name Name of bid room in Honest Buildings will be returned
bidform_id Unique ID of the bid form in Honest Buildings will be returned
contract_id If a contract exists, the contract ID will be returned; if no contract exits, “null” will be returned
bidders Vendor company name will be returned

Contract Room

GET Contract

URL:

GET /3.0/pub/contract/{id}?apiKey={apiKey}

Response:

 

Paremeter Description
cost_schedule_id 1:1 relationship to the Contract ID; parent to the Cost Detail ID
cost_details A list of cost detail associated to the given contract

 

Cost Detail Description
id Unique ID of the cost detail in Honest Buildings will be returned; child to the Cost Schedule ID
cost_schdule_id 1:1 relationship to the Contract ID; parent to the Cost Detail ID
gl_code_id Unique ID of GL code in HB
lp-hero.jpg