GET api/banners?IsActive={IsActive}&IsFeatured={IsFeatured}&DateFrom={DateFrom}&DateTo={DateTo}&PageIndex={PageIndex}&PageSize={PageSize}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
IsActive

boolean

None.

IsFeatured

boolean

None.

DateFrom

date

None.

DateTo

date

None.

PageIndex

integer

None.

PageSize

integer

None.

Body Parameters

None.

Response Information

Resource Description

PaginationRespModelOfBannerOutputModel
NameDescriptionTypeAdditional information
CurrentPage

integer

None.

LastPage

integer

None.

PerPage

integer

None.

Total

integer

None.

From

integer

None.

To

integer

None.

Data

Collection of BannerOutputModel

None.

Response Formats

application/json, text/json

Sample:
{
  "CurrentPage": 1,
  "LastPage": 2,
  "PerPage": 3,
  "Total": 4,
  "From": 5,
  "To": 6,
  "Data": [
    {
      "Id": "sample string 1",
      "DisplayOrder": 2,
      "IsActive": true,
      "IsFeatured": true,
      "ImageUrl": "sample string 5",
      "StartDate": "2024-09-28T11:17:41.7413357+08:00",
      "EndDate": "2024-09-28T11:17:41.7413357+08:00",
      "WhatsAppNumber": "sample string 8",
      "ContactNumber": "sample string 9",
      "WebsiteUrl": "sample string 10",
      "Location": "sample string 11",
      "Latitude": 12.0,
      "Longitude": 13.0,
      "IsLiked": true,
      "Title": "sample string 15",
      "Description": "sample string 16",
      "TermAndCondition": "sample string 17",
      "LanguageCode": "sample string 18",
      "Images": [
        {
          "Id": 1,
          "ImageUrl": "sample string 2"
        },
        {
          "Id": 1,
          "ImageUrl": "sample string 2"
        }
      ],
      "Route": "sample string 19",
      "Params": {}
    },
    {
      "Id": "sample string 1",
      "DisplayOrder": 2,
      "IsActive": true,
      "IsFeatured": true,
      "ImageUrl": "sample string 5",
      "StartDate": "2024-09-28T11:17:41.7413357+08:00",
      "EndDate": "2024-09-28T11:17:41.7413357+08:00",
      "WhatsAppNumber": "sample string 8",
      "ContactNumber": "sample string 9",
      "WebsiteUrl": "sample string 10",
      "Location": "sample string 11",
      "Latitude": 12.0,
      "Longitude": 13.0,
      "IsLiked": true,
      "Title": "sample string 15",
      "Description": "sample string 16",
      "TermAndCondition": "sample string 17",
      "LanguageCode": "sample string 18",
      "Images": [
        {
          "Id": 1,
          "ImageUrl": "sample string 2"
        },
        {
          "Id": 1,
          "ImageUrl": "sample string 2"
        }
      ],
      "Route": "sample string 19",
      "Params": {}
    }
  ]
}

application/xml, text/xml

Sample:
<PaginationRespModelOfBannerOutputModelpVZiKEaY xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HyperQB.ClientPropertyManagement.API.Models">
  <CurrentPage>1</CurrentPage>
  <Data>
    <BannerOutputModel>
      <Params />
      <Route>sample string 19</Route>
      <ContactNumber>sample string 9</ContactNumber>
      <Description>sample string 16</Description>
      <DisplayOrder>2</DisplayOrder>
      <EndDate>2024-09-28T11:17:41.7413357+08:00</EndDate>
      <Id>sample string 1</Id>
      <ImageUrl>sample string 5</ImageUrl>
      <Images>
        <BannerImageModel>
          <Id>1</Id>
          <ImageUrl>sample string 2</ImageUrl>
        </BannerImageModel>
        <BannerImageModel>
          <Id>1</Id>
          <ImageUrl>sample string 2</ImageUrl>
        </BannerImageModel>
      </Images>
      <IsActive>true</IsActive>
      <IsFeatured>true</IsFeatured>
      <IsLiked>true</IsLiked>
      <LanguageCode>sample string 18</LanguageCode>
      <Latitude>12</Latitude>
      <Location>sample string 11</Location>
      <Longitude>13</Longitude>
      <StartDate>2024-09-28T11:17:41.7413357+08:00</StartDate>
      <TermAndCondition>sample string 17</TermAndCondition>
      <Title>sample string 15</Title>
      <WebsiteUrl>sample string 10</WebsiteUrl>
      <WhatsAppNumber>sample string 8</WhatsAppNumber>
    </BannerOutputModel>
    <BannerOutputModel>
      <Params />
      <Route>sample string 19</Route>
      <ContactNumber>sample string 9</ContactNumber>
      <Description>sample string 16</Description>
      <DisplayOrder>2</DisplayOrder>
      <EndDate>2024-09-28T11:17:41.7413357+08:00</EndDate>
      <Id>sample string 1</Id>
      <ImageUrl>sample string 5</ImageUrl>
      <Images>
        <BannerImageModel>
          <Id>1</Id>
          <ImageUrl>sample string 2</ImageUrl>
        </BannerImageModel>
        <BannerImageModel>
          <Id>1</Id>
          <ImageUrl>sample string 2</ImageUrl>
        </BannerImageModel>
      </Images>
      <IsActive>true</IsActive>
      <IsFeatured>true</IsFeatured>
      <IsLiked>true</IsLiked>
      <LanguageCode>sample string 18</LanguageCode>
      <Latitude>12</Latitude>
      <Location>sample string 11</Location>
      <Longitude>13</Longitude>
      <StartDate>2024-09-28T11:17:41.7413357+08:00</StartDate>
      <TermAndCondition>sample string 17</TermAndCondition>
      <Title>sample string 15</Title>
      <WebsiteUrl>sample string 10</WebsiteUrl>
      <WhatsAppNumber>sample string 8</WhatsAppNumber>
    </BannerOutputModel>
  </Data>
  <From>5</From>
  <LastPage>2</LastPage>
  <PerPage>3</PerPage>
  <To>6</To>
  <Total>4</Total>
</PaginationRespModelOfBannerOutputModelpVZiKEaY>