GET adserving/BANNER/{LCID}?CID={CID}

Documentation for 'BANNER'.

Request Information

Parameters

NameDescriptionAdditional information
CID
Documentation for 'CID'.

Define this parameter in the request URI.

LCID
Documentation for 'LCID'.

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "errors": [
    {
      "Number": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "Number": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "Number": "sample string 1",
      "Message": "sample string 2"
    }
  ],
  "banners": [
    {
      "azr_rkey": "sample string 1",
      "adzone_rkey": "sample string 2",
      "asset_id": "sample string 3",
      "asset_sizewidth": "sample string 4",
      "asset_sizeheight": "sample string 5",
      "asset_usetargeturl": "sample string 6",
      "asset_templarcssclass": "sample string 7",
      "adzone_location": "sample string 8",
      "adzone_tags": "sample string 9",
      "adzone_format": "sample string 10",
      "adzone_audience": "sample string 11",
      "adzone_failoverimage": "sample string 12",
      "campaigns": [
        {
          "name": "sample string 1",
          "url": "sample string 2",
          "imageurl": "sample string 3",
          "startdate": "sample string 4",
          "starttime": "sample string 5",
          "enddate": "sample string 6",
          "endtime": "sample string 7"
        },
        {
          "name": "sample string 1",
          "url": "sample string 2",
          "imageurl": "sample string 3",
          "startdate": "sample string 4",
          "starttime": "sample string 5",
          "enddate": "sample string 6",
          "endtime": "sample string 7"
        },
        {
          "name": "sample string 1",
          "url": "sample string 2",
          "imageurl": "sample string 3",
          "startdate": "sample string 4",
          "starttime": "sample string 5",
          "enddate": "sample string 6",
          "endtime": "sample string 7"
        }
      ],
      "slideShowSetting": {
        "failOver": "sample string 1",
        "effect": "sample string 2",
        "animSpeed": "sample string 3",
        "pauseTime": "sample string 4",
        "startSlide": "sample string 5",
        "directionNav": "sample string 6",
        "directionNavHide": "sample string 7",
        "controlNav": "sample string 8",
        "controlNavThumbs": "sample string 9",
        "controlNavThumbsFromRel": "sample string 10",
        "keyboardNav": "sample string 11",
        "pauseOnHover": "sample string 12",
        "captionOpacity": "sample string 13",
        "loopStop": "sample string 14",
        "enableNavinbr": "sample string 15"
      }
    },
    {
      "azr_rkey": "sample string 1",
      "adzone_rkey": "sample string 2",
      "asset_id": "sample string 3",
      "asset_sizewidth": "sample string 4",
      "asset_sizeheight": "sample string 5",
      "asset_usetargeturl": "sample string 6",
      "asset_templarcssclass": "sample string 7",
      "adzone_location": "sample string 8",
      "adzone_tags": "sample string 9",
      "adzone_format": "sample string 10",
      "adzone_audience": "sample string 11",
      "adzone_failoverimage": "sample string 12",
      "campaigns": [
        {
          "name": "sample string 1",
          "url": "sample string 2",
          "imageurl": "sample string 3",
          "startdate": "sample string 4",
          "starttime": "sample string 5",
          "enddate": "sample string 6",
          "endtime": "sample string 7"
        },
        {
          "name": "sample string 1",
          "url": "sample string 2",
          "imageurl": "sample string 3",
          "startdate": "sample string 4",
          "starttime": "sample string 5",
          "enddate": "sample string 6",
          "endtime": "sample string 7"
        },
        {
          "name": "sample string 1",
          "url": "sample string 2",
          "imageurl": "sample string 3",
          "startdate": "sample string 4",
          "starttime": "sample string 5",
          "enddate": "sample string 6",
          "endtime": "sample string 7"
        }
      ],
      "slideShowSetting": {
        "failOver": "sample string 1",
        "effect": "sample string 2",
        "animSpeed": "sample string 3",
        "pauseTime": "sample string 4",
        "startSlide": "sample string 5",
        "directionNav": "sample string 6",
        "directionNavHide": "sample string 7",
        "controlNav": "sample string 8",
        "controlNavThumbs": "sample string 9",
        "controlNavThumbsFromRel": "sample string 10",
        "keyboardNav": "sample string 11",
        "pauseOnHover": "sample string 12",
        "captionOpacity": "sample string 13",
        "loopStop": "sample string 14",
        "enableNavinbr": "sample string 15"
      }
    },
    {
      "azr_rkey": "sample string 1",
      "adzone_rkey": "sample string 2",
      "asset_id": "sample string 3",
      "asset_sizewidth": "sample string 4",
      "asset_sizeheight": "sample string 5",
      "asset_usetargeturl": "sample string 6",
      "asset_templarcssclass": "sample string 7",
      "adzone_location": "sample string 8",
      "adzone_tags": "sample string 9",
      "adzone_format": "sample string 10",
      "adzone_audience": "sample string 11",
      "adzone_failoverimage": "sample string 12",
      "campaigns": [
        {
          "name": "sample string 1",
          "url": "sample string 2",
          "imageurl": "sample string 3",
          "startdate": "sample string 4",
          "starttime": "sample string 5",
          "enddate": "sample string 6",
          "endtime": "sample string 7"
        },
        {
          "name": "sample string 1",
          "url": "sample string 2",
          "imageurl": "sample string 3",
          "startdate": "sample string 4",
          "starttime": "sample string 5",
          "enddate": "sample string 6",
          "endtime": "sample string 7"
        },
        {
          "name": "sample string 1",
          "url": "sample string 2",
          "imageurl": "sample string 3",
          "startdate": "sample string 4",
          "starttime": "sample string 5",
          "enddate": "sample string 6",
          "endtime": "sample string 7"
        }
      ],
      "slideShowSetting": {
        "failOver": "sample string 1",
        "effect": "sample string 2",
        "animSpeed": "sample string 3",
        "pauseTime": "sample string 4",
        "startSlide": "sample string 5",
        "directionNav": "sample string 6",
        "directionNavHide": "sample string 7",
        "controlNav": "sample string 8",
        "controlNavThumbs": "sample string 9",
        "controlNavThumbsFromRel": "sample string 10",
        "keyboardNav": "sample string 11",
        "pauseOnHover": "sample string 12",
        "captionOpacity": "sample string 13",
        "loopStop": "sample string 14",
        "enableNavinbr": "sample string 15"
      }
    }
  ],
  "status": "sample string 1"
}

application/xml, text/xml

Sample:
<BannerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpecialsAPI.Models">
  <banners>
    <BannerDeal>
      <adzone_audience>sample string 11</adzone_audience>
      <adzone_failoverimage>sample string 12</adzone_failoverimage>
      <adzone_format>sample string 10</adzone_format>
      <adzone_location>sample string 8</adzone_location>
      <adzone_rkey>sample string 2</adzone_rkey>
      <adzone_tags>sample string 9</adzone_tags>
      <asset_id>sample string 3</asset_id>
      <asset_sizeheight>sample string 5</asset_sizeheight>
      <asset_sizewidth>sample string 4</asset_sizewidth>
      <asset_templarcssclass>sample string 7</asset_templarcssclass>
      <asset_usetargeturl>sample string 6</asset_usetargeturl>
      <azr_rkey>sample string 1</azr_rkey>
      <campaigns>
        <Campaign>
          <enddate>sample string 6</enddate>
          <endtime>sample string 7</endtime>
          <imageurl>sample string 3</imageurl>
          <name>sample string 1</name>
          <startdate>sample string 4</startdate>
          <starttime>sample string 5</starttime>
          <url>sample string 2</url>
        </Campaign>
        <Campaign>
          <enddate>sample string 6</enddate>
          <endtime>sample string 7</endtime>
          <imageurl>sample string 3</imageurl>
          <name>sample string 1</name>
          <startdate>sample string 4</startdate>
          <starttime>sample string 5</starttime>
          <url>sample string 2</url>
        </Campaign>
        <Campaign>
          <enddate>sample string 6</enddate>
          <endtime>sample string 7</endtime>
          <imageurl>sample string 3</imageurl>
          <name>sample string 1</name>
          <startdate>sample string 4</startdate>
          <starttime>sample string 5</starttime>
          <url>sample string 2</url>
        </Campaign>
      </campaigns>
      <slideShowSetting>
        <animSpeed>sample string 3</animSpeed>
        <captionOpacity>sample string 13</captionOpacity>
        <controlNav>sample string 8</controlNav>
        <controlNavThumbs>sample string 9</controlNavThumbs>
        <controlNavThumbsFromRel>sample string 10</controlNavThumbsFromRel>
        <directionNav>sample string 6</directionNav>
        <directionNavHide>sample string 7</directionNavHide>
        <effect>sample string 2</effect>
        <enableNavinbr>sample string 15</enableNavinbr>
        <failOver>sample string 1</failOver>
        <keyboardNav>sample string 11</keyboardNav>
        <loopStop>sample string 14</loopStop>
        <pauseOnHover>sample string 12</pauseOnHover>
        <pauseTime>sample string 4</pauseTime>
        <startSlide>sample string 5</startSlide>
      </slideShowSetting>
    </BannerDeal>
    <BannerDeal>
      <adzone_audience>sample string 11</adzone_audience>
      <adzone_failoverimage>sample string 12</adzone_failoverimage>
      <adzone_format>sample string 10</adzone_format>
      <adzone_location>sample string 8</adzone_location>
      <adzone_rkey>sample string 2</adzone_rkey>
      <adzone_tags>sample string 9</adzone_tags>
      <asset_id>sample string 3</asset_id>
      <asset_sizeheight>sample string 5</asset_sizeheight>
      <asset_sizewidth>sample string 4</asset_sizewidth>
      <asset_templarcssclass>sample string 7</asset_templarcssclass>
      <asset_usetargeturl>sample string 6</asset_usetargeturl>
      <azr_rkey>sample string 1</azr_rkey>
      <campaigns>
        <Campaign>
          <enddate>sample string 6</enddate>
          <endtime>sample string 7</endtime>
          <imageurl>sample string 3</imageurl>
          <name>sample string 1</name>
          <startdate>sample string 4</startdate>
          <starttime>sample string 5</starttime>
          <url>sample string 2</url>
        </Campaign>
        <Campaign>
          <enddate>sample string 6</enddate>
          <endtime>sample string 7</endtime>
          <imageurl>sample string 3</imageurl>
          <name>sample string 1</name>
          <startdate>sample string 4</startdate>
          <starttime>sample string 5</starttime>
          <url>sample string 2</url>
        </Campaign>
        <Campaign>
          <enddate>sample string 6</enddate>
          <endtime>sample string 7</endtime>
          <imageurl>sample string 3</imageurl>
          <name>sample string 1</name>
          <startdate>sample string 4</startdate>
          <starttime>sample string 5</starttime>
          <url>sample string 2</url>
        </Campaign>
      </campaigns>
      <slideShowSetting>
        <animSpeed>sample string 3</animSpeed>
        <captionOpacity>sample string 13</captionOpacity>
        <controlNav>sample string 8</controlNav>
        <controlNavThumbs>sample string 9</controlNavThumbs>
        <controlNavThumbsFromRel>sample string 10</controlNavThumbsFromRel>
        <directionNav>sample string 6</directionNav>
        <directionNavHide>sample string 7</directionNavHide>
        <effect>sample string 2</effect>
        <enableNavinbr>sample string 15</enableNavinbr>
        <failOver>sample string 1</failOver>
        <keyboardNav>sample string 11</keyboardNav>
        <loopStop>sample string 14</loopStop>
        <pauseOnHover>sample string 12</pauseOnHover>
        <pauseTime>sample string 4</pauseTime>
        <startSlide>sample string 5</startSlide>
      </slideShowSetting>
    </BannerDeal>
    <BannerDeal>
      <adzone_audience>sample string 11</adzone_audience>
      <adzone_failoverimage>sample string 12</adzone_failoverimage>
      <adzone_format>sample string 10</adzone_format>
      <adzone_location>sample string 8</adzone_location>
      <adzone_rkey>sample string 2</adzone_rkey>
      <adzone_tags>sample string 9</adzone_tags>
      <asset_id>sample string 3</asset_id>
      <asset_sizeheight>sample string 5</asset_sizeheight>
      <asset_sizewidth>sample string 4</asset_sizewidth>
      <asset_templarcssclass>sample string 7</asset_templarcssclass>
      <asset_usetargeturl>sample string 6</asset_usetargeturl>
      <azr_rkey>sample string 1</azr_rkey>
      <campaigns>
        <Campaign>
          <enddate>sample string 6</enddate>
          <endtime>sample string 7</endtime>
          <imageurl>sample string 3</imageurl>
          <name>sample string 1</name>
          <startdate>sample string 4</startdate>
          <starttime>sample string 5</starttime>
          <url>sample string 2</url>
        </Campaign>
        <Campaign>
          <enddate>sample string 6</enddate>
          <endtime>sample string 7</endtime>
          <imageurl>sample string 3</imageurl>
          <name>sample string 1</name>
          <startdate>sample string 4</startdate>
          <starttime>sample string 5</starttime>
          <url>sample string 2</url>
        </Campaign>
        <Campaign>
          <enddate>sample string 6</enddate>
          <endtime>sample string 7</endtime>
          <imageurl>sample string 3</imageurl>
          <name>sample string 1</name>
          <startdate>sample string 4</startdate>
          <starttime>sample string 5</starttime>
          <url>sample string 2</url>
        </Campaign>
      </campaigns>
      <slideShowSetting>
        <animSpeed>sample string 3</animSpeed>
        <captionOpacity>sample string 13</captionOpacity>
        <controlNav>sample string 8</controlNav>
        <controlNavThumbs>sample string 9</controlNavThumbs>
        <controlNavThumbsFromRel>sample string 10</controlNavThumbsFromRel>
        <directionNav>sample string 6</directionNav>
        <directionNavHide>sample string 7</directionNavHide>
        <effect>sample string 2</effect>
        <enableNavinbr>sample string 15</enableNavinbr>
        <failOver>sample string 1</failOver>
        <keyboardNav>sample string 11</keyboardNav>
        <loopStop>sample string 14</loopStop>
        <pauseOnHover>sample string 12</pauseOnHover>
        <pauseTime>sample string 4</pauseTime>
        <startSlide>sample string 5</startSlide>
      </slideShowSetting>
    </BannerDeal>
  </banners>
  <errors>
    <Error>
      <Message>sample string 2</Message>
      <Number>sample string 1</Number>
    </Error>
    <Error>
      <Message>sample string 2</Message>
      <Number>sample string 1</Number>
    </Error>
    <Error>
      <Message>sample string 2</Message>
      <Number>sample string 1</Number>
    </Error>
  </errors>
  <status>sample string 1</status>
</BannerResponse>