Returns all items for a specific change order in your ConstructionOnline company account
https://api.constructiononline.com/ChangeOrderItems?changeOrderID={changeOrderID}
This endpoint allows users to extract a record of all items for a specific change order from their ConstructionOnline company account. Users must know the unique ID assigned to the change order to call this endpoint. Please note that only detailed change orders may contain individual items; this endpoint will return an empty response if called on a lump-sum change order.
Requests
REQUIRED PARAMETERS
changeOrderID: integer
- Unique identifier for the change order.
Sample URL request:
- https://api.constructiononline.com/api/ChangeOrderItems?changeOrderID=1234567
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
# {changeOrderID} with the change order's ID
curl https://api.constructiononline.com/api/ChangeOrderItems?changeOrderID={changeOrderID} -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
{changeOrderID} with the change order'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/ChangeOrderItems?changeOrderID={changeOrderID}"));
Python
#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
#{changeOrderID} with the change order'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/ChangeOrderItems?changeOrderID={changeOrderID}"))
JavaScript
/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key
{changeOrderID} with the change order'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/ChangeOrderItems?changeOrderID={changeOrderID}");
Responses
200: Success
A successful request will return a 200 response with the requested change order items in the body, as seen below. Definitions for all returned properties can be found here.
{
"ID": 524469,
"CHANGE_ORDER_ID": 500942,
"NAME": "Chandelier",
"PRJ_ID": 1321036,
"PROJECTNAME": "3931 E Lake Blvd",
"ROW_NUMBER": 0,
"DESCRIPTION": "",
"CLASSIFICATION": 1,
"STATUS": 3,
"COST_ESTIMATE": 850.0,
"COST_TOTAL": null,
"NOTES_TEAMLINK": null,
"NOTES_CLIENTLINK": null,
"NOTES_GENERAL": null,
"LINE_ITEM_MARKUP": "20",
"RATE": 850.0,
"RATE_QTY": 1.0,
"LINE_ITEM_MARKUP_TYPE": 0,
"ADJUSTMENT": 0.0,
"TRAFFIC_COLOR": 0,
"COST_CODE_ID": 371,
"MARKUP": 170.0,
"COMMITTED_COSTS": 0.0,
"INVOICED_AMOUNTS": 0.0,
"ACTUAL": 0.0,
"QB_COMMITTED": null,
"QB_INVOICED": null,
"QB_ACTUAL": null,
"TAX_PERCENT": 0.0,
"TAX_METHOD": 3,
"SALES_TAX": 0.0,
"CLIENT_PRICE": 1020.0,
"DATE_CREATED": "2023-06-02T15:13:36.403",
"CREATED_BY": 985888,
"CREATOR": "Alex Kim",
"DATE_CLOSED": null,
"CLOSED_BY": null,
"CLOSER": "",
"DATE_MODIFIED": "2023-06-27T17:25:05.983",
"MODIFIED_BY": 985888,
"MODIFIER": "",
"CUSTOM_UNIT": null,
"UNIT_NAME": null,
"RELSUBCATS": null
}
404: Error
The server was not able to locate the resource specified in the request. The change order ID may have been entered incorrectly or a change order 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