SeasonPass Service Events 0.1.0 documentation

info

In this document, PUB means "publish" and SUB means "subscribe". This refers to the "publish/subscribe" (pub/sub) messaging framework, where "publish" means that the service sends data to Kafka topics, and "subscribe" means the service acts as a consumer that subscribes to specific Kafka topics to receive data.

• Specification ID: urn:net:accelbyte:seasonpass:userseason
• Protobuf File Spec: seasonpass.proto

Table of Contents

• Operations
  • PUB userSeason

Operations

PUB userSeason Operation

Accepts one of the following messages:

Message userSeasonPassChanged

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userSeason	object	-	-	-	additional properties are allowed
payload.userSeason.id	string	-	-	-	-
payload.userSeason.namespace	string	-	-	-	-
payload.userSeason.userId	string	-	-	-	-
payload.userSeason.seasonId	string	-	-	-	-
payload.userSeason.enrolledPasses	array<string>	-	-	-	-
payload.userSeason.enrolledPasses (single item)	string	-	-	-	-
payload.userSeason.enrolledAt	string	-	-	format (date-time)	-
payload.userSeason.currentTierIndex	integer	-	-	-	-
payload.userSeason.lastTierIndex	integer	-	-	-	-
payload.userSeason.requiredExp	integer	-	-	-	-
payload.userSeason.currentExp	integer	-	-	-	-
payload.userSeason.cleared	boolean	-	-	-	-
payload.grantedPasses	array<string>	-	-	-	-
payload.grantedPasses (single item)	string	-	-	-	-
payload.x-uid0	-	-	"AnonymousSchema1"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "userSeason": {
      "id": "string",
      "namespace": "string",
      "userId": "string",
      "seasonId": "string",
      "enrolledPasses": [
        "string"
      ],
      "enrolledAt": "2019-08-24T14:15:22Z",
      "currentTierIndex": 0,
      "lastTierIndex": 0,
      "requiredExp": 0,
      "currentExp": 0,
      "cleared": true
    },
    "grantedPasses": [
      "string"
    ]
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message userSeasonTierUp

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userSeason	object	-	-	-	additional properties are allowed
payload.userSeason.id	string	-	-	-	-
payload.userSeason.namespace	string	-	-	-	-
payload.userSeason.userId	string	-	-	-	-
payload.userSeason.seasonId	string	-	-	-	-
payload.userSeason.enrolledPasses	array<string>	-	-	-	-
payload.userSeason.enrolledPasses (single item)	string	-	-	-	-
payload.userSeason.enrolledAt	string	-	-	format (date-time)	-
payload.userSeason.currentTierIndex	integer	-	-	-	-
payload.userSeason.lastTierIndex	integer	-	-	-	-
payload.userSeason.requiredExp	integer	-	-	-	-
payload.userSeason.currentExp	integer	-	-	-	-
payload.userSeason.cleared	boolean	-	-	-	-
payload.grantedPasses	integer	-	-	-	-
payload.x-uid0	-	-	"AnonymousSchema2"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "userSeason": {
      "id": "string",
      "namespace": "string",
      "userId": "string",
      "seasonId": "string",
      "enrolledPasses": [
        "string"
      ],
      "enrolledAt": "2019-08-24T14:15:22Z",
      "currentTierIndex": 0,
      "lastTierIndex": 0,
      "requiredExp": 0,
      "currentExp": 0,
      "cleared": true
    },
    "grantedPasses": 0
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message userSeasonTierCleared

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userSeason	object	-	-	-	additional properties are allowed
payload.userSeason.id	string	-	-	-	-
payload.userSeason.namespace	string	-	-	-	-
payload.userSeason.userId	string	-	-	-	-
payload.userSeason.seasonId	string	-	-	-	-
payload.userSeason.enrolledPasses	array<string>	-	-	-	-
payload.userSeason.enrolledPasses (single item)	string	-	-	-	-
payload.userSeason.enrolledAt	string	-	-	format (date-time)	-
payload.userSeason.currentTierIndex	integer	-	-	-	-
payload.userSeason.lastTierIndex	integer	-	-	-	-
payload.userSeason.requiredExp	integer	-	-	-	-
payload.userSeason.currentExp	integer	-	-	-	-
payload.userSeason.cleared	boolean	-	-	-	-
payload.x-uid0	-	-	"AnonymousSchema3"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "userSeason": {
      "id": "string",
      "namespace": "string",
      "userId": "string",
      "seasonId": "string",
      "enrolledPasses": [
        "string"
      ],
      "enrolledAt": "2019-08-24T14:15:22Z",
      "currentTierIndex": 0,
      "lastTierIndex": 0,
      "requiredExp": 0,
      "currentExp": 0,
      "cleared": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message userSeasonRewardRewarded

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userSeasonReward	object	-	-	-	additional properties are allowed
payload.userSeasonReward.namespace	string	-	-	-	-
payload.userSeasonReward.userId	string	-	-	-	-
payload.userSeasonReward.seasonId	string	-	-	-	-
payload.userSeasonReward.tierIndex	string	-	-	-	-
payload.userSeasonReward.passCode	string	-	-	-	-
payload.userSeasonReward.rewardCode	string	-	-	-	-
payload.x-uid0	-	-	"AnonymousSchema4"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "userSeasonReward": {
      "namespace": "string",
      "userId": "string",
      "seasonId": "string",
      "tierIndex": "string",
      "passCode": "string",
      "rewardCode": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}