Get all Selection Choices

Returns a record of all selection choices within your ConstructionOnline company account

https://api.constructiononline.com/SelectionChoices

This endpoint allows users to extract a record of all selection choices from their ConstructionOnline company account. 

• Requests
• Responses

Requests

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

curl https://api.constructiononline.com/api/SelectionChoices -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 */

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/SelectionChoices"));

Python

#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key

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/SelectionChoices"))

JavaScript

/* replace {username} with the email address for your ConstructionOnline account
           {password} with your ConstructionOnline password
           {apikey} with your provided API key */

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/SelectionChoices");

Responses

 200: Success

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

 { 
            "ID": 1792038,
            "NAME": "LG Electronics 6.9 cu. ft. Smart Double Oven Slide In Gas Range with ProBake Convection and Wi-Fi in Stainless Steel-LTG4715ST - The Home Depot",
            "PRJ_ID": 1321333,
            "PROJECTNAME": "3931 E Lake Blvd",
            "CATEGORY_ID": 1148456,
            "CATEGORYNAME": "Range",
            "DETAILS": "With 6.9 cu. ft. of capacity, you can do it all at once",
            "DATE_APPROVED": "2023-08-17T17:55:40.637",
            "APPROVED_BY": 987777,
            "APPROVER": "",
            "PRICE": 2098.0,
            "QTY": 1.0,
            "TOTAL_COST": 2098.0,
            "URL": "https://www.homedepot.com/p/LG-Electronics-6-9-cu-ft-Smart-Double-Oven-Slide-In-Gas-Range-with-ProBake-Convection-and-Wi-Fi-in-Stainless-Steel-LTG4715ST/304994119",
            "IMAGE_ID": 9708942,
            "VENDOR_TEXT": "homedepot.com",
            "STATUS": 0,
            "VENDOR_ID": 985779,
            "VENDOR": "",
            "DATE_CREATED": "2022-09-20T14:23:22.637",
            "CREATED_BY": 1004444,
            "CREATOR": "",
            "SORT_NUM": 1,
            "TYPE": 0,
            "IS_DEFAULT": false,
            "AMOUNT_PAID": 0.0,
            "TEMPLATE_ID": 0,
            "ACTUAL": 0.0,
            "MARKUP": 502.0,
            "SALES_TAX": 0.0,
            "QB_INVOICED": 0.0,
            "QB_ACTUAL": 0.0,
            "UNIT": 1,
            "UNIT_NAME": "Each"

        }

 404: Error

The server was not able to locate the resource specified in the request. 

 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