Navigation :

Messages

A message object returns a paginated list of messages sorted by date created descending. From the Field Nation Platform, you can locate messages in the Work Order > Messages tab. The table below describes each parameter in the message results and how it maps to the Field Nation app.

Note: Updating and deleting messages from the API is not supported. You can add message replies.

Message Object

Parameter	Type	Example	Mapping/Notes
from	object	"from": {}	User info for the message creator. Read-only. Defaults to the API User ID.
msg_id	string	"msg_id": "612"	Message ID. Read-only.
created	object	"created": {}	Create Date. Read only. Dates and Times.
message	string	"message": "This is an example message."	Message text. Does not support HTML.
replies	array	"replies": []	Array of message replies.
name	string	"name":"other"	Shipments > Carrier. Options “ups”, “fedex”, “usps”, “other”
notify	array	"notify":[776, 756]	Messages > Notify company users. User ids to notify. Write-only (does not return in message object). Used to create sharedText.
sharedText	integer	"sharedText": "Your Company"	Messages > Notify company users. Read-only.

Examples

Message Object, No Replies

{
    "actions": [
        "add",
        "messageCompany"
    ],
    "correlation_id": "d39da892d3e8084bc9293217be0d78bc725dbb0a",
    "metadata": {
        "total": 3,
        "page": 1,
        "pages": 1,
        "per_page": 250,
        "columns": "from,to,date,content,message,read,created,actions,problem,base",
        "view": "model",
        "sort": "",
        "order": "asc"
    },
    "params": [],
    "f_work_order": [
        true,
        1731
    ],
    "fs_work_order": true,
    "f_only_workorder": false,
    "fs_only_workorder": true,
    "results": [
        {
            "from": {
                "id": 756,
                "name": "API User",
                "thumbnail": "/images/missing-profile.png",
                "hideWoManager": false,
                "msgLink": "/workorders/1731/messages",
                "role": null
            },
            "role": null,
            "msg_id": "612",
            "parent_id": "0",
            "read": true,
            "created": {
                "utc": "2018-12-17 18:50:10",
                "local": {
                    "date": "2018-12-17",
                    "time": "11:50:10"
                }
            },
            "message": "This is an example message.",
            "problem": [],
            "actions": [
                "add",
                "canReply"
            ],
            "replies": [],
            "sharedText": "Your Company"
        }
    ]
}

Work Order Message Response

The work order > messages object displays only the total message count. To return message details, refer to Messages by Work Order.

"messages": { }

Work Order Message Response

"messages": {
    "metadata": {
        "total": 6,
        "per_page": 0,
        "pages": 1,
        "page": 1
    },
    "actions": [
        "add"
    ],
    "results": [],
    "correlation_id": "2b08b48c304be61ee2ff6e16cd9caa09eba17757"
}