Update a schedule

Edit an existing schedule in your ConstructionOnline company account

 put https://api.constructiononline.com/api/Schedules?id={id}&SchedInfo={SchedInfo}

This endpoint allows users to edit an existing schedule within their company account. Users can update the majority of the schedule's properties, such as its name and start date. To update a schedule, users must know the unique numerical ID assigned to the schedule. Users should also enter the schedule fields to be updated in the URL of the request.

Requests

REQUIRED PARAMETERS

id: integer

  • Unique identifier for the schedule. 

SchedInfo: JSON object

  • Updated properties for the schedule.
Sample request URL:
  • https://api.constructiononline.com/api/Schedules?id=1234567&SchedInfo={"TITLE": "Downtown Renovation v5"} 

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 schedule's ID
# {SchedInfo} with the updated fields


curl -X PUT https://api.constructiononline.com/api/Schedules?id={id}&SchedInfo={SchedInfo} -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 schedule's ID
{SchedInfo} 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(MakeRequest("api/Schedules?id={id}&SchedInfo={SchedInfo}");

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 schedule's ID
#{SchedInfo} 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/Schedules?id={id}&SchedInfo={SchedInfo}")

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 schedule'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/Schedules?id={id}&SchedInfo={SchedInfo}");

Responses

green 200: Success

A successful request will return a 200 response with a record of the edited schedule in the body.

A sample response and property definitions can be found here

red 404: Error

The server was not able to locate the resource specified in the request. The ID may have been entered incorrectly or a schedule with the entered ID does not exist.

red 429: Error

The user has surpassed the request rate limit for the hour, day, week, or month.

 red 500: Error

There was an internal server error and the server was unable to complete the request.

 

Last updated: Jan 29, 2024