GET api/v1/channelcommunications?Limit={Limit}&Offset={Offset}&OrderBy={OrderBy}&campaignTypeCode={campaignTypeCode}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Limit | integer |
None. |
|
| Offset | integer |
None. |
|
| OrderBy | string |
None. |
|
| campaignTypeCode | string |
Required |
Body Parameters
None.
Response Information
Resource Description
MultiResultResponseOfChannelCommunicationDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Meta | MetaMultiResult |
None. |
|
| Notifications |
None. |
Response Formats
application/json, text/json
Sample:
{
"meta": {
"limit": 1,
"offset": 2,
"totalResults": 3
},
"notifications": [
{},
{}
],
"results": [
{
"id": "37a0281d-194c-4595-8e22-337c87b06203",
"code": "sample string 1",
"name": "sample string 2"
},
{
"id": "37a0281d-194c-4595-8e22-337c87b06203",
"code": "sample string 1",
"name": "sample string 2"
}
]
}
application/xml, text/xml
Sample:
<MultiResultResponseOfChannelCommunicationDtoaM_S85dVU xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Presentation.WebApi.Dtos.Response">
<Meta>
<Limit>1</Limit>
<Offset>2</Offset>
<TotalResults>3</TotalResults>
</Meta>
<Notifications>
<Notification />
<Notification />
</Notifications>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Domain.Dtos">
<d2p1:ChannelCommunicationDto>
<d2p1:Code>sample string 1</d2p1:Code>
<d2p1:Id>37a0281d-194c-4595-8e22-337c87b06203</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:ChannelCommunicationDto>
<d2p1:ChannelCommunicationDto>
<d2p1:Code>sample string 1</d2p1:Code>
<d2p1:Id>37a0281d-194c-4595-8e22-337c87b06203</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:ChannelCommunicationDto>
</Results>
</MultiResultResponseOfChannelCommunicationDtoaM_S85dVU>