Customers & Sales

genericFlag

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

Read · 3

Read operations

search/genericFlag/searchTry it

search genericFlag

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

genericFlagIDsinteger

No description in the upstream reference.

officeIDsinteger

No description in the upstream reference.

codestring

No description in the upstream reference.

descriptionstring

No description in the upstream reference.

statusinteger

No description in the upstream reference.

typestring

No description in the upstream reference.

includeDatainteger

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

Returns

genericFlagIDsarray

No description in the upstream reference.

Request

/genericFlag/search

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

get genericFlag

Get Bulk data for genericFlag. Accepts an array of genericFlagIDs. Returns a max of 1000 records.

Parameters

genericFlagIDsarray

No description in the upstream reference.

Returns

genericFlagIDinteger

Unique Identifier

officeIDsinteger

Alias for officeID.

officeIDinteger

No description in the upstream reference.

codestring

No description in the upstream reference.

descriptionstring

No description in the upstream reference.

statusinteger

No description in the upstream reference.

typestring

No description in the upstream reference.

Request

/genericFlag/get

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

Response

success:true

]

count:2

}

by id/genericFlag/{id}Try it

Fetch by id genericFlag

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

Parameters

No parameters beyond authentication.

Returns

genericFlagIDinteger

Unique Identifier

officeIDsinteger

Alias for officeID.

officeIDinteger

No description in the upstream reference.

codestring

No description in the upstream reference.

descriptionstring

No description in the upstream reference.

statusinteger

No description in the upstream reference.

typestring

No description in the upstream reference.

Request

/genericFlag/{id}

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

genericFlagID:8433

officeIDs:2

officeID:2602

code:"sample-code"

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

status:2

type:"sample-type"

}