Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

count

Total events (aka traces).

integer

items

Array of events

object[]

canAdd

Boolean. If true then the connected user has the right to add a new message to the order.

bool

Each element in items is an object with these properties:

...

pid

The user (person) who triggered the event or trace.

If the an event is triggered by the system and not a user then this property is null as well as all other properties below, it will impersonate the platform administrator.

integer?

pfname

User first name.

string (*)

plname

User last name.

string (*)

cid

User’s company ID.

integer ?(*)

cname

User’s company name.

string (*)

(*) If the user (pid) has been deleted then all other properties above are null.

EXAMPLE

An example for typical events in an order:

Code Block
{
    "count": 16,
    "items": [
        {
            "date": "2022-11-11T14:48:36.517Z",
            "message": "Thank you for this information",
            "status": 2,
            "statust": "In progress",
            "deadline": "2022-10-28T11:00:00Z",
            "sender": {
                "pid": 201,
                "pfname": "Marcus",
                "plname": "Leen",
                "cid": 76,
                "cname": "Henderson Inc"
            }
        },
        {
            "date": "2022-11-11T14:31:14.183Z",
            "message": "We will deliver tomorrow, a day earlier :-)",
            "status": 2,
            "statust": "In progress",
            "deadline": "2022-10-28T11:00:00Z",
            "sender": {
                "pid": 562,
                "pfname": "John",
                "plname": "Mann",
                "cid": 537,
                "cname": "Translation Profis"
            }
        }
    ],
    "canAdd": true
}

ACCESS RIGHTS

This method is available to any user (clients, internal users) who has access to the given order online.

...