FieldRoutes APIConfiguration & Audit
accessControl
3 endpoints. Start at search to collect IDs, then resolve them through get.
Read operations
search accessControl
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
employeeIDintegerEmployee ID of custom Access Control Profile
accessControlProfileIDinteger0: Custom Access Control Profile per user. Otherwise, ID of defined Access Control Profiles
adminintegerAdministrator
adminMessageintegerAdmin Messages
editPreferencesintegerAdjust Preferences
viewOwnRoutesintegerView Own Routes
viewOtherRoutesintegerView Other's Routes
editOwnRoutesintegerEdit Own Routes
Returns
accessControlIDsarrayNo description in the upstream reference.
Request
curl -X POST 'https://{subdomain}.pestroutes.com/api/accessControl/search' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
--data-urlencode 'employeeID=1' \
--data-urlencode 'accessControlProfileID=1' \
--data-urlencode 'authenticationKey=<your-key>' \
--data-urlencode 'authenticationToken=<your-token>'Response
get accessControl
Get Bulk data for accessControl. Accepts an array of employeeIDs. Returns a max of 1000 records.
Parameters
employeeIDsarrayNo description in the upstream reference.
Returns
employeeIDintegerEmployee ID of custom Access Control Profile
accessControlProfileIDinteger0: Custom Access Control Profile per user. Otherwise, ID of defined Access Control Profiles
adminintegerAdministrator
adminMessageintegerAdmin Messages
editPreferencesintegerAdjust Preferences
viewOwnRoutesintegerView Own Routes
viewOtherRoutesintegerView Other's Routes
editOwnRoutesintegerEdit Own Routes
Request
curl -X POST 'https://{subdomain}.pestroutes.com/api/accessControl/get' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
--data-urlencode 'employeeIDs=value' \
--data-urlencode 'authenticationKey=<your-key>' \
--data-urlencode 'authenticationToken=<your-token>'Response
Fetch by id accessControl
Get accessControl data for single ID -- please provide a specific record ID in the URL structure.
Parameters
No parameters beyond authentication.
Returns
employeeIDintegerEmployee ID of custom Access Control Profile
accessControlProfileIDinteger0: Custom Access Control Profile per user. Otherwise, ID of defined Access Control Profiles
adminintegerAdministrator
adminMessageintegerAdmin Messages
editPreferencesintegerAdjust Preferences
viewOwnRoutesintegerView Own Routes
viewOtherRoutesintegerView Other's Routes
editOwnRoutesintegerEdit Own Routes
Request
curl -X POST 'https://{subdomain}.pestroutes.com/api/accessControl/{id}' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
--data-urlencode 'authenticationKey=<your-key>' \
--data-urlencode 'authenticationToken=<your-token>'Response