Configuration & Audit

office

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

Read · 3

Read operations

search/office/searchTry it

search office

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

officeIDinteger

Primary Key

companyIDinteger

companyID of the office

includeDatainteger

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

Returns

officeIDsarray

No description in the upstream reference.

Request

/office/search

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

get office

Get Bulk data for office. Accepts an array of officeIDs. Returns a max of 1000 records.

Parameters

officeIDsarray

No description in the upstream reference.

Returns

officeIDinteger

Primary Key

officeNamestring

Description of the product

companyIDinteger

companyID of the office

Request

/office/get

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

Response

success:true

]

count:2

}

by id/office/{id}Try it

Fetch by id office

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

Parameters

No parameters beyond authentication.

Returns

officeIDinteger

Primary Key

officeNamestring

Description of the product

companyIDinteger

companyID of the office

Request

/office/{id}

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

officeID:2602

officeName:"Quarterly Perimeter"

companyID:1291

}