Returns a record of all time sheets for a specified user within your ConstructionOnline company account
https://api.constructiononline.com/api/User/TimeTracking?userID={userID}&START={StartDate}&END={EndDate}
This endpoint allows users to extract a record of all time sheets for an individual company employee from their ConstructionOnline company account.
Please note: All time sheets pulled through the API will automatically be converted to UTC. Ensure that your application handles the necessary timezone adjustments to maintain accurate data representation.
Requests
REQUIRED PARAMETERS
userID: integer
- Unique identifier for the company employee.
START: string
- Beginning date and time for the range of included time sheets.
- Must be formatted in ISO 8601 format [YYYY-MM-DDTHH:mm:ss]
END: string
- End date and time for the range of included time sheets.
- Must be formatted in ISO 8601 format [YYYY-MM-DDTHH:mm:ss]
Sample URL request:
- https://api.constructiononline.com/api/User/TimeTracking?userID=885048&START=2024-11-4T00:00:00&END=2024-11-15T00:00:00
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
# {userID} with the user's ID
# {StartDate} with the desired start range
# {EndDate} with the desired end range
curl https://api.constructiononline.com/api/User/TimeTracking?userID={userID}&START={StartDate}&END={EndDate} -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
{userID} with the user's ID
{StartDate} with the desired start range
{EndDate} with the desired end range */
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/User/TimeTracking?userID={userID}&START={StartDate}&END={EndDate}"));
Python
#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
#{userID} with the user's ID
#{StartDate} with the desired start range
#{EndDate} with the desired end range
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/User/TimeTracking?userID={userID}&START={StartDate}&END={EndDate}"))
JavaScript
/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key
{userID} with the user's ID
{StartDate} with the desired start range
{EndDate} with the desired end range */
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/User/TimeTracking?userID={userID}&START={StartDate}&END={EndDate}");
Responses
200: Success
A successful request will return a 200 response with the requested time sheets in the body, as seen below.
[
{
"name": "e8WBVV8H5TIlUTbWfcc3",
"projectId": "1432504",
"startNote": "",
"startTime": "11/13/2024 8:00:00 AM",
"costCode": "",
"adminNote": "",
"endTime": "11/13/2024 5:30:00 PM",
"paid": "True",
"type": "0",
"createTime": "2024-11-22T14:19:54.453231Z",
"updateTime": "2024-11-22T15:44:19.536068Z"
}
]
404: Error
The server was not able to locate the resource specified in the request.
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: Nov 11, 2024