Requests by Work Order
Gets a paginated list of Providers > Pending assignment. This list includes routed providers and provider requests.
URLs
| Environment | Method | URL |
|---|---|---|
| Sandbox | https://api-sandbox.fndev.net/api/rest/v2/workorders/work_order_id/providers | |
| Production | https://api.fieldnation.com/api/rest/v2/workorders/work_order_id/providers |
Path Parameters
| Parameter | Type | Example | Notes |
|---|---|---|---|
| work_order_id | integer | 1753 | Work Order ID. |
Query Parameters
Refer to Pagination for a list of additional query parameters.
| Parameter | Type | Example | Notes |
|---|---|---|---|
| access_token | string | abc123defg459hijk786lmn45 | Required. |
| list | string | &list=find_providers_pending_assignment | Provider List Type. Required. |
Body
Not applicable.
Response
You can locate provider information in the Response > results object. Refer to Pagination for more information.
Examples
For provider requests, has_request is true and includes a request object. Routed providers include a route object.
Provider Request
{
"actions": [
"selection_rule"
],
"metadata": {
"total": 1,
"page": 1,
"pages": 1,
"per_page": 25,
"columns": "w2,correlation_id,routable,marketplace,worked_with,has_request,managed,route,previous_request,request,can_request,selection_rule,provider_scoring",
"view": "model",
"sort": "",
"order": "asc",
"list": "find_providers_pending_assignment"
},
"params": [],
"lists": [],
"results": [
{
"id": 557,
"w2": false,
"correlation_id": "eb1899be0f2f15d3a0add331c0d6afbd6faeab38",
"routable": true,
"marketplace": true,
"worked_with": false,
"has_request": true,
"managed": false,
"request": {
"id": 107,
"schedule": {
"eta": {
"mode": "exact",
"start": {
"utc": "",
"local": {
"date": "",
"time": ""
}
},
"end": {
"utc": "",
"local": {
"date": "",
"time": ""
}
},
"hour_estimate": "0"
}
},
"counter_notes": "",
"counter": false,
"work_order": {
"id": 4047
},
"user": {
"id": 557
},
"notes": "Provider request example.",
"hour_estimate": 2,
"expires": {
"utc": "2018-12-26 22:47:13",
"local": {
"date": "2018-12-26",
"time": "16:47:13"
}
},
"pay": {
"type": "",
"term": {
"id": 0,
"explanation": ""
},
"base": {
"amount": 0,
"units": 0
},
"additional": {
"amount": 0,
"units": 0
},
"labor_sum": 0,
"max_pay": 0
},
"active": true,
"expired": false,
"created": {
"utc": "2018-12-26 22:17:13",
"local": {
"date": "2018-12-26",
"time": "16:17:13"
}
},
"type": 1,
"arrival": {
"utc": "2019-01-02 19:00:00",
"local": {
"date": "2019-01-02",
"time": "13:00:00"
}
},
"expenses": {
"results": [],
"total": 0,
"pending": 0
}
},
"can_request": true,
"selection_rule": {
"id": false,
"is_match": false,
"points": 175,
"is_default": true,
"criterion": [
{
"id": 1,
"weight": 150,
"name": "Work orders completed (Automated Teller Machine (ATM))",
"is_required": true,
"can_remote": false,
"points": 0,
"width": "28%",
"status": "no_match_required",
"order": 3,
"is_match": false
},
{
"id": 2,
"weight": 100,
"name": "Worked with your company before",
"is_required": false,
"can_remote": true,
"points": 0,
"width": "18%",
"status": "no_match_preferred",
"order": 2,
"is_match": false
},
{
"id": 3,
"weight": 75,
"name": "Provider cancel rate",
"is_required": true,
"can_remote": true,
"points": 75,
"width": "14%",
"status": "match",
"order": 1,
"is_match": true
},
{
"id": 4,
"weight": 60,
"name": "Provider block rate",
"is_required": true,
"can_remote": true,
"points": 60,
"width": "11%",
"status": "match",
"order": 1,
"is_match": true
},
{
"id": 5,
"weight": 45,
"name": "Provider rating",
"is_required": true,
"can_remote": true,
"points": 0,
"width": "8%",
"status": "no_match_required",
"order": 3,
"is_match": false
},
{
"id": 6,
"weight": 40,
"name": "Member of a preferred group",
"is_required": false,
"can_remote": true,
"points": 40,
"width": "7%",
"status": "match",
"order": 1,
"is_match": true
},
{
"id": 7,
"weight": 35,
"name": "Background check",
"is_required": false,
"can_remote": false,
"points": 0,
"width": "6%",
"status": "no_match_preferred",
"order": 2,
"is_match": false
},
{
"id": 8,
"weight": 25,
"name": "Distance from work address",
"is_required": false,
"can_remote": false,
"points": 0,
"width": "4%",
"status": "no_match_preferred",
"order": 2,
"is_match": false
}
],
"max_points": 530
},
"provider_scoring": {
"is_recommended": false,
"is_new_connection": false,
"provider_score": 0
},
"category": {
"id": "request",
"label": "Requested",
"sub_label": "Can be immediately assigned pending your review"
},
"actions": [
"message",
"assign",
"hide"
]
}
],
"selection_rule_id": 0,
"f_range": 100,
"correlation_id": "find_providers",
"confidence_scoring_enabled": false
}
Routed Provider
{
"actions": [
"selection_rule"
],
"metadata": {
"total": 1,
"page": 1,
"pages": 1,
"per_page": 25,
"columns": "w2,correlation_id,routable,marketplace,worked_with,has_request,managed,route,previous_request,request,can_request,selection_rule,provider_scoring",
"view": "model",
"sort": "",
"order": "asc",
"list": "find_providers_pending_assignment"
},
"params": [],
"lists": [],
"results": [
{
"id": 557,
"w2": false,
"correlation_id": "eb1899be0f2f15d3a0add331c0d6afbd6faeab38",
"routable": true,
"marketplace": true,
"worked_with": false,
"has_request": false,
"managed": false,
"route": {
"id": 417,
"author": {
"id": 756,
"first_name": "API",
"last_name": "User"
},
"created": {
"utc": "2018-12-13",
"local": {
"date": "2018-12-13",
"time": "16:11:19"
}
},
"schedule": {
"eta": {
"start": {
"utc": "",
"local": {
"date": "",
"time": ""
}
},
"end": {
"local": {
"time": "",
"date": ""
},
"utc": ""
}
}
},
"type": 5
},
"can_request": true,
"selection_rule": {
"id": false,
"is_match": false,
"points": 175,
"is_default": true,
"criterion": [
{
"id": 1,
"weight": 150,
"name": "Work orders completed (Automated Teller Machine (ATM))",
"is_required": true,
"can_remote": false,
"points": 0,
"width": "28%",
"status": "no_match_required",
"order": 3,
"is_match": false
},
{
"id": 2,
"weight": 100,
"name": "Worked with your company before",
"is_required": false,
"can_remote": true,
"points": 0,
"width": "18%",
"status": "no_match_preferred",
"order": 2,
"is_match": false
},
{
"id": 3,
"weight": 75,
"name": "Provider cancel rate",
"is_required": true,
"can_remote": true,
"points": 75,
"width": "14%",
"status": "match",
"order": 1,
"is_match": true
},
{
"id": 4,
"weight": 60,
"name": "Provider block rate",
"is_required": true,
"can_remote": true,
"points": 60,
"width": "11%",
"status": "match",
"order": 1,
"is_match": true
},
{
"id": 5,
"weight": 45,
"name": "Provider rating",
"is_required": true,
"can_remote": true,
"points": 0,
"width": "8%",
"status": "no_match_required",
"order": 3,
"is_match": false
},
{
"id": 6,
"weight": 40,
"name": "Member of a preferred group",
"is_required": false,
"can_remote": true,
"points": 40,
"width": "7%",
"status": "match",
"order": 1,
"is_match": true
},
{
"id": 7,
"weight": 35,
"name": "Background check",
"is_required": false,
"can_remote": false,
"points": 0,
"width": "6%",
"status": "no_match_preferred",
"order": 2,
"is_match": false
},
{
"id": 8,
"weight": 25,
"name": "Distance from work address",
"is_required": false,
"can_remote": false,
"points": 0,
"width": "4%",
"status": "no_match_preferred",
"order": 2,
"is_match": false
}
],
"max_points": 530
},
"provider_scoring": {
"is_recommended": false,
"is_new_connection": false,
"provider_score": 0
},
"category": {
"id": "routed",
"label": "Routed",
"sub_label": "The first to accept the route will immediately be assigned the work order"
},
"actions": [
"message",
"un_route"
]
}
],
"selection_rule_id": 0,
"f_range": 100,
"correlation_id": "find_providers",
"confidence_scoring_enabled": false
}