Returns all categories for the estimate that corresponds with the provided ID
https://api.constructiononline.com/EstimateCategories?estID={estID}
This endpoint allows users to extract all estimate categories from an estimate within their ConstructionOnline company account. Users must know the unique ID assigned to the estimate to call this endpoint. Please note that this endpoint does not return any information on subcategories or items that are within each estimate category.
Requests
REQUIRED PARAMETERS
estID: integer
- Unique identifier for the estimate.
Sample URL request:
- https://api.constructiononline.com/api/EstimateCategories?estID=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
# {estID} with the estimate's ID
curl https://api.constructiononline.com/api/EstimateCategories?estID={estID} -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
{estID} with the estimate'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/EstimateCategories?estID={estID}"));
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
#{estID} with the estimate'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/EstimateCategories?estID={estID}"))
JavaScript
/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key
{estID} with the estimate'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/EstimateCategories?estID={estID}");
Responses
200: Success
A successful request will return a 200 response with the requested estimate categories in the body, as seen below. Definitions for all returned properties can be found here.
{
"ID": 4393212,
"ESTIMATE_ID": 367610,
"ROW_NUMBER": 19,
"NAME": "Foundation",
"DESCRIPTION": "",
"NOTES_TEAMLINK": "",
"NOTES_CLIENTLINK": "",
"NOTES_GENERAL": "",
"TRAFFIC_COLOR": 0,
"COST_CODE": "",
"COST_CODE_ID": 0,
"COST_ESTIMATE": 19078.100000000002
},
{
(estimate categories continued...)
}
404: Error
The server was not able to locate the resource specified in the request. The estimate ID may have been entered incorrectly or an estimate 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