Archive a project

Archive an existing project in your ConstructionOnline company account

  https://api.constructiononline.com/api/Projects?id={id}&action=ARCHIVE&projectInfo={projectInfo}

In ConstructionOnline, projects that are completed or no longer actively maintained can be archived within the system. Archived projects are designed for historical record maintenance and are managed & stored separately from active, ongoing projects in ConstructionOnline. This endpoint allows users to archive a live or pending project within their ConstructionOnline company account. To archive a project, users must know the unique numerical ID assigned to the project. This is stored in the property 'ID' for the specific project.

• Requests
• Responses

Requests

REQUIRED PARAMETERS

id: integer

• Unique identifier for the project

projectInfo: JSON object

• Must contain the ID for the project in the form of a key-value pair
• Example: projectInfo={"id" : "1234567"}

Sample request URL:

• https://api.constructiononline.com/api/Projects?id=1234567&action=ARCHIVE&projectInfo={"id" : "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
# {id} with the project's ID
# {projectInfo} with the project's ID

curl -X PUT https://api.constructiononline.com/api/Projects?id={id}&action=ARCHIVE&projectInfo={projectInfo} -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
           {projectInfo} 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/Projects?id={id}&action=ARCHIVE&projectInfo={projectInfo}");

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
#{projectInfo} 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/Projects?id={id}&action=ARCHIVE&projectInfo={projectInfo}"))

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
           {contactInfo} 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/Projects?id={id}&action=ARCHIVE&projectInfo={projectInfo}");

Responses

 200: Success

A successful request will return an empty 200 response, signaling that the project was successfully archived.

 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 28, 2023