Delete an estimate subcategory

Remove an estimate subcategory from an estimate in your ConstructionOnline company account

  https://api.constructiononline.com/api/EstimateSubCategories?subcatID={subcatID}&subcategoryInfo={subcategoryInfo}&action=DELETE

This endpoint allows users to remove an estimate subcategory from an estimate they have access to in ConstructionOnline. To delete an estimate subcategory, users must know the unique numerical ID assigned to the subcategory. Please note—deleting an estimate subcategory will also delete any items within the estimate subcategory.

• Requests
• Responses

Requests

REQUIRED PARAMETERS

subcatID: integer

• Unique identifier for the estimate subcategory

subcategoryInfo: JSON 

• Must contain the ID of the estimate subcategory in the form of a key-value pair
• Example: subcategoryInfo={"ID" : "1234556"}

Sample request URL:

• https://api.constructiononline.com/api/EstimateSubCategories?subcatID=1234556&subcategoryInfo={"ID" : "1234556"}&action=DELETE

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
# {subcatID} with the estimate subcategory's ID
# {subcategoryInfo} with the estimate subcategory's ID

curl -X PUT https://api.constructiononline.com/api/EstimateSubCategories?subcatID={subcatID}&subcategoryInfo={subcategoryInfo}&action=DELETE -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 
           {subcatID} with the estimate subcategory's ID 
           {subcatInfo} with the estimate subcategory'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/EstimateSubCategories?subcatID={subcatID}&subcategoryInfo={subcategoryInfo}&action=DELETE");

Python

#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
#{subcatID} with the estimate subcategory's ID
#{subcatInfo} with the estimate subcategory'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/EstimateSubCategories?subcatID={subcatID}&subcategoryInfo={subcategoryInfo}&action=DELETE"))

JavaScript

/* replace {username} with the email address for your ConstructionOnline account
           {password} with your ConstructionOnline password
           {apikey} with your provided API key 
           {subcatID} with the estimate subcategory's ID
           {subcatInfo} with the estimate subcategory'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/EstimateSubCategories?subcatID={subcatID}&subcategoryInfo={subcategoryInfo}&action=DELETE");

Responses

 200: Success

A successful request will return an empty 200 response, signaling that the estimate subcategory was successfully removed.

 404: Error

The server was not able to locate the resource specified in the request. The ID may have been entered incorrectly or an estimate subcategory 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