GET api/Banner/GetBanner?languageType={languageType}

Request Information

URI Parameters

Name	Description	Type	Additional information
languageType		CmsLanguage	Required

Body Parameters

None.

Response Information

Resource Description

BannerResponse

Name	Type	Additional information
WebBannerInfo	BannerInfo	None.
MobileBannerInfo	BannerInfo	None.
ResponseCode	ResponseCode	None.
AlertMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "WebBannerInfo": {
    "TopList": [
      {
        "BannerID": 1,
        "AlertText": "sample string 2",
        "ImageUrl": "sample string 3",
        "LinkUrl": "sample string 4",
        "UrlTarget": 5,
        "BannerTypeDesc": "sample string 6",
        "DeviceType": 7,
        "Sequence": 8,
        "Title": "sample string 9"
      },
      {
        "BannerID": 1,
        "AlertText": "sample string 2",
        "ImageUrl": "sample string 3",
        "LinkUrl": "sample string 4",
        "UrlTarget": 5,
        "BannerTypeDesc": "sample string 6",
        "DeviceType": 7,
        "Sequence": 8,
        "Title": "sample string 9"
      }
    ],
    "HorizontalInfo": {
      "BannerID": 1,
      "AlertText": "sample string 2",
      "ImageUrl": "sample string 3",
      "LinkUrl": "sample string 4",
      "UrlTarget": 5,
      "BannerTypeDesc": "sample string 6",
      "DeviceType": 7,
      "Sequence": 8,
      "Title": "sample string 9"
    }
  },
  "MobileBannerInfo": {
    "TopList": [
      {
        "BannerID": 1,
        "AlertText": "sample string 2",
        "ImageUrl": "sample string 3",
        "LinkUrl": "sample string 4",
        "UrlTarget": 5,
        "BannerTypeDesc": "sample string 6",
        "DeviceType": 7,
        "Sequence": 8,
        "Title": "sample string 9"
      },
      {
        "BannerID": 1,
        "AlertText": "sample string 2",
        "ImageUrl": "sample string 3",
        "LinkUrl": "sample string 4",
        "UrlTarget": 5,
        "BannerTypeDesc": "sample string 6",
        "DeviceType": 7,
        "Sequence": 8,
        "Title": "sample string 9"
      }
    ],
    "HorizontalInfo": {
      "BannerID": 1,
      "AlertText": "sample string 2",
      "ImageUrl": "sample string 3",
      "LinkUrl": "sample string 4",
      "UrlTarget": 5,
      "BannerTypeDesc": "sample string 6",
      "DeviceType": 7,
      "Sequence": 8,
      "Title": "sample string 9"
    }
  },
  "ResponseCode": 1,
  "AlertMessage": "sample string 1"
}

text/xml

Sample:

<BannerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CentaMortgageWebAPI.Models">
  <AlertMessage>sample string 1</AlertMessage>
  <ResponseCode>Success</ResponseCode>
  <MobileBannerInfo>
    <HorizontalInfo>
      <AlertText>sample string 2</AlertText>
      <BannerID>1</BannerID>
      <BannerTypeDesc>sample string 6</BannerTypeDesc>
      <DeviceType>7</DeviceType>
      <ImageUrl>sample string 3</ImageUrl>
      <LinkUrl>sample string 4</LinkUrl>
      <Sequence>8</Sequence>
      <Title>sample string 9</Title>
      <UrlTarget>5</UrlTarget>
    </HorizontalInfo>
    <TopList>
      <BannerModel>
        <AlertText>sample string 2</AlertText>
        <BannerID>1</BannerID>
        <BannerTypeDesc>sample string 6</BannerTypeDesc>
        <DeviceType>7</DeviceType>
        <ImageUrl>sample string 3</ImageUrl>
        <LinkUrl>sample string 4</LinkUrl>
        <Sequence>8</Sequence>
        <Title>sample string 9</Title>
        <UrlTarget>5</UrlTarget>
      </BannerModel>
      <BannerModel>
        <AlertText>sample string 2</AlertText>
        <BannerID>1</BannerID>
        <BannerTypeDesc>sample string 6</BannerTypeDesc>
        <DeviceType>7</DeviceType>
        <ImageUrl>sample string 3</ImageUrl>
        <LinkUrl>sample string 4</LinkUrl>
        <Sequence>8</Sequence>
        <Title>sample string 9</Title>
        <UrlTarget>5</UrlTarget>
      </BannerModel>
    </TopList>
  </MobileBannerInfo>
  <WebBannerInfo>
    <HorizontalInfo>
      <AlertText>sample string 2</AlertText>
      <BannerID>1</BannerID>
      <BannerTypeDesc>sample string 6</BannerTypeDesc>
      <DeviceType>7</DeviceType>
      <ImageUrl>sample string 3</ImageUrl>
      <LinkUrl>sample string 4</LinkUrl>
      <Sequence>8</Sequence>
      <Title>sample string 9</Title>
      <UrlTarget>5</UrlTarget>
    </HorizontalInfo>
    <TopList>
      <BannerModel>
        <AlertText>sample string 2</AlertText>
        <BannerID>1</BannerID>
        <BannerTypeDesc>sample string 6</BannerTypeDesc>
        <DeviceType>7</DeviceType>
        <ImageUrl>sample string 3</ImageUrl>
        <LinkUrl>sample string 4</LinkUrl>
        <Sequence>8</Sequence>
        <Title>sample string 9</Title>
        <UrlTarget>5</UrlTarget>
      </BannerModel>
      <BannerModel>
        <AlertText>sample string 2</AlertText>
        <BannerID>1</BannerID>
        <BannerTypeDesc>sample string 6</BannerTypeDesc>
        <DeviceType>7</DeviceType>
        <ImageUrl>sample string 3</ImageUrl>
        <LinkUrl>sample string 4</LinkUrl>
        <Sequence>8</Sequence>
        <Title>sample string 9</Title>
        <UrlTarget>5</UrlTarget>
      </BannerModel>
    </TopList>
  </WebBannerInfo>
</BannerResponse>