Work Order Problems
A problem object includes the problem description and resolution details. The table below describes each parameter in the problems results and how it maps to the Field Nation Platform.
Note: Problems can not be reported for a work order in Draft status.
Problem Object
| Parameter | Type | Example | Mapping/Notes |
|---|---|---|---|
| id | integer | "id":643 | Problem ID. Read-only. |
| zendesk_ticket_id | integer | "zendesk_ticket_id":0 | Field Nation Support Ticket ID. |
| type | object | "type":{ "id":22 } |
Report a Problem > Problem Type. Required.
Options
22 = “I can’t find a provider”, 31 = “Internal Issue with my company”, 33 = “How to/platform help”
|
| comments | string | "comments":"Can't find a provider note." | Report a Problem > Provide Explanation. Required. |
| resolution | object | "resolution":{} | Problem status and details. |
| status | string | "status":"resolved" | Resolution > Status.
Options
“open”, “resolved”
|
| at | object | "at":{} | Resolution > Date resolved. Read-only. Dates and Times. |
| by | object | "by":{} | Resolution > Resolved by User ID, First Name, and Last Name. |
| allowed_resolvers | array | "allowed_resolvers":[] | Resolution > Who can resolve.
Options
buyer, support, assigned_provider
|
| author | object | "author":{} | Problem Reporter User ID, First Name, and Last Name. |
| created | object | "created": {} | Problem Create Date. Read only. Dates and Times. |
Examples
Problem Object, I can't find a provider
{
"id":643,
"zendesk_ticket_id":0,
"type":{
"id":22,
"name":"I can't find a provider",
"other":""
},
"comments":"Can't find a provider note.",
"use_provider":false,
"only_company_can_mark_resolved":false,
"resolution":{
"status":"open",
"at":{
"utc":"",
"date":"",
"time":""
},
"by":{
"id":0,
"first_name":"",
"last_name":""
},
"allowed_resolvers":[
"buyer",
"support"
]
},
"author":{
"id":756,
"first_name":"API",
"last_name":"User"
},
"created":{
"utc":"2018-12-18 20:33:24",
"local":{
"date":"2018-12-18",
"time":"14:33:24"
}
},
"message":{
"id":643
},
"escalate":false,
"actions":[
"view_message",
"resolve",
"edit",
"delete"
]
}
Problem Object, Provider is running late
{
"id":653,
"zendesk_ticket_id":0,
"type":{
"id":2,
"name":"I'm going to be late",
"other":""
},
"comments":"Provider is running late, estimated arrival in 10 minutes.",
"use_provider":false,
"only_company_can_mark_resolved":false,
"resolution":{
"status":"open",
"at":{
"utc":"",
"date":"",
"time":""
},
"by":{
"id":0,
"first_name":"",
"last_name":""
},
"allowed_resolvers":[
"assigned_provider",
"buyer"
]
},
"author":{
"id":557,
"first_name":"Marketplace",
"last_name":"Provider"
},
"created":{
"utc":"2018-12-26 19:31:08",
"local":{
"date":"2018-12-26",
"time":"13:31:08"
}
},
"message":{
"id":653
},
"escalate":false,
"actions":[
"view_message",
"resolve"
]
}
Problem Object, Resolved
{
"id":644,
"zendesk_ticket_id":0,
"type":{
"id":31,
"name":"Internal Issue with my company",
"other":""
},
"comments":"Internal issue note.",
"use_provider":false,
"only_company_can_mark_resolved":false,
"resolution":{
"status":"resolved",
"at":{
"utc":"2018-12-18 21:07:48",
"date":"2018-12-18",
"time":"15:07:48"
},
"by":{
"id":756,
"first_name":"FieldNation",
"last_name":"User"
},
"allowed_resolvers":[
"buyer"
]
},
"author":{
"id":756,
"first_name":"API",
"last_name":"User"
},
"created":{
"utc":"2018-12-18 20:34:01",
"local":{
"date":"2018-12-18",
"time":"14:34:01"
}
},
"message":{
"id":644
},
"escalate":false,
"actions":[
"reopen"
]
}
Problems Response
The example below includes all three problem objects in the problem results.
{
"metadata": {
"total": 3,
"per_page": 4,
"page": 1,
"pages": 1
},
"correlation_id": "c5e3fcd91a4d85faf718fd6a6615a779460c84a1",
"actions": [
"add"
],
"types": [],
"results": [
{
"id": 643,
"zendesk_ticket_id": 0,
"type": {
"id": 22,
"name": "I can't find a provider",
"other": ""
},
"comments": "Can't find a provider note.",
"use_provider": false,
"only_company_can_mark_resolved": false,
"resolution": {
"status": "open",
"at": {
"utc": "",
"date": "",
"time": ""
},
"by": {
"id": 0,
"first_name": "",
"last_name": ""
},
"allowed_resolvers": [
"buyer",
"support"
]
},
"author": {
"id": 756,
"first_name": "Techdoc",
"last_name": "Admin"
},
"created": {
"utc": "2018-12-18 20:33:24",
"local": {
"date": "2018-12-18",
"time": "14:33:24"
}
},
"message": {
"id": 643
},
"escalate": false,
"actions": [
"view_message",
"resolve",
"edit",
"delete"
]
},
{
"id": 644,
"zendesk_ticket_id": 0,
"type": {
"id": 31,
"name": "Internal Issue with my company",
"other": ""
},
"comments": "Internal issue note.",
"use_provider": false,
"only_company_can_mark_resolved": false,
"resolution": {
"status": "open",
"at": {
"utc": "",
"date": "",
"time": ""
},
"by": {
"id": 0,
"first_name": "",
"last_name": ""
},
"allowed_resolvers": [
"buyer"
]
},
"author": {
"id": 756,
"first_name": "API",
"last_name": "User"
},
"created": {
"utc": "2018-12-18 20:34:01",
"local": {
"date": "2018-12-18",
"time": "14:34:01"
}
},
"message": {
"id": 644
},
"escalate": false,
"actions": [
"view_message",
"resolve",
"edit",
"delete"
]
},
{
"id": 645,
"zendesk_ticket_id": 0,
"type": {
"id": 33,
"name": "How to/platform help",
"other": ""
},
"comments": "How to/platform help note.",
"use_provider": false,
"only_company_can_mark_resolved": false,
"resolution": {
"status": "open",
"at": {
"utc": "",
"date": "",
"time": ""
},
"by": {
"id": 0,
"first_name": "",
"last_name": ""
},
"allowed_resolvers": [
"support"
]
},
"author": {
"id": 756,
"first_name": "API",
"last_name": "User"
},
"created": {
"utc": "2018-12-18 20:34:31",
"local": {
"date": "2018-12-18",
"time": "14:34:31"
}
},
"message": {
"id": 645
},
"escalate": false,
"actions": [
"view_message",
"edit",
"delete"
]
}
],
"active": {
"id": 643,
"zendesk_ticket_id": 0,
"type": {
"id": 22,
"name": "I can't find a provider",
"other": ""
},
"comments": "Can't find a provider note.",
"use_provider": false,
"only_company_can_mark_resolved": false,
"resolution": {
"status": "open",
"at": {
"utc": "",
"date": "",
"time": ""
},
"by": {
"id": 0,
"first_name": "",
"last_name": ""
},
"allowed_resolvers": [
"buyer",
"support"
]
},
"author": {
"id": 756,
"first_name": "API",
"last_name": "User"
},
"created": {
"utc": "2018-12-18 20:33:24",
"local": {
"date": "2018-12-18",
"time": "14:33:24"
}
},
"message": {
"id": 643
},
"escalate": false,
"actions": [
"view_message",
"resolve",
"edit",
"delete"
]
}
}Work Order Problems Response
You can locate problems in the work order > problems object.
"problems": { }
Work Order Problems Response
"problems":{
"metadata":{
"total":3,
"per_page":4,
"page":1,
"pages":1
},
"correlation_id":"c5e3fcd91a4d85faf718fd6a6615a779460c84a1",
"actions":[],
"types":[],
"results":[
{
"id":643,
"zendesk_ticket_id":0,
"type":{
"id":22,
"name":"I can't find a provider",
"other":""
},
"comments":"Can't find a provider note.",
"use_provider":false,
"only_company_can_mark_resolved":false,
"resolution":{
"status":"open",
"at":{
"utc":"",
"date":"",
"time":""
},
"by":{
"id":0,
"first_name":"",
"last_name":""
},
"allowed_resolvers":[
"buyer",
"support"
]
},
"author":{
"id":756,
"first_name": "API",
"last_name": "User"
},
"created":{
"utc":"2018-12-18 20:33:24",
"local":{
"date":"2018-12-18",
"time":"14:33:24"
}
},
"message":{
"id":643
},
"escalate":false,
"actions":[
"view_message",
"resolve",
"edit",
"delete"
]
}
],
"active":{
"id":643,
"zendesk_ticket_id":0,
"type":{
"id":22,
"name":"I can't find a provider",
"other":""
},
"comments":"Can't find a provider note.",
"use_provider":false,
"only_company_can_mark_resolved":false,
"resolution":{
"status":"open",
"at":{
"utc":"",
"date":"",
"time":""
},
"by":{
"id":0,
"first_name":"",
"last_name":""
},
"allowed_resolvers":[
"buyer",
"support"
]
},
"author":{
"id":756,
"first_name": "API",
"last_name": "User"
},
"created":{
"utc":"2018-12-18 20:33:24",
"local":{
"date":"2018-12-18",
"time":"14:33:24"
}
},
"message":{
"id":643
},
"escalate":false,
"actions":[
"view_message",
"resolve",
"edit",
"delete"
]
}
}