Field Operations

team

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

Read · 3

Read operations

search/team/searchTry it

search team

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

teamIDinteger

Unique Identifier

officeIDsinteger

No description in the upstream reference.

namestring

Team Name

typeinteger

Team type. 0: Office Team, 2: Sales Team

teamLeaderinteger

Employee ID of the team leader

employeeIDsinteger

Employee IDs of team members

includeDatainteger

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

Returns

teamIDsarray

No description in the upstream reference.

Request

/team/search

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

get team

Get Bulk data for team. Accepts an array of teamIDs. Returns a max of 1000 records.

Parameters

teamIDsarray

No description in the upstream reference.

Returns

teamIDinteger

Unique Identifier

officeIDinteger

Office ID this team belongs to

namestring

Team name

teamLeaderinteger

Team Leader ID

employeeIDsinteger

Employee IDs of team members

Request

/team/get

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

Response

success:true

]

count:2

}

by id/team/{id}Try it

Fetch by id team

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

Parameters

No parameters beyond authentication.

Returns

teamIDinteger

Unique Identifier

officeIDinteger

Office ID this team belongs to

namestring

Team name

teamLeaderinteger

Team Leader ID

employeeIDsinteger

Employee IDs of team members

Request

/team/{id}

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

teamID:6955

officeID:2602

name:"Quarterly Perimeter"

teamLeader:1

employeeIDs:1

}