Get estimate subcategories for a project

Returns all estimate subcategories for the project that corresponds with the provided ID

get https://api.constructiononline.com/EstimateSubCategories?projectID={projectID}

This endpoint allows users to extract all estimate subcategories from a project's estimate within their ConstructionOnline company account. Users must know the unique ID assigned to the project to call this endpoint. Please note that this endpoint does not return any information on items that are within each estimate subcategory.

⭐ This endpoint returns estimate subcategories by project ID. To return estimate subcategories by estimate ID, use this endpoint.

Requests

REQUIRED PARAMETERS

projectID: integer

  • Unique identifier for the project.

Sample URL request:

  • https://api.constructiononline.com/api/EstimateSubCategories?projectID=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
# {projectID} with the project's ID


curl https://api.constructiononline.com/api/EstimateSubCategories?projectID={projectID} -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
          {projectID} with the project'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/EstimateSubCategories?projectID={projectID}"));

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
#{projectID} with the project'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/EstimateSubCategories?projectID={projectID}"))

JavaScript

/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key
          {projectID} with the project'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/EstimateSubCategories?projectID={projectID}");

Responses

green 200: Success

A successful request will return a 200 response with the requested estimate subcategories in the body, as seen below. Definitions for all returned properties can be found here

{
       "ID": 22069965,
        "ESTIMATE_ID": 367610,
        "CATEGORY_ID": 4393211,
        "ROW_NUMBER": 2,
        "NAME": "Design Services",
        "DESCRIPTION": "",
        "CLASSIFICATION": 6,
        "STATUS": 0,
        "COST_ESTIMATE": 5000.0,
        "NOTES_TEAMLINK": "",
        "NOTES_CLIENTLINK": "",
        "NOTES_GENERAL": "",
        "LINE_ITEM_MARKUP": "0",
        "RATE": 0.0,
        "RATE_QTY": 0.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": null,
        "COST_CODE": "",
        "COST_CODE_ID": 0,
        "DOLLAR_MARKUP": 0.0,
        "TOTAL_MARKUP": 0.0,
        "COMMITTED_COSTS": 0.0,
        "INVOICED_AMOUNTS": 0.0,
        "ACTUAL": 0.0,
        "QB_COMMITTED": 0.0,
        "QB_INVOICED": 0.0,
        "QB_ACTUAL": 0.0,
        "SALES_TAX": 0.0,
        "UNIT": "0",
        "UNIT_NAME": null,
        "ASSIGNED": null
     
},

{

(estimate categories continued...)
}

red 404: Error

The server was not able to locate the resource specified in the request. The project ID may have been entered incorrectly or a project with the entered ID does not exist.

red 429: Error

The user has surpassed the request rate limit for the hour, day, week, or month.

 red 500: Error

There was an internal server error and the server was unable to complete the request.

 

Last updated: Feb 12, 2024