GET api/Banner/Get?apiKey={apiKey}&imagePlacementIds={imagePlacementIds}&lng={lng}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apiKey

string

Required

imagePlacementIds

string

Required

lng

string

Default value is en

Body Parameters

None.

Response Information

Resource Description

Collection of Banner
NameDescriptionTypeAdditional information
BannerID

globally unique identifier

None.

Title

string

None.

SubTitle

string

None.

SequenceNo

integer

None.

NavigationUrl

string

None.

ImagePlacement

ImagePlacement

None.

BannerAttachment

Attachment

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "BannerID": "8f78c293-d72a-4dee-bc04-3ab0b3a771ac",
    "Title": "sample string 2",
    "SubTitle": "sample string 3",
    "SequenceNo": 4,
    "NavigationUrl": "sample string 5",
    "ImagePlacement": {
      "Id": 1,
      "Name": "sample string 2"
    },
    "BannerAttachment": {
      "AttachmentID": "edc1c6ec-c0ab-4bbf-a407-148de8a6922f",
      "ImageString": "sample string 6",
      "AttachmentDataBase64": "sample string 7"
    }
  },
  {
    "BannerID": "8f78c293-d72a-4dee-bc04-3ab0b3a771ac",
    "Title": "sample string 2",
    "SubTitle": "sample string 3",
    "SequenceNo": 4,
    "NavigationUrl": "sample string 5",
    "ImagePlacement": {
      "Id": 1,
      "Name": "sample string 2"
    },
    "BannerAttachment": {
      "AttachmentID": "edc1c6ec-c0ab-4bbf-a407-148de8a6922f",
      "ImageString": "sample string 6",
      "AttachmentDataBase64": "sample string 7"
    }
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.