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:
[ "25fea1f2-1786-493f-8532-48101c3e5186", "28aa23c4-d02e-4d07-9441-409904426ecf" ]
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>25fea1f2-1786-493f-8532-48101c3e5186</guid> <guid>28aa23c4-d02e-4d07-9441-409904426ecf</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": "fdf2d5a8-acad-452d-95b7-bfefd31b6993", "Success": true, "ResponseMessage": "sample string 3" }, { "MessageKey": "fdf2d5a8-acad-452d-95b7-bfefd31b6993", "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>fdf2d5a8-acad-452d-95b7-bfefd31b6993</MessageKey> <ResponseMessage>sample string 3</ResponseMessage> <Success>true</Success> </MarkMessageAsReadResponse> <MarkMessageAsReadResponse> <MessageKey>fdf2d5a8-acad-452d-95b7-bfefd31b6993</MessageKey> <ResponseMessage>sample string 3</ResponseMessage> <Success>true</Success> </MarkMessageAsReadResponse> </ArrayOfMarkMessageAsReadResponse>