Update a project

Edit an existing project in your ConstructionOnline company account

https://api.constructiononline.com/api/v2/Projects?id={id}

This endpoint allows users to edit an existing project within their ConstructionOnline company account. Users can update any of the project's properties, such as its scope of work, address, or initial contract price. To update a project, users must know the unique numerical ID assigned to the project. The project's ID is stored in the project property 'ID'. Users should enter the properties to be updated in the payload/body of the request. Only the properties specified in the payload will be updated. The other properties will remain as is.

• Requests
• Responses

Requests

REQUIRED PARAMETERS

id: integer

• Unique identifier for the project.

Sample request URL:

• https://api.constructiononline.com/api/v2/Projects?id=1233456

PAYLOAD EXAMPLE

Edited properties should be entered as JSON key-value pairs, as seen below:

{

   "ADDRESS":"1420 Piedmont Ave",
   "CITY":"Atlanta"
   "STATE":"Georgia",
   "ZIP":"30002"

}

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 project's ID
# {data} with the payload containing the project properties

curl -X PUT https://api.constructiononline.com/api/v2/Projects?id={id} -d '{data}'-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 project's ID */

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/v2/Projects?id={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 project's ID

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/v2/Projects?id={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 project's ID */

 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/v2/Projects?id={id}");

Responses

 200: Success

A successful request will return a 200 response with a record of the edited project 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 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: Dec 27, 2023