Update a company overhead and margin entry

Edit a single company overhead and margin entry from an estimate in your ConstructionOnline company account

 https://api.constructiononline.com/api/EstimateMarkup?muID={muID}&markupInfo={markupInfo}

This endpoint allows users to edit an existing company overhead and margin entry within an estimate in their ConstructionOnline company account. To update the entry, users must know its assigned unique numerical ID. This is stored in the property 'ID'. Users should enter the properties to be updated in the URL of the request—specifically, in the "markupInfo" request parameter. Only the properties specified in the parameter will be updated; the other properties will remain as is. 

• Requests
• Responses

Requests

muID: integer

• Unique identifier for the company overhead and margin entry.

markupInfo: JSON 

• Updated properties for the entry.
• Allowed properties in markupInfo: NAME, VALUE, MARKUP_TYPE, VISIBLE, INVOICED, ACTUALS, QB_ACTUALS, QB_INVOICED

Sample request URL:

• https://api.constructiononline.com/api/EstimateMarkup?muID=345678&markupInfo={"VALUE" : "23,000"}

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
# {muID} with the entry's ID
# {markupInfo} with the updated properties

curl -X PUT https://api.constructiononline.com/api/EstimateMarkup?muID={muID}&markupInfo={markupInfo} -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 
           {muID} with the entry's ID 
           {markupInfo} with the updated 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.PutAsync(endpoint, content).Result.ToString();
                }
                return response;
            }
     MakeRequest("api/EstimateMarkup?muID={muID}&markupInfo={markupInfo}");

Python

#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
#{muID} with the entry's ID
#{markupInfo} with the updated 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("PUT", url, headers=headers, data=payload)
                return json.dumps(json.loads(response.text), indent=2)   
    #Main Program 
    print(makeRequest("api/EstimateMarkup?muID={muID}&markupInfo={markupInfo}"))

JavaScript

/* replace {username} with the email address for your ConstructionOnline account
           {password} with your ConstructionOnline password
           {apikey} with your provided API key 
           {muID} with the entry's ID 
           {markupInfo} with the updated 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: 'PUT',
                    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/EstimateMarkup?muID={muID}&markupInfo={markupInfo}");

Responses

 200: Success

A successful request will return a 200 response with a record of the edited entry 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. The ID may have been entered incorrectly or an entry 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 19, 2024