Get Entity Favorite Guide

GET 
/guide/v1/:entity_type/:entity_id/favorite-guide

Get entity's favorite guides

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

Query Parameters

sort_by SearchFavoriteGuideSort

Possible values: [created, modified, upvotes, favorited_at]

Default value: favorited_at

sort SortDirection

Possible values: [asc, desc]

Default value: desc

cursor any
page_size Page Size

Default value: 20

owner_entity_type any
owner_entity_id any
language any
guide_type any
game_version any
name any
ref_1 any
ref_2 any
ref_3 any
ref_4 any
ref_5 any
ref_6 any
ref_7 any
ref_8 any
ref_9 any
ref_10 any
ref_11 any
ref_12 any
ref_13 any
ref_14 any
ref_15 any
ref_16 any
ref_17 any
ref_18 any
ref_19 any
ref_20 any
ref_21 any
ref_22 any
ref_23 any
ref_24 any
ref_25 any
ref_26 any
ref_27 any
ref_28 any
ref_29 any
ref_30 any
ref_31 any
ref_32 any

Responses

200

Successful Response

application/json

Schema

Schema

results

object[]

Array [

guide_type Guide Type (string)required

Possible values: <= 16 characters

language Language (string)required

Possible values: <= 3 characters

game_version Game Version (string)required

Possible values: <= 64 characters

Version this guide was created for

name Name (string)required

Possible values: non-empty and <= 128 characters

short_desc

object

anyOf

MOD1

string

Possible values: <= 512 characters

ref_1

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_2

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_3

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_4

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_5

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_6

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_7

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_8

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_9

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_10

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_11

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_12

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_13

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_14

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_15

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_16

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_17

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_18

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_19

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_20

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_21

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_22

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_23

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_24

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_25

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_26

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_27

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_28

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_29

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_30

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_31

object

anyOf

MOD1

string

Possible values: <= 64 characters

ref_32

object

anyOf

MOD1

string

Possible values: <= 64 characters

guide_id uuidrequired

owner_entity_type EntityType (string)required

Possible values: [player]

owner_entity_id Owner Entity Id (string)required

Possible values: <= 128 characters

created date-timerequired

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

modified date-timerequired

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

favorites Favorites (integer)

Default value: 0

Number of players who have favorited

upvotes Upvotes (integer)

Default value: 0

Number of players who have upvoted

downvotes Downvotes (integer)

Default value: 0

Number of players who have downvoted

etag Etag (string)required

unique identifer for a specific version of this guide

]

cursor

object

anyOf

MOD1

string

Example (from schema)

{
  "results": [
    {
      "guide_type": "string",
      "language": "string",
      "game_version": "string",
      "name": "string",
      "short_desc": "string",
      "ref_1": "string",
      "ref_2": "string",
      "ref_3": "string",
      "ref_4": "string",
      "ref_5": "string",
      "ref_6": "string",
      "ref_7": "string",
      "ref_8": "string",
      "ref_9": "string",
      "ref_10": "string",
      "ref_11": "string",
      "ref_12": "string",
      "ref_13": "string",
      "ref_14": "string",
      "ref_15": "string",
      "ref_16": "string",
      "ref_17": "string",
      "ref_18": "string",
      "ref_19": "string",
      "ref_20": "string",
      "ref_21": "string",
      "ref_22": "string",
      "ref_23": "string",
      "ref_24": "string",
      "ref_25": "string",
      "ref_26": "string",
      "ref_27": "string",
      "ref_28": "string",
      "ref_29": "string",
      "ref_30": "string",
      "ref_31": "string",
      "ref_32": "string",
      "guide_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "owner_entity_type": "player",
      "owner_entity_id": "string",
      "created": "2023-01-23T21:07:02.000000+00:00",
      "modified": "2023-01-23T21:07:02.000000+00:00",
      "favorites": 0,
      "upvotes": 0,
      "downvotes": 0,
      "etag": "string"
    }
  ],
  "cursor": "string"
}

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...