Scheduling

serviceType

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

Read · 3

Read operations

search/serviceType/searchTry it

search serviceType

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

officeIDsinteger

Office Unique Identifier

typeIDsinteger

Service Type Unique Identifier

descriptionstring

Description of the Service Type

categorystring

Category of the Service Type

reserviceinteger

Service is a reservice type

includeDatainteger

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

Returns

serviceTypeIDsarray

No description in the upstream reference.

Request

/serviceType/search

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

get serviceType

Get Bulk data for serviceType. Accepts an array of typeIDs. Returns a max of 1000 records.

Parameters

typeIDsarray

No description in the upstream reference.

Returns

typeIDinteger

Unique Identifier

officeIDinteger

Office ID this service type belongs to, it will be -1 if it is a Global service type

descriptionstring

Service type description

frequencyinteger

Service Type Frequecy. (-1 when it is As need, 0 when it is One Time, -3 when it is Custom Schedule)

defaultChargedouble

Service type default charge

categorystring

Service type category

reserviceinteger

Service is a reservice type

defaultLengthinteger

Default appointment duration in minutes

Request

/serviceType/get

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

Response

success:true

]

count:2

}

by id/serviceType/{id}Try it

Fetch by id serviceType

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

Parameters

No parameters beyond authentication.

Returns

typeIDinteger

Unique Identifier

officeIDinteger

Office ID this service type belongs to, it will be -1 if it is a Global service type

descriptionstring

Service type description

frequencyinteger

Service Type Frequecy. (-1 when it is As need, 0 when it is One Time, -3 when it is Custom Schedule)

defaultChargedouble

Service type default charge

categorystring

Service type category

reserviceinteger

Service is a reservice type

defaultLengthinteger

Default appointment duration in minutes

Request

/serviceType/{id}

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

typeID:8552

officeID:2602

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

frequency:2

defaultCharge:98.5

category:"sample-category"

reservice:0

defaultLength:1

defaultInitialCharge:132.5

initialID:2098

minimumRecurringCharge:176.5

minimumInitialCharge:15.5

regularService:1

initial:2

glAccountID:1590

}