Scheduling

group

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

Read · 3

search get by id

Write · 2

create update

Read operations

search/group/searchTry it

search group

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

groupIDsinteger

Primary key

groupIDinteger

Primary key alias

officeIDsinteger

Office ID region belongs to

includeDatainteger

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

Returns

groupIDsarray

No description in the upstream reference.

Request

/group/search

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

get group

Get Bulk data for group. Accepts an array of groupIDs. Returns a max of 1000 records.

Parameters

groupIDsarray

No description in the upstream reference.

Returns

groupIDinteger

No description in the upstream reference.

Request

/group/get

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

Response

success:true

]

count:2

}

by id/group/{id}Try it

Fetch by id group

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

Parameters

No parameters beyond authentication.

Returns

groupIDinteger

No description in the upstream reference.

Request

/group/{id}

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

groupID:1709

}

Write operations

create/group/createTry it

create group

create a group

Parameters

datestring

Date to create for

templateIDinteger

templateID from office software

titlestring

Title string (30 character limit)

Returns

Returns a success acknowledgement.

Request

/group/create

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

Response

success:true

groupID:4821

}

update/group/updateTry it

update group

Update group details

Parameters

titlestring

Title string (30 character limit) groupID - integer - required Primary key to the group table.

Returns

Returns a success acknowledgement.

Request

/group/update

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

Response

success:true

groupID:4821

}