GET api/WebBanner/List?affiliateId={affiliateId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| affiliateId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of WebBanner| Name | Description | Type | Additional information |
|---|---|---|---|
| Description | string |
None. |
|
| Discount | Discount |
None. |
|
| EndDate | date |
None. |
|
| CampaignId | globally unique identifier |
None. |
|
| Url | string |
None. |
|
| ImageHeight | integer |
None. |
|
| ImageWidth | integer |
None. |
|
| StartDate | date |
None. |
|
| Title | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Description": "sample string 1",
"Discount": {
"Amount": 1.0,
"ApplyAtEnd": true,
"ApplyAtStart": true,
"Code": "sample string 4",
"Description": "sample string 5",
"Id": "3ade654e-0551-4c15-a84c-7f0c0be79de6",
"IsPercentage": true,
"Monthly": true,
"NumberOfMonths": 9
},
"EndDate": "2026-02-04T01:08:33.8640008+00:00",
"CampaignId": "530e99c5-4ab5-4d6a-a8cd-9934dac27d5c",
"Url": "sample string 3",
"ImageHeight": 4,
"ImageWidth": 5,
"StartDate": "2026-02-04T01:08:33.8640008+00:00",
"Title": "sample string 6"
},
{
"Description": "sample string 1",
"Discount": {
"Amount": 1.0,
"ApplyAtEnd": true,
"ApplyAtStart": true,
"Code": "sample string 4",
"Description": "sample string 5",
"Id": "3ade654e-0551-4c15-a84c-7f0c0be79de6",
"IsPercentage": true,
"Monthly": true,
"NumberOfMonths": 9
},
"EndDate": "2026-02-04T01:08:33.8640008+00:00",
"CampaignId": "530e99c5-4ab5-4d6a-a8cd-9934dac27d5c",
"Url": "sample string 3",
"ImageHeight": 4,
"ImageWidth": 5,
"StartDate": "2026-02-04T01:08:33.8640008+00:00",
"Title": "sample string 6"
}
]
application/xml, text/xml
Sample:
<ArrayOfWebBanner xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tss.Eitr.Customer.Agria.WebApi.Models">
<WebBanner>
<CampaignId>530e99c5-4ab5-4d6a-a8cd-9934dac27d5c</CampaignId>
<Description>sample string 1</Description>
<Discount>
<Amount>1</Amount>
<ApplyAtEnd>true</ApplyAtEnd>
<ApplyAtStart>true</ApplyAtStart>
<Code>sample string 4</Code>
<Description>sample string 5</Description>
<Id>3ade654e-0551-4c15-a84c-7f0c0be79de6</Id>
<IsPercentage>true</IsPercentage>
<Monthly>true</Monthly>
<NumberOfMonths>9</NumberOfMonths>
</Discount>
<EndDate>2026-02-04T01:08:33.8640008+00:00</EndDate>
<ImageHeight>4</ImageHeight>
<ImageWidth>5</ImageWidth>
<StartDate>2026-02-04T01:08:33.8640008+00:00</StartDate>
<Title>sample string 6</Title>
<Url>sample string 3</Url>
</WebBanner>
<WebBanner>
<CampaignId>530e99c5-4ab5-4d6a-a8cd-9934dac27d5c</CampaignId>
<Description>sample string 1</Description>
<Discount>
<Amount>1</Amount>
<ApplyAtEnd>true</ApplyAtEnd>
<ApplyAtStart>true</ApplyAtStart>
<Code>sample string 4</Code>
<Description>sample string 5</Description>
<Id>3ade654e-0551-4c15-a84c-7f0c0be79de6</Id>
<IsPercentage>true</IsPercentage>
<Monthly>true</Monthly>
<NumberOfMonths>9</NumberOfMonths>
</Discount>
<EndDate>2026-02-04T01:08:33.8640008+00:00</EndDate>
<ImageHeight>4</ImageHeight>
<ImageWidth>5</ImageWidth>
<StartDate>2026-02-04T01:08:33.8640008+00:00</StartDate>
<Title>sample string 6</Title>
<Url>sample string 3</Url>
</WebBanner>
</ArrayOfWebBanner>