POST api/v2.0/Messaging/MarkMessagesAsRead
Marks the specified Mailbox Messages as 'Read'.
Request Information
URI Parameters
None.
Body Parameters
List of MessageKeys
Collection of globally unique identifierRequest Formats
application/json, text/json
Sample:
[ "6fba258f-0345-4925-a9ac-2397af950927", "ae49c4fc-637e-4036-b538-48a65ce97295" ]
application/xml, text/xml
Sample:
<ArrayOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <guid>6fba258f-0345-4925-a9ac-2397af950927</guid> <guid>ae49c4fc-637e-4036-b538-48a65ce97295</guid> </ArrayOfguid>
Response Information
Resource Description
A list of the results. If any of the Messages could not be marked as read, an error message will be included.
Collection of MarkMessageAsReadResponseName | Description | Type | Additional information |
---|---|---|---|
MessageKey |
Unique Identifier of an Inbox Message. |
globally unique identifier |
None. |
Success |
Indicates if the message was succesfully marked as Read. |
boolean |
None. |
ResponseMessage |
Additional information such as the reason for a failure. |
string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "MessageKey": "249e1c70-97c4-436f-b3cd-6e95a3cd327c", "Success": true, "ResponseMessage": "sample string 3" }, { "MessageKey": "249e1c70-97c4-436f-b3cd-6e95a3cd327c", "Success": true, "ResponseMessage": "sample string 3" } ]
application/xml, text/xml
Sample:
<ArrayOfMarkMessageAsReadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Messaging"> <MarkMessageAsReadResponse> <MessageKey>249e1c70-97c4-436f-b3cd-6e95a3cd327c</MessageKey> <ResponseMessage>sample string 3</ResponseMessage> <Success>true</Success> </MarkMessageAsReadResponse> <MarkMessageAsReadResponse> <MessageKey>249e1c70-97c4-436f-b3cd-6e95a3cd327c</MessageKey> <ResponseMessage>sample string 3</ResponseMessage> <Success>true</Success> </MarkMessageAsReadResponse> </ArrayOfMarkMessageAsReadResponse>