FieldRoutes APICustomers & Sales
form
3 endpoints. Start at search to collect IDs, then resolve them through get.
Read operations
search form
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
formIDsintegerNo description in the upstream reference.
officeIDsintegerNo description in the upstream reference.
customerIDintegerNo description in the upstream reference.
dateSignedstringThe date the form was signed.
dateAddedstringThe date the form was added.
unitIDintegerThe unitID associated with the form.
employeeIDintegerThe employeeID who created the form.
documentStateintegerState of the document e.g. WIP, COMPLETED
Returns
formIDsarrayNo description in the upstream reference.
Request
curl -X POST 'https://{subdomain}.pestroutes.com/api/form/search' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
--data-urlencode 'formIDs=1' \
--data-urlencode 'officeIDs=1' \
--data-urlencode 'authenticationKey=<your-key>' \
--data-urlencode 'authenticationToken=<your-token>'Response
get form
Get Bulk data for form. Accepts an array of contractIDs. Returns a max of 1000 records.
Parameters
contractIDsarrayNo description in the upstream reference.
includeDocumentLinkintegerSend as 1 to retrieve a link to the document on AWS with a 15 day TTL.
Returns
formIDintegerNo description in the upstream reference.
customerIDintegerNo description in the upstream reference.
dateSignedstringThe date the form was signed.
dateAddedstringThe date the form was added.
unitIDintegerThe unitID associated with the form.
employeeIDintegerThe employeeID who created the form.
documentStateintegerState of the document e.g. WIP, COMPLETED
formTemplateIDintegerID of the template this form was created from
Request
curl -X POST 'https://{subdomain}.pestroutes.com/api/form/get' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
--data-urlencode 'contractIDs=value' \
--data-urlencode 'includeDocumentLink=1' \
--data-urlencode 'authenticationKey=<your-key>' \
--data-urlencode 'authenticationToken=<your-token>'Response
Fetch by id form
Get form data for single ID -- please provide a specific record ID in the URL structure.
Parameters
includeDocumentLinkintegerSend as 1 to retrieve a link to the document on AWS with a 15 day TTL.
Returns
formIDintegerNo description in the upstream reference.
customerIDintegerNo description in the upstream reference.
dateSignedstringThe date the form was signed.
dateAddedstringThe date the form was added.
unitIDintegerThe unitID associated with the form.
employeeIDintegerThe employeeID who created the form.
documentStateintegerState of the document e.g. WIP, COMPLETED
formTemplateIDintegerID of the template this form was created from
Request
curl -X POST 'https://{subdomain}.pestroutes.com/api/form/{id}' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
--data-urlencode 'includeDocumentLink=1' \
--data-urlencode 'authenticationKey=<your-key>' \
--data-urlencode 'authenticationToken=<your-token>'Response