AsyncAPI for campaign service 0.0.1 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:platform:campaign
• Protobuf File Spec: campaign.proto
• Default content type: application/json

Table of Contents

• Operations
  • PUB campaignManagement
  • PUB keyGroupManagement
  • PUB codeRedemption
  • PUB ticketSale

Operations

PUB campaignManagement Operation

Accepts one of the following messages:

Message campaignCreated

message is sent when campaign is created

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.campaign	object	-	-	-	additional properties are allowed
payload.campaign.id	string	campaign id	-	-	-
payload.campaign.type	string	campaign type	allowed ("REDEMPTION")	-	-
payload.campaign.namespace	string	namespace of this campaign	-	-	-
payload.campaign.name	string	name of this campaign	-	-	-
payload.campaign.description	string	description of this campaign	-	-	-
payload.campaign.tags	array<string>	tags of this campaign	-	-	-
payload.campaign.tags (single item)	string	-	-	-	-
payload.campaign.status	string	status of this campaign	allowed ("ACTIVE", "INACTIVE")	-	-
payload.campaign.redeemStart	string	redeem start time	-	format (date-time)	-
payload.campaign.redeemEnd	string	redeem end time	-	format (date-time)	-
payload.campaign.maxRedeemCountPerCode	integer	max redeem count per code, -1 means UNLIMITED	-	format (int32)	-
payload.campaign.maxRedeemCountPerCodePerUser	integer	max redeem count per code per user, -1 mean UNLIMITED	-	format (int32)	-
payload.campaign.maxRedeemCountPerCampaignPerUser	integer	max redeem count per campaign per user, -1 mean UNLIMITED	-	format (int32)	-
payload.campaign.maxSaleCount	integer	max sale count, -1 mean UNLIMITED	-	format (int32)	-
payload.campaign.redeemType	string	redeem type	allowed ("ITEM")	-	-
payload.campaign.items	array<object>	-	-	-	-
payload.campaign.items.itemId	string	The redeemable item id	-	-	required
payload.campaign.items.itemName	string	The redeemable item name	-	-	required
payload.campaign.items.quantity	integer	The redeemable item quantity, 1 for default	-	format (int32)	-
payload.campaign.items.extraSubscriptionDays	integer	Extra subscription days if the item is a subscription, 0 by default	-	format (int32)	-
payload.campaign.boothName	string	booth name for sale	-	-	-
payload.campaign.createdAt	string	time when campaign is created	-	format (date-time)	-
payload.campaign.updatedAt	string	time when campaign is updated	-	format (date-time)	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "campaign": {
      "id": "string",
      "type": "REDEMPTION",
      "namespace": "string",
      "name": "string",
      "description": "string",
      "tags": [
        "string"
      ],
      "status": "ACTIVE",
      "redeemStart": "2019-08-24T14:15:22Z",
      "redeemEnd": "2019-08-24T14:15:22Z",
      "maxRedeemCountPerCode": 0,
      "maxRedeemCountPerCodePerUser": 0,
      "maxRedeemCountPerCampaignPerUser": 0,
      "maxSaleCount": 0,
      "redeemType": "ITEM",
      "items": [
        {
          "itemId": "string",
          "itemName": "string",
          "quantity": 0,
          "extraSubscriptionDays": 0
        }
      ],
      "boothName": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  },
  "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 campaignUpdated

message is sent when campaign is updated

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.campaign	object	-	-	-	additional properties are allowed
payload.campaign.id	string	campaign id	-	-	-
payload.campaign.type	string	campaign type	allowed ("REDEMPTION")	-	-
payload.campaign.namespace	string	namespace of this campaign	-	-	-
payload.campaign.name	string	name of this campaign	-	-	-
payload.campaign.description	string	description of this campaign	-	-	-
payload.campaign.tags	array<string>	tags of this campaign	-	-	-
payload.campaign.tags (single item)	string	-	-	-	-
payload.campaign.status	string	status of this campaign	allowed ("ACTIVE", "INACTIVE")	-	-
payload.campaign.redeemStart	string	redeem start time	-	format (date-time)	-
payload.campaign.redeemEnd	string	redeem end time	-	format (date-time)	-
payload.campaign.maxRedeemCountPerCode	integer	max redeem count per code, -1 means UNLIMITED	-	format (int32)	-
payload.campaign.maxRedeemCountPerCodePerUser	integer	max redeem count per code per user, -1 mean UNLIMITED	-	format (int32)	-
payload.campaign.maxRedeemCountPerCampaignPerUser	integer	max redeem count per campaign per user, -1 mean UNLIMITED	-	format (int32)	-
payload.campaign.maxSaleCount	integer	max sale count, -1 mean UNLIMITED	-	format (int32)	-
payload.campaign.redeemType	string	redeem type	allowed ("ITEM")	-	-
payload.campaign.items	array<object>	-	-	-	-
payload.campaign.items.itemId	string	The redeemable item id	-	-	required
payload.campaign.items.itemName	string	The redeemable item name	-	-	required
payload.campaign.items.quantity	integer	The redeemable item quantity, 1 for default	-	format (int32)	-
payload.campaign.items.extraSubscriptionDays	integer	Extra subscription days if the item is a subscription, 0 by default	-	format (int32)	-
payload.campaign.boothName	string	booth name for sale	-	-	-
payload.campaign.createdAt	string	time when campaign is created	-	format (date-time)	-
payload.campaign.updatedAt	string	time when campaign is updated	-	format (date-time)	-
payload.oldCampaign	object	-	-	-	additional properties are allowed
payload.oldCampaign.id	string	campaign id	-	-	-
payload.oldCampaign.type	string	campaign type	allowed ("REDEMPTION")	-	-
payload.oldCampaign.namespace	string	namespace of this campaign	-	-	-
payload.oldCampaign.name	string	name of this campaign	-	-	-
payload.oldCampaign.description	string	description of this campaign	-	-	-
payload.oldCampaign.tags	array<string>	tags of this campaign	-	-	-
payload.oldCampaign.tags (single item)	string	-	-	-	-
payload.oldCampaign.status	string	status of this campaign	allowed ("ACTIVE", "INACTIVE")	-	-
payload.oldCampaign.redeemStart	string	redeem start time	-	format (date-time)	-
payload.oldCampaign.redeemEnd	string	redeem end time	-	format (date-time)	-
payload.oldCampaign.maxRedeemCountPerCode	integer	max redeem count per code, -1 means UNLIMITED	-	format (int32)	-
payload.oldCampaign.maxRedeemCountPerCodePerUser	integer	max redeem count per code per user, -1 mean UNLIMITED	-	format (int32)	-
payload.oldCampaign.maxRedeemCountPerCampaignPerUser	integer	max redeem count per campaign per user, -1 mean UNLIMITED	-	format (int32)	-
payload.oldCampaign.maxSaleCount	integer	max sale count, -1 mean UNLIMITED	-	format (int32)	-
payload.oldCampaign.redeemType	string	redeem type	allowed ("ITEM")	-	-
payload.oldCampaign.items	array<object>	-	-	-	-
payload.oldCampaign.items.itemId	string	The redeemable item id	-	-	required
payload.oldCampaign.items.itemName	string	The redeemable item name	-	-	required
payload.oldCampaign.items.quantity	integer	The redeemable item quantity, 1 for default	-	format (int32)	-
payload.oldCampaign.items.extraSubscriptionDays	integer	Extra subscription days if the item is a subscription, 0 by default	-	format (int32)	-
payload.oldCampaign.boothName	string	booth name for sale	-	-	-
payload.oldCampaign.createdAt	string	time when campaign is created	-	format (date-time)	-
payload.oldCampaign.updatedAt	string	time when campaign is updated	-	format (date-time)	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "campaign": {
      "id": "string",
      "type": "REDEMPTION",
      "namespace": "string",
      "name": "string",
      "description": "string",
      "tags": [
        "string"
      ],
      "status": "ACTIVE",
      "redeemStart": "2019-08-24T14:15:22Z",
      "redeemEnd": "2019-08-24T14:15:22Z",
      "maxRedeemCountPerCode": 0,
      "maxRedeemCountPerCodePerUser": 0,
      "maxRedeemCountPerCampaignPerUser": 0,
      "maxSaleCount": 0,
      "redeemType": "ITEM",
      "items": [
        {
          "itemId": "string",
          "itemName": "string",
          "quantity": 0,
          "extraSubscriptionDays": 0
        }
      ],
      "boothName": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    },
    "oldCampaign": {
      "id": "string",
      "type": "REDEMPTION",
      "namespace": "string",
      "name": "string",
      "description": "string",
      "tags": [
        "string"
      ],
      "status": "ACTIVE",
      "redeemStart": "2019-08-24T14:15:22Z",
      "redeemEnd": "2019-08-24T14:15:22Z",
      "maxRedeemCountPerCode": 0,
      "maxRedeemCountPerCodePerUser": 0,
      "maxRedeemCountPerCampaignPerUser": 0,
      "maxSaleCount": 0,
      "redeemType": "ITEM",
      "items": [
        {
          "itemId": "string",
          "itemName": "string",
          "quantity": 0,
          "extraSubscriptionDays": 0
        }
      ],
      "boothName": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  },
  "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 codeCreated

message is when redeem codes are created

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.codeCreate	object	-	-	-	additional properties are allowed
payload.codeCreate.campaignId	string	campaign id of the code belong to	-	-	-
payload.codeCreate.campaignName	string	the campaign name	-	-	-
payload.codeCreate.quantity	integer	quantity of code created	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "codeCreate": {
      "campaignId": "string",
      "campaignName": "string",
      "quantity": 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 codeDisabled

message is sent when code is disabled

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.codeCondition	object	-	-	-	additional properties are allowed
payload.codeCondition.campaignId	string	campaign id of the codes belong to	-	-	-
payload.codeCondition.batchNo	integer	code batch number	-	-	-
payload.codeCondition.value	string	code value	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "codeCondition": {
      "campaignId": "string",
      "batchNo": 0,
      "value": "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 codeEnabled

message is sent when redeem code is enabled

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.codeCondition	object	-	-	-	additional properties are allowed
payload.codeCondition.campaignId	string	campaign id of the codes belong to	-	-	-
payload.codeCondition.batchNo	integer	code batch number	-	-	-
payload.codeCondition.value	string	code value	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "codeCondition": {
      "campaignId": "string",
      "batchNo": 0,
      "value": "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 codeBulkDisabled

message is sent when bulk codes are disabled

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.codeCondition	object	-	-	-	additional properties are allowed
payload.codeCondition.campaignId	string	campaign id of the codes belong to	-	-	-
payload.codeCondition.batchNo	integer	code batch number	-	-	-
payload.codeCondition.value	string	code value	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "codeCondition": {
      "campaignId": "string",
      "batchNo": 0,
      "value": "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 codeBulkEnabled

message is sent when bulk codes are enabled

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.codeCondition	object	-	-	-	additional properties are allowed
payload.codeCondition.campaignId	string	campaign id of the codes belong to	-	-	-
payload.codeCondition.batchNo	integer	code batch number	-	-	-
payload.codeCondition.value	string	code value	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "codeCondition": {
      "campaignId": "string",
      "batchNo": 0,
      "value": "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"
}

PUB keyGroupManagement Operation

Accepts one of the following messages:

Message keyGroupCreated

message is sent when key group is created

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.keyGroup	object	-	-	-	additional properties are allowed
payload.keyGroup.id	string	key group id	-	-	-
payload.keyGroup.namespace	string	namespace of this key group	-	-	-
payload.keyGroup.name	string	name of key group	-	-	-
payload.keyGroup.description	string	description of key group	-	-	-
payload.keyGroup.tags	array<string>	tags of key group	-	-	-
payload.keyGroup.tags (single item)	string	-	-	-	-
payload.keyGroup.status	string	status of key group	allowed ("ACTIVE", "INACTIVE")	-	-
payload.keyGroup.boothName	string	booth name for sale	-	-	-
payload.keyGroup.createdAt	string	time when key group was created	-	format (date-time)	-
payload.keyGroup.updatedAt	string	time when key group was updated	-	format (date-time)	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "keyGroup": {
      "id": "string",
      "namespace": "string",
      "name": "string",
      "description": "string",
      "tags": [
        "string"
      ],
      "status": "ACTIVE",
      "boothName": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  },
  "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 keyGroupUpdated

message is sent when key group is updated

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.keyGroup	object	-	-	-	additional properties are allowed
payload.keyGroup.id	string	key group id	-	-	-
payload.keyGroup.namespace	string	namespace of this key group	-	-	-
payload.keyGroup.name	string	name of key group	-	-	-
payload.keyGroup.description	string	description of key group	-	-	-
payload.keyGroup.tags	array<string>	tags of key group	-	-	-
payload.keyGroup.tags (single item)	string	-	-	-	-
payload.keyGroup.status	string	status of key group	allowed ("ACTIVE", "INACTIVE")	-	-
payload.keyGroup.boothName	string	booth name for sale	-	-	-
payload.keyGroup.createdAt	string	time when key group was created	-	format (date-time)	-
payload.keyGroup.updatedAt	string	time when key group was updated	-	format (date-time)	-
payload.oldKeyGroup	object	-	-	-	additional properties are allowed
payload.oldKeyGroup.id	string	key group id	-	-	-
payload.oldKeyGroup.namespace	string	namespace of this key group	-	-	-
payload.oldKeyGroup.name	string	name of key group	-	-	-
payload.oldKeyGroup.description	string	description of key group	-	-	-
payload.oldKeyGroup.tags	array<string>	tags of key group	-	-	-
payload.oldKeyGroup.tags (single item)	string	-	-	-	-
payload.oldKeyGroup.status	string	status of key group	allowed ("ACTIVE", "INACTIVE")	-	-
payload.oldKeyGroup.boothName	string	booth name for sale	-	-	-
payload.oldKeyGroup.createdAt	string	time when key group was created	-	format (date-time)	-
payload.oldKeyGroup.updatedAt	string	time when key group was updated	-	format (date-time)	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "keyGroup": {
      "id": "string",
      "namespace": "string",
      "name": "string",
      "description": "string",
      "tags": [
        "string"
      ],
      "status": "ACTIVE",
      "boothName": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    },
    "oldKeyGroup": {
      "id": "string",
      "namespace": "string",
      "name": "string",
      "description": "string",
      "tags": [
        "string"
      ],
      "status": "ACTIVE",
      "boothName": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  },
  "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 keyUploaded

message is sent when upload keys

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.keyUpload	object	-	-	-	additional properties are allowed
payload.keyUpload.keyGroupId	string	key group id	-	-	-
payload.keyUpload.keyGroupName	string	the key group name	-	-	-
payload.keyUpload.quantity	integer	quantity of key uploaded	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "keyUpload": {
      "keyGroupId": "string",
      "keyGroupName": "string",
      "quantity": 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"
}

PUB codeRedemption Operation

Message codeRedeemed

message is sent when code is redeemed

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.codeRedemption	object	-	-	-	additional properties are allowed
payload.codeRedemption.userId	string	user id	-	-	-
payload.codeRedemption.campaignId	string	the campaign id	-	-	-
payload.codeRedemption.campaignName	string	the campaign name	-	-	-
payload.codeRedemption.code	string	the code value	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "codeRedemption": {
      "userId": "string",
      "campaignId": "string",
      "campaignName": "string",
      "code": "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"
}

PUB ticketSale Operation

Message ticketAcquired

message is sent when ticket is acquired, for example, when user buy a code type item

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.ticketAcquisition	object	-	-	-	additional properties are allowed
payload.ticketAcquisition.userId	string	user id	-	-	-
payload.ticketAcquisition.boothName	string	booth name	-	-	-
payload.ticketAcquisition.count	integer	purchase count	-	-	-
payload.ticketAcquisition.orderNo	string	order no	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "ticketAcquisition": {
      "userId": "string",
      "boothName": "string",
      "count": 0,
      "orderNo": "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"
}