< 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 33",
  "OriginalId": "sample string 0",
  "Subject": "sample string 87",
  "Status": "sample string 26",
  "MarkedUnread": true,
  "LastChangedDateTime": "2024-04-25T22:10:03.3335857+02:00",
  "CreatedDate": "2024-04-25T22:10:03.3335857+02:00",
  "LastChangedBy": "sample string 47",
  "ServiceOwner": "sample string 28",
  "Type": "sample string 24",
  "MessageSender": "sample string 23",
  "Summary": "sample string 44",
  "Body": "sample string 44",
  "ServiceCode": "sample string 20",
  "ServiceEdition": 16,
  "SignatureSpec": {
    "FormIds": [
      1,
      2,
      3
    ],
    "AttachmentIds": [
      1,
      2,
      3
    ]
  },
  "DueDate": "2024-04-25T22:10:03.3335857+02:00",
  "AvailableAction": 0,
  "ArchiveReference": "sample string 12",
  "ReplyOptions": [
    {
      "Type": "sample string 95",
      "URL": "sample string 59",
      "Text": "sample string 56"
    },
    {
      "Type": "sample string 95",
      "URL": "sample string 59",
      "Text": "sample string 56"
    },
    {
      "Type": "sample string 95",
      "URL": "sample string 59",
      "Text": "sample string 56"
    }
  ]
}