Create a new announcement

Generate a new announcement in your ConstructionOnline company account

 post https://api.constructiononline.com/api/Announcements

This endpoint allows users to create a new announcement in their ConstructionOnline company account. If successful, the endpoint will return a record of the newly created announcement. The new announcement will be automatically assigned a unique numerical ID called 'ID', which will be used for any future references. The only property required for creation is the title/subject of the announcement. All other allowed properties are optional; these can be entered during announcement creation or updated at a later time. Users must enter the properties for creation in the payload of the request.

IMPORTANT: Users can create project-specific announcements and general company announcements in ConstructionOnline. To create an announcement for a specific project, ensure the project's ID is entered in the property 'PRJ_ID' for the announcement. If this property is empty, the announcement will be created as a general company announcement. 

Requests

PAYLOAD EXAMPLE

Individual properties for creation should be entered as JSON key-value pairs, as seen below:

{

"TITLE": "Work Delay 1/14/24",
"PRJ_ID": 123456,
"PRIORITY": 3

}
  • Required properties: TITLE
  • Allowed properties: MESSAGE, PRIORITY, PINNED, PRJ_ID
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
# {data} with the payload for announcement creation


curl -X POST https://api.constructiononline.com/api/Announcements -d '{data}' -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 */


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.PostAsync(endpoint, content).Result.ToString();
          }
    return response;
            }

   MakeRequest("api/Announcements");

Python

#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key


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("POST", url, headers=headers, data=payload)
    return json.dumps(json.loads(response.text), indent=2)   
#Main Program
print(makeRequest("api/Announcements"))

JavaScript

/* replace {username} with the email address for your ConstructionOnline account
           {password} with your ConstructionOnline password
         {apikey} with your provided API key */


 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: 'POST',
                    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/Announcements");

Responses

green 200: Success

A successful request will return a 200 response with a record of the newly created announcement in the body.

A sample response and property definitions can be found here.

red 404: Error

The server was not able to locate the resource specified in the request. 

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: Jan 9, 2024