For the complete documentation index, see llms.txt. This page is also available as Markdown.

Manage Banners

Add a new banner

post

This is for adding a new banner.

Header parameters
AuthorizationstringRequired
Body
titlestringRequired
contentstringOptional
imagestringRequired
linkstringOptional
positioninteger · int32Optional
statusinteger · int32Required
linkTypeinteger · int32Optional
Responses
200

success response

application/json
bannerIdintegerOptional
titlestringOptional
linkstringOptional
contentstringOptional
positionintegerOptional
imagestringOptional
imagePathstringOptional
isActiveintegerOptional
linkTypeintegerOptional
post/banner
POST /banner HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 99

"title='text'&content='text'&image='text'&link='text'&position=1&status=1&linkType=1"
{
  "bannerId": 1,
  "title": "text",
  "link": "text",
  "content": "text",
  "position": 1,
  "image": "text",
  "imagePath": "text",
  "isActive": 1,
  "linkType": 1
}

List of Banners

get

This is for getting the list of added banners.

Query parameters
limitintegerOptional
offsetintegerOptional
keywordstringOptional
statusstringOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Successfully got banner count " or " Successfully got banner list
get/banner
GET /banner HTTP/1.1
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully got banner count \" or \" Successfully got banner list"
}

Delete a banner

delete

This is for deleting an already added banner.

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Successfully deleted banner.
delete/banner/{id}
DELETE /banner/{id} HTTP/1.1
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "Successfully deleted banner."
}

Update banner

put

This is for updating an already added banner, if not needed anymore.

Path parameters
idintegerRequired
Header parameters
AuthorizationstringRequired
Body
bannerIdinteger · int32Required
titlestringRequired
contentstringOptional
imagestringOptional
linkstringOptional
positioninteger · int32Optional
statusinteger · int32Required
linkTypeinteger · int32Optional
Responses
200

success response

application/json
createdByintegerOptional
createdDatestring · date-timeOptional
modifiedByintegerOptional
modifiedDatestring · date-timeOptional
bannerIdintegerOptional
titlestringOptional
sortOrderintegerOptional
urlstringOptional
linkstringOptional
bannerGroupIdintegerOptional
imagestringOptional
imagePathstringOptional
containerNamestringOptional
viewPageCountintegerOptional
isActivestringOptional
put/banner/{id}
PUT /banner/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 112

"bannerId=1&title='text'&content='text'&image='text'&link='text'&position=1&status=1&linkType=1"
{
  "createdBy": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "modifiedBy": 1,
  "modifiedDate": "2026-01-01T00:00:00.000Z",
  "bannerId": 1,
  "title": "text",
  "sortOrder": 1,
  "url": "text",
  "link": "text",
  "bannerGroupId": 1,
  "image": "text",
  "imagePath": "text",
  "containerName": "text",
  "viewPageCount": 1,
  "isActive": "text"
}

Delete multiple banner

post

This is for deletting the multiple banners.

Header parameters
AuthorizationstringRequired
Body
pageIdinteger[]Optional
Responses
200

success response

application/json
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Successfully deleted Banner.
post/banner/delete-banner
POST /banner/delete-banner HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 14

"pageId=[1]"
{
  "status": 1,
  "message": "Successfully deleted Banner."
}

Getting banner count

get

This is for getting the banner Count

Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Successfully got the banner count
get/banner/banner-count
GET /banner/banner-count HTTP/1.1
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully got the banner count"
}

List of Banner

get

This is for getting a list of banner

Query parameters
bannerIdintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: ""
datastringOptionalDefault: ""
get/banner/banner-detail
GET /banner/banner-detail?bannerId=1 HTTP/1.1
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "",
  "data": ""
}

Excel list of Banner

get

This is for getting the excel list of banner

Query parameters
bannerIdstringRequired
Header parameters
AuthorizationstringRequired
Responses
400

error response

*/*
statusintegerOptional
messagestringOptionalDefault: choose atleast one banner " or " Invalid bannerId
get/banner/banner-excel-list
GET /banner/banner-excel-list?bannerId=text HTTP/1.1
Authorization: text
Accept: */*
400

error response

{
  "status": 1,
  "message": "choose atleast one banner \" or \" Invalid bannerId"
}

Last updated