GET api/v1/campaigncommunications?Limit={Limit}&Offset={Offset}&OrderBy={OrderBy}&filter={filter}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Limit | integer |
None. |
|
Offset | integer |
None. |
|
OrderBy | string |
None. |
|
filter | CommunicationFilter |
Default value is All |
Body Parameters
None.
Response Information
Resource Description
MultiResultResponseOfCampaignCommunicationInListDtoName | 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": [ { "campaignId": "6844ade7-568c-4798-83f9-ad19b11fd962", "campaignCode": "sample string 2", "campaignTypeCode": "sample string 3", "campaignTypeName": "sample string 4", "channelCommunicationCode": "sample string 5", "sendNow": true, "id": "aa89731a-6d2f-4634-94ce-f606c0b17187", "code": "sample string 6", "organizationCode": "sample string 7", "name": "sample string 8", "creationDate": "2025-08-31T08:55:27.5203686+00:00", "modificationDate": "2025-08-31T08:55:27.5203686+00:00", "isDraft": true, "isSent": true, "sendDate": "2025-08-31T08:55:27.5203686+00:00" }, { "campaignId": "6844ade7-568c-4798-83f9-ad19b11fd962", "campaignCode": "sample string 2", "campaignTypeCode": "sample string 3", "campaignTypeName": "sample string 4", "channelCommunicationCode": "sample string 5", "sendNow": true, "id": "aa89731a-6d2f-4634-94ce-f606c0b17187", "code": "sample string 6", "organizationCode": "sample string 7", "name": "sample string 8", "creationDate": "2025-08-31T08:55:27.5203686+00:00", "modificationDate": "2025-08-31T08:55:27.5203686+00:00", "isDraft": true, "isSent": true, "sendDate": "2025-08-31T08:55:27.5203686+00:00" } ] }
application/xml, text/xml
Sample:
<MultiResultResponseOfCampaignCommunicationInListDtoaM_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:CampaignCommunicationInListDto> <d2p1:Code>sample string 6</d2p1:Code> <d2p1:CreationDate>2025-08-31T08:55:27.5203686+00:00</d2p1:CreationDate> <d2p1:Id>aa89731a-6d2f-4634-94ce-f606c0b17187</d2p1:Id> <d2p1:IsDraft>true</d2p1:IsDraft> <d2p1:IsSent>true</d2p1:IsSent> <d2p1:ModificationDate>2025-08-31T08:55:27.5203686+00:00</d2p1:ModificationDate> <d2p1:Name>sample string 8</d2p1:Name> <d2p1:OrganizationCode>sample string 7</d2p1:OrganizationCode> <d2p1:SendDate>2025-08-31T08:55:27.5203686+00:00</d2p1:SendDate> <d2p1:CampaignCode>sample string 2</d2p1:CampaignCode> <d2p1:CampaignId>6844ade7-568c-4798-83f9-ad19b11fd962</d2p1:CampaignId> <d2p1:CampaignTypeCode>sample string 3</d2p1:CampaignTypeCode> <d2p1:CampaignTypeName>sample string 4</d2p1:CampaignTypeName> <d2p1:ChannelCommunicationCode>sample string 5</d2p1:ChannelCommunicationCode> <d2p1:SendNow>true</d2p1:SendNow> </d2p1:CampaignCommunicationInListDto> <d2p1:CampaignCommunicationInListDto> <d2p1:Code>sample string 6</d2p1:Code> <d2p1:CreationDate>2025-08-31T08:55:27.5203686+00:00</d2p1:CreationDate> <d2p1:Id>aa89731a-6d2f-4634-94ce-f606c0b17187</d2p1:Id> <d2p1:IsDraft>true</d2p1:IsDraft> <d2p1:IsSent>true</d2p1:IsSent> <d2p1:ModificationDate>2025-08-31T08:55:27.5203686+00:00</d2p1:ModificationDate> <d2p1:Name>sample string 8</d2p1:Name> <d2p1:OrganizationCode>sample string 7</d2p1:OrganizationCode> <d2p1:SendDate>2025-08-31T08:55:27.5203686+00:00</d2p1:SendDate> <d2p1:CampaignCode>sample string 2</d2p1:CampaignCode> <d2p1:CampaignId>6844ade7-568c-4798-83f9-ad19b11fd962</d2p1:CampaignId> <d2p1:CampaignTypeCode>sample string 3</d2p1:CampaignTypeCode> <d2p1:CampaignTypeName>sample string 4</d2p1:CampaignTypeName> <d2p1:ChannelCommunicationCode>sample string 5</d2p1:ChannelCommunicationCode> <d2p1:SendNow>true</d2p1:SendNow> </d2p1:CampaignCommunicationInListDto> </Results> </MultiResultResponseOfCampaignCommunicationInListDtoaM_S85dVU>