GET api/banners/{bannerId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| bannerId | string |
Required |
Body Parameters
None.
Response Information
Resource Description
BannerOutputModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | string |
None. |
|
| DisplayOrder | integer |
None. |
|
| IsActive | boolean |
None. |
|
| IsFeatured | boolean |
None. |
|
| ImageUrl | string |
None. |
|
| StartDate | date |
None. |
|
| EndDate | date |
None. |
|
| WhatsAppNumber | string |
None. |
|
| ContactNumber | string |
None. |
|
| WebsiteUrl | string |
None. |
|
| Location | string |
None. |
|
| Latitude | decimal number |
None. |
|
| Longitude | decimal number |
None. |
|
| IsLiked | boolean |
None. |
|
| Title | string |
None. |
|
| Description | string |
None. |
|
| TermAndCondition | string |
None. |
|
| LanguageCode | string |
None. |
|
| Images | Collection of BannerImageModel |
None. |
|
| Route | string |
None. |
|
| Params | Object |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "sample string 1",
"DisplayOrder": 2,
"IsActive": true,
"IsFeatured": true,
"ImageUrl": "sample string 5",
"StartDate": "2025-10-30T23:39:07.8366339+08:00",
"EndDate": "2025-10-30T23:39:07.8366339+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:
<BannerOutputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HyperQB.ClientPropertyManagement.API.Models">
<Params />
<Route>sample string 19</Route>
<ContactNumber>sample string 9</ContactNumber>
<Description>sample string 16</Description>
<DisplayOrder>2</DisplayOrder>
<EndDate>2025-10-30T23:39:07.8366339+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>2025-10-30T23:39:07.8366339+08:00</StartDate>
<TermAndCondition>sample string 17</TermAndCondition>
<Title>sample string 15</Title>
<WebsiteUrl>sample string 10</WebsiteUrl>
<WhatsAppNumber>sample string 8</WhatsAppNumber>
</BannerOutputModel>