Skip to content

Get Notification By Id

GET
/notification/v1/player/{player_uuid}/notification/{notification_id}

Retrieve a single notification by id

This version can be used for any client provided its id (with proper permissions)

Required Permissions:

  • For any player (including themselves) any of: notification:player:*, notification:player:read

  • For the player themselves any of: notification:player:self:*, notification:player:self:read

Authorizations

Parameters

Path Parameters

notification_id
required
string
player_uuid
required
string format: uuid

Responses

200

Successful Response

object
message
required

Base Message for the notification

string
<= 4096 characters
rh_url

Path to get additional data about this notification

string
>= 1 characters <= 4096 characters
custom_data

Custom values for the notification

object
key
additional properties
string
>= 1 characters <= 4096 characters
etag

ETag for the resource at rh_url at the time of this notification

string
>= 1 characters
notification_id
required

Unique Identifier for the notification. You cannot depend on the format of this string, and it must be considered opaque

string
created
required

When this notification was added

string format: date-time

400

Error Codes:

  • bad_id - Passed client id is not a valid id
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

403

Error Codes:

  • auth_token_invalid_claim - Token contained invalid claim value: {}
  • auth_invalid_version - Invalid Authorization - version
  • auth_invalid_key_id - Invalid Authorization - Invalid Key ID in Access Token
  • auth_malformed_access - Invalid Authorization - malformed access token
  • auth_token_unknown - Failed to parse token
  • auth_not_jwt - Invalid Authorization
  • auth_token_sig_invalid - Token Signature is invalid
  • insufficient_permissions - Insufficient Permissions
  • auth_token_format - Invalid Authorization - {}
  • auth_token_expired - Token is expired
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

404

Error Codes:

  • resource_not_found - Notification could not be found
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string