Skip to main content

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 Operation

Accepts one of the following messages:

Message userSeasonPassChanged

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userSeasonobject---additional properties are allowed
payload.userSeason.idstring----
payload.userSeason.namespacestring----
payload.userSeason.userIdstring----
payload.userSeason.seasonIdstring----
payload.userSeason.enrolledPassesarray<string>----
payload.userSeason.enrolledPasses (single item)string----
payload.userSeason.enrolledAtstring--format (date-time)-
payload.userSeason.currentTierIndexinteger----
payload.userSeason.lastTierIndexinteger----
payload.userSeason.requiredExpinteger----
payload.userSeason.currentExpinteger----
payload.userSeason.clearedboolean----
payload.grantedPassesarray<string>----
payload.grantedPasses (single item)string----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

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
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userSeasonobject---additional properties are allowed
payload.userSeason.idstring----
payload.userSeason.namespacestring----
payload.userSeason.userIdstring----
payload.userSeason.seasonIdstring----
payload.userSeason.enrolledPassesarray<string>----
payload.userSeason.enrolledPasses (single item)string----
payload.userSeason.enrolledAtstring--format (date-time)-
payload.userSeason.currentTierIndexinteger----
payload.userSeason.lastTierIndexinteger----
payload.userSeason.requiredExpinteger----
payload.userSeason.currentExpinteger----
payload.userSeason.clearedboolean----
payload.grantedPassesinteger----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

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
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userSeasonobject---additional properties are allowed
payload.userSeason.idstring----
payload.userSeason.namespacestring----
payload.userSeason.userIdstring----
payload.userSeason.seasonIdstring----
payload.userSeason.enrolledPassesarray<string>----
payload.userSeason.enrolledPasses (single item)string----
payload.userSeason.enrolledAtstring--format (date-time)-
payload.userSeason.currentTierIndexinteger----
payload.userSeason.lastTierIndexinteger----
payload.userSeason.requiredExpinteger----
payload.userSeason.currentExpinteger----
payload.userSeason.clearedboolean----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

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
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userSeasonRewardobject---additional properties are allowed
payload.userSeasonReward.namespacestring----
payload.userSeasonReward.userIdstring----
payload.userSeasonReward.seasonIdstring----
payload.userSeasonReward.tierIndexstring----
payload.userSeasonReward.passCodestring----
payload.userSeasonReward.rewardCodestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

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"
}