GET api/v1/templatecommunications?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
MultiResultResponseOfTemplateCommunicationDtoName | 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": "c104381a-eb3c-41fa-b98f-630507ca36fc", "code": "sample string 1", "name": "sample string 2", "url": "sample string 3", "urlScreenshot": "sample string 4", "languageCode": "sample string 5", "channelCommunicationCode": "sample string 6", "campaignTypeCode": "sample string 7" }, { "id": "c104381a-eb3c-41fa-b98f-630507ca36fc", "code": "sample string 1", "name": "sample string 2", "url": "sample string 3", "urlScreenshot": "sample string 4", "languageCode": "sample string 5", "channelCommunicationCode": "sample string 6", "campaignTypeCode": "sample string 7" } ] }
application/xml, text/xml
Sample:
<MultiResultResponseOfTemplateCommunicationDtoaM_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:TemplateCommunicationDto> <d2p1:CampaignTypeCode>sample string 7</d2p1:CampaignTypeCode> <d2p1:ChannelCommunicationCode>sample string 6</d2p1:ChannelCommunicationCode> <d2p1:Code>sample string 1</d2p1:Code> <d2p1:Id>c104381a-eb3c-41fa-b98f-630507ca36fc</d2p1:Id> <d2p1:LanguageCode>sample string 5</d2p1:LanguageCode> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Url>sample string 3</d2p1:Url> <d2p1:UrlScreenshot>sample string 4</d2p1:UrlScreenshot> </d2p1:TemplateCommunicationDto> <d2p1:TemplateCommunicationDto> <d2p1:CampaignTypeCode>sample string 7</d2p1:CampaignTypeCode> <d2p1:ChannelCommunicationCode>sample string 6</d2p1:ChannelCommunicationCode> <d2p1:Code>sample string 1</d2p1:Code> <d2p1:Id>c104381a-eb3c-41fa-b98f-630507ca36fc</d2p1:Id> <d2p1:LanguageCode>sample string 5</d2p1:LanguageCode> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Url>sample string 3</d2p1:Url> <d2p1:UrlScreenshot>sample string 4</d2p1:UrlScreenshot> </d2p1:TemplateCommunicationDto> </Results> </MultiResultResponseOfTemplateCommunicationDtoaM_S85dVU>