< 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 96"
    }
  },
  "_embedded": {
    "sample string 64": [
      {
        "Status": "sample string 47",
        "Type": "sample string 74",
        "Subject": "sample string 0",
        "MessageId": "sample string 43",
        "OriginalId": "sample string 67",
        "MarkedUnread": true,
        "LastChangedDateTime": "2024-04-24T05:56:35.9062884+02:00",
        "CreatedDate": "2024-04-24T05:56:35.9062884+02:00",
        "LastChangedBy": "sample string 1",
        "ServiceOwner": "sample string 31",
        "MessageSender": "sample string 0",
        "Summary": "sample string 12",
        "Body": "sample string 58",
        "ServiceCode": "sample string 18",
        "ServiceEdition": 16,
        "SignatureSpec": {
          "FormIds": [
            1,
            2,
            3
          ],
          "AttachmentIds": [
            1,
            2,
            3
          ]
        },
        "DueDate": "2024-04-24T05:56:35.9062884+02:00",
        "AvailableAction": 0,
        "ArchiveReference": "sample string 50",
        "ReplyOptions": [
          {
            "Type": "sample string 36",
            "URL": "sample string 37",
            "Text": "sample string 80"
          },
          {
            "Type": "sample string 36",
            "URL": "sample string 37",
            "Text": "sample string 80"
          },
          {
            "Type": "sample string 36",
            "URL": "sample string 37",
            "Text": "sample string 80"
          }
        ],
        "_links": {
          "self": {
            "href": "sample string 49"
          }
        }
      },
      {
        "Status": "sample string 47",
        "Type": "sample string 74",
        "Subject": "sample string 0",
        "MessageId": "sample string 43",
        "OriginalId": "sample string 67",
        "MarkedUnread": true,
        "LastChangedDateTime": "2024-04-24T05:56:35.9062884+02:00",
        "CreatedDate": "2024-04-24T05:56:35.9062884+02:00",
        "LastChangedBy": "sample string 1",
        "ServiceOwner": "sample string 31",
        "MessageSender": "sample string 0",
        "Summary": "sample string 12",
        "Body": "sample string 58",
        "ServiceCode": "sample string 18",
        "ServiceEdition": 16,
        "SignatureSpec": {
          "FormIds": [
            1,
            2,
            3
          ],
          "AttachmentIds": [
            1,
            2,
            3
          ]
        },
        "DueDate": "2024-04-24T05:56:35.9062884+02:00",
        "AvailableAction": 0,
        "ArchiveReference": "sample string 50",
        "ReplyOptions": [
          {
            "Type": "sample string 36",
            "URL": "sample string 37",
            "Text": "sample string 80"
          },
          {
            "Type": "sample string 36",
            "URL": "sample string 37",
            "Text": "sample string 80"
          },
          {
            "Type": "sample string 36",
            "URL": "sample string 37",
            "Text": "sample string 80"
          }
        ],
        "_links": {
          "self": {
            "href": "sample string 49"
          }
        }
      },
      {
        "Status": "sample string 47",
        "Type": "sample string 74",
        "Subject": "sample string 0",
        "MessageId": "sample string 43",
        "OriginalId": "sample string 67",
        "MarkedUnread": true,
        "LastChangedDateTime": "2024-04-24T05:56:35.9062884+02:00",
        "CreatedDate": "2024-04-24T05:56:35.9062884+02:00",
        "LastChangedBy": "sample string 1",
        "ServiceOwner": "sample string 31",
        "MessageSender": "sample string 0",
        "Summary": "sample string 12",
        "Body": "sample string 58",
        "ServiceCode": "sample string 18",
        "ServiceEdition": 16,
        "SignatureSpec": {
          "FormIds": [
            1,
            2,
            3
          ],
          "AttachmentIds": [
            1,
            2,
            3
          ]
        },
        "DueDate": "2024-04-24T05:56:35.9062884+02:00",
        "AvailableAction": 0,
        "ArchiveReference": "sample string 50",
        "ReplyOptions": [
          {
            "Type": "sample string 36",
            "URL": "sample string 37",
            "Text": "sample string 80"
          },
          {
            "Type": "sample string 36",
            "URL": "sample string 37",
            "Text": "sample string 80"
          },
          {
            "Type": "sample string 36",
            "URL": "sample string 37",
            "Text": "sample string 80"
          }
        ],
        "_links": {
          "self": {
            "href": "sample string 49"
          }
        }
      }
    ]
  }
}