Get All Banners

GET

/api/v1/banners

curl --request GET \
  --url 'https://example.com/api/v1/banners?only_active=false&platform=USER_PORTAL&limit=100&offset=0&order_by=created_at&order_by_direction=ASC'

Parameters

Query Parameters

only_active

Only Active

If True, returns only active banners. Default: False

boolean

If True, returns only active banners. Default: False

platform

BannerPlatform

If value, returns only banners assigned to the corresponding platform. Default: None

string

Allowed values: USER_PORTAL COMMUNITY_PLATFORM

If value, returns only banners assigned to the corresponding platform. Default: None

limit

Limit

integer

default: 100 > 0 < 101

offset

Offset

integer

0

order_by

Order By

string

default: created_at

order_by_direction

SortDirection

string

default: DESC

Allowed values: ASC DESC

Responses

200

Successful Response

Media typeapplication/json

HeaderPaginatedResponse[ProducedBannerResponse]

object

status

JSendStatus

string

default: success

Allowed values: success fail error

message

Message

string

default: OK.

code

Code

string

default: 200

data

required

Data

Array<object>

ProducedBannerResponse

Response to a request for banners to display on a page

object

id

required

Id

string format: uuid

banner_message

required

Banner Message

string

start_datetime

required

Start Datetime

string format: date-time

end_datetime

required

End Datetime

string format: date-time

level

required

BannerLevel

string

Allowed values: INFO WARNING

platform

required

BannerPlatform

string

Allowed values: USER_PORTAL COMMUNITY_PLATFORM

pagination

required

JSendPagination

Pagination information

object

total

required

Total

integer

start

required

Start

integer

end

required

End

integer

Example

{
  "status": "success",
  "message": "OK.",
  "code": "200",
  "data": [
    {
      "level": "INFO",
      "platform": "USER_PORTAL"
    }
  ]
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}