Get Custom Values by Type

Returns all entries for a specific custom value type

https://api.constructiononline.com/api/CustomValues?type={type}

In ConstructionOnline, custom values are fields that can be customized for each company to best fit their specific needs. Custom values can be found throughout the many different features of ConstructionOnline and are denoted by a gear icon ⚙️ beside the field heading. There are 42 different types of custom values, such as Trade, Project Stage, Key Roles, and Project Type.

Each type of custom value can include multiple entries, or specific options for that field. For example, the custom value type "Trade" may contain entries such as HVAC, Mechanical, Electrical, and Plumbing. While some custom values are preloaded with default options, each custom value type can be completely customized by adding or removing specific entries.

• Requests
• Custom Values
• Responses

Requests

REQUIRED PARAMETERS

type: integer

• Integer representation of the specific Custom Value type. For example: the number 7 represents the Custom Value type "Project Stage". A full list of custom value types and their corresponding numbers can be found here. 

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
# {type} with the number that represents the specific custom value type

curl https://api.constructiononline.com/api/CustomValues?type={type} -u {email}:{password} -H 'APIKey:{apikey}'

C#

/* replace {username} with the email address for your ConstructionOnline account
           {password} with your ConstructionOnline password
           {apikey} with the API key you were provided with
           {type} with the number that represents the specific custom value type */

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/CustomValues?type={type}"));
   

Python

#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with the API key you were provided with
#{type} with the number that represents the specific custom value type 

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/CustomValues?type={type}"))

JavaScript

/* replace {username} with the email address for your ConstructionOnline account
           {password} with your ConstructionOnline password
           {apikey} with the API key you were provided with
           {type} with the number that represents the specific custom value type */

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/CustomValues?type={type}");

Custom Values

Each custom value type is represented by a specific number. Use the following table to look up the number that is assigned to a specific custom value type.

Responses

200: Success

A successful request will return a 200 response with a collection of the requested custom values in the body.

A response for the sample GET URL " https://api.constructiononline.com/api/CustomValues?type=2" can be seen below:

[
    {
        "ID": 250,
        "TYPE": 2,
        "TITLE": "General Requirements",
        "COMPANY_ID": 0,
        "REPLACE_ID": null,
        "IS_DEFAULT": true,
        "IMAGE_ID": null
    },
    {
        "ID": 251,
        "TYPE": 2,
        "TITLE": "Site Construction",
        "COMPANY_ID": 0,
        "REPLACE_ID": null,
        "IS_DEFAULT": true,
        "IMAGE_ID": null
    },
    {
        "ID": 252,
        "TYPE": 2,
        "TITLE": "Concrete",
        "COMPANY_ID": 0,
        "REPLACE_ID": null,
        "IS_DEFAULT": true,
        "IMAGE_ID": null
    } 
]

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.