SeasonPass Service Events 0.1.0 documentation
- Protobuf File Spec: seasonpass.proto
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
Name | Type | Description |
---|---|---|
userSeason | userSeason | - |
grantedPasses | array | - |
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
Name | Type | Description |
---|---|---|
userSeason | userSeason | - |
grantedPasses | integer | - |
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
Name | Type | Description |
---|---|---|
userSeason | userSeason | - |
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
Name | Type | Description |
---|---|---|
userSeasonReward | object | - |
payload.userSeasonReward
Name | Type | Description |
---|---|---|
namespace | string | - |
userId | string | - |
seasonId | string | - |
tierIndex | string | - |
passCode | string | - |
rewardCode | string | - |
Schemas
userSeason
Name | Type | Description |
---|---|---|
id | string | - |
namespace | string | - |
userId | string | - |
seasonId | string | - |
enrolledPasses | array | - |
enrolledAt | string (date-time) | - |
currentTierIndex | integer | - |
lastTierIndex | integer | - |
requiredExp | integer | - |
currentExp | integer | - |
cleared | boolean | - |
event
Name | Type | Description |
---|---|---|
id | string | - |
version | integer | - |
name | string | - |
namespace | string | - |
parentNamespace | string | - |
timestamp | string (date-time) | - |
clientId | string | - |
userId | string | - |
traceId | string | - |
sessionId | string | - |