FieldRoutes APIField Operations
timeClockCategory
3 endpoints. Start at search to collect IDs, then resolve them through get.
Read operations
search timeClockCategory
Provide a set of parameters which will return a list of ids. There is no limit to the number of IDs this will return. You can then supply these ids to the get endpoint in order to retrieve bulk data. Every parameter available supports a simple value OR a powerful query object that gives you access to all basic comparators.
Example
dateAdded={"operator":">","value":"2016-01-01"}Example
dateAdded={"operator\":\"BETWEEN\",\"value\":[\"2016-05-12\",\"2016-05-13\"]}Available operators
><>=<==!=INBETWEENLIKESTARTSWITHENDSWITHCONTAINSEach of the search endpoints allows for an optional parameter 'includeData'. When sent, the API will additionally send the resolved objects for the first 1000 IDs.
Keep in mind when using 'includeData' that if there are more than 1000 items an additional property '{entity}IDsNoDataExported' will specify the items that are not included in the resolved data array.
Parameters
clockCategoryIDsintegerPrimary key.
timeClockCategoryIDsintegerPrimary key (alias)
officeIDsintegerNo description in the upstream reference.
visibleintegerVisible to staff
allowOnClockInintegertime clock category is allowed on initial clock in.
systemReservedinteger1 = system reserved category (cannot be deleted or changed)
paidinteger0 for unpaid categories, 1 for paid categories. Clock entries with no category association are considered paid.
dateUpdatedstringDate this category was last changed
Returns
timeClockCategoryIDsarrayNo description in the upstream reference.
Request
curl -X POST 'https://{subdomain}.pestroutes.com/api/timeClockCategory/search' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
--data-urlencode 'clockCategoryIDs=1' \
--data-urlencode 'timeClockCategoryIDs=1' \
--data-urlencode 'authenticationKey=<your-key>' \
--data-urlencode 'authenticationToken=<your-token>'Response
get timeClockCategory
Get Bulk data for timeClockCategory. Accepts an array of clockCategoryIDs. Returns a max of 1000 records.
Parameters
clockCategoryIDsarrayNo description in the upstream reference.
Returns
clockCategoryIDintegerPrimary key.
officeIDintegerNo description in the upstream reference.
visibleintegerVisible to staff
allowOnClockInintegertime clock category is allowed on initial clock in.
systemReservedinteger1 = system reserved category (cannot be deleted or changed)
paidinteger0 for unpaid categories, 1 for paid categories. Clock entries with no category association are considered paid.
dateUpdatedstringDate this category was last changed
descriptionintegerDescription associated with the clock category
Request
curl -X POST 'https://{subdomain}.pestroutes.com/api/timeClockCategory/get' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
--data-urlencode 'clockCategoryIDs=value' \
--data-urlencode 'authenticationKey=<your-key>' \
--data-urlencode 'authenticationToken=<your-token>'Response
Fetch by id timeClockCategory
Get timeClockCategory data for single ID -- please provide a specific record ID in the URL structure.
Parameters
No parameters beyond authentication.
Returns
clockCategoryIDintegerPrimary key.
officeIDintegerNo description in the upstream reference.
visibleintegerVisible to staff
allowOnClockInintegertime clock category is allowed on initial clock in.
systemReservedinteger1 = system reserved category (cannot be deleted or changed)
paidinteger0 for unpaid categories, 1 for paid categories. Clock entries with no category association are considered paid.
dateUpdatedstringDate this category was last changed
descriptionintegerDescription associated with the clock category
Request
curl -X POST 'https://{subdomain}.pestroutes.com/api/timeClockCategory/{id}' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
--data-urlencode 'authenticationKey=<your-key>' \
--data-urlencode 'authenticationToken=<your-token>'Response