Scheduling

location

3 endpoints. Start at search to collect IDs, then resolve them through get.

Read · 3

Read operations

search/location/searchTry it

search location

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

><>=<==!=INBETWEENLIKESTARTSWITHENDSWITHCONTAINS

Each 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

locationIDsinteger

Primary key

locationIDinteger

Primary key alias

officeIDsinteger

OfficeID insect belongs to

visibleinteger

visibility of the location

includeDatainteger

{0,1} Sends the resolved objects for the first 1000 IDs. If there are more than 1000 items an additional property locationIDsNoDataExported will specify the items that are not included in the resolved location array.

Returns

locationIDsarray

No description in the upstream reference.

Request

/location/search

curl -X POST 'https://{subdomain}.pestroutes.com/api/location/search' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'locationIDs=1' \
  --data-urlencode 'locationID=1' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

0:10000

1:10007

2:10014

3:10021

4:10028

5:10035

6:10042

7:10049

]

count:8

}

get/location/getTry it

get location

Get Bulk data for location. Accepts an array of locationIDs. Returns a max of 1000 records.

Parameters

locationIDsarray

No description in the upstream reference.

Returns

locationIDinteger

No description in the upstream reference.

officeIDinteger

No description in the upstream reference.

namestring

No description in the upstream reference.

visibleinteger

No description in the upstream reference.

systeminteger

No description in the upstream reference.

Request

/location/get

curl -X POST 'https://{subdomain}.pestroutes.com/api/location/get' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'locationIDs=value' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

]

count:2

}

by id/location/{id}Try it

Fetch by id location

Get location data for single ID -- please provide a specific record ID in the URL structure.

Parameters

No parameters beyond authentication.

Returns

locationIDinteger

No description in the upstream reference.

officeIDinteger

No description in the upstream reference.

namestring

No description in the upstream reference.

visibleinteger

No description in the upstream reference.

systeminteger

No description in the upstream reference.

Request

/location/{id}

curl -X POST 'https://{subdomain}.pestroutes.com/api/location/{id}' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

locationID:5539

officeID:2602

name:"Quarterly Perimeter"

visible:0

system:2

}