Scheduling

unit

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

Read · 3

Read operations

search/unit/searchTry it

search unit

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

unitIDsinteger

Primary key.

officeIDsinteger

No description in the upstream reference.

customerIDsinteger

Customer who owns this unit

includeDatainteger

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

Returns

unitIDsarray

🏠 Home 📗 Endpoints 👨‍🏫 Examples ❔ FAQ ☀️

Request

/unit/search

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

get unit

Get Bulk data for unit. Accepts an array of unitIDs. Returns a max of 1000 records.

Parameters

unitIDsarray

No description in the upstream reference.

Returns

unitIDinteger

Unique ID

unitNamestring

Unit name (building + - + description)

buildingstring

Unit building

descriptionstring

Unit description

customerIDinteger

customerID the unit belongs to.

Request

/unit/get

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

Response

success:true

]

count:2

}

by id/unit/{id}Try it

Fetch by id unit

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

Parameters

No parameters beyond authentication.

Returns

unitIDinteger

Unique ID

unitNamestring

Unit name (building + - + description)

buildingstring

Unit building

descriptionstring

Unit description

customerIDinteger

customerID the unit belongs to.

Request

/unit/{id}

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

unitID:8850

unitName:"Quarterly Perimeter"

building:"sample-building"

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

customerID:2124

}