{ "basePath": "/social", "definitions": { "A DTO object for resetting user stat items": { "properties": { "additionalData": { "additionalProperties": { "type": "object" }, "description": "additional data to be published in event payload", "type": "object" }, "statCode": { "description": "stat code", "type": "string" } }, "required": [ "statCode" ], "type": "object" }, "A DTO object for user stat item value": { "properties": { "profileId": { "description": "profile id", "type": "string" }, "statCode": { "description": "stat code", "type": "string" }, "value": { "description": "current value", "format": "double", "type": "number" } }, "type": "object" }, "Attribute": { "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "BulkCycleStatsAdd": { "properties": { "statCodes": { "items": { "type": "string" }, "type": "array" } }, "required": [ "statCodes" ], "type": "object" }, "BulkStatCycleOperationResult": { "properties": { "cycleId": { "type": "string" }, "details": { "type": "object" }, "statCode": { "type": "string" }, "success": { "type": "boolean" } }, "type": "object" }, "BulkStatCycleRequest": { "properties": { "cycleIds": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "cycleIds" ], "type": "object" }, "BulkStatCycleResult": { "properties": { "data": { "items": { "$ref": "#/definitions/StatCycleInfo" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "BulkStatItemCreate": { "properties": { "statCode": { "type": "string" } }, "required": [ "statCode" ], "type": "object" }, "BulkStatItemInc": { "properties": { "inc": { "format": "double", "type": "number" }, "statCode": { "type": "string" } }, "required": [ "statCode" ], "type": "object" }, "BulkStatItemReset": { "properties": { "statCode": { "type": "string" } }, "required": [ "statCode" ], "type": "object" }, "BulkStatItemUpdate": { "properties": { "additionalData": { "additionalProperties": { "type": "object" }, "description": "Additional data to be published in event payload", "type": "object" }, "requestId": { "type": "string" }, "statCode": { "type": "string" }, "updateStrategy": { "enum": [ "INCREMENT", "MAX", "MIN", "OVERRIDE" ], "type": "string" }, "value": { "format": "double", "type": "number" } }, "required": [ "statCode", "updateStrategy", "value" ], "type": "object" }, "BulkStatOperationResult": { "properties": { "details": { "type": "object" }, "requestId": { "type": "string" }, "statCode": { "type": "string" }, "success": { "type": "boolean" }, "userId": { "type": "string" } }, "type": "object" }, "BulkUserStatItemByStatCodes": { "properties": { "statCodes": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } }, "type": "object" }, "BulkUserStatItemInc": { "properties": { "inc": { "format": "double", "type": "number" }, "statCode": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "statCode", "userId" ], "type": "object" }, "BulkUserStatItemReset": { "properties": { "statCode": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "statCode", "userId" ], "type": "object" }, "BulkUserStatItemUpdate": { "properties": { "additionalData": { "additionalProperties": { "type": "object" }, "description": "Additional data to be published in event payload", "type": "object" }, "additionalKey": { "description": "Additional key to identify multi level user's statitems, e.g. character's statitems", "type": "string" }, "requestId": { "type": "string" }, "statCode": { "type": "string" }, "updateStrategy": { "enum": [ "INCREMENT", "MAX", "MIN", "OVERRIDE" ], "type": "string" }, "userId": { "type": "string" }, "value": { "format": "double", "type": "number" } }, "required": [ "statCode", "updateStrategy", "userId", "value" ], "type": "object" }, "CycleOverride": { "properties": { "cycleId": { "type": "string" }, "maximum": { "format": "double", "type": "number" }, "minimum": { "format": "double", "type": "number" } }, "type": "object" }, "CycleOverrideRequest": { "properties": { "cycleId": { "type": "string" }, "maximum": { "format": "double", "type": "number" }, "minimum": { "format": "double", "type": "number" } }, "required": [ "cycleId" ], "type": "object" }, "ErrorEntity": { "properties": { "devStackTrace": { "description": "internal server error stack trace in configured environment", "type": "string" }, "errorCode": { "description": "numeric error code", "format": "int32", "type": "integer" }, "errorMessage": { "description": "error message", "type": "string" }, "messageVariables": { "additionalProperties": { "type": "string" }, "description": "message variables", "type": "object" }, "requiredPermission": { "$ref": "#/definitions/Permission" } }, "required": [ "errorCode", "errorMessage" ], "type": "object" }, "FieldValidationError": { "properties": { "errorCode": { "type": "string" }, "errorField": { "type": "string" }, "errorMessage": { "type": "string" }, "errorValue": { "type": "string" }, "messageVariables": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" }, "GameProfileHeader": { "properties": { "avatarUrl": { "type": "string" }, "label": { "type": "string" }, "namespace": { "type": "string" }, "profileId": { "type": "string" }, "profileName": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "userId": { "type": "string" } }, "type": "object" }, "GameProfileInfo": { "properties": { "achievements": { "items": { "type": "string" }, "type": "array" }, "attributes": { "additionalProperties": { "type": "string" }, "type": "object" }, "avatarUrl": { "type": "string" }, "inventories": { "items": { "type": "string" }, "type": "array" }, "label": { "type": "string" }, "namespace": { "type": "string" }, "profileId": { "type": "string" }, "profileName": { "type": "string" }, "statistics": { "items": { "type": "string" }, "type": "array" }, "tags": { "items": { "type": "string" }, "type": "array" }, "userId": { "type": "string" } }, "type": "object" }, "GameProfilePublicInfo": { "properties": { "avatarUrl": { "type": "string" }, "namespace": { "type": "string" }, "profileId": { "type": "string" }, "profileName": { "type": "string" } }, "type": "object" }, "GameProfileRequest": { "properties": { "achievements": { "items": { "type": "string" }, "type": "array" }, "attributes": { "additionalProperties": { "type": "string" }, "type": "object" }, "avatarUrl": { "type": "string" }, "inventories": { "items": { "type": "string" }, "type": "array" }, "label": { "type": "string" }, "profileName": { "type": "string" }, "statistics": { "items": { "type": "string" }, "type": "array" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "GlobalStatItemInfo": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "globalAggregationMethod": { "enum": [ "LAST", "MAX", "MIN", "TOTAL" ], "type": "string" }, "namespace": { "type": "string" }, "statCode": { "type": "string" }, "statName": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "updatedAt": { "format": "date-time", "type": "string" }, "value": { "format": "double", "type": "number" } }, "required": [ "createdAt", "namespace", "statCode", "statName", "updatedAt", "value" ], "type": "object" }, "GlobalStatItemPagingSlicedResult": { "properties": { "data": { "items": { "$ref": "#/definitions/GlobalStatItemInfo" }, "type": "array" }, "paging": { "$ref": "#/definitions/Paging" } }, "required": [ "data" ], "type": "object" }, "NamespaceSlotConfigInfo": { "properties": { "maxSlotSize": { "format": "int32", "type": "integer" }, "maxSlots": { "format": "int32", "type": "integer" }, "namespace": { "type": "string" } }, "type": "object" }, "Paging": { "properties": { "next": { "type": "string" }, "previous": { "type": "string" } }, "type": "object" }, "Permission": { "properties": { "action": { "format": "int32", "type": "integer" }, "resource": { "type": "string" } }, "type": "object" }, "SlotConfigUpdate": { "properties": { "maxSlotSize": { "format": "int32", "type": "integer" }, "maxSlots": { "format": "int32", "type": "integer" } }, "type": "object" }, "SlotInfo": { "properties": { "checksum": { "description": "base64 encoded md5", "type": "string" }, "customAttribute": { "type": "string" }, "dateAccessed": { "format": "date-time", "type": "string" }, "dateCreated": { "format": "date-time", "type": "string" }, "dateModified": { "format": "date-time", "type": "string" }, "label": { "type": "string" }, "mimeType": { "type": "string" }, "namespace": { "type": "string" }, "originalName": { "type": "string" }, "size": { "format": "int64", "type": "integer" }, "slotId": { "type": "string" }, "storedName": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "userId": { "type": "string" } }, "type": "object" }, "SlotMetadataUpdate": { "properties": { "customAttribute": { "type": "string" }, "label": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "StatCreate": { "properties": { "capCycleOverride": { "description": "The field used to define cap behavior of stat cycle min/max override.\nIf set to false, all stat cycle and stat item will continue as is if one stat cycle is capped on its min/max.\nIf set to true, all stat cycle and stat item cannot continue if one of stat cycle is capped on its min/max", "type": "boolean" }, "cycleIds": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "cycleOverrides": { "items": { "$ref": "#/definitions/CycleOverrideRequest" }, "type": "array", "uniqueItems": true }, "defaultValue": { "format": "double", "type": "number" }, "description": { "type": "string" }, "globalAggregationMethod": { "description": "The aggregation method for global stat, default TOTAL", "enum": [ "LAST", "MAX", "MIN", "TOTAL" ], "type": "string" }, "ignoreAdditionalDataOnValueRejected": { "type": "boolean" }, "incrementOnly": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "maximum": { "description": "default value is 1.7976931348623157e+308", "format": "double", "type": "number" }, "minimum": { "description": "default value is 0.0", "format": "double", "type": "number" }, "name": { "type": "string" }, "setAsGlobal": { "type": "boolean" }, "setBy": { "enum": [ "CLIENT", "SERVER" ], "type": "string" }, "statCode": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "visibility": { "description": "The visibility for a stat, the default SHOWALL", "enum": [ "SERVERONLY", "SHOWALL" ], "type": "string" } }, "required": [ "defaultValue", "name", "setBy", "statCode" ], "type": "object" }, "StatCycleCreate": { "properties": { "cycleType": { "description": "Cycle Type", "enum": [ "ANNUALLY", "DAILY", "MONTHLY", "SEASONAL", "WEEKLY" ], "type": "string" }, "description": { "type": "string" }, "end": { "description": "end date time", "format": "date-time", "type": "string" }, "id": { "description": "cycle id", "type": "string" }, "name": { "type": "string" }, "resetDate": { "description": "reset date", "format": "int32", "type": "integer" }, "resetDay": { "description": "reset day of week", "format": "int32", "type": "integer" }, "resetMonth": { "description": "reset month", "format": "int32", "type": "integer" }, "resetTime": { "type": "string" }, "seasonPeriod": { "description": "season period", "format": "int32", "type": "integer" }, "start": { "description": "start date time", "format": "date-time", "type": "string" } }, "required": [ "cycleType", "name", "resetTime", "start" ], "type": "object" }, "StatCycleInfo": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "currentVersion": { "format": "int32", "type": "integer" }, "cycleType": { "enum": [ "ANNUALLY", "DAILY", "MONTHLY", "SEASONAL", "WEEKLY" ], "type": "string" }, "description": { "type": "string" }, "end": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "nextReset": { "format": "date-time", "type": "string" }, "resetDate": { "format": "int32", "type": "integer" }, "resetDay": { "format": "int32", "type": "integer" }, "resetMonth": { "format": "int32", "type": "integer" }, "resetTime": { "type": "string" }, "seasonPeriod": { "format": "int32", "type": "integer" }, "start": { "format": "date-time", "type": "string" }, "status": { "enum": [ "ACTIVE", "INIT", "STOPPED" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "createdAt", "currentVersion", "cycleType", "id", "name", "namespace", "resetTime", "start", "status", "updatedAt" ], "type": "object" }, "StatCyclePagingSlicedResult": { "properties": { "data": { "items": { "$ref": "#/definitions/StatCycleInfo" }, "type": "array" }, "paging": { "$ref": "#/definitions/Paging" } }, "required": [ "data" ], "type": "object" }, "StatCycleUpdate": { "properties": { "cycleType": { "description": "Cycle Type", "enum": [ "ANNUALLY", "DAILY", "MONTHLY", "SEASONAL", "WEEKLY" ], "type": "string" }, "description": { "type": "string" }, "end": { "description": "end date time", "format": "date-time", "type": "string" }, "name": { "type": "string" }, "resetDate": { "description": "reset date", "format": "int32", "type": "integer" }, "resetDay": { "description": "reset day of week", "format": "int32", "type": "integer" }, "resetMonth": { "description": "reset month", "format": "int32", "type": "integer" }, "resetTime": { "type": "string" }, "seasonPeriod": { "description": "season period", "format": "int32", "type": "integer" }, "start": { "description": "start date time", "format": "date-time", "type": "string" } }, "required": [ "cycleType", "name", "resetTime", "start" ], "type": "object" }, "StatImportInfo": { "properties": { "failedConfigs": { "items": { "type": "string" }, "type": "array" }, "ignoredConfigs": { "items": { "type": "string" }, "type": "array" }, "newConfigs": { "items": { "type": "string" }, "type": "array" }, "replacedConfigs": { "items": { "type": "string" }, "type": "array" } }, "required": [ "failedConfigs", "ignoredConfigs", "newConfigs", "replacedConfigs" ], "type": "object" }, "StatInfo": { "properties": { "capCycleOverride": { "type": "boolean" }, "createdAt": { "format": "date-time", "type": "string" }, "cycleIds": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "cycleOverrides": { "items": { "$ref": "#/definitions/CycleOverride" }, "type": "array", "uniqueItems": true }, "defaultValue": { "format": "double", "type": "number" }, "description": { "type": "string" }, "globalAggregationMethod": { "enum": [ "LAST", "MAX", "MIN", "TOTAL" ], "type": "string" }, "ignoreAdditionalDataOnValueRejected": { "type": "boolean" }, "incrementOnly": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "maximum": { "format": "double", "type": "number" }, "minimum": { "format": "double", "type": "number" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "setAsGlobal": { "type": "boolean" }, "setBy": { "enum": [ "CLIENT", "SERVER" ], "type": "string" }, "statCode": { "type": "string" }, "status": { "enum": [ "INIT", "TIED" ], "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "updatedAt": { "format": "date-time", "type": "string" }, "visibility": { "enum": [ "SERVERONLY", "SHOWALL" ], "type": "string" } }, "required": [ "createdAt", "defaultValue", "ignoreAdditionalDataOnValueRejected", "incrementOnly", "isPublic", "name", "namespace", "setAsGlobal", "setBy", "statCode", "status", "updatedAt" ], "type": "object" }, "StatItemInc": { "properties": { "inc": { "format": "double", "type": "number" } }, "type": "object" }, "StatItemIncResult": { "properties": { "currentValue": { "format": "double", "type": "number" } }, "required": [ "currentValue" ], "type": "object" }, "StatItemUpdate": { "properties": { "additionalData": { "additionalProperties": { "type": "object" }, "description": "Additional data to be published in event payload", "type": "object" }, "updateStrategy": { "enum": [ "INCREMENT", "MAX", "MIN", "OVERRIDE" ], "type": "string" }, "value": { "format": "double", "type": "number" } }, "required": [ "updateStrategy", "value" ], "type": "object" }, "StatItemValue": { "properties": { "createdAt": { "description": "created at", "format": "date-time", "type": "string" }, "updatedAt": { "description": "updated at", "format": "date-time", "type": "string" }, "userId": { "description": "user id", "type": "string" }, "value": { "description": "current value", "format": "double", "type": "number" } }, "type": "object" }, "StatItemValuePagingSlicedResult": { "properties": { "data": { "items": { "$ref": "#/definitions/StatItemValue" }, "type": "array" }, "paging": { "$ref": "#/definitions/Paging" } }, "required": [ "data" ], "type": "object" }, "StatPagingSlicedResult": { "properties": { "data": { "items": { "$ref": "#/definitions/StatInfo" }, "type": "array" }, "paging": { "$ref": "#/definitions/Paging" } }, "required": [ "data" ], "type": "object" }, "StatResetInfo": { "properties": { "additionalData": { "additionalProperties": { "type": "object" }, "description": "Additional data to be published in event payload", "type": "object" } }, "type": "object" }, "StatUpdate": { "properties": { "capCycleOverride": { "description": "The field used to define cap behavior of stat cycle min/max override.\nIf set to false, all stat cycle and stat item will continue as is if one stat cycle is capped on its min/max.\nIf set to true, all stat cycle and stat item cannot continue if one of stat cycle is capped on its min/max", "type": "boolean" }, "cycleIds": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "cycleOverrides": { "items": { "$ref": "#/definitions/CycleOverrideRequest" }, "type": "array", "uniqueItems": true }, "defaultValue": { "format": "double", "type": "number" }, "description": { "type": "string" }, "globalAggregationMethod": { "enum": [ "LAST", "MAX", "MIN", "TOTAL" ], "type": "string" }, "ignoreAdditionalDataOnValueRejected": { "type": "boolean" }, "incrementOnly": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "maximum": { "format": "double", "type": "number" }, "minimum": { "format": "double", "type": "number" }, "name": { "type": "string" }, "setAsGlobal": { "type": "boolean" }, "setBy": { "enum": [ "CLIENT", "SERVER" ], "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "visibility": { "enum": [ "SERVERONLY", "SHOWALL" ], "type": "string" } }, "type": "object" }, "UserGameProfiles": { "properties": { "gameProfiles": { "items": { "$ref": "#/definitions/GameProfilePublicInfo" }, "type": "array" }, "userId": { "type": "string" } }, "type": "object" }, "UserSlotConfigInfo": { "properties": { "maxSlotSize": { "format": "int32", "type": "integer" }, "maxSlots": { "format": "int32", "type": "integer" }, "namespace": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "UserStatCycleItemInfo": { "properties": { "additionalData": { "additionalProperties": { "type": "object" }, "type": "object" }, "createdAt": { "format": "date-time", "type": "string" }, "cycleId": { "type": "string" }, "cycleName": { "type": "string" }, "cycleVersion": { "format": "int32", "type": "integer" }, "namespace": { "type": "string" }, "statCode": { "type": "string" }, "statName": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "updatedAt": { "format": "date-time", "type": "string" }, "userId": { "type": "string" }, "value": { "format": "double", "type": "number" } }, "required": [ "createdAt", "cycleId", "cycleName", "cycleVersion", "namespace", "statCode", "statName", "updatedAt", "userId", "value" ], "type": "object" }, "UserStatCycleItemPagingSlicedResult": { "properties": { "data": { "items": { "$ref": "#/definitions/UserStatCycleItemInfo" }, "type": "array" }, "paging": { "$ref": "#/definitions/Paging" } }, "required": [ "data" ], "type": "object" }, "UserStatItemInfo": { "properties": { "additionalData": { "additionalProperties": { "type": "object" }, "type": "object" }, "createdAt": { "format": "date-time", "type": "string" }, "namespace": { "type": "string" }, "statCode": { "type": "string" }, "statName": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "updatedAt": { "format": "date-time", "type": "string" }, "userId": { "type": "string" }, "value": { "format": "double", "type": "number" } }, "required": [ "createdAt", "namespace", "statCode", "statName", "updatedAt", "userId", "value" ], "type": "object" }, "UserStatItemPagingSlicedResult": { "properties": { "data": { "items": { "$ref": "#/definitions/UserStatItemInfo" }, "type": "array" }, "paging": { "$ref": "#/definitions/Paging" } }, "required": [ "data" ], "type": "object" }, "ValidationErrorEntity": { "properties": { "errorCode": { "description": "numeric error code", "format": "int32", "type": "integer" }, "errorMessage": { "description": "error message", "type": "string" }, "errors": { "items": { "$ref": "#/definitions/FieldValidationError" }, "type": "array" } }, "required": [ "errorCode", "errorMessage" ], "type": "object" } }, "externalDocs": { "description": "API Docs", "url": "https://stage.accelbyte.io/social" }, "info": { "contact": { "email": "engineering@accelbyte.io", "name": "Engineering Team at AccelByte", "url": "https://accelbyte.io" }, "description": "Justice Statistics Service", "title": "justice-statistics-service", "version": "4.5.2" }, "paths": { "/admin/namespaces/{namespace}/config": { "delete": { "deprecated": true, "description": "

The endpoint is going to be deprecated


Deletes a namespace slot configuration, the configuration will be default after delete.
Other detail info:", "operationId": "deleteNamespaceSlotConfig", "parameters": [ { "description": "Namespace", "in": "path", "name": "namespace", "required": true, "type": "string" } ], "responses": { "204": { "description": "Successful delete of namespace slot config" } }, "security": [ { "authorization": [] } ], "summary": "Deletes a namespace slot configuration", "tags": [ "SlotConfig" ], "x-operationId": { "value": "social/admin/slot-definitions/v1/delete" }, "x-security": { "userPermissions": "ADMIN:NAMESPACE:{namespace}:SLOTCONFIG [DELETE]" }, "x-errorCodes": {} }, "get": { "deprecated": true, "description": "

The endpoint is going to be deprecated


Get slot configuration for a given namespace. In case slot configuration is not set, the default will be returned.
Other detail info:", "operationId": "getNamespaceSlotConfig", "parameters": [ { "description": "Namespace", "in": "path", "name": "namespace", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/NamespaceSlotConfigInfo" } } }, "security": [ { "authorization": [] } ], "summary": "Returns a namespace slot configuration", "tags": [ "SlotConfig" ], "x-operationId": { "value": "social/admin/slot-definitions/v1/get" }, "x-security": { "userPermissions": "ADMIN:NAMESPACE:{namespace}:SLOTCONFIG [READ]" }, "x-errorCodes": {} }, "put": { "consumes": [ "application/json" ], "deprecated": true, "description": "

The endpoint is going to be deprecated


Update a slot namespace configuration.
Other detail info:", "operationId": "updateNamespaceSlotConfig", "parameters": [ { "description": "Namespace", "in": "path", "name": "namespace", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/SlotConfigUpdate" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/NamespaceSlotConfigInfo" } } }, "security": [ { "authorization": [] } ], "summary": "Update a namespace slot configuration", "tags": [ "SlotConfig" ], "x-operationId": { "value": "social/admin/slot-definitions/v1/update" }, "x-security": { "userPermissions": "ADMIN:NAMESPACE:{namespace}:SLOTCONFIG [UPDATE]" }, "x-errorCodes": {} } }, "/admin/namespaces/{namespace}/users/{userId}/config": { "delete": { "deprecated": true, "description": "

The endpoint is going to be deprecated


Deletes a user slot configuration in given namespace, the namespace slot configuration will be returned after delete.
Other detail info: