Get a schedule

Returns the schedule that corresponds with the provided ID

get https://api.constructiononline.com/api/Schedules/{ID}

This endpoint allows users to search for a schedule by its unique numerical ID. The schedule's ID is stored in the schedule property 'ID'. If a schedule in the user's company account matches the provided ID, information about the schedule will be returned.

Requests

REQUIRED PARAMETERS

ID: integer

  • Unique identifier for the schedule

Sample URL request:

  • https://api.constructiononline.com/api/Schedules/123456

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
# {ID} with the schedule's ID


curl https://api.constructiononline.com/api/Schedules/{ID} -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
{ID} with the schedule'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/Schedules/{ID}"));

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 schedule'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/Schedules/{ID}"))

JavaScript

/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key
{ID} with the schedule'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/Schedules/{ID}");

Responses

green 200: Success

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

{
       
"ID": 400001,
        "TITLE": "Downtown Remodel Schedule",
        "IS_TEMPLATE": false,
        "CUSTOM_COLOR": null,
        "HOLIDAY": 65,
        "HOLIDAY_CONTEXT": 1,
        "DATE_START": "2024-02-14T00:00:00",
        "DATE_END": "2024-12-13T00:00:00",
        "WORKDAYS": 160,
        "PROJECT_ID": 1321111,
        "PROJECT_NAME": "Downtown Remodel",
        "DATE_CREATED": "2024-01-20T14:23:24.907",
        "CREATED_BY": 1000000,
        "CREATOR": "Benjamin Chen",
        "LMOD_DATE": null,
        "LMOD_BY": null,
        "LMOD_NAME": "Benjamin Chen",
        "RELATEDCONIDS": null,
        "ASSIGNEDCONIDS": null
   
}

red 404: Error

The server was not able to locate the resource specified in the request. The schedule ID may have been entered incorrectly or a schedule 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: Jan 23, 2024