GearN Server | Rest Api references | Dashboard

Overview

Fetch complete configuration and metadata for a specified game.

Client

Require permission rules dashboard.getGameInformation.selfEnable. See PermissionRules

HTTP

POST /api/rJson/dashboard/client/getGameInformation

Request Headers

Name	Type	Required	Description
Auth-Token	string	true	A token used to authenticate the user. It is issued after successful login from the client type authenticate (e.g., loginByAccount, loginWithCustomId, etc.) or when an admin logs in via the GearN Dashboard. This token identifies the request sender and determines their access level.
Secret-Key	string	true	The SecretKey in SecretInfo with role must is Player.
Game-Id	string		Optional if the gameId in the SecretInfo use in headers Secret-Key has assign a valid value, if not, let unique identifier of the game this request is targeting.
Content-Type	string	true	application/json

Request Body

Code	Type	Required	Description
gameId	string	true	Unique identifier of the game to query or modify. (2 - 32 characters)

Response Body

200 Ok

Code	Type	Required	Description
returnCode	ReturnCode	true	Additional metadata that can be attached to any request. Especially useful when working with advanced features such as EventCallbackScript. See ReturnCode
debugMessage	string		A developer-oriented message that provides additional context useful for debugging and internal logging. This field is not intended for end-users and may include stack traces, validation failures, or internal error diagnostics.
invalidRequestParameters	InvalidMember[]		Just had data when the returnCode is InvalidRequestParameters.A list of members that failed validation or could not be processed during the request. Each entry typically includes identifying information and an error reason. This is useful for partial success scenarios where some members are accepted and others are rejected. See InvalidMember
parameters	ResponseData		Just had data when the returnCode is Ok. A dynamic set of key-value pairs included in the response to provide additional context or metadata. These parameters may vary depending on the operation and typically contain optional fields such as timestamps, identifiers, or computed values relevant to the result. See ResponseData

ReturnCode

Name	Code	Description
SecretInvalid	-10	The selected secret key is missing, wrong, or does not match the current route/game context.
MaxSizeRequestReject	-9	The serialized request payload exceeded the maximum size accepted by the backend.
MaxRequestReject	-8	The backend rejected the request because the current caller exceeded a request-rate limit.
MaxCCUReject	-7	The backend rejected the request because the current concurrent-user/session limit was exceeded.
OperationNotAuthorized	-6	The target operation exists, but the caller is not authorized for the selected role or target resource.
InvalidRequestParameters	-5	The request shape or one or more request-member values are invalid. When available, inspect `invalidMembers` for field-level details.
OperationInvalid	-4	The requested operation code is unknown or is not valid for the selected request type/role.
InternalServerError	-3	The backend hit an unhandled internal failure before producing a valid business response.
OperationNotAllow	-2	The operation is known and the secret key is valid, but the permission rules attached to the current secret key do not allow this operation in the current target context. This usually maps to missing `selfEnable`, `otherSelfEnable`, `serverSelfEnable`, or `adminSelfEnable` permission for the resolved request.
OperationTimeout	-1	The request timed out before a response was received. This code may be synthesized by the SDK timeout layer as well as returned by the backend.
UnknownError	0	The request failed, but no more specific low-level return code was mapped.
Ok	1	The request completed successfully at protocol level and produced a response payload. Callers must still validate the business `errorCode` in that payload.

ResponseData

Code	Type	Required	Description
errorCode	ErrorCode		A string that represents the status of the operation. It indicates whether the request was successful or failed due to a specific error condition. See ErrorCode
gameId	string	true	Identifier of the game project.
tsCreate	number	true	Timestamp indicating when the entity was created.
gameName	string	true	GameName used in GetGameInformationResponseData.
creatorId	string	true	CreatorId used in GetGameInformationResponseData.
gameDescription	string	true	GameDescription used in GetGameInformationResponseData.
gameIconUrl	string	true	GameIconUrl used in GetGameInformationResponseData.
gameSettings	GameSettingsParam	true	GameSettings used in GetGameInformationResponseData. See GameSettingsParam
matchmakingQueueSettings	MatchmakingQueueSettingsParam[]	true	MatchmakingQueueSettings used in GetGameInformationResponseData. See MatchmakingQueueSettingsParam

GameSettingsParam

Configuration structure defining backend behavior or system-level preferences.

Code	Type	Description
gamePlayerSettings	GamePlayerSettingsParam	GamePlayerSettings used in GameSettingsParam. See GamePlayerSettingsParam
characterPlayerSettings	CharacterPlayerSettingsParam	CharacterPlayerSettings used in GameSettingsParam. See CharacterPlayerSettingsParam
groupSettings	GroupSettingsParam	GroupSettings used in GameSettingsParam. See GroupSettingsParam
inventorySettings	InventorySettingsParam	InventorySettings used in GameSettingsParam. See InventorySettingsParam

GamePlayerSettingsParam

Configuration structure defining backend behavior or system-level preferences.

Code	Type	Description
playerCurrenciesSettings	CurrencySettingsParam[]	PlayerCurrenciesSettings used in GamePlayerSettingsParam. See CurrencySettingsParam
playerStatisticsSettings	StatisticsSettingsParam[]	PlayerStatisticsSettings used in GamePlayerSettingsParam. See StatisticsSettingsParam
playerDatasSettings	DataSettingsParam[]	PlayerDatasSettings used in GamePlayerSettingsParam. See DataSettingsParam
customDatasSettings	DataSettingsParam[]	CustomDatasSettings used in GamePlayerSettingsParam. See DataSettingsParam
tagsSettings	TagSettingsParam[]	TagsSettings used in GamePlayerSettingsParam. See TagSettingsParam
playerCharacterCatalogSettings	CharacterCatalogSettingsParam[]	PlayerCharacterCatalogSettings used in GamePlayerSettingsParam. See CharacterCatalogSettingsParam
playerGroupCatalogSettings	GroupCatalogSettingsParam[]	PlayerGroupCatalogSettings used in GamePlayerSettingsParam. See GroupCatalogSettingsParam
playerItemCatalogSettings	ItemCatalogSettingsParam[]	PlayerItemCatalogSettings used in GamePlayerSettingsParam. See ItemCatalogSettingsParam
playerFriendCatalogSettings	FriendCatalogSettingsParam[]	PlayerFriendCatalogSettings used in GamePlayerSettingsParam. See FriendCatalogSettingsParam

CurrencySettingsParam

Configuration structure defining backend behavior or system-level preferences.

Code	Type	Required	Description
key	string	true	Key used to reference the value or setting. (2 - 32 characters)
initialValue	number	true	Value assigned to the configuration or key.
description	string	true	Description used in CurrencySettingsParam.
index	boolean	true	Index used in CurrencySettingsParam.

StatisticsSettingsParam

Configuration structure defining backend behavior or system-level preferences.

Code	Type	Required	Description
key	string	true	Key used to reference the value or setting. (2 - 32 characters)
statisticsAggregationMethod	number int	true	StatisticsAggregationMethod used in StatisticsSettingsParam.
maximumValue	number		Value assigned to the configuration or key. (Default: null)
minimumValue	number		Value assigned to the configuration or key. (Default: null)
initialValue	number	true	Value assigned to the configuration or key.
description	string	true	Description used in StatisticsSettingsParam.
index	boolean	true	Index used in StatisticsSettingsParam.

DataSettingsParam

Configuration structure defining backend behavior or system-level preferences.

Code	Type	Required	Description
key	string	true	Key used to reference the value or setting. (2 - 32 characters)
description	string	true	Description used in DataSettingsParam.
permission	number int	true	Permissions configuration or role-based access control settings.

TagSettingsParam

Configuration structure defining backend behavior or system-level preferences.

Code	Type	Required	Description
key	string	true	Key used to reference the value or setting. (2 - 32 characters)
description	string	true	Description used in TagSettingsParam.
index	boolean	true	Index used in TagSettingsParam.

CharacterCatalogSettingsParam

Configuration structure defining backend behavior or system-level preferences.

Code	Type	Required	Description
catalogId	string	true	CatalogId used in CharacterCatalogSettingsParam. (2 - 32 characters)
description	string	true	Description used in CharacterCatalogSettingsParam.

GroupCatalogSettingsParam

Configuration structure defining backend behavior or system-level preferences.

Code	Type	Required	Description
catalogId	string	true	CatalogId used in GroupCatalogSettingsParam. (2 - 32 characters)
description	string	true	Description used in GroupCatalogSettingsParam.
forceAcceptMember	boolean	true	ForceAcceptMember used in GroupCatalogSettingsParam.

ItemCatalogSettingsParam

Configuration structure defining backend behavior or system-level preferences.

Code	Type	Required	Description
catalogId	string	true	CatalogId used in ItemCatalogSettingsParam. (2 - 32 characters)
itemType	number int	true	ItemType used in ItemCatalogSettingsParam.
itemClassSettings	ItemClassSettingsParam[]	true	ItemClassSettings used in ItemCatalogSettingsParam. See ItemClassSettingsParam

ItemClassSettingsParam

Configuration structure defining backend behavior or system-level preferences.

Code	Type	Required	Description
classId	string	true	ClassId used in ItemClassSettingsParam. (2 - 32 characters)
description	string	true	Description used in ItemClassSettingsParam.

FriendCatalogSettingsParam

Configuration structure defining backend behavior or system-level preferences.

Code	Type	Required	Description
catalogId	string	true	CatalogId used in FriendCatalogSettingsParam. (2 - 32 characters)
description	string	true	Description used in FriendCatalogSettingsParam.
forceAcceptFriend	boolean	true	ForceAcceptFriend used in FriendCatalogSettingsParam.

CharacterPlayerSettingsParam

Configuration structure defining backend behavior or system-level preferences.

Code	Type	Description
playerCurrenciesSettings	CurrencySettingsParam[]	PlayerCurrenciesSettings used in CharacterPlayerSettingsParam. See CurrencySettingsParam
playerStatisticsSettings	StatisticsSettingsParam[]	PlayerStatisticsSettings used in CharacterPlayerSettingsParam. See StatisticsSettingsParam
playerDatasSettings	DataSettingsParam[]	PlayerDatasSettings used in CharacterPlayerSettingsParam. See DataSettingsParam
customDatasSettings	DataSettingsParam[]	CustomDatasSettings used in CharacterPlayerSettingsParam. See DataSettingsParam
tagsSettings	TagSettingsParam[]	TagsSettings used in CharacterPlayerSettingsParam. See TagSettingsParam
playerGroupCatalogSettings	GroupCatalogSettingsParam[]	PlayerGroupCatalogSettings used in CharacterPlayerSettingsParam. See GroupCatalogSettingsParam
playerItemCatalogSettings	ItemCatalogSettingsParam[]	PlayerItemCatalogSettings used in CharacterPlayerSettingsParam. See ItemCatalogSettingsParam
playerFriendCatalogSettings	FriendCatalogSettingsParam[]	PlayerFriendCatalogSettings used in CharacterPlayerSettingsParam. See FriendCatalogSettingsParam

GroupSettingsParam

Configuration structure defining backend behavior or system-level preferences.

Code	Type	Description
groupCurrenciesSettings	CurrencySettingsParam[]	GroupCurrenciesSettings used in GroupSettingsParam. See CurrencySettingsParam
groupStatisticsSettings	StatisticsSettingsParam[]	GroupStatisticsSettings used in GroupSettingsParam. See StatisticsSettingsParam
groupDatasSettings	DataSettingsParam[]	GroupDatasSettings used in GroupSettingsParam. See DataSettingsParam
customDatasSettings	DataSettingsParam[]	CustomDatasSettings used in GroupSettingsParam. See DataSettingsParam
tagsSettings	TagSettingsParam[]	TagsSettings used in GroupSettingsParam. See TagSettingsParam
groupItemCatalogSettings	ItemCatalogSettingsParam[]	GroupItemCatalogSettings used in GroupSettingsParam. See ItemCatalogSettingsParam

InventorySettingsParam

Configuration structure defining backend behavior or system-level preferences.

Code	Type	Description
itemStatisticsSettings	StatisticsSettingsParam[]	ItemStatisticsSettings used in InventorySettingsParam. See StatisticsSettingsParam
itemDatasSettings	DataSettingsParam[]	ItemDatasSettings used in InventorySettingsParam. See DataSettingsParam
customDatasSettings	DataSettingsParam[]	CustomDatasSettings used in InventorySettingsParam. See DataSettingsParam
tagsSettings	TagSettingsParam[]	TagsSettings used in InventorySettingsParam. See TagSettingsParam

MatchmakingQueueSettingsParam

Configuration structure defining backend behavior or system-level preferences.

Code	Type	Required	Description
queueName	string	true	QueueName used in MatchmakingQueueSettingsParam. (6 - 32 characters)
matchSize	SizeParam	true	MatchSize used in MatchmakingQueueSettingsParam. See SizeParam
ticketSize	SizeParam	true	TicketSize used in MatchmakingQueueSettingsParam. See SizeParam
serverAllocation	ServerAllocationParam	true	ServerAllocation used in MatchmakingQueueSettingsParam. See ServerAllocationParam
teams	TeamParam[]		Teams used in MatchmakingQueueSettingsParam. See TeamParam
rules	RuleParam[]		Rules used in MatchmakingQueueSettingsParam. See RuleParam
remove	boolean		Remove used in MatchmakingQueueSettingsParam.

SizeParam

Parameters used to configure or control a related operation.

Code	Type	Required	Description
min	number int	true	Min used in SizeParam. (from 1)
max	number int	true	Max used in SizeParam. (from 1)

ServerAllocationParam

Parameters used to configure or control a related operation.

Code	Type	Required	Description
enable	boolean	true	Enable used in ServerAllocationParam.

TeamParam

Parameters used to configure or control a related operation.

Code	Type	Required	Description
teamId	string	true	TeamId used in TeamParam. (1 - 32 characters)
teamSize	SizeParam	true	TeamSize used in TeamParam. See SizeParam

RuleParam

Parameters used to configure or control a related operation.

Code	Type	Required	Description
name	string	true	Name used in RuleParam. (1 - 32 characters)
type	number int	true	Type used in RuleParam. (from 1 to 8)
attributeSource	number		AttributeSource used in RuleParam. (from 1 to 2)
attributePath	string		AttributePath used in RuleParam. (1 - 32 characters)
defaultValue	any		Value assigned to the configuration or key.
compairType	number int		CompairType used in RuleParam. (from 1 to 2)
allowedDifference	number		AllowedDifference used in RuleParam. (from 0)
min	number		Min used in RuleParam.
max	number		Max used in RuleParam.
advancedSettings	AdvancedSettingsParam		AdvancedSettings used in RuleParam. See AdvancedSettingsParam

AdvancedSettingsParam

Configuration structure defining backend behavior or system-level preferences.

Code	Type	Required	Description
secondsUntilOptional	number	true	SecondsUntilOptional used in AdvancedSettingsParam. (from 1)
expansionType	number int		ExpansionType used in AdvancedSettingsParam. (from 1 to 3)
linearExpansions	LinearExpansionsParam		LinearExpansions used in AdvancedSettingsParam. See LinearExpansionsParam
customExpansions	CustomExpansionsParam		CustomExpansions used in AdvancedSettingsParam. See CustomExpansionsParam

LinearExpansionsParam

Parameters used to configure or control a related operation.

Code	Type	Required	Description
secondsBetweenExpansions	number	true	SecondsBetweenExpansions used in LinearExpansionsParam. (from 1)
delta	number		Delta used in LinearExpansionsParam.
limit	number		Limit used in LinearExpansionsParam.

CustomExpansionsParam

Parameters used to configure or control a related operation.

Code	Type	Required	Description
secondsBetweenExpansions	number	true	SecondsBetweenExpansions used in CustomExpansionsParam. (from 1)
overrideValue	any[]		Value assigned to the configuration or key.
overrideMin	any[]		OverrideMin used in CustomExpansionsParam.
overrideMax	any[]		OverrideMax used in CustomExpansionsParam.

ErrorCode

Name	Code	Description
Ok	1	The business operation completed successfully.
GameNotFound	22	The target game does not exist.

InvalidMember

Code	Type	Description
code	string	The parameterCode invalid.
invalidMemberType	InvalidMemberType	The invalid member type of this parameterCode. See InvalidMemberType

InvalidMemberType

Name	Code	Description
UnknownError	1	The backend rejected the member but did not map it to a more specific validation category.
DataRequired	2	The member is required but missing.
TypeInvalid	3	The member type does not match the expected runtime type.
StringNull	4	A required string member is null or empty when null is not allowed.
StringMinLength	5	A string member is shorter than the configured minimum length.
StringMaxLength	6	A string member is longer than the configured maximum length.
NumberMinValue	7	A numeric member is lower than the configured minimum value.
NumberMaxValue	8	A numeric member is higher than the configured maximum value.
NumberMustInt	9	A numeric member must be an integer but received a non-integer value.
GNHashtableNull	10	A required `GNHashtable` member is null.
GNHashtableMinLength	11	A `GNHashtable` member contains fewer entries than allowed.
GNHashtableMaxLength	12	A `GNHashtable` member contains more entries than allowed.
GNArrayNull	13	A required `GNArray` member is null.
GNArrayMinLength	14	A `GNArray` member contains fewer items than allowed.
GNArrayMaxLength	15	A `GNArray` member contains more items than allowed.