Get a banner by its Id

1min
GET
/developer/support/banners/{bannerId}
Retrieves a banner using the specified bannerId.
Path Parameters
bannerId
string
*
Header Parameters
x-developerplatform-access
string
*
Responses
200
GetBannerByIdResponseDto
bannerId
string
*
levelType
string
*
levelIds
string[]
*
title
string
*
content
object
*
activeFromTime
string
*
activeUntilTime
string
*
400
Bad Request
BadRequestErrorResponseDTO
error
BadRequestErrorDTO
*
request
StandardRequestDTO
*
403
User does not have a support role.
ForbiddenErrorResponseDTO
error
ForbiddenErrorDTO
*
request
StandardRequestDTO
*
404
Banner Id not found.
NotFoundErrorResponseDTO
error
NotFoundErrorDTO
*
request
StandardRequestDTO
*
Curl
JS
Ruby
Python
curl --location --globoff '/developer/support/banners/{bannerId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff '/developer/support/banners/{bannerId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
403
404
{
  "bannerId": "",
  "levelType": "stack",
  "levelIds": [
    ""
  ],
  "title": "Scheduled Maintenance Alert!",
  "content": {
    "message": "",
    "data": {
      "activityStartTime": {},
      "activityEndTime": {},
      "activityDate": {}
    }
  },
  "activeFromTime": "2024-08-29T00:00:00.000Z",
  "activeUntilTime": "2024-08-29T23:30:00.000Z"
}
{
  "bannerId": "",
  "levelType": "stack",
  "levelIds": [
    ""
  ],
  "title": "Scheduled Maintenance Alert!",
  "content": {
    "message": "",
    "data": {
      "activityStartTime": {},
      "activityEndTime": {},
      "activityDate": {}
    }
  },
  "activeFromTime": "2024-08-29T00:00:00.000Z",
  "activeUntilTime": "2024-08-29T23:30:00.000Z"
}
﻿
﻿
Updated 10 Oct 2024
Did this page help you?
Delete a banner by its Id.
Create App Role