Skip to main content

SeasonPass Service Events 0.1.0 documentation

Published Messages (userSeason)

The service publishes one of these messages below.

userSeasonPassChanged

Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
userSeasonuserSeason-
grantedPassesarray-

userSeasonTierUp

Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
userSeasonuserSeason-
grantedPassesinteger-

userSeasonTierCleared

Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
userSeasonuserSeason-

userSeasonRewardRewarded

Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
userSeasonRewardobject-
payload.userSeasonReward
NameTypeDescription
namespacestring-
userIdstring-
seasonIdstring-
tierIndexstring-
passCodestring-
rewardCodestring-

Schemas

userSeason

NameTypeDescription
idstring-
namespacestring-
userIdstring-
seasonIdstring-
enrolledPassesarray-
enrolledAtstring (date-time)-
currentTierIndexinteger-
lastTierIndexinteger-
requiredExpinteger-
currentExpinteger-
clearedboolean-

event

NameTypeDescription
idstring-
versioninteger-
namestring-
namespacestring-
parentNamespacestring-
timestampstring (date-time)-
clientIdstring-
userIdstring-
traceIdstring-
sessionIdstring-