GET api/WebBanner/List?affiliateId={affiliateId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
affiliateId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Collection of WebBanner
NameDescriptionTypeAdditional 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": "d1ea8b79-f7bc-4087-b0d1-43ba9a334689",
      "IsPercentage": true,
      "Monthly": true,
      "NumberOfMonths": 9
    },
    "EndDate": "2025-07-07T13:40:48.9094216+01:00",
    "CampaignId": "da26b827-43cf-4815-b08c-58aba198cb84",
    "Url": "sample string 3",
    "ImageHeight": 4,
    "ImageWidth": 5,
    "StartDate": "2025-07-07T13:40:48.9094216+01: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": "d1ea8b79-f7bc-4087-b0d1-43ba9a334689",
      "IsPercentage": true,
      "Monthly": true,
      "NumberOfMonths": 9
    },
    "EndDate": "2025-07-07T13:40:48.9094216+01:00",
    "CampaignId": "da26b827-43cf-4815-b08c-58aba198cb84",
    "Url": "sample string 3",
    "ImageHeight": 4,
    "ImageWidth": 5,
    "StartDate": "2025-07-07T13:40:48.9094216+01: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>da26b827-43cf-4815-b08c-58aba198cb84</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>d1ea8b79-f7bc-4087-b0d1-43ba9a334689</Id>
      <IsPercentage>true</IsPercentage>
      <Monthly>true</Monthly>
      <NumberOfMonths>9</NumberOfMonths>
    </Discount>
    <EndDate>2025-07-07T13:40:48.9094216+01:00</EndDate>
    <ImageHeight>4</ImageHeight>
    <ImageWidth>5</ImageWidth>
    <StartDate>2025-07-07T13:40:48.9094216+01:00</StartDate>
    <Title>sample string 6</Title>
    <Url>sample string 3</Url>
  </WebBanner>
  <WebBanner>
    <CampaignId>da26b827-43cf-4815-b08c-58aba198cb84</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>d1ea8b79-f7bc-4087-b0d1-43ba9a334689</Id>
      <IsPercentage>true</IsPercentage>
      <Monthly>true</Monthly>
      <NumberOfMonths>9</NumberOfMonths>
    </Discount>
    <EndDate>2025-07-07T13:40:48.9094216+01:00</EndDate>
    <ImageHeight>4</ImageHeight>
    <ImageWidth>5</ImageWidth>
    <StartDate>2025-07-07T13:40:48.9094216+01:00</StartDate>
    <Title>sample string 6</Title>
    <Url>sample string 3</Url>
  </WebBanner>
</ArrayOfWebBanner>