Get Entity Guide Engagement

POST 
/guide/v1/:entity_type/:entity_id/guide-engagement

Get entity's engagement for a set of guide ids

Required Permissions:

• For any entity (including themselves) any of: guide:*, guide:engage:read:any, guide:engage:write:any

• For the entity themselves any of: guide:engage:read:self, guide:engage:write:self

Request

Path Parameters

entity_type EntityTyperequired

Possible values: [player]

entity_id Entity Idrequired

application/json

Body

required

guides uuid[]

Possible values: >= 1, <= 100

Default value: ``

Responses

200

Successful Response

application/json

Schema

Schema

results

object[]

Array [

guide_id uuidrequired

rating Rating (integer)

Possible values: >= -1 and <= 1

Default value: 0

favorited_at

object

anyOf

Time Zone Aware Datetime

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string

]

Example (from schema)

{
  "results": [
    {
      "guide_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "rating": 0,
      "favorited_at": "2023-01-23T21:07:02.000000+00:00"
    }
  ]
}

403

Error Codes:

• auth_invalid_key_id - Invalid Authorization - Invalid Key ID in Access Token

• auth_invalid_version - Invalid Authorization - version

• auth_malformed_access - Invalid Authorization - malformed access token

• auth_not_jwt - Invalid Authorization

• auth_token_expired - Token is expired

• auth_token_format - Invalid Authorization - {}

• auth_token_invalid_claim - Token contained invalid claim value: {}

• auth_token_invalid_type - Invalid Authorization - Invalid Token Type

• auth_token_sig_invalid - Token Signature is invalid

• auth_token_unknown - Failed to parse token

• insufficient_permissions - Insufficient Permissions

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...