POST api/InboundMessage/GetInboundMessages
Fetch Inbound Messages from the Communication Db
Request Information
URI Parameters
None.
Body Parameters
InboundMessageRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| EntityId | integer |
None. |
|
| Category | string |
None. |
|
| ProjectName | string |
None. |
|
| ItemCount | integer |
None. |
|
| SortParam | integer |
None. |
|
| PageNumber | integer |
None. |
|
| PageSize | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"EntityId": 1,
"Category": "sample string 2",
"ProjectName": "sample string 3",
"ItemCount": 4,
"SortParam": 5,
"PageNumber": 1,
"PageSize": 1
}
application/xml, text/xml
Sample:
<InboundMessageRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ECEMessageCenterCommon.Models.Inbound"> <Category>sample string 2</Category> <EntityId>1</EntityId> <ItemCount>4</ItemCount> <PageNumber>1</PageNumber> <PageSize>1</PageSize> <ProjectName>sample string 3</ProjectName> <SortParam>5</SortParam> </InboundMessageRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of InboundMessages| Name | Description | Type | Additional information |
|---|---|---|---|
| Subject | string |
None. |
|
| Body | string |
None. |
|
| Category | string |
None. |
|
| SubCategory | string |
None. |
|
| Verbiage | string |
None. |
|
| ProjectName | string |
None. |
|
| Attachments | Collection of AttachementDataModel |
None. |
|
| EntityId | integer |
None. |
|
| CaseId | integer |
None. |
|
| ActivityId | integer |
None. |
|
| SentDate | date |
None. |
|
| Status | string |
None. |
|
| CreatedOn | date |
None. |
|
| CreatedBy | string |
None. |
|
| TotalCount | integer |
None. |
|
| MessageOrder | integer |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Subject": "sample string 1",
"Body": "sample string 2",
"Category": "sample string 3",
"SubCategory": "sample string 4",
"Verbiage": "sample string 5",
"ProjectName": "sample string 6",
"Attachments": [
{
"ContentFilePath": "sample string 1",
"ContentFileName": "sample string 2",
"ReferenceId": 1,
"ReferenceType": "sample string 3",
"CreatedBy": "sample string 4"
},
{
"ContentFilePath": "sample string 1",
"ContentFileName": "sample string 2",
"ReferenceId": 1,
"ReferenceType": "sample string 3",
"CreatedBy": "sample string 4"
}
],
"EntityId": 7,
"CaseId": 1,
"ActivityId": 1,
"SentDate": "2024-04-27T17:10:35.7507421-07:00",
"Status": "sample string 8",
"CreatedOn": "2024-04-27T17:10:35.7507421-07:00",
"CreatedBy": "sample string 9",
"TotalCount": 1,
"MessageOrder": 1
},
{
"Subject": "sample string 1",
"Body": "sample string 2",
"Category": "sample string 3",
"SubCategory": "sample string 4",
"Verbiage": "sample string 5",
"ProjectName": "sample string 6",
"Attachments": [
{
"ContentFilePath": "sample string 1",
"ContentFileName": "sample string 2",
"ReferenceId": 1,
"ReferenceType": "sample string 3",
"CreatedBy": "sample string 4"
},
{
"ContentFilePath": "sample string 1",
"ContentFileName": "sample string 2",
"ReferenceId": 1,
"ReferenceType": "sample string 3",
"CreatedBy": "sample string 4"
}
],
"EntityId": 7,
"CaseId": 1,
"ActivityId": 1,
"SentDate": "2024-04-27T17:10:35.7507421-07:00",
"Status": "sample string 8",
"CreatedOn": "2024-04-27T17:10:35.7507421-07:00",
"CreatedBy": "sample string 9",
"TotalCount": 1,
"MessageOrder": 1
}
]
application/xml, text/xml
Sample:
<ArrayOfInboundMessages xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ECEMessageCenterCommon.Models.Inbound">
<InboundMessages>
<ActivityId>1</ActivityId>
<Attachments xmlns:d3p1="http://schemas.datacontract.org/2004/07/ECEMessageCenterCommon.Models.CommunicationFiles">
<d3p1:AttachementDataModel>
<d3p1:ContentFileName>sample string 2</d3p1:ContentFileName>
<d3p1:ContentFilePath>sample string 1</d3p1:ContentFilePath>
<d3p1:CreatedBy>sample string 4</d3p1:CreatedBy>
<d3p1:ReferenceId>1</d3p1:ReferenceId>
<d3p1:ReferenceType>sample string 3</d3p1:ReferenceType>
</d3p1:AttachementDataModel>
<d3p1:AttachementDataModel>
<d3p1:ContentFileName>sample string 2</d3p1:ContentFileName>
<d3p1:ContentFilePath>sample string 1</d3p1:ContentFilePath>
<d3p1:CreatedBy>sample string 4</d3p1:CreatedBy>
<d3p1:ReferenceId>1</d3p1:ReferenceId>
<d3p1:ReferenceType>sample string 3</d3p1:ReferenceType>
</d3p1:AttachementDataModel>
</Attachments>
<Body>sample string 2</Body>
<CaseId>1</CaseId>
<Category>sample string 3</Category>
<CreatedBy>sample string 9</CreatedBy>
<CreatedOn>2024-04-27T17:10:35.7507421-07:00</CreatedOn>
<EntityId>7</EntityId>
<MessageOrder>1</MessageOrder>
<ProjectName>sample string 6</ProjectName>
<SentDate>2024-04-27T17:10:35.7507421-07:00</SentDate>
<Status>sample string 8</Status>
<SubCategory>sample string 4</SubCategory>
<Subject>sample string 1</Subject>
<TotalCount>1</TotalCount>
<Verbiage>sample string 5</Verbiage>
</InboundMessages>
<InboundMessages>
<ActivityId>1</ActivityId>
<Attachments xmlns:d3p1="http://schemas.datacontract.org/2004/07/ECEMessageCenterCommon.Models.CommunicationFiles">
<d3p1:AttachementDataModel>
<d3p1:ContentFileName>sample string 2</d3p1:ContentFileName>
<d3p1:ContentFilePath>sample string 1</d3p1:ContentFilePath>
<d3p1:CreatedBy>sample string 4</d3p1:CreatedBy>
<d3p1:ReferenceId>1</d3p1:ReferenceId>
<d3p1:ReferenceType>sample string 3</d3p1:ReferenceType>
</d3p1:AttachementDataModel>
<d3p1:AttachementDataModel>
<d3p1:ContentFileName>sample string 2</d3p1:ContentFileName>
<d3p1:ContentFilePath>sample string 1</d3p1:ContentFilePath>
<d3p1:CreatedBy>sample string 4</d3p1:CreatedBy>
<d3p1:ReferenceId>1</d3p1:ReferenceId>
<d3p1:ReferenceType>sample string 3</d3p1:ReferenceType>
</d3p1:AttachementDataModel>
</Attachments>
<Body>sample string 2</Body>
<CaseId>1</CaseId>
<Category>sample string 3</Category>
<CreatedBy>sample string 9</CreatedBy>
<CreatedOn>2024-04-27T17:10:35.7507421-07:00</CreatedOn>
<EntityId>7</EntityId>
<MessageOrder>1</MessageOrder>
<ProjectName>sample string 6</ProjectName>
<SentDate>2024-04-27T17:10:35.7507421-07:00</SentDate>
<Status>sample string 8</Status>
<SubCategory>sample string 4</SubCategory>
<Subject>sample string 1</Subject>
<TotalCount>1</TotalCount>
<Verbiage>sample string 5</Verbiage>
</InboundMessages>
</ArrayOfInboundMessages>