Field Operations

insect

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

Read · 3

Read operations

search/insect/searchTry it

search insect

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

insectIDsinteger

Primary key

insectIDinteger

Primary key alias

officeIDsinteger

OfficeID insect belongs to

includeDatainteger

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

Returns

insectIDsarray

No description in the upstream reference.

Request

/insect/search

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

get insect

Get Bulk data for insect. Accepts an array of insectIDs. Returns a max of 1000 records.

Parameters

insectIDsarray

No description in the upstream reference.

Returns

insectIDinteger

No description in the upstream reference.

officeIDinteger

No description in the upstream reference.

namestring

No description in the upstream reference.

familystring

No description in the upstream reference.

threatstring

No description in the upstream reference.

factstring

No description in the upstream reference.

about1string

No description in the upstream reference.

about2string

No description in the upstream reference.

Request

/insect/get

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

Response

success:true

]

count:2

}

by id/insect/{id}Try it

Fetch by id insect

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

Parameters

No parameters beyond authentication.

Returns

insectIDinteger

No description in the upstream reference.

officeIDinteger

No description in the upstream reference.

namestring

No description in the upstream reference.

familystring

No description in the upstream reference.

threatstring

No description in the upstream reference.

factstring

No description in the upstream reference.

about1string

No description in the upstream reference.

about2string

No description in the upstream reference.

Request

/insect/{id}

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

insectID:6678

officeID:2602

name:"Quarterly Perimeter"

family:"sample-family"

threat:"sample-threat"

fact:"sample-fact"

about1:"sample-about1"

about2:"sample-about2"

aboutBlurb:"sample-aboutBlurb"

funFacts:"sample-funFacts"

factBlurb:"sample-factBlurb"

image:"sample-image"

visible:0

system:2

}