Returns all subcategories for a specific selection category
https://api.constructiononline.com/SelectionSubCategories?categoryID={categoryID}
This endpoint allows users to extract all subcategories within a single selection category from their ConstructionOnline company account. Users must know the unique ID assigned to the specific selection category to call this endpoint. This endpoint does not return individual selection choices belonging to each subcategory. Please note that the ConstructionOnline API refers to selections (middle tier level of organization for client selections) as selection subcategories, as mentioned below.
NOTE:
In ConstructionOnline, client selections are organized into three different tiers: Category > Selection > Choice
Category is the broadest level of organization, Selection is the secondary level of organization, and Choice is the most granular level of organization. Users approve selections at the Choice level.
However, the ConstructionOnline API refers to the different levels of client selections using the following terms: Category > Subcategory > Choice
👉 In other words, a selection is referred to as a selection subcategory object in the API.
Requests
REQUIRED PARAMETERS
categoryID: integer
- Unique identifier for the selection category.
Sample URL request:
- https://api.constructiononline.com/api/SelectionSubCategories?categoryID=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
# {categoryID} with the selection category's ID
curl https://api.constructiononline.com/api/SelectionSubCategories?categoryID={categoryID} -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
{categoryID} with the selection category'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/SelectionSubCategories?categoryID={categoryID}"));
Python
#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
#{categoryID} with the selection category'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/SelectionSubCategories?categoryID={categoryID}"))
JavaScript
/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key
{categoryID} with the selection category'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/SelectionSubCategories?categoryID={categoryID}");
Responses
200: Success
A successful request will return a 200 response with the requested selection subcategories in the body, as seen below. Definitions for all returned properties can be found here.
{
"ID": 1148457,
"NAME": "Refrigerator",
"PRJ_ID": 1321333,
"PROJECTNAME": "3931 E Lake Blvd",
"CAT_TYPE_ID": 616649,
"CATEGORYNAME": "Appliances",
"LOCATION": "Kitchen",
"DUE_DATE": "2024-02-01T00:00:00",
"ALLOWANCE": 15000.0,
"COST": 0.0,
"NET": 0.0,
"DETAILS": "",
"CLOSED": false,
"SORT_NUM": 2,
"TYPE": 0,
"TEMPLATE_ID": 0,
"MILESTONE": null,
"SUBJECT": null,
"CHOICE_NAME": "LG Electronics 29.7 cu. ft. French Door Refrigerator with Door-in-Door and CustomChill Drawer in Stainless Steel-LMXS30776S - The Home Depot",
"CHOICE_ID": 1792040,
"APPROVED": true,
"DATE_APPROVED": "2024-03-12T15:14:46.57",
"APPROVED_BY": 912344,
"CHOICE_PRICE": 3999.0,
"CHOICE_QTY": 3.0,
"CHOICE_TOTAL_COST": 11997.0,
"CHOICE_MARKUP": 501.0,
"CHOICE_SALES_TAX": 0.0,
"CHOICE_ACTUAL": 0.0,
"CHOICE_INVOICED": 0.0,
"CHOICE_QB_ACTUAL": 0.0,
"CHOICE_QB_INVOICED": 0.0,
"APPROVED_PRICE": 12498.0
}
404: Error
The server was not able to locate the resource specified in the request. The selection category ID may have been entered incorrectly or a selection category 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: Mar 13, 2024