POST api/messages/inboxitems
Request Information
URI Parameters
None.
Body Parameters
DataSourceRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| page | integer |
None. |
|
| page_size | integer |
None. |
|
| skip | integer |
None. |
|
| take | integer |
None. |
|
| sorts | Collection of SortDescriptor |
None. |
|
| filters | Collection of IFilterDescriptor |
None. |
Request Formats
application/json, text/json
Sample:
{
"page": 1,
"page_size": 2,
"skip": 3,
"take": 4,
"sorts": [
{
"member": "sample string 1",
"sort_direction": 0
},
{
"member": "sample string 1",
"sort_direction": 0
}
],
"filters": null
}
application/xml, text/xml
Sample:
<DataSourceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Infrastructure.DataSource">
<Filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<Page>1</Page>
<PageSize>2</PageSize>
<Skip>3</Skip>
<Sorts>
<SortDescriptor>
<Member>sample string 1</Member>
<SortDirection>Ascending</SortDirection>
</SortDescriptor>
<SortDescriptor>
<Member>sample string 1</Member>
<SortDirection>Ascending</SortDirection>
</SortDescriptor>
</Sorts>
<Take>4</Take>
</DataSourceRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
DataSourceResultOfMessageInboxModel| Name | Description | Type | Additional information |
|---|---|---|---|
| data | Collection of MessageInboxModel |
None. |
|
| total | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"data": [
{
"received_date_utc": "2025-12-08T19:49:50.133839+08:00",
"received_date": "2025-12-08T19:49:50.133839+08:00",
"from": "sample string 1",
"is_read": true,
"subject": "sample string 2",
"can_delete": true,
"id": "ad0af6ee-901e-49dd-a811-126f9e98034d",
"ts": "QEA="
},
{
"received_date_utc": "2025-12-08T19:49:50.133839+08:00",
"received_date": "2025-12-08T19:49:50.133839+08:00",
"from": "sample string 1",
"is_read": true,
"subject": "sample string 2",
"can_delete": true,
"id": "ad0af6ee-901e-49dd-a811-126f9e98034d",
"ts": "QEA="
}
],
"total": 1
}
application/xml, text/xml
Sample:
<DataSourceResultOfMessageInboxModelihvqq9wh xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Infrastructure.DataSource">
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models">
<d2p1:MessageInboxModel>
<Id xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">ad0af6ee-901e-49dd-a811-126f9e98034d</Id>
<Ts xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">QEA=</Ts>
<d2p1:CanDelete>true</d2p1:CanDelete>
<d2p1:Subject>sample string 2</d2p1:Subject>
<d2p1:From>sample string 1</d2p1:From>
<d2p1:IsRead>true</d2p1:IsRead>
<d2p1:ReceivedDate>2025-12-08T19:49:50.133839+08:00</d2p1:ReceivedDate>
<d2p1:ReceivedDateUtc>2025-12-08T19:49:50.133839+08:00</d2p1:ReceivedDateUtc>
</d2p1:MessageInboxModel>
<d2p1:MessageInboxModel>
<Id xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">ad0af6ee-901e-49dd-a811-126f9e98034d</Id>
<Ts xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">QEA=</Ts>
<d2p1:CanDelete>true</d2p1:CanDelete>
<d2p1:Subject>sample string 2</d2p1:Subject>
<d2p1:From>sample string 1</d2p1:From>
<d2p1:IsRead>true</d2p1:IsRead>
<d2p1:ReceivedDate>2025-12-08T19:49:50.133839+08:00</d2p1:ReceivedDate>
<d2p1:ReceivedDateUtc>2025-12-08T19:49:50.133839+08:00</d2p1:ReceivedDateUtc>
</d2p1:MessageInboxModel>
</Data>
<Total>1</Total>
</DataSourceResultOfMessageInboxModelihvqq9wh>