Delete a selection category

Remove a selection category from a project in your ConstructionOnline company account

put https://api.constructiononline.com/api/SelectionCategories/{id}?selInfo={selInfo}&action=DELETE

This endpoint allows users to remove an existing selection category within their ConstructionOnline company account. To delete the selection category, uses must know the unique numerical ID assigned to the category.

❗ Important: As a safety precaution to avoid accidental deletion, users must enter the ID for the category in both the parameters 'id' and 'selInfo'.

Please note: deleting a selection category will also delete all selection subcategories and choices within the category. 

Requests


id: integer

  • Unique identifier for the selection category

selInfo: JSON 

  • Must contain the ID of the selection category in the form of a key-value pair
  • Example: selInfo={"id" : "1234556"}

Sample request URL:

  • https://api.constructiononline.com/api/SelectionCategories/1234567?selInfo={"ID" : "1234567"}&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
# {id} with the category's ID
# {selInfo} with the category's ID


curl -X PUT https://api.constructiononline.com/api/SelectionCategories/{id}?selInfo={selInfo}?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
{id} with the category's ID
          {selInfo} with the category'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/SelectionCategories/{id}?selInfo={selInfo}?action=DELETE");

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 category's ID
#{selInfo} with the category'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/SelectionCategories/{id}?selInfo={selInfo}?action=DELETE"))

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 category's ID
          {selInfo} with the category'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/SelectionCategories/{id}?selInfo={selInfo}?action=DELETE");

Responses

green 200: Success

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

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 selection category 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: April 19, 2024