Field service

Employees in the field, the tasks assigned to them, and what they report back.

Field service covers work done away from a desk: the employees who do it, the tasks and routes assigned to them, the places they visit, and the forms and check-ins they send back from site.

Task is the centre of it, and Employee is who a task is assigned to. Form and Check-ins are what comes back, and Place is where the work happens.

Operations in this section

Check-ins

Endpoint	Method	What it does
/checkin/read	POST	Read check-in
/checkin/list	POST	List check-ins
/checkin/delete	POST	Delete check-ins
/checkin/create	POST	Create check-in
/checkin/image/create	POST	Create check-in image
/checkin/form/create	POST	Create check-in form
/checkin/form/file/create	POST	Create check-in form file

Departments

Endpoint	Method	What it does
/department/list	POST	List departments
/department/create	POST	Create department
/department/update	POST	Update department
/department/delete	POST	Delete department

Employee

Endpoint	Method	What it does
/employee/list	POST	List employees
/employee/create	POST	Create employee
/employee/read	POST	Read employee
/employee/update	POST	Update employee
/employee/delete	POST	Delete employee
/employee/batch_convert	POST	Convert employee batch

Employee avatar

Endpoint	Method	What it does
/employee/avatar/assign	POST	Assign employee icon
/employee/avatar/upload	POST	Upload employee avatar

Employee import

Endpoint	Method	What it does
/employee/import/start	POST	Start employee import
/employee/import/read	POST	Read employee import
/employee/import/list	POST	List employee imports
/employee/import/download_failed	POST	Download failed employee rows

Form

Endpoint	Method	What it does
/form/read	POST	Read form
/form/download	POST	Download form

Form templates

Endpoint	Method	What it does
/form/template/list	POST	List form templates
/form/template/create	POST	Create form template
/form/template/read	POST	Read form template
/form/template/update	POST	Update form template
/form/template/delete	POST	Delete form template
/form/template/stats/read	POST	Read template usage

Place avatar

Endpoint	Method	What it does
/place/avatar/upload	POST	Upload place avatar
/place/avatar/assign	POST	Assign place icon

Place import

Endpoint	Method	What it does
/place/import/start	POST	Start POI import
/place/import/read	POST	Read POI import
/place/import/list	POST	List POI imports
/place/import/download_failed	POST	Download failed POI rows
/place/import/finish	POST	Finish POI import

Places (POI)

Endpoint	Method	What it does
/place/read	POST	Read place
/place/list	POST	List places
/place/create	POST	Create place
/place/search_location	POST	Search places by location
/place/update	POST	Update place
/place/delete	POST	Delete place
/place/batch_convert	POST	Convert place batch
/place/upload	POST	Upload places

Task

Endpoint	Method	What it does
/task/assign	POST	Assign task
/task/batch_convert	POST	Convert task batch
/task/count	POST	Count tasks
/task/create	POST	Create task
/task/delete	POST	Delete task
/task/list	POST	List tasks
/task/read	POST	Read task
/task/transmute	POST	Convert task to checkpoint
/task/update	POST	Update task

Checkpoints

Endpoint	Method	What it does
/task/checkpoint/create	POST	Create checkpoint
/task/checkpoint/delete	POST	Delete checkpoint
/task/checkpoint/list	POST	List checkpoints
/task/checkpoint/read	POST	Read checkpoint
/task/checkpoint/transmute	POST	Convert checkpoint to task
/task/checkpoint/update	POST	Update checkpoint

Task history

Endpoint	Method	What it does
/task/history/list	POST	List task history

Form

Endpoint	Method	What it does
/task/form/create	POST	Attach form to task
/task/form/delete	POST	Delete task form
/task/form/download	POST	Download task form
/task/form/list	POST	List forms
/task/form/read	POST	Read task form

Task form files

Endpoint	Method	What it does
/task/form/file/create	POST	Create form file

Task form values

Endpoint	Method	What it does
/task/form/values/update	POST	Update form values

Route

Endpoint	Method	What it does
/task/route/assign	POST	Assign route
/task/route/create	POST	Create route
/task/route/delete	POST	Delete route
/task/route/list	POST	List routes
/task/route/read	POST	Read route
/task/route/update	POST	Update route

Route optimization

Endpoint	Method	What it does
/task/route/points/optimize	POST	Optimize route points

Schedule

Endpoint	Method	What it does
/task/schedule/create	POST	Create task schedule
/task/schedule/delete	POST	Delete task schedule
/task/schedule/list	POST	List task schedules
/task/schedule/read	POST	Read task schedule
/task/schedule/update	POST	Update task schedule

Task schedule checkpoints

Endpoint	Method	What it does
/task/schedule/checkpoint/delete	POST	Delete schedule checkpoint
/task/schedule/checkpoint/transmute	POST	Convert schedule checkpoint to task

Schedule proposals

Endpoint	Method	What it does
/task/schedule/proposal/list	POST	List schedule proposals

Route schedules

Endpoint	Method	What it does
/task/schedule/route/create	POST	Create route schedule
/task/schedule/route/delete	POST	Delete route schedule
/task/schedule/route/update	POST	Update route schedule