Returns all change orders for the project that corresponds with the provided ID
https://api.constructiononline.com/ChangeOrders
This endpoint allows users to extract all change orders from a specific project within their ConstructionOnline company account. Users must know the unique ID assigned to the project to call this endpoint. Please note that this endpoint does not return any change order items belonging to individual change orders.
Requests
REQUIRED PARAMETERS
projectID: integer
- Unique identifier for the project.
Sample URL request:
- https://api.constructiononline.com/api/ChangeOrders?projectID=3456123
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
# {projectID} with the project's ID
curl https://api.constructiononline.com/api/ChangeOrders?projectID={projectID} -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
{projectID} with the project'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/ChangeOrders?projectID={projectID}"));
Python
#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
#{projectID} with the project'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/ChangeOrders?projectID={projectID}"))
JavaScript
/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key
{projectID} with the project'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/ChangeOrders?projectID={projectID}");
Responses
200: Success
A successful request will return a 200 response with the requested change orders in the body, as seen below. Definitions for all returned properties can be found here.
{ "ID": 498099,
"NAME": "Living Room Light Fixtures",
"PRJ_ID": 1321036,
"PROJECTNAME": "3931 E Lake Blvd",
"NUMBER": "2",
"DETAILS": "Client requested different overhead light fixtures for the living room. \nNew fixtures exceed existing allowance.\nFixtures need to be ordered & delivered before installation date of 7/01/23.",
"CONDITION": 0,
"COST_MONEY": 2380.0,
"COST_TIME": 3,
"DATE_CREATED": "2023-05-17T18:15:45.037",
"CREATED_BY": 985300,
"CREATOR": "",
"DATE_CLOSED": "2023-06-02T19:59:14.217",
"CLOSED_BY": 988884,
"CLOSER": "",
"DATE_MODIFIED": "2024-02-19T17:48:46.417",
"MODIFIED_BY": 988884,
"MODIFIER": "",
"NOTES": "",
"REASONING": "",
"PRICE": 2380.0,
"QTY": 1.0,
"SUBTITLE": "Upgraded light fixtures for the living room",
"IMAGE_ID": 0,
"URL": "",
"SUBSTANTIAL_COMMENCEMENT": null,
"MULTIPLIER": null,
"MARKUP": 385.0,
"TAX_PERCENT": 0.0,
"TAX_METHOD": 3,
"SALES_TAX": 0.0,
"CLIENT_PRICE": 2765.0,
"DATE_SUBMITTED": "2023-05-14T00:00:00",
"GCCO": "",
"QBO_INVOICE_ID": null,
"ACCT_INVOICE_ID": null,
"ACTUAL": 0.0,
"INVOICED_AMOUNTS": 0.0,
"COMMITTED_COSTS": 0.0,
"MARKUP_TYPE": 1,
"QB_COMMITTED": null,
"QB_INVOICED": 0.0,
"QB_ACTUALS": 0.0,
"UNIT": null,
"UNIT_NAME": null,
"RELSUBCATS": null,
"RELCONIDS": null,
"RELUSERIDS": "985779,Theo Brown"
}
404: Error
The server was not able to locate the resource specified in the request. The project ID may have been entered incorrectly or a project 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