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:
[ "cd79e660-cf46-407e-b635-c033fdf0b291", "aea92f4c-5a63-442c-9c30-7a383ccff0cb" ]
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>cd79e660-cf46-407e-b635-c033fdf0b291</guid> <guid>aea92f4c-5a63-442c-9c30-7a383ccff0cb</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": "8d965cac-079b-4766-9c96-1c5fa0bc4ebc", "Success": true, "ResponseMessage": "sample string 3" }, { "MessageKey": "8d965cac-079b-4766-9c96-1c5fa0bc4ebc", "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>8d965cac-079b-4766-9c96-1c5fa0bc4ebc</MessageKey> <ResponseMessage>sample string 3</ResponseMessage> <Success>true</Success> </MarkMessageAsReadResponse> <MarkMessageAsReadResponse> <MessageKey>8d965cac-079b-4766-9c96-1c5fa0bc4ebc</MessageKey> <ResponseMessage>sample string 3</ResponseMessage> <Success>true</Success> </MarkMessageAsReadResponse> </ArrayOfMarkMessageAsReadResponse>