Configuration & Audit

region

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

Read · 3

Read operations

search/region/searchTry it

search region

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

regionIDsinteger

Primary key

officeIDsinteger

Office ID region belongs to

descriptionstring

Description of the region

createdstring

Time the region was created

deletedstring

Time the region was deleted

typestring

No description in the upstream reference.

activestring

Active status for the region.

includeDatainteger

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

Returns

regionIDsarray

No description in the upstream reference.

Request

/region/search

curl -X POST 'https://{subdomain}.pestroutes.com/api/region/search' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'regionIDs=1' \
  --data-urlencode 'officeIDs=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/region/getTry it

get region

Get Bulk data for region. Accepts an array of regionIDs. Returns a max of 1000 records.

Parameters

regionIDsarray

No description in the upstream reference.

Returns

regionIDsinteger

Primary key

officeIDsinteger

Office ID region belongs to

descriptionstring

Description of the region

createdstring

Time the region was created

deletedstring

Time the region was deleted

pointsstring

latitude and longitude bounding points separated by colons

typestring

No description in the upstream reference.

activestring

Active status for the region.

Request

/region/get

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

Response

success:true

]

count:2

}

by id/region/{id}Try it

Fetch by id region

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

Parameters

No parameters beyond authentication.

Returns

regionIDsinteger

Primary key

officeIDsinteger

Office ID region belongs to

descriptionstring

Description of the region

createdstring

Time the region was created

deletedstring

Time the region was deleted

pointsstring

latitude and longitude bounding points separated by colons

typestring

No description in the upstream reference.

activestring

Active status for the region.

Request

/region/{id}

curl -X POST 'https://{subdomain}.pestroutes.com/api/region/{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

regionIDs:0

officeIDs:2

description:"Sample value returned by the mock engine."

created:"sample-created"

deleted:"sample-deleted"

points:"sample-points"

type:"sample-type"

active:"sample-active"

}