AsyncAPI for revocation service 0.0.1 documentation

備考

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 Operation​

Message revocationCompleted​

message is sent when revoking user item ownership.

Payload​
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdstringuserId---
payload.sourcestringcurrent revocation source constains these DLC, ORDER, OTHER---
payload.metaobjectrevocation source meta properties, will put store orderNo, DLC transaction record id into it--additional properties are allowed
payload.creditRevocationsarray<object>credit revocations---
payload.creditRevocations.walletIdstring----
payload.creditRevocations.currencyCodestring----
payload.creditRevocations.balanceOriginstring----
payload.creditRevocations.amountinteger--format (int32)-
payload.creditRevocations.statusstringrevocation statusallowed ("SUCCESS", "FAIL")--
payload.creditRevocations.revocationStrategystring----
payload.creditRevocations.skippedboolean----
payload.creditRevocations.reasonstring----
payload.entitlementRevocationsarray<object>credit revocations---
payload.entitlementRevocations.entitlementIdstring----
payload.entitlementRevocations.quantityinteger--format (int32)-
payload.entitlementRevocations.itemIdstring----
payload.entitlementRevocations.itemSkustring----
payload.entitlementRevocations.revocationStrategystring----
payload.entitlementRevocations.statusstringrevocation statusallowed ("SUCCESS", "FAIL")--
payload.entitlementRevocations.skippedboolean----
payload.entitlementRevocations.reasonstring----
payload.revokeEntriesarray<object>revoke entry request list---
payload.revokeEntries.typestring-allowed ("ITEM", "CURRENCY", "ENTITLEMENT")--
payload.revokeEntries.itemobject---additional properties are allowed
payload.revokeEntries.item.itemIdentityTypestring-allowed ("ITEM_ID", "ITEM_SKU")--
payload.revokeEntries.item.itemIdentitystringitem id or item sku---
payload.revokeEntries.entitlementobject---additional properties are allowed
payload.revokeEntries.entitlement.entitlementIdstring----
payload.revokeEntries.entitlement.typestringentitlement type---
payload.revokeEntries.entitlement.clazzstringentitlement clazz---
payload.revokeEntries.currencyobject---additional properties are allowed
payload.revokeEntries.currency.walletIdstring----
payload.revokeEntries.currency.namespacestring----
payload.revokeEntries.currency.currencyCodestring----
payload.revokeEntries.currency.balanceOriginstring----
payload.revokeEntries.quantityinteger--format (int32)-
payload.itemRevocationsarray<object>item revocations---
payload.itemRevocations.quantityinteger--format (int32)-
payload.itemRevocations.itemIdstring----
payload.itemRevocations.itemSkustring----
payload.itemRevocations.itemTypestring----
payload.itemRevocations.revocationStrategystring----
payload.itemRevocations.statusstringrevocation statusallowed ("SUCCESS", "FAIL")--
payload.itemRevocations.skippedboolean----
payload.itemRevocations.reasonstring----
payload.itemRevocations.itemRevocationsarray<object>----
payload.itemRevocations.itemRevocations.quantityinteger--format (int32)-
payload.itemRevocations.itemRevocations.itemIdstring----
payload.itemRevocations.itemRevocations.itemSkustring----
payload.itemRevocations.itemRevocations.itemTypestring----
payload.itemRevocations.itemRevocations.revocationStrategystring----
payload.itemRevocations.itemRevocations.statusstringrevocation statusallowed ("SUCCESS", "FAIL")--
payload.itemRevocations.itemRevocations.skippedboolean----
payload.itemRevocations.itemRevocations.reasonstring----
payload.itemRevocations.itemRevocations.itemRevocationsarray<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.creditRevocationsarray<object>----
payload.itemRevocations.itemRevocations.creditRevocations.walletIdstring----
payload.itemRevocations.itemRevocations.creditRevocations.currencyCodestring----
payload.itemRevocations.itemRevocations.creditRevocations.balanceOriginstring----
payload.itemRevocations.itemRevocations.creditRevocations.amountinteger--format (int32)-
payload.itemRevocations.itemRevocations.creditRevocations.statusstringrevocation statusallowed ("SUCCESS", "FAIL")--
payload.itemRevocations.itemRevocations.creditRevocations.revocationStrategystring----
payload.itemRevocations.itemRevocations.creditRevocations.skippedboolean----
payload.itemRevocations.itemRevocations.creditRevocations.reasonstring----
payload.itemRevocations.itemRevocations.entitlementRevocationsarray<object>----
payload.itemRevocations.itemRevocations.entitlementRevocations.entitlementIdstring----
payload.itemRevocations.itemRevocations.entitlementRevocations.quantityinteger--format (int32)-
payload.itemRevocations.itemRevocations.entitlementRevocations.itemIdstring----
payload.itemRevocations.itemRevocations.entitlementRevocations.itemSkustring----
payload.itemRevocations.itemRevocations.entitlementRevocations.revocationStrategystring----
payload.itemRevocations.itemRevocations.entitlementRevocations.statusstringrevocation statusallowed ("SUCCESS", "FAIL")--
payload.itemRevocations.itemRevocations.entitlementRevocations.skippedboolean----
payload.itemRevocations.itemRevocations.entitlementRevocations.reasonstring----
payload.itemRevocations.creditRevocationsarray<object>----
payload.itemRevocations.creditRevocations.walletIdstring----
payload.itemRevocations.creditRevocations.currencyCodestring----
payload.itemRevocations.creditRevocations.balanceOriginstring----
payload.itemRevocations.creditRevocations.amountinteger--format (int32)-
payload.itemRevocations.creditRevocations.statusstringrevocation statusallowed ("SUCCESS", "FAIL")--
payload.itemRevocations.creditRevocations.revocationStrategystring----
payload.itemRevocations.creditRevocations.skippedboolean----
payload.itemRevocations.creditRevocations.reasonstring----
payload.itemRevocations.entitlementRevocationsarray<object>----
payload.itemRevocations.entitlementRevocations.entitlementIdstring----
payload.itemRevocations.entitlementRevocations.quantityinteger--format (int32)-
payload.itemRevocations.entitlementRevocations.itemIdstring----
payload.itemRevocations.entitlementRevocations.itemSkustring----
payload.itemRevocations.entitlementRevocations.revocationStrategystring----
payload.itemRevocations.entitlementRevocations.statusstringrevocation statusallowed ("SUCCESS", "FAIL")--
payload.itemRevocations.entitlementRevocations.skippedboolean----
payload.itemRevocations.entitlementRevocations.reasonstring----
payload.revocationIdstringrevocation history id---
payload.namespacestringnamespace---
payload.statusstringrevocation statusallowed ("SUCCESS", "FAIL")--
payload.revocationErrorarray<object>----
payload.revocationError.httpStatusinteger--format (int32)-
payload.revocationError.codeinteger--format (int32)-
payload.revocationError.messagestring----
payload.requestIdstring----
0 (allOf item)object---additional properties are allowed
idstringevent id-format (uuid)-
versioninteger----
namestringevent name---
namespacestringevent namespace---
timestampstring--format (date-time)-
clientIdstringclient id---
userIdstringthe operator id---
traceIdstringtrace id---
sessionIdstringsession 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"
}
に最終更新

On this page