Returns the announcement that corresponds with the provided ID
https://api.constructiononline.com/api/Announcements?ID={id}
This endpoint allows users to search for an announcement by its unique numerical ID. The announcement's ID is stored in the announcement property 'ID'. If an announcement in the user's company account matches the provided ID, information about the announcement will be returned.
Requests
REQUIRED PARAMETERS
ID: integer
- Unique identifier for the announcement.
Sample URL request:
- https://api.constructiononline.com/api/Announcements/id=62700
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 announcement's unique ID
curl https://api.constructiononline.com/api/Announcements?id={id} -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 announcement's unique ID */
public string GetData(string endpoint) {
string username = "{username}";
string password = "{password}";
string apikey = "{apikey}";
HttpResponseMessage response = null;
HttpClientHandler handler = new HttpClientHandler() { AutomaticDecompression = System.Net.DecompressionMethods.GZip };
using (HttpClient client = new HttpClient(handler)) {
client.Timeout = new TimeSpan(0, 0, 30);
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");
response = client.GetAsync(endpoint).Result;
}
return response?.Content.ReadAsStringAsync().Result;
}
MessageBox.Show(GetData("api/Announcements?id={id}"));
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 announcement's unique ID
import base64, requests, json
apikey = "{apikey}"
username = "{username}"
password = "{password}"
def makeRequest(endpoint):
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.get(url, headers=headers)
return json.dumps(json.loads(response.text), indent=2)
#Main Program
print(makeRequest("api/Announcements?id={id}"))
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 announcement's unique ID */
username = '{username}';
password = '{password}';
apikey = '{apikey}';
function makeRequest(endpoint) {
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: 'GET',
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?id={id}");
Responses
200: Success
A successful request will return a 200 response with the requested announcement in the body, as seen below. Definitions for all returned properties can be found here.
{
"ID": 62700,
"PRJ_ID": 1261234,
"TITLE": "No Work Friday 1/21",
"MESSAGE": "<p>Work is canceled all day Friday 1/21 due to a campus event&nbsp;</p>",
"PRIORITY": 3,
"LMOD": "2024-01-07T17:22:16.77",
"LMOD_USER": 999999,
"DATE_CREATED": "2024-01-07T17:22:16.77",
"CREATED_BY": 999999,
"PINNED": false,
"PROJECT_NAME": "Auburn University - Shelby Renovation",
"ATTACHIDS": null,
"ATTACHMENTS": null
}
404: Error
The server was not able to locate the resource specified in the request. The announcement ID may have been entered incorrectly or an announcement 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: Jan 9, 2024