Returns all items for a specific estimate subcategory
https://api.constructiononline.com/EstimateItems?subcatID={subcatID}
This endpoint allows users to extract all items within a single estimate subcategory from an estimate in their ConstructionOnline company account. Users must know the unique ID assigned to the specific estimate subcategory to call this endpoint.
Requests
REQUIRED PARAMETERS
subcatID: integer
- Unique identifier for the estimate item.
Sample URL request:
- https://api.constructiononline.com/api/EstimateItems?subcatID=4393212
Example requests in cURL, C#, Python, and JavaScript can be found below:
cURL
# replace {email} with the email address for your ConstructionOnline account
# {password} with your ConstructionOnline password
# {apikey} with your provided API key
# {subcatID} with the estimate subcategory's ID
curl https://api.constructiononline.com/api/EstimateItems?subcatID={subcatID} -u {email}:{password} -H 'APIKey:{apikey}'
C#
/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key
{id} with the estimate's ID
{subcatID} with the estimate subcategory's ID */
public string GetData(string endpoint) {
string username = "{username}";
string password = "{password}";
string apikey = "{apikey}";
HttpResponseMessage response = null;
HttpClientHandler handler = new HttpClientHandler() { AutomaticDecompression = System.Net.DecompressionMethods.GZip };
using (HttpClient client = new HttpClient(handler)) {
client.Timeout = new TimeSpan(0, 0, 30);
client.BaseAddress = new Uri("http://api.constructiononline.com");
client.DefaultRequestHeaders.Accept.Clear();
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic",
System.Convert.ToBase64String(System.Text.Encoding.GetEncoding("ISO-8859-1").GetBytes(username + ":" + password)));
client.DefaultRequestHeaders.Add("APIKey", apikey);
client.DefaultRequestHeaders.Add("Accept-Encoding", "gzip");
response = client.GetAsync(endpoint).Result;
}
return response?.Content.ReadAsStringAsync().Result;
}
MessageBox.Show(GetData("api/EstimateItems?subcatID={subcatID}"));
Python
#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
#{id} with the estimate's ID
#{subcatID} with the estimate subcategory's ID
import base64, requests, json
apikey = "{apikey}"
username = "{username}"
password = "{password}"
def makeRequest(endpoint):
url = "https://api.constructiononline.com/" + endpoint
userPass = username + ":" + password
headers = {
"APIKey": apikey,
"Accept-Encoding": "gzip, deflate, br",
"Authorization": "Basic " + base64.b64encode(userPass.encode()).decode(),
}
response = requests.get(url, headers=headers)
return json.dumps(json.loads(response.text), indent=2)
#Main Program
print(makeRequest("api/EstimateItems?subcatID={subcatID}"))
JavaScript
/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key
{id} with the estimate's ID
{subcatID} with the estimate subcategory's ID */
username = '{username}';
password = '{password}';
apikey = '{apikey}';
function makeRequest(endpoint) {
auth = btoa('${username}:${password}');
var myHeaders = new Headers();
myHeaders.append("APIKey", apikey);
myHeaders.append("Accept-Encoding", "gzip, deflate, br");
myHeaders.append("Authorization", "Basic ${auth}");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.constructiononline.com/" + endpoint, requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
return response;
};makeRequest("api/EstimateItems?subcatID={subcatID}");
Responses
200: Success
A successful request will return a 200 response with the requested estimate items in the body, as seen below. Definitions for all returned properties can be found here.
{
"ID": 47440788,
"ESTIMATE_ID": 367610,
"CATEGORY_ID": 4393211,
"SUBCATEGORY_ID": 22069965,
"ROW_NUMBER": 3,
"NAME": "Site Work",
"DESCRIPTION": "",
"CLASSIFICATION": 5,
"STATUS": 0,
"COST_ESTIMATE": 5000.0,
"NOTES_TEAMLINK": "",
"NOTES_CLIENTLINK": "",
"NOTES_GENERAL": "Specifications require a 10' uncleared buffer area.",
"LINE_ITEM_MARKUP": "1",
"RATE": 500.0,
"RATE_QTY": 10.0,
"LINE_ITEM_MARKUP_TYPE": 1,
"ADJUSTMENT": 0.0,
"FIVE_COLUMN_EQUIPMENT": null,
"FIVE_COLUMN_LABOR": null,
"FIVE_COLUMN_MATERIAL": null,
"FIVE_COLUMN_OTHER": null,
"FIVE_COLUMN_SUB": null,
"TRAFFIC_COLOR": 1,
"COST_CODE": "",
"COST_CODE_ID": 75,
"DOLLAR_MARKUP": 0.0,
"COMMITTED_COSTS": 0.0,
"INVOICED_AMOUNTS": 1000.0,
"ACTUAL": 0.0,
"QB_COMMITTED": null,
"QB_INVOICED": null,
"QB_ACTUAL": 0.0,
"SALES_TAX": 0.0,
"UNIT": "0",
"UNIT_NAME": null,
"ASSIGNED": 123456
}
404: Error
The server was not able to locate the resource specified in the request. The estimate subcategory ID may have been entered incorrectly or an estimate subcategory with the entered ID does not exist.
429: Error
The user has surpassed the request rate limit for the hour, day, week, or month.
500: Error
There was an internal server error and the server was unable to complete the request.
Last updated: Feb 12, 2024