Edit an existing estimate subcategory in your ConstructionOnline company account
https://api.constructiononline.com/api/EstimateSubCategories?subcatID={subcatID}&subcategoryInfo={subcategoryInfo}
This endpoint allows users to edit an existing estimate subcategory within an estimate in their ConstructionOnline company account. To update an estimate subcategory, users must know the unique numerical ID assigned to the subcategory. The estimate subcategory's ID is stored in the property 'ID'. Users should enter the properties to be updated in the URL of the request—specifically, in the "subcategoryInfo" request parameter. Only the properties specified in the parameter will be updated; the other properties will remain as is. This endpoint cannot be used to update items within the estimate subcategory.
Requests
subcatID: integer
- Unique identifier for the estimate subcategory.
subcategoryInfo: JSON
- Updated properties for the subcategory.
- Allowed properties in subcategoryInfo: NAME, DESCRIPTION, ROW_NUMBER, COST_CODE, CLASSIFICATION, STATUS, COST_ESTIMATE, LINE_ITEM_MARKUP, COMMITTED_COSTS, INVOICED_AMOUNTS, ACTUAL, RATE, RATE_QTY, LINE_ITEM_MARKUP_TYPE, ADJUSTMENT, FIVE_COLUMN_EQUIPMENT, FIVE_COLUMN_LABOR, FIVE_COLUMN_MATERIAL, FIVE_COLUMN_OTHER, FIVE_COLUMN_SUB, UNIT_NAME, QB_ACTUAL, QB_COMMITTED, QB_INVOICED
Sample request URL:
- https://api.constructiononline.com/api/EstimateSubCategories?subcatID=345678&subcategoryInfo={"COST_ESTIMATE":"3,000"}
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 updated properties
curl -X PUT https://api.constructiononline.com/api/EstimateSubCategories?subcatID={subcatID}&subcategoryInfo={subcategoryInfo} -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
{subcategoryInfo} 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("api/EstimateSubCategories?subcatID={subcatID}&subcategoryInfo={subcategoryInfo}");
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
#{subcategoryInfo} 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/EstimateSubCategories?subcatID={subcatID}&subcategoryInfo={subcategoryInfo}"))
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
{subcategoryInfo} with the updated properties */
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}");
Responses
200: Success
A successful request will return a 200 response with a record of the edited estimate subcategory in the body.
A sample response and property definitions can be found here.
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