POST Agents/Diagnostics/GetSystemMessages

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Diagnostics/GetSystemMessages

Retrieves a list of system messages for a specific associate.

Query String Parameters

Parameter Name Type Description
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. 
POST /api/v1/Agents/Diagnostics/GetSystemMessages?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

AssociateId

Property Name Type Description
AssociateId Integer

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
MessageId int32 Primary key
AssociateId int32 The associate that is the target of this message
OnlineappId int32 The online app that owns this message
SystemMessageId string Message identifier, used for message update or removal
MarkdownMessage string Markdown message to be displayed to user
Expire date-time The date and time the message expires in UTC.
Type string Type of message, example: info, warning, error
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Diagnostics/GetSystemMessages
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv
Content-Type: application/json; charset=utf-8

{
  "AssociateId": 914
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "MessageId": 637,
    "AssociateId": 947,
    "OnlineappId": 222,
    "SystemMessageId": "ullam",
    "MarkdownMessage": "quia",
    "Expire": "2009-03-26T17:54:02.9452152+01:00",
    "Type": "Error",
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.String",
        "FieldLength": 557
      }
    }
  }
]