Create a Change Order Item

 https://api.constructiononline.com/api/ChangeOrderItems?coItemInfo={coItemInfo}

This endpoint allows users to create a new change order item for an existing change order in their ConstructionOnline company account. The change order item must be created for a specific change order within an existing project. If a change order ID is not included in the URL of the request, the change order item will fail to create.

The new change order item will be automatically assigned a unique numerical ID called ID, which will be used for any future references. Users should enter the properties for creation in the URL of the request—specifically, in the "coItemInfo" request parameter. The required properties for creation are NAME and CHANGE_ORDER_ID; all other properties are optional and can be entered during item creation or updated at a later time. If successful, the endpoint will return a record of the newly created change order item with the included properties.

• Requests
• Responses

Requests

coItemInfo: JSON 

• Properties to be added to the change order item.
• Required properties: NAME, CHANGE_ORDER_ID

• Allowed properties: DESCRIPTION, LINE_ITEM_MARKUP, RATE, RATE_QTY, LINE_ITEM_MARKUP_TYPE, ADJUSTMENT, COST_CODE_ID, DOLLAR_MARKUP, INVOICED_AMOUNTS, ACTUAL, QB_INVOICED, QB_ACTUAL, TAX_PERCENT, SALES_TAX, COST_ESTIMATE, SUBCATIDS

Sample URL request:

• https://api.constructiononline.com/api/ChangeOrderItems?coItemInfo={"NAME" : "Windows", "CHANGE_ORDER_ID" : "1234567"}

Example requests in cURL, C#, Python, and JavaScript can be found below:

# replace {email} with the email address for your ConstructionOnline account
# {password} with your ConstructionOnline password
# {apikey} with your provided API key
# {coItemInfo} with the change order item's properties

curl -X POST https://api.constructiononline.com/api/ChangeOrderItems?coItemInfo={coItemInfo} -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 
           {coItemInfo} with the change order item's properties */
        

public string MakeRequest(string endpoint, string payload) {
     string username = {username};
     string password = {password};
     string apiKey = {apikey};
     string response = "";
      var handler = new HttpClientHandler() { AutomaticDecompression = System.Net.DecompressionMethods.GZip };
          using (HttpClient client = new HttpClient(handler)) {
           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");
           HttpContent content = new StringContent(payload, System.Text.Encoding.UTF32, "application/json");
           response = client.PostAsync(endpoint, content).Result.ToString();
            }
      return response;
            }

     MakeRequest("api/ChangeOrderItems?coItemInfo={coItemInfo});

Python

#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
#{coItemInfo} with the change order item's properties


import base64, requests, json
#Global Variables
  apikey = {apikey}
  username = {username}
  password = {password}

#Functions
  def makeRequest(endpoint, payload):
       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.request("POST", url, headers=headers, data=payload)
       return json.dumps(json.loads(response.text), indent=2)   
#Main Program 
print(makeRequest("api/ChangeOrderItems?coItemInfo={coItemInfo}"))

JavaScript

/* replace {username} with the email address for your ConstructionOnline account
           {password} with your ConstructionOnline password
           {apikey} with your provided API key 
           {coItemInfo} with the change order item's properties */
     

 username = '{username}';
 password = '{password}';
 apikey = '{apikey}';

 function makeRequest(endpoint, payload) {
          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: 'POST',
                    body: '',
                    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?coItemInfo={coItemInfo}");

Responses

 200: Success

A successful request will return a 200 response with a record of the newly created change order item in the body.

A sample response and property definitions can be found here.

 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: April 19, 2024