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:
[ "21ddd898-a9a1-427e-9645-6d45c6177a15", "435ec2f8-77ca-4109-9aff-08ac4060c062" ]
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>21ddd898-a9a1-427e-9645-6d45c6177a15</guid> <guid>435ec2f8-77ca-4109-9aff-08ac4060c062</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": "b13f18ba-f3ad-4f26-937a-8300defe749f", "Success": true, "ResponseMessage": "sample string 3" }, { "MessageKey": "b13f18ba-f3ad-4f26-937a-8300defe749f", "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>b13f18ba-f3ad-4f26-937a-8300defe749f</MessageKey> <ResponseMessage>sample string 3</ResponseMessage> <Success>true</Success> </MarkMessageAsReadResponse> <MarkMessageAsReadResponse> <MessageKey>b13f18ba-f3ad-4f26-937a-8300defe749f</MessageKey> <ResponseMessage>sample string 3</ResponseMessage> <Success>true</Success> </MarkMessageAsReadResponse> </ArrayOfMarkMessageAsReadResponse>