Field Operations
chemicalUse
3 endpoints. Start at search to collect IDs, then resolve them through get.
Read operations
search chemicalUse
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
chemicalUseIDsintegerPrimary key
chemicalUseIDintegerPrimary key alias
officeIDsintegerOffice ID region belongs to
chemicalIDintegerID of the chemical Used
appointmentIDintegerNo description in the upstream reference.
customerIDintegerNo description in the upstream reference.
dateCreatedstringNo description in the upstream reference.
createdBystringNo description in the upstream reference.
Returns
chemicalUseIDsarrayNo description in the upstream reference.
Request
curl -X POST 'https://{subdomain}.pestroutes.com/api/chemicalUse/search' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
--data-urlencode 'chemicalUseIDs=1' \
--data-urlencode 'chemicalUseID=1' \
--data-urlencode 'authenticationKey=<your-key>' \
--data-urlencode 'authenticationToken=<your-token>'Response
get chemicalUse
Get Bulk data for chemicalUse. Accepts an array of chemicalUseIDs. Returns a max of 1000 records.
Parameters
chemicalUseIDsarrayNo description in the upstream reference.
Returns
chemicalUseIDintegerNo description in the upstream reference.
chemicalIDintegerNo description in the upstream reference.
officeIDintegerNo description in the upstream reference.
appointmentIDintegerNo description in the upstream reference.
customerIDintegerNo description in the upstream reference.
dateCreatedstringNo description in the upstream reference.
createdBystringNo description in the upstream reference.
serviceIDintegerNo description in the upstream reference.
Request
curl -X POST 'https://{subdomain}.pestroutes.com/api/chemicalUse/get' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
--data-urlencode 'chemicalUseIDs=value' \
--data-urlencode 'authenticationKey=<your-key>' \
--data-urlencode 'authenticationToken=<your-token>'Response
Fetch by id chemicalUse
Get chemicalUse data for single ID -- please provide a specific record ID in the URL structure.
Parameters
No parameters beyond authentication.
Returns
chemicalUseIDintegerNo description in the upstream reference.
chemicalIDintegerNo description in the upstream reference.
officeIDintegerNo description in the upstream reference.
appointmentIDintegerNo description in the upstream reference.
customerIDintegerNo description in the upstream reference.
dateCreatedstringNo description in the upstream reference.
createdBystringNo description in the upstream reference.
serviceIDintegerNo description in the upstream reference.
Request
curl -X POST 'https://{subdomain}.pestroutes.com/api/chemicalUse/{id}' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
--data-urlencode 'authenticationKey=<your-key>' \
--data-urlencode 'authenticationToken=<your-token>'Response