< Back to main page

GET {who}/Messages?language={language}

Gets all messages for the given 'who'. These can optionally be retrieved in the language specified.

Request Information

Parameters

NameDescriptionAdditional information
who Who to retrieve messages for. Valid values are "my", or an organization number of an organization the user can represent, or <Reportee.ReporteeId>, where the identified reportee may be a person or organization.

Define this parameter in the request URI.
queryOptions The supplied ODataQueryOptions (if any).

None.
language Translation of messages retrieved, valid values are: 1033 (English), 1044 (Bokmal) and 2068 (Nynorsk) This is an optional parameter, defaults to the user preset language.

Define this parameter in the request URI.

Response Information

All messages for the requested user.

Response body formats

application/hal+xml

Sample:

Sample not available.

application/hal+json

Sample: 
{
  "_links": {
    "self": {
      "href": "sample string 63"
    }
  },
  "_embedded": {
    "sample string 20": [
      {
        "MessageId": "sample string 16",
        "OriginalId": "sample string 62",
        "Subject": "sample string 29",
        "Status": "sample string 36",
        "MarkedUnread": true,
        "LastChangedDateTime": "2024-04-26T13:31:24.7347718+02:00",
        "CreatedDate": "2024-04-26T13:31:24.7347718+02:00",
        "LastChangedBy": "sample string 18",
        "ServiceOwner": "sample string 23",
        "Type": "sample string 12",
        "MessageSender": "sample string 68",
        "Summary": "sample string 11",
        "Body": "sample string 49",
        "ServiceCode": "sample string 45",
        "ServiceEdition": 16,
        "SignatureSpec": {
          "FormIds": [
            1,
            2,
            3
          ],
          "AttachmentIds": [
            1,
            2,
            3
          ]
        },
        "DueDate": "2024-04-26T13:31:24.7347718+02:00",
        "AvailableAction": 0,
        "ArchiveReference": "sample string 72",
        "ReplyOptions": [
          {
            "Type": "sample string 90",
            "URL": "sample string 0",
            "Text": "sample string 31"
          },
          {
            "Type": "sample string 90",
            "URL": "sample string 0",
            "Text": "sample string 31"
          },
          {
            "Type": "sample string 90",
            "URL": "sample string 0",
            "Text": "sample string 31"
          }
        ]
      },
      {
        "MessageId": "sample string 16",
        "OriginalId": "sample string 62",
        "Subject": "sample string 29",
        "Status": "sample string 36",
        "MarkedUnread": true,
        "LastChangedDateTime": "2024-04-26T13:31:24.7347718+02:00",
        "CreatedDate": "2024-04-26T13:31:24.7347718+02:00",
        "LastChangedBy": "sample string 18",
        "ServiceOwner": "sample string 23",
        "Type": "sample string 12",
        "MessageSender": "sample string 68",
        "Summary": "sample string 11",
        "Body": "sample string 49",
        "ServiceCode": "sample string 45",
        "ServiceEdition": 16,
        "SignatureSpec": {
          "FormIds": [
            1,
            2,
            3
          ],
          "AttachmentIds": [
            1,
            2,
            3
          ]
        },
        "DueDate": "2024-04-26T13:31:24.7347718+02:00",
        "AvailableAction": 0,
        "ArchiveReference": "sample string 72",
        "ReplyOptions": [
          {
            "Type": "sample string 90",
            "URL": "sample string 0",
            "Text": "sample string 31"
          },
          {
            "Type": "sample string 90",
            "URL": "sample string 0",
            "Text": "sample string 31"
          },
          {
            "Type": "sample string 90",
            "URL": "sample string 0",
            "Text": "sample string 31"
          }
        ]
      },
      {
        "MessageId": "sample string 16",
        "OriginalId": "sample string 62",
        "Subject": "sample string 29",
        "Status": "sample string 36",
        "MarkedUnread": true,
        "LastChangedDateTime": "2024-04-26T13:31:24.7347718+02:00",
        "CreatedDate": "2024-04-26T13:31:24.7347718+02:00",
        "LastChangedBy": "sample string 18",
        "ServiceOwner": "sample string 23",
        "Type": "sample string 12",
        "MessageSender": "sample string 68",
        "Summary": "sample string 11",
        "Body": "sample string 49",
        "ServiceCode": "sample string 45",
        "ServiceEdition": 16,
        "SignatureSpec": {
          "FormIds": [
            1,
            2,
            3
          ],
          "AttachmentIds": [
            1,
            2,
            3
          ]
        },
        "DueDate": "2024-04-26T13:31:24.7347718+02:00",
        "AvailableAction": 0,
        "ArchiveReference": "sample string 72",
        "ReplyOptions": [
          {
            "Type": "sample string 90",
            "URL": "sample string 0",
            "Text": "sample string 31"
          },
          {
            "Type": "sample string 90",
            "URL": "sample string 0",
            "Text": "sample string 31"
          },
          {
            "Type": "sample string 90",
            "URL": "sample string 0",
            "Text": "sample string 31"
          }
        ]
      }
    ]
  }
}