PUT api/content/v4/getadvertisements

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerId	integer	None.
Page	integer	None.
Type	integer	None.
UniqueId	globally unique identifier	None.
UserUniqueId	integer	None.
AdvertiseIds	Collection of integer	None.
SectionId	integer	None.
LanguageId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "Page": 2,
  "Type": 3,
  "UniqueId": "b3965cd0-8d5a-4e86-bcdc-7d525f5e5023",
  "UserUniqueId": 5,
  "AdvertiseIds": [
    1,
    2
  ],
  "SectionId": 6,
  "LanguageId": 7
}

application/xml, text/xml

Sample:

<AdvertisementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/">
  <AdvertiseIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </AdvertiseIds>
  <CustomerId>1</CustomerId>
  <LanguageId>7</LanguageId>
  <Page>2</Page>
  <SectionId>6</SectionId>
  <Type>3</Type>
  <UniqueId>b3965cd0-8d5a-4e86-bcdc-7d525f5e5023</UniqueId>
  <UserUniqueId>5</UserUniqueId>
</AdvertisementRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APICommonWrapperOfAdvertisementResponse

Name	Type	Additional information
Status	HttpStatusCode	None.
Message	string	None.
Data	AdvertisementResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": 100,
  "Message": "sample string 1",
  "Data": {
    "Advertise": {
      "Id": 1,
      "Title": "sample string 2",
      "RedirectURL": "sample string 3",
      "Image": "sample string 4",
      "Token": "3b12903b-7519-4155-9448-75169e29068c",
      "AdType": 6
    }
  }
}

application/xml, text/xml

Sample:

<APICommonWrapperOfAdvertisementResponseMTRdQN6P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/">
    <d2p1:Advertise>
      <d2p1:AdType>6</d2p1:AdType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Image>sample string 4</d2p1:Image>
      <d2p1:RedirectURL>sample string 3</d2p1:RedirectURL>
      <d2p1:Title>sample string 2</d2p1:Title>
      <d2p1:Token>3b12903b-7519-4155-9448-75169e29068c</d2p1:Token>
    </d2p1:Advertise>
  </Data>
  <Message>sample string 1</Message>
  <Status>Continue</Status>
</APICommonWrapperOfAdvertisementResponseMTRdQN6P>