Delete a Selection Choice

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

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

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

• Requests
• Responses

Requests

id: integer

• Unique identifier for the selection choice

selInfo: JSON 

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

Sample request URL:

• https://api.constructiononline.com/api/SelectionChoices/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 choice's ID
# {selInfo} with the choice's ID

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

Responses

 200: Success

A successful request will return an empty 200 response, signaling that the selection choice 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 a selection choice 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: April 19, 2024