Get Platform Entitlements Prepared By Player Uuid

GET 
/inventory/v2/player/:player_uuid/entitlement/prepared

Get list of entitlements from the platform, as we will grant them to the user

Required Permissions:

• For any player (including themselves) any of: inv:*, inv:platform_entitlements:any

• For the player themselves : inv:platform_entitlements:self

Request

Path Parameters

player_uuid uuidrequired

Query Parameters

platform_id Platform Idrequired

Platform this entitlement was purchased was made on

platform_token any

Platform token that can be used to verify the identity of the user

platform_environment any

Platform Environment to check for ownership

platform_region PlatformRegionrequired

Possible values: [Unknown, NA, EU]

region this purchase was made in

client_type ClientTyperequired

Possible values: [UNKNOWN, WIN, MAC, XBOXONE, PS4, SWITCH, ANDROID, IOS, PS5, LINUX, XSX]

client type this purchase was made on

Responses

200

Successful Response

application/json

Schema

Schema

entitlements

object[]

Array [

platform_entitlement_id

object

Unique identifier for this instance of an entitlement on the platform

anyOf

MOD1

string

sku Sku (string)required

Unique SKU from the platform

quantity Quantity (integer)

Default value: 1

Quantity available to be used from the platform

received_type

object

Type of entitlement the platform sent us. If they provide this metadata, then RallyHere Entitlement SKUs must be configured with matching types, or the entitlement will not process

anyOf

EntitlementType

The method of granting a Platform Entitlement SKU

string

Possible values: [consumable, durable, durable_single_use]

platform_label

object

anyOf

MOD1

string

platform_metadata object

Default value: [object Object]

Platform-specific metadata about this entitlement

]

error_code

object

anyOf

MOD1

string

Example (from schema)

{
  "entitlements": [
    {
      "platform_entitlement_id": "string",
      "sku": "string",
      "quantity": 1,
      "received_type": "consumable",
      "platform_label": "string",
      "platform_metadata": {}
    }
  ],
  "error_code": "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...