Customers & Sales
door
3 endpoints. Start at search to collect IDs, then resolve them through get.
Read operations
search door
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
doorIDintegerdoorID
latdoublelat
lngdoublelng
employeeIDintegeremployeeID
searchDistanceintegerSize in miles of the search grid when using centerLat, centerLng filters.
centerLatdoubleLatitude of search radius center. Default distance 50 miles; override with searchDistance parameter. centerLng must also be set to use this filter
centerLngdoubleLongitude of search radius center. Default distance 50 miles; override with searchDistance parameter. centerLat must also be set to use this filter
includeDatainteger{0,1} Sends the resolved objects for the first 1000 IDs. If there are more than 1000 items an additional property doorIDsNoDataExported will specify the items that are not included in the resolved door array.
Returns
doorIDsarrayNo description in the upstream reference.
Request
curl -X POST 'https://{subdomain}.pestroutes.com/api/door/search' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
--data-urlencode 'doorID=1' \
--data-urlencode 'lat=value' \
--data-urlencode 'authenticationKey=<your-key>' \
--data-urlencode 'authenticationToken=<your-token>'Response
get door
Get Bulk data for door. Accepts an array of doorIDs. Returns a max of 1000 records.
Parameters
doorIDsarrayNo description in the upstream reference.
Returns
doorIDintegerdoorID
latdoublelat
lngdoublelng
timeCreatedstringtimeCreated
employeeIDintegeremployeeID
namestringname
addressstringaddress
citystringcity
Request
curl -X POST 'https://{subdomain}.pestroutes.com/api/door/get' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
--data-urlencode 'doorIDs=value' \
--data-urlencode 'authenticationKey=<your-key>' \
--data-urlencode 'authenticationToken=<your-token>'Response
Fetch by id door
Get door data for single ID -- please provide a specific record ID in the URL structure.
Parameters
No parameters beyond authentication.
Returns
doorIDintegerdoorID
latdoublelat
lngdoublelng
timeCreatedstringtimeCreated
employeeIDintegeremployeeID
namestringname
addressstringaddress
citystringcity
Request
curl -X POST 'https://{subdomain}.pestroutes.com/api/door/{id}' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
--data-urlencode 'authenticationKey=<your-key>' \
--data-urlencode 'authenticationToken=<your-token>'Response