POST api/OutboundMessage/GetOutboundMessages
Fetch Inbound Messages from the Communication Db
Request Information
URI Parameters
None.
Body Parameters
OutboundMessageRequestModel| 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:
<OutboundMessageRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ECEMessageCenterCommon.Models.Outbound"> <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> </OutboundMessageRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of OutboundCase| Name | Description | Type | Additional information |
|---|---|---|---|
| CaseId | integer |
None. |
|
| Verbiage | string |
None. |
|
| Category | string |
None. |
|
| SubCategory | string |
None. |
|
| CaseOrder | integer |
None. |
|
| LastActivityDate | date |
None. |
|
| UnReadCount | integer |
None. |
|
| TotalCount | integer |
None. |
|
| OutboundMessages | Collection of OutboundMessage |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"CaseId": 1,
"Verbiage": "sample string 1",
"Category": "sample string 2",
"SubCategory": "sample string 3",
"CaseOrder": 1,
"LastActivityDate": "2024-04-27T14:10:27.616613-07:00",
"UnReadCount": 5,
"TotalCount": 1,
"OutboundMessages": [
{
"Id": 1,
"Subject": "sample string 2",
"Body": "sample string 3",
"Category": "sample string 4",
"SubCategory": "sample string 5",
"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"
}
],
"Verbiage": "sample string 6",
"EntityId": 1,
"ProjectName": "sample string 7",
"CaseId": 1,
"ActivityId": 1,
"UnRead": true,
"Status": "sample string 8",
"MessageType": "sample string 9",
"CreatedBy": "sample string 10",
"CreatedOn": "2024-04-27T14:10:27.616613-07:00"
},
{
"Id": 1,
"Subject": "sample string 2",
"Body": "sample string 3",
"Category": "sample string 4",
"SubCategory": "sample string 5",
"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"
}
],
"Verbiage": "sample string 6",
"EntityId": 1,
"ProjectName": "sample string 7",
"CaseId": 1,
"ActivityId": 1,
"UnRead": true,
"Status": "sample string 8",
"MessageType": "sample string 9",
"CreatedBy": "sample string 10",
"CreatedOn": "2024-04-27T14:10:27.616613-07:00"
}
]
},
{
"CaseId": 1,
"Verbiage": "sample string 1",
"Category": "sample string 2",
"SubCategory": "sample string 3",
"CaseOrder": 1,
"LastActivityDate": "2024-04-27T14:10:27.616613-07:00",
"UnReadCount": 5,
"TotalCount": 1,
"OutboundMessages": [
{
"Id": 1,
"Subject": "sample string 2",
"Body": "sample string 3",
"Category": "sample string 4",
"SubCategory": "sample string 5",
"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"
}
],
"Verbiage": "sample string 6",
"EntityId": 1,
"ProjectName": "sample string 7",
"CaseId": 1,
"ActivityId": 1,
"UnRead": true,
"Status": "sample string 8",
"MessageType": "sample string 9",
"CreatedBy": "sample string 10",
"CreatedOn": "2024-04-27T14:10:27.616613-07:00"
},
{
"Id": 1,
"Subject": "sample string 2",
"Body": "sample string 3",
"Category": "sample string 4",
"SubCategory": "sample string 5",
"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"
}
],
"Verbiage": "sample string 6",
"EntityId": 1,
"ProjectName": "sample string 7",
"CaseId": 1,
"ActivityId": 1,
"UnRead": true,
"Status": "sample string 8",
"MessageType": "sample string 9",
"CreatedBy": "sample string 10",
"CreatedOn": "2024-04-27T14:10:27.616613-07:00"
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfOutboundCase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ECEMessageCenterCommon.Models.Outbound">
<OutboundCase>
<CaseId>1</CaseId>
<CaseOrder>1</CaseOrder>
<Category>sample string 2</Category>
<LastActivityDate>2024-04-27T14:10:27.616613-07:00</LastActivityDate>
<OutboundMessages>
<OutboundMessage>
<ActivityId>1</ActivityId>
<Attachments xmlns:d5p1="http://schemas.datacontract.org/2004/07/ECEMessageCenterCommon.Models.CommunicationFiles">
<d5p1:AttachementDataModel>
<d5p1:ContentFileName>sample string 2</d5p1:ContentFileName>
<d5p1:ContentFilePath>sample string 1</d5p1:ContentFilePath>
<d5p1:CreatedBy>sample string 4</d5p1:CreatedBy>
<d5p1:ReferenceId>1</d5p1:ReferenceId>
<d5p1:ReferenceType>sample string 3</d5p1:ReferenceType>
</d5p1:AttachementDataModel>
<d5p1:AttachementDataModel>
<d5p1:ContentFileName>sample string 2</d5p1:ContentFileName>
<d5p1:ContentFilePath>sample string 1</d5p1:ContentFilePath>
<d5p1:CreatedBy>sample string 4</d5p1:CreatedBy>
<d5p1:ReferenceId>1</d5p1:ReferenceId>
<d5p1:ReferenceType>sample string 3</d5p1:ReferenceType>
</d5p1:AttachementDataModel>
</Attachments>
<Body>sample string 3</Body>
<CaseId>1</CaseId>
<Category>sample string 4</Category>
<CreatedBy>sample string 10</CreatedBy>
<CreatedOn>2024-04-27T14:10:27.616613-07:00</CreatedOn>
<EntityId>1</EntityId>
<Id>1</Id>
<MessageType>sample string 9</MessageType>
<ProjectName>sample string 7</ProjectName>
<Status>sample string 8</Status>
<SubCategory>sample string 5</SubCategory>
<Subject>sample string 2</Subject>
<UnRead>true</UnRead>
<Verbiage>sample string 6</Verbiage>
</OutboundMessage>
<OutboundMessage>
<ActivityId>1</ActivityId>
<Attachments xmlns:d5p1="http://schemas.datacontract.org/2004/07/ECEMessageCenterCommon.Models.CommunicationFiles">
<d5p1:AttachementDataModel>
<d5p1:ContentFileName>sample string 2</d5p1:ContentFileName>
<d5p1:ContentFilePath>sample string 1</d5p1:ContentFilePath>
<d5p1:CreatedBy>sample string 4</d5p1:CreatedBy>
<d5p1:ReferenceId>1</d5p1:ReferenceId>
<d5p1:ReferenceType>sample string 3</d5p1:ReferenceType>
</d5p1:AttachementDataModel>
<d5p1:AttachementDataModel>
<d5p1:ContentFileName>sample string 2</d5p1:ContentFileName>
<d5p1:ContentFilePath>sample string 1</d5p1:ContentFilePath>
<d5p1:CreatedBy>sample string 4</d5p1:CreatedBy>
<d5p1:ReferenceId>1</d5p1:ReferenceId>
<d5p1:ReferenceType>sample string 3</d5p1:ReferenceType>
</d5p1:AttachementDataModel>
</Attachments>
<Body>sample string 3</Body>
<CaseId>1</CaseId>
<Category>sample string 4</Category>
<CreatedBy>sample string 10</CreatedBy>
<CreatedOn>2024-04-27T14:10:27.616613-07:00</CreatedOn>
<EntityId>1</EntityId>
<Id>1</Id>
<MessageType>sample string 9</MessageType>
<ProjectName>sample string 7</ProjectName>
<Status>sample string 8</Status>
<SubCategory>sample string 5</SubCategory>
<Subject>sample string 2</Subject>
<UnRead>true</UnRead>
<Verbiage>sample string 6</Verbiage>
</OutboundMessage>
</OutboundMessages>
<SubCategory>sample string 3</SubCategory>
<TotalCount>1</TotalCount>
<UnReadCount>5</UnReadCount>
<Verbiage>sample string 1</Verbiage>
</OutboundCase>
<OutboundCase>
<CaseId>1</CaseId>
<CaseOrder>1</CaseOrder>
<Category>sample string 2</Category>
<LastActivityDate>2024-04-27T14:10:27.616613-07:00</LastActivityDate>
<OutboundMessages>
<OutboundMessage>
<ActivityId>1</ActivityId>
<Attachments xmlns:d5p1="http://schemas.datacontract.org/2004/07/ECEMessageCenterCommon.Models.CommunicationFiles">
<d5p1:AttachementDataModel>
<d5p1:ContentFileName>sample string 2</d5p1:ContentFileName>
<d5p1:ContentFilePath>sample string 1</d5p1:ContentFilePath>
<d5p1:CreatedBy>sample string 4</d5p1:CreatedBy>
<d5p1:ReferenceId>1</d5p1:ReferenceId>
<d5p1:ReferenceType>sample string 3</d5p1:ReferenceType>
</d5p1:AttachementDataModel>
<d5p1:AttachementDataModel>
<d5p1:ContentFileName>sample string 2</d5p1:ContentFileName>
<d5p1:ContentFilePath>sample string 1</d5p1:ContentFilePath>
<d5p1:CreatedBy>sample string 4</d5p1:CreatedBy>
<d5p1:ReferenceId>1</d5p1:ReferenceId>
<d5p1:ReferenceType>sample string 3</d5p1:ReferenceType>
</d5p1:AttachementDataModel>
</Attachments>
<Body>sample string 3</Body>
<CaseId>1</CaseId>
<Category>sample string 4</Category>
<CreatedBy>sample string 10</CreatedBy>
<CreatedOn>2024-04-27T14:10:27.616613-07:00</CreatedOn>
<EntityId>1</EntityId>
<Id>1</Id>
<MessageType>sample string 9</MessageType>
<ProjectName>sample string 7</ProjectName>
<Status>sample string 8</Status>
<SubCategory>sample string 5</SubCategory>
<Subject>sample string 2</Subject>
<UnRead>true</UnRead>
<Verbiage>sample string 6</Verbiage>
</OutboundMessage>
<OutboundMessage>
<ActivityId>1</ActivityId>
<Attachments xmlns:d5p1="http://schemas.datacontract.org/2004/07/ECEMessageCenterCommon.Models.CommunicationFiles">
<d5p1:AttachementDataModel>
<d5p1:ContentFileName>sample string 2</d5p1:ContentFileName>
<d5p1:ContentFilePath>sample string 1</d5p1:ContentFilePath>
<d5p1:CreatedBy>sample string 4</d5p1:CreatedBy>
<d5p1:ReferenceId>1</d5p1:ReferenceId>
<d5p1:ReferenceType>sample string 3</d5p1:ReferenceType>
</d5p1:AttachementDataModel>
<d5p1:AttachementDataModel>
<d5p1:ContentFileName>sample string 2</d5p1:ContentFileName>
<d5p1:ContentFilePath>sample string 1</d5p1:ContentFilePath>
<d5p1:CreatedBy>sample string 4</d5p1:CreatedBy>
<d5p1:ReferenceId>1</d5p1:ReferenceId>
<d5p1:ReferenceType>sample string 3</d5p1:ReferenceType>
</d5p1:AttachementDataModel>
</Attachments>
<Body>sample string 3</Body>
<CaseId>1</CaseId>
<Category>sample string 4</Category>
<CreatedBy>sample string 10</CreatedBy>
<CreatedOn>2024-04-27T14:10:27.616613-07:00</CreatedOn>
<EntityId>1</EntityId>
<Id>1</Id>
<MessageType>sample string 9</MessageType>
<ProjectName>sample string 7</ProjectName>
<Status>sample string 8</Status>
<SubCategory>sample string 5</SubCategory>
<Subject>sample string 2</Subject>
<UnRead>true</UnRead>
<Verbiage>sample string 6</Verbiage>
</OutboundMessage>
</OutboundMessages>
<SubCategory>sample string 3</SubCategory>
<TotalCount>1</TotalCount>
<UnReadCount>5</UnReadCount>
<Verbiage>sample string 1</Verbiage>
</OutboundCase>
</ArrayOfOutboundCase>