AsyncAPI for revocation 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:revocation
• Default content type: application/json

Table of Contents

• Operations
  • PUB revocation

Operations

PUB revocation Operation

Message revocationCompleted

message is sent when revoking user item ownership.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.userId	string	userId	-	-	-
payload.source	string	current revocation source constains these DLC, ORDER, OTHER	-	-	-
payload.meta	object	revocation source meta properties, will put store orderNo, DLC transaction record id into it	-	-	additional properties are allowed
payload.creditRevocations	array<object>	credit revocations	-	-	-
payload.creditRevocations.walletId	string	-	-	-	-
payload.creditRevocations.currencyCode	string	-	-	-	-
payload.creditRevocations.balanceOrigin	string	-	-	-	-
payload.creditRevocations.amount	integer	-	-	format (int32)	-
payload.creditRevocations.status	string	revocation status	allowed ("SUCCESS", "FAIL")	-	-
payload.creditRevocations.revocationStrategy	string	-	-	-	-
payload.creditRevocations.skipped	boolean	-	-	-	-
payload.creditRevocations.reason	string	-	-	-	-
payload.entitlementRevocations	array<object>	credit revocations	-	-	-
payload.entitlementRevocations.entitlementId	string	-	-	-	-
payload.entitlementRevocations.quantity	integer	-	-	format (int32)	-
payload.entitlementRevocations.itemId	string	-	-	-	-
payload.entitlementRevocations.itemSku	string	-	-	-	-
payload.entitlementRevocations.revocationStrategy	string	-	-	-	-
payload.entitlementRevocations.status	string	revocation status	allowed ("SUCCESS", "FAIL")	-	-
payload.entitlementRevocations.skipped	boolean	-	-	-	-
payload.entitlementRevocations.reason	string	-	-	-	-
payload.revokeEntries	array<object>	revoke entry request list	-	-	-
payload.revokeEntries.type	string	-	allowed ("ITEM", "CURRENCY", "ENTITLEMENT")	-	-
payload.revokeEntries.item	object	-	-	-	additional properties are allowed
payload.revokeEntries.item.itemIdentityType	string	-	allowed ("ITEM_ID", "ITEM_SKU")	-	-
payload.revokeEntries.item.itemIdentity	string	item id or item sku	-	-	-
payload.revokeEntries.entitlement	object	-	-	-	additional properties are allowed
payload.revokeEntries.entitlement.entitlementId	string	-	-	-	-
payload.revokeEntries.entitlement.type	string	entitlement type	-	-	-
payload.revokeEntries.entitlement.clazz	string	entitlement clazz	-	-	-
payload.revokeEntries.currency	object	-	-	-	additional properties are allowed
payload.revokeEntries.currency.walletId	string	-	-	-	-
payload.revokeEntries.currency.namespace	string	-	-	-	-
payload.revokeEntries.currency.currencyCode	string	-	-	-	-
payload.revokeEntries.currency.balanceOrigin	string	-	-	-	-
payload.revokeEntries.quantity	integer	-	-	format (int32)	-
payload.itemRevocations	array<object>	item revocations	-	-	-
payload.itemRevocations.quantity	integer	-	-	format (int32)	-
payload.itemRevocations.itemId	string	-	-	-	-
payload.itemRevocations.itemSku	string	-	-	-	-
payload.itemRevocations.itemType	string	-	-	-	-
payload.itemRevocations.revocationStrategy	string	-	-	-	-
payload.itemRevocations.status	string	revocation status	allowed ("SUCCESS", "FAIL")	-	-
payload.itemRevocations.skipped	boolean	-	-	-	-
payload.itemRevocations.reason	string	-	-	-	-
payload.itemRevocations.itemRevocations	array<object>	-	-	-	-
payload.itemRevocations.itemRevocations.quantity	integer	-	-	format (int32)	-
payload.itemRevocations.itemRevocations.itemId	string	-	-	-	-
payload.itemRevocations.itemRevocations.itemSku	string	-	-	-	-
payload.itemRevocations.itemRevocations.itemType	string	-	-	-	-
payload.itemRevocations.itemRevocations.revocationStrategy	string	-	-	-	-
payload.itemRevocations.itemRevocations.status	string	revocation status	allowed ("SUCCESS", "FAIL")	-	-
payload.itemRevocations.itemRevocations.skipped	boolean	-	-	-	-
payload.itemRevocations.itemRevocations.reason	string	-	-	-	-
payload.itemRevocations.itemRevocations.itemRevocations	array<object>	This is an instance of itemRevocation but is treated as a freeform object to avoid infinite recursion.	-	-	-
payload.itemRevocations.itemRevocations.itemRevocations (single item)	object	-	-	-	additional properties are allowed
payload.itemRevocations.itemRevocations.creditRevocations	array<object>	-	-	-	-
payload.itemRevocations.itemRevocations.creditRevocations.walletId	string	-	-	-	-
payload.itemRevocations.itemRevocations.creditRevocations.currencyCode	string	-	-	-	-
payload.itemRevocations.itemRevocations.creditRevocations.balanceOrigin	string	-	-	-	-
payload.itemRevocations.itemRevocations.creditRevocations.amount	integer	-	-	format (int32)	-
payload.itemRevocations.itemRevocations.creditRevocations.status	string	revocation status	allowed ("SUCCESS", "FAIL")	-	-
payload.itemRevocations.itemRevocations.creditRevocations.revocationStrategy	string	-	-	-	-
payload.itemRevocations.itemRevocations.creditRevocations.skipped	boolean	-	-	-	-
payload.itemRevocations.itemRevocations.creditRevocations.reason	string	-	-	-	-
payload.itemRevocations.itemRevocations.entitlementRevocations	array<object>	-	-	-	-
payload.itemRevocations.itemRevocations.entitlementRevocations.entitlementId	string	-	-	-	-
payload.itemRevocations.itemRevocations.entitlementRevocations.quantity	integer	-	-	format (int32)	-
payload.itemRevocations.itemRevocations.entitlementRevocations.itemId	string	-	-	-	-
payload.itemRevocations.itemRevocations.entitlementRevocations.itemSku	string	-	-	-	-
payload.itemRevocations.itemRevocations.entitlementRevocations.revocationStrategy	string	-	-	-	-
payload.itemRevocations.itemRevocations.entitlementRevocations.status	string	revocation status	allowed ("SUCCESS", "FAIL")	-	-
payload.itemRevocations.itemRevocations.entitlementRevocations.skipped	boolean	-	-	-	-
payload.itemRevocations.itemRevocations.entitlementRevocations.reason	string	-	-	-	-
payload.itemRevocations.creditRevocations	array<object>	-	-	-	-
payload.itemRevocations.creditRevocations.walletId	string	-	-	-	-
payload.itemRevocations.creditRevocations.currencyCode	string	-	-	-	-
payload.itemRevocations.creditRevocations.balanceOrigin	string	-	-	-	-
payload.itemRevocations.creditRevocations.amount	integer	-	-	format (int32)	-
payload.itemRevocations.creditRevocations.status	string	revocation status	allowed ("SUCCESS", "FAIL")	-	-
payload.itemRevocations.creditRevocations.revocationStrategy	string	-	-	-	-
payload.itemRevocations.creditRevocations.skipped	boolean	-	-	-	-
payload.itemRevocations.creditRevocations.reason	string	-	-	-	-
payload.itemRevocations.entitlementRevocations	array<object>	-	-	-	-
payload.itemRevocations.entitlementRevocations.entitlementId	string	-	-	-	-
payload.itemRevocations.entitlementRevocations.quantity	integer	-	-	format (int32)	-
payload.itemRevocations.entitlementRevocations.itemId	string	-	-	-	-
payload.itemRevocations.entitlementRevocations.itemSku	string	-	-	-	-
payload.itemRevocations.entitlementRevocations.revocationStrategy	string	-	-	-	-
payload.itemRevocations.entitlementRevocations.status	string	revocation status	allowed ("SUCCESS", "FAIL")	-	-
payload.itemRevocations.entitlementRevocations.skipped	boolean	-	-	-	-
payload.itemRevocations.entitlementRevocations.reason	string	-	-	-	-
payload.revocationId	string	revocation history id	-	-	-
payload.namespace	string	namespace	-	-	-
payload.status	string	revocation status	allowed ("SUCCESS", "FAIL")	-	-
payload.revocationError	array<object>	-	-	-	-
payload.revocationError.httpStatus	integer	-	-	format (int32)	-
payload.revocationError.code	integer	-	-	format (int32)	-
payload.revocationError.message	string	-	-	-	-
payload.requestId	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	format (uuid)	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
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": {
    "userId": "string",
    "source": "string",
    "meta": {},
    "creditRevocations": [
      {
        "walletId": "string",
        "currencyCode": "string",
        "balanceOrigin": "string",
        "amount": 0,
        "status": "SUCCESS",
        "revocationStrategy": "string",
        "skipped": true,
        "reason": "string"
      }
    ],
    "entitlementRevocations": [
      {
        "entitlementId": "string",
        "quantity": 0,
        "itemId": "string",
        "itemSku": "string",
        "revocationStrategy": "string",
        "status": "SUCCESS",
        "skipped": true,
        "reason": "string"
      }
    ],
    "revokeEntries": [
      {
        "type": "ITEM",
        "item": {
          "itemIdentityType": "ITEM_ID",
          "itemIdentity": "string"
        },
        "entitlement": {
          "entitlementId": "string",
          "type": "string",
          "clazz": "string"
        },
        "currency": {
          "walletId": "string",
          "namespace": "string",
          "currencyCode": "string",
          "balanceOrigin": "string"
        },
        "quantity": 0
      }
    ],
    "itemRevocations": [
      {
        "quantity": 0,
        "itemId": "string",
        "itemSku": "string",
        "itemType": "string",
        "revocationStrategy": "string",
        "status": "SUCCESS",
        "skipped": true,
        "reason": "string",
        "itemRevocations": [
          {
            "quantity": 0,
            "itemId": "string",
            "itemSku": "string",
            "itemType": "string",
            "revocationStrategy": "string",
            "status": "SUCCESS",
            "skipped": true,
            "reason": "string",
            "itemRevocations": [
              {}
            ],
            "creditRevocations": [
              {
                "walletId": "string",
                "currencyCode": "string",
                "balanceOrigin": "string",
                "amount": 0,
                "status": "SUCCESS",
                "revocationStrategy": "string",
                "skipped": true,
                "reason": "string"
              }
            ],
            "entitlementRevocations": [
              {
                "entitlementId": "string",
                "quantity": 0,
                "itemId": "string",
                "itemSku": "string",
                "revocationStrategy": "string",
                "status": "SUCCESS",
                "skipped": true,
                "reason": "string"
              }
            ]
          }
        ],
        "creditRevocations": [
          {
            "walletId": "string",
            "currencyCode": "string",
            "balanceOrigin": "string",
            "amount": 0,
            "status": "SUCCESS",
            "revocationStrategy": "string",
            "skipped": true,
            "reason": "string"
          }
        ],
        "entitlementRevocations": [
          {
            "entitlementId": "string",
            "quantity": 0,
            "itemId": "string",
            "itemSku": "string",
            "revocationStrategy": "string",
            "status": "SUCCESS",
            "skipped": true,
            "reason": "string"
          }
        ]
      }
    ],
    "revocationId": "string",
    "namespace": "string",
    "status": "SUCCESS",
    "revocationError": [
      {
        "httpStatus": 0,
        "code": 0,
        "message": "string"
      }
    ],
    "requestId": "string"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}