Auto-Dispatch
Auto-dispatches a group of work orders. Includes selection rule, strategy, and duration (in seconds).
URLs
| Environment | Method | URL |
|---|---|---|
| Sandbox | https://api-sandbox.fndev.net/api/rest/v2/workorders/auto_dispatch | |
| Production | https://api.fieldnation.com/api/rest/v2/workorders/auto_dispatch |
Path Parameters
Not applicable.
Query Parameters
| Parameter | Type | Example | Notes |
|---|---|---|---|
| access_token | string | abc123defg459hijk786lmn45 | Required. |
Body Parameters
| Parameter | Type | Example | Mapping/Notes |
|---|---|---|---|
| selection_rule_id | integer | "selection_rule_id":254 | Auto-dispatch > Selection rule. Include 0 for Default ranking. |
| should_route | conditional | "should_route":false | Auto-dispatch > Strategy. Include false to 'Publish and assign to most qualified request.' Include "1" to 'Route and assign to the first to accept.' |
| delay | string | "delay":"900" | Auto-dispatch > Duration. 5 minutes to 1 week. |
| work_order_ids | array | "work_order_ids":[] | List of work order ids to auto-dispatch. |
Examples
Response
Returns the auto-dispatch worker id and dispatch information.