Field Operations

employee

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

Read · 3

search get by id

Write · 2

create update

Destructive · 1

dealias

Read operations

search/employee/searchTry it

search employee

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

No description in the upstream reference.

activeinteger

'Active': 1 or 'Inactive': 0

employeeIDsinteger

Unique Identifier

employeeIDinteger

Unique Identifier

yearsExperienceinteger

How many years this employee has in experience. Typically used for sales reps to distinguish between rookies and seasoned.

lnamestring

Employee's last name

fnamestring

Employee's first name

typeinteger

Employee type. 0: Office Staff, 1: Technician, 2: Sales Rep

Returns

employeeIDsarray

No description in the upstream reference.

Request

/employee/search

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

get employee

Get Bulk data for employee. Accepts an array of employeeIDs. Returns a max of 1000 records.

Parameters

employeeIDsarray

No description in the upstream reference.

Returns

employeeIDinteger

Unique Identifier

officeIDinteger

Office ID this employee belongs to

activeinteger

0: Inactive account, 1: Active account

fnamestring

Employee's first name

lnamestring

Employee's last name

initialsstring

Employee's name initials -- user defined in case of duplicate's

nicknamestring

Employee's nickname

typeinteger

Employee type. 0: Office Staff, 1: Technician, 2: Sales Rep

Request

/employee/get

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

Response

success:true

]

count:2

}

by id/employee/{id}Try it

Fetch by id employee

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

Parameters

No parameters beyond authentication.

Returns

employeeIDinteger

Unique Identifier

officeIDinteger

Office ID this employee belongs to

activeinteger

0: Inactive account, 1: Active account

fnamestring

Employee's first name

lnamestring

Employee's last name

initialsstring

Employee's name initials -- user defined in case of duplicate's

nicknamestring

Employee's nickname

typeinteger

Employee type. 0: Office Staff, 1: Technician, 2: Sales Rep

Request

/employee/{id}

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

employeeID:5916

officeID:2602

active:1

fname:"Dana"

lname:"Reyes"

initials:"sample-initials"

nickname:"Quarterly Perimeter"

type:0

phone:"5558675309"

email:0

username:"Quarterly Perimeter"

experience:1

pic:"sample-pic"

linkedEmployeeIDs:1

employeeLink:"sample-employeeLink"

licenseNumber:"sample-licenseNumber"

supervisorID:6454

roamingRep:2

teamIDs:0

primaryTeam:0

}

Write operations

create/employee/createTry it

create employee

Create a new employee.

Parameters

typeinteger

0: office staff, 1: technician, 2: salesman fname - string - required Employee first name. lname - string - required Employee last name.

phonestring

Employee phone.

emailstring

Employee email.

usernamestring

passwordstring

roamingRepinteger

EmployeeID of the master account. If a non-master account is selected, that account's master rep will be used instead.

roamingMasterinteger

Set as 1 to specify that the user is a roaming master account. This setting will override roamingRep.

employeeLinkstring

Employee's Link

Returns

Returns a success acknowledgement.

Request

/employee/create

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

Response

success:true

employeeID:4821

}

update/employee/updateTry it

update employee

Update an employee.

Parameters

typeinteger

0: office staff, 1: technician, 2: salesman

fnamestring

Employee first name.

lnamestring

Employee last name.

phonestring

Employee phone.

emailstring

Employee email.

usernamestring

passwordstring

roamingRepinteger

EmployeeID of the master account. If a non-master account is selected, that account's master rep will be used instead.

Returns

Returns a success acknowledgement.

Request

/employee/update

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

Response

success:true

employeeID:4821

}

Destructive operations

dealias/employee/dealiasTry it

dealias employee

Find the employeeIDs associated with this employeeID or link

Parameters

employeeIDinteger

Primary key of the employee

employeeLinkinteger

External key of the employee

activeinteger

active property of the employee 0: inactive 1: active

useBothKeysinteger

Send as 1 to join on both roamingRep and employeeLink relationship

Returns

Returns a success acknowledgement.

Request

/employee/dealias

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

Response

success:true

employeeID:4821

}