GET api/messages?documentId={documentId}
For a given document retrieves a list of messages in which it was sent.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| documentId |
Document ID. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of MessageDocumentDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| From |
Author of the message. For e-mail messages it's a valid e-mail address. |
string |
None. |
| To |
Message recipient. For e-mail messages it's a valid e-mail address. |
string |
None. |
| ReplyTo |
Optional reply-to address, for e-mail messages. |
string |
None. |
| Subject |
Message subject. |
string |
None. |
| Url |
URL where the document is stored. Should be a document generated by CPP and stored on the files.cpp.hr domain, though no specific validation is performed. |
string |
None. |
| Status |
Message status. |
string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"From": "sample string 1",
"To": "sample string 2",
"ReplyTo": "sample string 3",
"Subject": "sample string 4",
"Url": "sample string 5",
"Status": "sample string 6"
},
{
"From": "sample string 1",
"To": "sample string 2",
"ReplyTo": "sample string 3",
"Subject": "sample string 4",
"Url": "sample string 5",
"Status": "sample string 6"
}
]
text/html
Sample:
[{"From":"sample string 1","To":"sample string 2","ReplyTo":"sample string 3","Subject":"sample string 4","Url":"sample string 5","Status":"sample string 6"},{"From":"sample string 1","To":"sample string 2","ReplyTo":"sample string 3","Subject":"sample string 4","Url":"sample string 5","Status":"sample string 6"}]
application/xml, text/xml
Sample:
<ArrayOfMessageDocumentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs">
<MessageDocumentDTO>
<From>sample string 1</From>
<ReplyTo>sample string 3</ReplyTo>
<Status>sample string 6</Status>
<Subject>sample string 4</Subject>
<To>sample string 2</To>
<Url>sample string 5</Url>
</MessageDocumentDTO>
<MessageDocumentDTO>
<From>sample string 1</From>
<ReplyTo>sample string 3</ReplyTo>
<Status>sample string 6</Status>
<Subject>sample string 4</Subject>
<To>sample string 2</To>
<Url>sample string 5</Url>
</MessageDocumentDTO>
</ArrayOfMessageDocumentDTO>