Work Orders
A work order object includes all of the work order details, routing, and payment information available from the Field Nation Platform. Most parameters provide a separate endpoint, allowing you to manage individual work order components from Draft to completion. The table below describes each parameter and how it maps to the Field Nation app. It also includes links to additional work order endpoints.
Work Order Object
| Parameter | Type | Example | Mapping/Notes |
|---|---|---|---|
| title | string | "title": "Fix Copier on 2nd Floor" | Overview > Title. Required. To create a work order in draft, the title is the only requirement. |
| require_gps | boolean | "require_gps": true | Overview > Require GPS. Optional. |
| incident_id | string | "incident_id": "54321" | Job Summary > Incident/Site ID. Optional. Creates a new Incident/Site ID to associate a new work order or site with a unique identifier. |
| site_revisit | object |
"site_revisit": { "job_status": "incomplete", "revisit_count": 3, "incomplete_reason": { "reason_id": 8, "reason_name": "Incorrect part provided" }, }, |
Job Summary > Revisits. Optional. job_status > Indicates whether the work order's full scope was completed by the provider. incomplete_reason > Required if job_status is incomplete, explaining why the provider could not complete the work order. reason_name is a string. Optional if job_status is complete. revisit_count > Tracks the number of repeat check-ins for revisits. Can be edited or deleted by the buyer. Optional. |
| type_of_work | object | "type_of_work":{ "id":76 } |
Overview > Work Type. Refer to Get Types of Work to return a work type list.
Warning: The support of type_of_work will be deprecated in the future and we encourage you to use types_of_work instead. |
| types_of_work | array of objects |
"types_of_work":[ { "id":146, "isPrimary" : true, }, { "id":127, "isPrimary" : false, } ], |
Overview > Work Type. Refer to Get Types of Work to return a work type list. |
| service_types | array of objects |
"service_types": [ { "id": 10, "name": "Installation" } ], |
Overview > Service Types. Service types are dependent on work types, so you cannot send in a service type without a work type, but you can send in a work type alone. However, in order to use auto-dispatch, service type has to be included. |
| service_types_new | array of objects |
"service_types_new": [ { "id": 10, "name": "Installation" } ], |
Overview > Service Types New. Service Types are dependent on Work Types - “service_types_new” will eventually be the only service type option as we depreciate the original “service_types” in the future. Please use this field for any new integration set ups. |
| client | object | Clients | Setup > Client. Optional. To return a list of client ids and names, refer to Get Clients and Projects. |
| project | object | Projects | Setup > Project. Optional. To return a list of project ids and names, refer to Get Projects. |
| manager | object | "manager": { "id": 776 } |
Contacts > Who will own this work order? Defaults to the API username if omitted. Has to be a Field Nation user. Refer to Get Managers to return a list of manager ids and names. |
| custom_fields | object | Custom Fields | Custom Buyer and Provider fields. Refer to Custom Fields for more information. |
| contacts | object | Contacts | Contacts > site/location contacts. Refer to Contacts for more information. |
| description | object | "description":{ "html":"<p>copier is displaying error code <b>206</b>.</p>" }, |
Description > Public Info (Unassigned). html can be standard text or HTML (not HTML encoded tags). |
| confidential | object | "confidential":{ "html":"If you have any issues, ask for Jim at the front desk." }, |
Description > Confidential Info (Assigned). Optional. html can be standard text or HTML (not HTML encoded tags). |
| tasks | object | Tasks | Tasks. Refer to Tasks for more information. |
| location | object | Locations | Location. Refer to Locations for location options and examples. |
| schedule | object | Schedules | Schedule. Refer to Schedules for schedule options and examples. |
| pay | object | Pay | Payment. Refer to Pay and Pay Rates for options and examples. |
| shipments | object | Shipments | Shipments. Refer to Shipments for more information. |
| status | object | Work Order Status | Flightboard Status. Refer to Work Order Status for more information. |
| messages | object | Messages | Work Order > Messages tab. Refer to Messages for more information. |
| tags | object | Work Order Tags | Work Order > TAGS. Refer to Tags for more information. |
| problems | object | Work Order Problems | Work Order > REPORT PROBLEM. Refer to Problems for more information. |
| attachments | object | Attachments | Work Order > Client Documents and Deliverables. Refer to Attachments for more information. |
| time_logs | object | Time Logs | Work Order Details > Tasks. Refer to Time Logs for more information. |
| eta | object | ETA | Provider ETA information. Refer to ETA for more information. |
| integration | object | "integration": { "id": "12345", "name": "REST", "href": "http://external-site.com/ticket/{id}" } |
Work Order > Overview > Integration. Optional. Used to display a link to an external site. id must be unique and name must be set to "REST." |
| auto-dispatch | boolean | "auto_dispatch": true | Required in order to use auto-dispatch, even if selection rule is set on the template or project. |
Work Order Response
Here's a sample JSON response that's trimmed to display all of the work order parameters. Refer to the table above for details.
{
"id": 1728,
"require_gps": true,
"networks": {},
"attachments": {},
"shipments": {},
"signatures": {},
"time_logs": {},
"problems": {},
"pay": {},
"publish_stats": {},
"requests": {},
"allow_counter_offers": true,
"is_user_declined": false,
"routes": {},
"custom_fields": {},
"qualifications": {},
"ratings": {},
"bundle": {},
"auto_dispatch_stats": {},
"schedule": {},
"conflicts": [],
"eta": {},
"location": {},
"holds": {},
"company": {},
"manager": {},
"w2": false,
"import_id": 0,
"printable": true,
"status": {},
"messages": {},
"assignee": {},
"tags": {},
"contacts": {},
"tasks": {},
"swaps": {},
"service_types": [],
"service_types_new": [],
"description": {},
"confidential": {},
"policy_and_procedures": {},
"standard_instructions": {},
"progress": {},
"role": {},
"workflow_completion": {},
"work_order_id": 1728,
"actions": [],
"title": "Fix Copier on 2nd Floor",
"correlation_id": "6a54a835bb274d3b69c9fb9b9f3e95059e9765c5",
"href": "https://ui-sandbox.fndev.net/workorders/1728",
"type_of_work": {},
"closing_notes": "",
"tasks_enabled": true,
"workflow_publish_or_route": {},
"workflow_cancel": {},
"auto_dispatch": true
}