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:
[ "9c56ad94-374d-4334-8e1d-de890e5a1751", "ae76fc40-24c4-4ddf-9735-2f34dbb9518a" ]
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>9c56ad94-374d-4334-8e1d-de890e5a1751</guid> <guid>ae76fc40-24c4-4ddf-9735-2f34dbb9518a</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": "33ca467f-a426-4a83-bc88-b3bff15ed7f5", "Success": true, "ResponseMessage": "sample string 3" }, { "MessageKey": "33ca467f-a426-4a83-bc88-b3bff15ed7f5", "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>33ca467f-a426-4a83-bc88-b3bff15ed7f5</MessageKey> <ResponseMessage>sample string 3</ResponseMessage> <Success>true</Success> </MarkMessageAsReadResponse> <MarkMessageAsReadResponse> <MessageKey>33ca467f-a426-4a83-bc88-b3bff15ed7f5</MessageKey> <ResponseMessage>sample string 3</ResponseMessage> <Success>true</Success> </MarkMessageAsReadResponse> </ArrayOfMarkMessageAsReadResponse>