< Back to main page

GET {who}/Messages/{messageId}?language={language}&markAsRead={markAsRead}

Gets a specific message by its messageId.

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.
messageId ID of the message to be retrieved

Define this parameter in the request URI.
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.
markAsRead Whether correspondence should be marked as Read upon retrieval. This is an optional parameter, by default correspondences will have their status set to "Read" by this operation. If this parameter is submitted as "False", correspondences not will have their status set to "Read" by this operation.

Define this parameter in the request URI.

Response Information

Message with the given messageId

Response body formats

application/hal+xml

Sample:

Sample not available.

application/hal+json

Sample: 
{
  "MessageId": "sample string 14",
  "OriginalId": "sample string 35",
  "Subject": "sample string 24",
  "Status": "sample string 97",
  "MarkedUnread": true,
  "LastChangedDateTime": "2025-01-26T02:49:11.0066437+01:00",
  "CreatedDate": "2025-01-26T02:49:11.0066437+01:00",
  "LastChangedBy": "sample string 44",
  "ServiceOwner": "sample string 85",
  "Type": "sample string 86",
  "MessageSender": "sample string 12",
  "Summary": "sample string 74",
  "Body": "sample string 78",
  "ServiceCode": "sample string 40",
  "ServiceEdition": 16,
  "SignatureSpec": {
    "FormIds": [
      1,
      2,
      3
    ],
    "AttachmentIds": [
      1,
      2,
      3
    ]
  },
  "DueDate": "2025-01-26T02:49:11.0066437+01:00",
  "AvailableAction": 0,
  "ArchiveReference": "sample string 70",
  "ReplyOptions": [
    {
      "Type": "sample string 68",
      "URL": "sample string 93",
      "Text": "sample string 64"
    },
    {
      "Type": "sample string 68",
      "URL": "sample string 93",
      "Text": "sample string 64"
    },
    {
      "Type": "sample string 68",
      "URL": "sample string 93",
      "Text": "sample string 64"
    }
  ],
  "_links": {
    "self": {
      "href": "sample string 31"
    }
  }
}