Manage Banners

Add a new banner

This is for adding a new banner.

POST/banner

Header parameters

Body

application/x-www-form-urlencoded

title*string

contentstring

image*string

linkstring

positioninteger (int32)

status*integer (int32)

linkTypeinteger (int32)

Response

200400

success response

Body

application/json

bannerIdinteger

titlestring

linkstring

contentstring

positioninteger

imagestring

imagePathstring

isActiveinteger

linkTypeinteger

Request

JavaScriptCurl

const response = await fetch('/banner', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "image": "text",
      "title": "text"
    }),
});
const data = await response.json();

Response

{
  "title": "text",
  "link": "text",
  "content": "text",
  "image": "text",
  "imagePath": "text"
}

List of Banners

This is for getting the list of added banners.

GET/banner

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/banner', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Delete a banner

This is for deleting an already added banner.

DELETE/banner/{id}

Path parameters

id*integer

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/banner/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully deleted banner."
}

Update banner

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

PUT/banner/{id}

Path parameters

id*integer

Header parameters

Body

application/x-www-form-urlencoded

bannerId*integer (int32)

title*string

contentstring

imagestring

linkstring

positioninteger (int32)

status*integer (int32)

linkTypeinteger (int32)

Response

200400

success response

Body

application/json

createdByinteger

createdDatestring (date-time)

modifiedByinteger

modifiedDatestring (date-time)

bannerIdinteger

titlestring

sortOrderinteger

urlstring

linkstring

bannerGroupIdinteger

imagestring

imagePathstring

containerNamestring

viewPageCountinteger

isActivestring

Request

JavaScriptCurl

const response = await fetch('/banner/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "title": "text"
    }),
});
const data = await response.json();

Response

{
  "createdDate": "2024-04-29T06:48:31.377Z",
  "modifiedDate": "2024-04-29T06:48:31.377Z",
  "title": "text",
  "url": "text",
  "link": "text",
  "image": "text",
  "imagePath": "text",
  "containerName": "text",
  "isActive": "text"
}

Delete multiple banner

This is for deletting the multiple banners.

POST/banner/delete-banner

Header parameters

Body

application/x-www-form-urlencoded

pageIdarray of integer

Response

200400

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/banner/delete-banner', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "Successfully deleted Banner."
}

Getting banner count

This is for getting the banner Count

GET/banner/banner-count

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/banner/banner-count', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got the banner count"
}

List of Banner

This is for getting a list of banner

GET/banner/banner-detail

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

datastring

Request

JavaScriptCurl

const response = await fetch('/banner/banner-detail', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "text",
  "data": "text"
}

Excel list of Banner

This is for getting the excel list of banner

GET/banner/banner-excel-list

Query parameters

Header parameters

Response

400

error response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/banner/banner-excel-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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