@xmobitea/gn-typescript-client 2.6.9-tsc → 2.6.10-tsc

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. package/dist/runtime/config/GNServerSettings.d.ts +3 -0
  2. package/dist/runtime/config/GNServerSettings.js +7 -0
  3. package/dist/runtime/constant/Commands.d.ts +1 -0
  4. package/dist/runtime/constant/Commands.js +1 -0
  5. package/dist/runtime/networking/http/HttpPeer.js +1 -0
  6. package/dist/runtime/networking/http/NetworkingHttpPeerBase.d.ts +2 -0
  7. package/dist/runtime/networking/http/NetworkingHttpPeerBase.js +3 -0
  8. package/dist/runtime/networking/http/NetworkingPeerAxiosRequest.js +19 -4
  9. package/package.json +1 -1
  10. package/responseModel/chatgpt/Authenticate.json +0 -724
  11. package/responseModel/chatgpt/CharacterPlayer.json +0 -1890
  12. package/responseModel/chatgpt/CloudScript.json +0 -254
  13. package/responseModel/chatgpt/Content.json +0 -273
  14. package/responseModel/chatgpt/Dashboard.json +0 -4110
  15. package/responseModel/chatgpt/GamePlayer.json +0 -2306
  16. package/responseModel/chatgpt/Generic.json +0 -253
  17. package/responseModel/chatgpt/Group.json +0 -1509
  18. package/responseModel/chatgpt/Inventory.json +0 -1211
  19. package/responseModel/chatgpt/MasterPlayer.json +0 -3801
  20. package/responseModel/chatgpt/Multiplayer.json +0 -634
  21. package/responseModel/chatgpt/StoreInventory.json +0 -1099
  22. package/responseModel/clients/AuthenticateModels.json +0 -271
  23. package/responseModel/clients/CharacterPlayerModels.json +0 -792
  24. package/responseModel/clients/CloudScriptModels.json +0 -191
  25. package/responseModel/clients/ContentModels.json +0 -178
  26. package/responseModel/clients/DashboardModels.json +0 -5423
  27. package/responseModel/clients/GamePlayerModels.json +0 -781
  28. package/responseModel/clients/GenericModels.json +0 -344
  29. package/responseModel/clients/GroupModels.json +0 -705
  30. package/responseModel/clients/InventoryModels.json +0 -568
  31. package/responseModel/clients/MasterPlayerModels.json +0 -1281
  32. package/responseModel/clients/MultiplayerModels.json +0 -439
  33. package/responseModel/clients/StoreInventoryModels.json +0 -971
  34. package/responseModel/finalChatgpt/Authenticate.json +0 -1475
  35. package/responseModel/finalChatgpt/CharacterPlayer.json +0 -4104
  36. package/responseModel/finalChatgpt/CloudScript.json +0 -515
  37. package/responseModel/finalChatgpt/Content.json +0 -536
  38. package/responseModel/finalChatgpt/Dashboard.json +0 -6712
  39. package/responseModel/finalChatgpt/GamePlayer.json +0 -5142
  40. package/responseModel/finalChatgpt/Generic.json +0 -333
  41. package/responseModel/finalChatgpt/Group.json +0 -3232
  42. package/responseModel/finalChatgpt/Inventory.json +0 -2606
  43. package/responseModel/finalChatgpt/MasterPlayer.json +0 -8385
  44. package/responseModel/finalChatgpt/Multiplayer.json +0 -1196
  45. package/responseModel/finalChatgpt/StoreInventory.json +0 -2085
  46. package/responseModel/finals/Authenticate.json +0 -1460
  47. package/responseModel/finals/CharacterPlayer.json +0 -3639
  48. package/responseModel/finals/CloudScript.json +0 -465
  49. package/responseModel/finals/Content.json +0 -479
  50. package/responseModel/finals/Dashboard.json +0 -6718
  51. package/responseModel/finals/GamePlayer.json +0 -4291
  52. package/responseModel/finals/Generic.json +0 -345
  53. package/responseModel/finals/Group.json +0 -2885
  54. package/responseModel/finals/Inventory.json +0 -2309
  55. package/responseModel/finals/MasterPlayer.json +0 -7018
  56. package/responseModel/finals/Multiplayer.json +0 -1082
  57. package/responseModel/finals/StoreInventory.json +0 -1979
  58. package/responseModel/finalsShort/Authenticate.json +0 -723
  59. package/responseModel/finalsShort/CharacterPlayer.json +0 -1889
  60. package/responseModel/finalsShort/CloudScript.json +0 -253
  61. package/responseModel/finalsShort/Content.json +0 -272
  62. package/responseModel/finalsShort/Dashboard.json +0 -4109
  63. package/responseModel/finalsShort/GamePlayer.json +0 -2305
  64. package/responseModel/finalsShort/Generic.json +0 -252
  65. package/responseModel/finalsShort/Group.json +0 -1508
  66. package/responseModel/finalsShort/Inventory.json +0 -1210
  67. package/responseModel/finalsShort/MasterPlayer.json +0 -3800
  68. package/responseModel/finalsShort/Multiplayer.json +0 -633
  69. package/responseModel/finalsShort/StoreInventory.json +0 -1098
  70. package/responseModel/operationResponse/AuthenticateResponseModels.json +0 -77
  71. package/responseModel/operationResponse/CharacterPlayerResponseModels.json +0 -217
  72. package/responseModel/operationResponse/CloudScriptResponseModels.json +0 -25
  73. package/responseModel/operationResponse/ContentResponseModels.json +0 -33
  74. package/responseModel/operationResponse/DashboardResponseModels.json +0 -109
  75. package/responseModel/operationResponse/GamePlayerResponseModels.json +0 -213
  76. package/responseModel/operationResponse/GroupResponseModels.json +0 -165
  77. package/responseModel/operationResponse/InventoryResponseModels.json +0 -141
  78. package/responseModel/operationResponse/MasterPlayerResponseModels.json +0 -349
  79. package/responseModel/operationResponse/MultiplayerResponseModels.json +0 -45
  80. package/responseModel/operationResponse/StoreInventoryResponseModels.json +0 -61
  81. package/responseModel/servers/Authenticate.json +0 -1328
  82. package/responseModel/servers/CharacterPlayer.json +0 -3199
  83. package/responseModel/servers/CloudScript.json +0 -278
  84. package/responseModel/servers/Content.json +0 -324
  85. package/responseModel/servers/GamePlayer.json +0 -3844
  86. package/responseModel/servers/Group.json +0 -2454
  87. package/responseModel/servers/Inventory.json +0 -1964
  88. package/responseModel/servers/MasterAdmin.json +0 -5569
  89. package/responseModel/servers/MasterPlayer.json +0 -5924
  90. package/responseModel/servers/Multiplayer.json +0 -545
  91. package/responseModel/servers/StoreInventory.json +0 -1290
package/responseModel/finalChatgpt/CharacterPlayer.json DELETED
@@ -1,4104 +0,0 @@
1
- {
2
- "requestType": "CharacterPlayer",
3
- "operations": [
4
- {
5
- "operationCode": "AddPlayerFriend",
6
- "details": [
7
- {
8
- "role": "Client",
9
- "requestData": [
10
- {
11
- "code": "CharacterId",
12
- "description": "Unique identifier of the character performing the action or being referenced.",
13
- "optional": false,
14
- "type": "string",
15
- "gnType": "String",
16
- "conditions": {
17
- "mustNonNull": true,
18
- "minLength": 11,
19
- "maxLength": 11
20
- }
21
- },
22
- {
23
- "code": "FriendId",
24
- "description": "Unique identifier of the friend character being added.",
25
- "optional": false,
26
- "type": "string",
27
- "gnType": "String",
28
- "conditions": {
29
- "mustNonNull": true,
30
- "minLength": 11,
31
- "maxLength": 11
32
- }
33
- },
34
- {
35
- "code": "CatalogId",
36
- "description": "Identifier of the catalog that contains the character or item data.",
37
- "optional": false,
38
- "type": "string",
39
- "gnType": "String",
40
- "conditions": {
41
- "mustNonNull": true,
42
- "minLength": 2,
43
- "maxLength": 32
44
- }
45
- }
46
- ]
47
- },
48
- {
49
- "role": "Server",
50
- "requestData": []
51
- },
52
- {
53
- "role": "Admin",
54
- "requestData": []
55
- }
56
- ],
57
- "responseData": [
58
- {
59
- "code": "ErrorCode",
60
- "value": [
61
- "CatalogIdNotFound",
62
- "CharacterPlayerNotFound",
63
- "Ok"
64
- ]
65
- }
66
- ],
67
- "description": "Send a friend request from one character to another.",
68
- "operationResponse": "EmptyResponseData"
69
- },
70
- {
71
- "operationCode": "AddSegment",
72
- "details": [
73
- {
74
- "role": "Client",
75
- "requestData": [
76
- {
77
- "code": "CharacterId",
78
- "description": "Unique identifier of the character performing the action or being referenced.",
79
- "optional": false,
80
- "type": "string",
81
- "gnType": "String",
82
- "conditions": {
83
- "mustNonNull": true,
84
- "minLength": 11,
85
- "maxLength": 11
86
- }
87
- },
88
- {
89
- "code": "Value",
90
- "description": "The specific value of the segment to be assigned to the character.",
91
- "optional": false,
92
- "type": "string",
93
- "gnType": "String",
94
- "conditions": {
95
- "mustNonNull": true,
96
- "minLength": 6,
97
- "maxLength": 32
98
- }
99
- }
100
- ]
101
- },
102
- {
103
- "role": "Server",
104
- "requestData": []
105
- },
106
- {
107
- "role": "Admin",
108
- "requestData": []
109
- }
110
- ],
111
- "responseData": [
112
- {
113
- "code": "ErrorCode",
114
- "value": [
115
- "CharacterPlayerNotFound",
116
- "Ok"
117
- ]
118
- }
119
- ],
120
- "description": "Tag a character with a specific segment for segmentation or personalization.",
121
- "operationResponse": "EmptyResponseData"
122
- },
123
- {
124
- "operationCode": "ChangePlayerCurrency",
125
- "details": [
126
- {
127
- "role": "Client",
128
- "requestData": [
129
- {
130
- "code": "CharacterId",
131
- "description": "Unique identifier of the character performing the action or being referenced.",
132
- "optional": false,
133
- "type": "string",
134
- "gnType": "String",
135
- "conditions": {
136
- "mustNonNull": true,
137
- "minLength": 11,
138
- "maxLength": 11
139
- }
140
- },
141
- {
142
- "code": "PlayerCurrencies",
143
- "description": "An array of currency modifications, including key and value pairs.",
144
- "optional": false,
145
- "type": "PlayerCurrencyParam",
146
- "gnType": "GNArray",
147
- "conditions": {
148
- "mustNonNull": true,
149
- "minLength": 1,
150
- "maxLength": 32
151
- }
152
- },
153
- {
154
- "code": "Log",
155
- "description": "Optional developer-provided note to describe the context or reason for the operation.",
156
- "optional": true,
157
- "type": "string",
158
- "gnType": "String",
159
- "conditions": {
160
- "mustNonNull": true,
161
- "minLength": 1,
162
- "maxLength": 256
163
- }
164
- }
165
- ]
166
- },
167
- {
168
- "role": "Server",
169
- "requestData": []
170
- },
171
- {
172
- "role": "Admin",
173
- "requestData": []
174
- }
175
- ],
176
- "responseData": [
177
- {
178
- "code": "ErrorCode",
179
- "value": [
180
- "CharacterPlayerNotFound",
181
- "NotEnoughCurrency",
182
- "Ok"
183
- ]
184
- },
185
- {
186
- "code": "InfoResponseParameters"
187
- }
188
- ],
189
- "description": "Adjust the amount of one or more currencies associated with a character.",
190
- "operationResponse": "CharacterPlayerResponseData"
191
- },
192
- {
193
- "operationCode": "ChangePlayerStatistics",
194
- "details": [
195
- {
196
- "role": "Client",
197
- "requestData": [
198
- {
199
- "code": "CharacterId",
200
- "description": "Unique identifier of the character performing the action or being referenced.",
201
- "optional": false,
202
- "type": "string",
203
- "gnType": "String",
204
- "conditions": {
205
- "mustNonNull": true,
206
- "minLength": 11,
207
- "maxLength": 11
208
- }
209
- },
210
- {
211
- "code": "PlayerStatistics",
212
- "description": "An array of statistic updates, such as kills, wins, or score.",
213
- "optional": false,
214
- "type": "PlayerStatisticsParam",
215
- "gnType": "GNArray",
216
- "conditions": {
217
- "mustNonNull": true,
218
- "minLength": 1,
219
- "maxLength": 32
220
- }
221
- },
222
- {
223
- "code": "Log",
224
- "description": "Optional developer-provided note to describe the context or reason for the operation.",
225
- "optional": true,
226
- "type": "string",
227
- "gnType": "String",
228
- "conditions": {
229
- "mustNonNull": true,
230
- "minLength": 1,
231
- "maxLength": 256
232
- }
233
- }
234
- ]
235
- },
236
- {
237
- "role": "Server",
238
- "requestData": []
239
- },
240
- {
241
- "role": "Admin",
242
- "requestData": []
243
- }
244
- ],
245
- "responseData": [
246
- {
247
- "code": "ErrorCode",
248
- "value": [
249
- "CharacterPlayerNotFound",
250
- "Ok"
251
- ]
252
- },
253
- {
254
- "code": "InfoResponseParameters"
255
- }
256
- ],
257
- "description": "Update statistical values such as score, experience, or level for a character.",
258
- "operationResponse": "CharacterPlayerResponseData"
259
- },
260
- {
261
- "operationCode": "CreateGroup",
262
- "details": [
263
- {
264
- "role": "Client",
265
- "requestData": [
266
- {
267
- "code": "CharacterId",
268
- "description": "Unique identifier of the character performing the action or being referenced.",
269
- "optional": false,
270
- "type": "string",
271
- "gnType": "String",
272
- "conditions": {
273
- "mustNonNull": true,
274
- "minLength": 11,
275
- "maxLength": 11
276
- }
277
- },
278
- {
279
- "code": "CatalogId",
280
- "description": "Identifier of the catalog that contains the character or item data.",
281
- "optional": false,
282
- "type": "string",
283
- "gnType": "String",
284
- "conditions": {
285
- "mustNonNull": true,
286
- "minLength": 2,
287
- "maxLength": 32
288
- }
289
- },
290
- {
291
- "code": "GroupMembers",
292
- "description": "List of member identifiers to add during group creation.",
293
- "optional": true,
294
- "type": "GroupMemberParam",
295
- "gnType": "GNArray",
296
- "conditions": {}
297
- },
298
- {
299
- "code": "DisplayName",
300
- "description": "The public-facing name of the created group or item.",
301
- "optional": true,
302
- "type": "string",
303
- "gnType": "String",
304
- "defaultValue": "\"\"",
305
- "conditions": {}
306
- }
307
- ]
308
- },
309
- {
310
- "role": "Server",
311
- "requestData": []
312
- },
313
- {
314
- "role": "Admin",
315
- "requestData": []
316
- }
317
- ],
318
- "responseData": [
319
- {
320
- "code": "ErrorCode",
321
- "value": [
322
- "CatalogIdNotFound",
323
- "CharacterPlayerNotFound",
324
- "Ok"
325
- ]
326
- },
327
- {
328
- "code": "InfoResponseParameters"
329
- }
330
- ],
331
- "description": "Initialize a new group and assign the character as the group leader or owner.",
332
- "operationResponse": "CharacterPlayerResponseData"
333
- },
334
- {
335
- "operationCode": "CreatePlayerItem",
336
- "details": [
337
- {
338
- "role": "Client",
339
- "requestData": [
340
- {
341
- "code": "CharacterId",
342
- "description": "Unique identifier of the character performing the action or being referenced.",
343
- "optional": false,
344
- "type": "string",
345
- "gnType": "String",
346
- "conditions": {
347
- "mustNonNull": true,
348
- "minLength": 11,
349
- "maxLength": 11
350
- }
351
- },
352
- {
353
- "code": "CatalogId",
354
- "description": "Identifier of the catalog that contains the character or item data.",
355
- "optional": false,
356
- "type": "string",
357
- "gnType": "String",
358
- "conditions": {
359
- "mustNonNull": true,
360
- "minLength": 2,
361
- "maxLength": 32
362
- }
363
- },
364
- {
365
- "code": "ClassId",
366
- "description": "Identifier for the item class or template to instantiate.",
367
- "optional": false,
368
- "type": "string",
369
- "gnType": "String",
370
- "conditions": {
371
- "mustNonNull": true,
372
- "minLength": 2,
373
- "maxLength": 32
374
- }
375
- },
376
- {
377
- "code": "DisplayName",
378
- "description": "The public-facing name of the created group or item.",
379
- "optional": true,
380
- "type": "string",
381
- "gnType": "String",
382
- "defaultValue": "\"\"",
383
- "conditions": {}
384
- },
385
- {
386
- "code": "Amount",
387
- "description": "The quantity of items to create and assign.",
388
- "optional": true,
389
- "type": "number",
390
- "gnType": "Number",
391
- "defaultValue": "1",
392
- "conditions": {
393
- "mustInt": true
394
- }
395
- }
396
- ]
397
- },
398
- {
399
- "role": "Server",
400
- "requestData": []
401
- },
402
- {
403
- "role": "Admin",
404
- "requestData": []
405
- }
406
- ],
407
- "responseData": [
408
- {
409
- "code": "ErrorCode",
410
- "value": [
411
- "CatalogIdNotFound",
412
- "ClassIdNotFound",
413
- "CharacterPlayerNotFound",
414
- "Ok"
415
- ]
416
- },
417
- {
418
- "code": "InfoResponseParameters"
419
- }
420
- ],
421
- "description": "Generate a new item and add it to the character’s inventory.",
422
- "operationResponse": "CharacterPlayerResponseData"
423
- },
424
- {
425
- "operationCode": "GetAvatar",
426
- "details": [
427
- {
428
- "role": "Client",
429
- "requestData": [
430
- {
431
- "code": "CharacterId",
432
- "description": "Unique identifier of the character performing the action or being referenced.",
433
- "optional": false,
434
- "type": "string",
435
- "gnType": "String",
436
- "conditions": {
437
- "mustNonNull": true,
438
- "minLength": 11,
439
- "maxLength": 11
440
- }
441
- }
442
- ]
443
- },
444
- {
445
- "role": "Server",
446
- "requestData": []
447
- },
448
- {
449
- "role": "Admin",
450
- "requestData": []
451
- }
452
- ],
453
- "responseData": [
454
- {
455
- "code": "ErrorCode",
456
- "value": [
457
- "CharacterPlayerNotFound",
458
- "Ok"
459
- ]
460
- },
461
- {
462
- "code": "InfoResponseParameters"
463
- }
464
- ],
465
- "description": "Fetch the avatar image or configuration currently assigned to the character.",
466
- "operationResponse": "CharacterPlayerResponseData"
467
- },
468
- {
469
- "operationCode": "GetCatalogId",
470
- "details": [
471
- {
472
- "role": "Client",
473
- "requestData": [
474
- {
475
- "code": "CharacterId",
476
- "description": "Unique identifier of the character performing the action or being referenced.",
477
- "optional": false,
478
- "type": "string",
479
- "gnType": "String",
480
- "conditions": {
481
- "mustNonNull": true,
482
- "minLength": 11,
483
- "maxLength": 11
484
- }
485
- }
486
- ]
487
- },
488
- {
489
- "role": "Server",
490
- "requestData": []
491
- },
492
- {
493
- "role": "Admin",
494
- "requestData": []
495
- }
496
- ],
497
- "responseData": [
498
- {
499
- "code": "ErrorCode",
500
- "value": [
501
- "CharacterPlayerNotFound",
502
- "Ok"
503
- ]
504
- },
505
- {
506
- "code": "InfoResponseParameters"
507
- }
508
- ],
509
- "description": "Retrieve the catalog identifier assigned to a specific character.",
510
- "operationResponse": "CharacterPlayerResponseData"
511
- },
512
- {
513
- "operationCode": "GetCountryCode",
514
- "details": [
515
- {
516
- "role": "Client",
517
- "requestData": [
518
- {
519
- "code": "CharacterId",
520
- "description": "Unique identifier of the character performing the action or being referenced.",
521
- "optional": false,
522
- "type": "string",
523
- "gnType": "String",
524
- "conditions": {
525
- "mustNonNull": true,
526
- "minLength": 11,
527
- "maxLength": 11
528
- }
529
- }
530
- ]
531
- },
532
- {
533
- "role": "Server",
534
- "requestData": []
535
- },
536
- {
537
- "role": "Admin",
538
- "requestData": []
539
- }
540
- ],
541
- "responseData": [
542
- {
543
- "code": "ErrorCode",
544
- "value": [
545
- "CharacterPlayerNotFound",
546
- "Ok"
547
- ]
548
- },
549
- {
550
- "code": "InfoResponseParameters"
551
- }
552
- ],
553
- "description": "Determine the country code associated with the character, typically based on IP.",
554
- "operationResponse": "CharacterPlayerResponseData"
555
- },
556
- {
557
- "operationCode": "GetCreateLeaderboard",
558
- "details": [
559
- {
560
- "role": "Client",
561
- "requestData": [
562
- {
563
- "code": "InfoRequestParam",
564
- "description": "Instructions on which additional profile fields to return in the response.",
565
- "optional": false,
566
- "type": "InfoRequestParam",
567
- "gnType": "GNHashtable",
568
- "conditions": {
569
- "mustNonNull": true
570
- }
571
- },
572
- {
573
- "code": "Skip",
574
- "description": "Number of leaderboard entries to skip (used for pagination).",
575
- "optional": true,
576
- "type": "number",
577
- "gnType": "Number",
578
- "defaultValue": "0",
579
- "conditions": {
580
- "mustInt": true,
581
- "minValue": 0
582
- }
583
- },
584
- {
585
- "code": "Limit",
586
- "description": "Maximum number of leaderboard entries to return in the result set.",
587
- "optional": true,
588
- "type": "number",
589
- "gnType": "Number",
590
- "defaultValue": "10",
591
- "conditions": {
592
- "mustInt": true,
593
- "minValue": 1,
594
- "maxValue": 100
595
- }
596
- },
597
- {
598
- "code": "LoadFromCache",
599
- "description": "LoadFromCache used in this request.",
600
- "optional": true,
601
- "type": "boolean",
602
- "gnType": "Boolean",
603
- "defaultValue": "true",
604
- "conditions": {}
605
- }
606
- ]
607
- },
608
- {
609
- "role": "Server",
610
- "requestData": []
611
- },
612
- {
613
- "role": "Admin",
614
- "requestData": []
615
- }
616
- ],
617
- "responseData": [
618
- {
619
- "code": "ErrorCode",
620
- "value": [
621
- "Ok"
622
- ]
623
- },
624
- {
625
- "code": "Results"
626
- }
627
- ],
628
- "description": "Return leaderboard entries created by characters, including custom info if requested.",
629
- "operationResponse": "GetCreateLeaderboardResponseData"
630
- },
631
- {
632
- "operationCode": "GetCurrencyLeaderboard",
633
- "details": [
634
- {
635
- "role": "Client",
636
- "requestData": [
637
- {
638
- "code": "Key",
639
- "description": "Key used in this request.",
640
- "optional": false,
641
- "type": "string",
642
- "gnType": "String",
643
- "conditions": {
644
- "mustNonNull": true,
645
- "minLength": 2,
646
- "maxLength": 32
647
- }
648
- },
649
- {
650
- "code": "InfoRequestParam",
651
- "description": "Instructions on which additional profile fields to return in the response.",
652
- "optional": false,
653
- "type": "InfoRequestParam",
654
- "gnType": "GNHashtable",
655
- "conditions": {
656
- "mustNonNull": true
657
- }
658
- },
659
- {
660
- "code": "Skip",
661
- "description": "Number of leaderboard entries to skip (used for pagination).",
662
- "optional": true,
663
- "type": "number",
664
- "gnType": "Number",
665
- "defaultValue": "0",
666
- "conditions": {
667
- "mustInt": true,
668
- "minValue": 0
669
- }
670
- },
671
- {
672
- "code": "Limit",
673
- "description": "Maximum number of leaderboard entries to return in the result set.",
674
- "optional": true,
675
- "type": "number",
676
- "gnType": "Number",
677
- "defaultValue": "10",
678
- "conditions": {
679
- "mustInt": true,
680
- "minValue": 1,
681
- "maxValue": 100
682
- }
683
- },
684
- {
685
- "code": "LoadFromCache",
686
- "description": "LoadFromCache used in this request.",
687
- "optional": true,
688
- "type": "boolean",
689
- "gnType": "Boolean",
690
- "defaultValue": "true",
691
- "conditions": {}
692
- },
693
- {
694
- "code": "CatalogId",
695
- "description": "Identifier of the catalog that contains the character or item data.",
696
- "optional": true,
697
- "type": "string",
698
- "gnType": "String",
699
- "conditions": {
700
- "mustNonNull": true,
701
- "minLength": 2,
702
- "maxLength": 32
703
- }
704
- }
705
- ]
706
- },
707
- {
708
- "role": "Server",
709
- "requestData": []
710
- },
711
- {
712
- "role": "Admin",
713
- "requestData": []
714
- }
715
- ],
716
- "responseData": [
717
- {
718
- "code": "ErrorCode",
719
- "value": [
720
- "KeyNotFound",
721
- "Ok"
722
- ]
723
- },
724
- {
725
- "code": "Results"
726
- }
727
- ],
728
- "description": "Perform the GetCurrencyLeaderboard operation.",
729
- "operationResponse": "GetCurrencyLeaderboardResponseData"
730
- },
731
- {
732
- "operationCode": "GetCurrencyLog",
733
- "details": [
734
- {
735
- "role": "Client",
736
- "requestData": [
737
- {
738
- "code": "Keys",
739
- "description": "Keys used in this request.",
740
- "optional": true,
741
- "type": "string",
742
- "gnType": "GNArray",
743
- "conditions": {
744
- "mustNonNull": true,
745
- "minLength": 1,
746
- "maxLength": 32
747
- }
748
- },
749
- {
750
- "code": "CharacterId",
751
- "description": "Unique identifier of the character performing the action or being referenced.",
752
- "optional": true,
753
- "type": "string",
754
- "gnType": "String",
755
- "conditions": {
756
- "mustNonNull": true,
757
- "minLength": 11,
758
- "maxLength": 11
759
- }
760
- },
761
- {
762
- "code": "Limit",
763
- "description": "Maximum number of leaderboard entries to return in the result set.",
764
- "optional": true,
765
- "type": "number",
766
- "gnType": "Number",
767
- "defaultValue": "10",
768
- "conditions": {
769
- "mustInt": true,
770
- "minValue": 1,
771
- "maxValue": 100
772
- }
773
- },
774
- {
775
- "code": "Token",
776
- "description": "Token used in this request.",
777
- "optional": true,
778
- "type": "string",
779
- "gnType": "String",
780
- "conditions": {
781
- "mustNonNull": true,
782
- "minLength": 24,
783
- "maxLength": 24
784
- }
785
- }
786
- ]
787
- },
788
- {
789
- "role": "Server",
790
- "requestData": []
791
- },
792
- {
793
- "role": "Admin",
794
- "requestData": []
795
- }
796
- ],
797
- "responseData": [
798
- {
799
- "code": "ErrorCode",
800
- "value": [
801
- "Ok"
802
- ]
803
- },
804
- {
805
- "code": "Results"
806
- },
807
- {
808
- "code": "Token"
809
- }
810
- ],
811
- "description": "Perform the GetCurrencyLog operation.",
812
- "operationResponse": "GetCurrencyLogResponseData"
813
- },
814
- {
815
- "operationCode": "GetCustomData",
816
- "details": [
817
- {
818
- "role": "Client",
819
- "requestData": [
820
- {
821
- "code": "CharacterId",
822
- "description": "Unique identifier of the character performing the action or being referenced.",
823
- "optional": false,
824
- "type": "string",
825
- "gnType": "String",
826
- "conditions": {
827
- "mustNonNull": true,
828
- "minLength": 11,
829
- "maxLength": 11
830
- }
831
- },
832
- {
833
- "code": "CustomDataKeys",
834
- "description": "CustomDataKeys used in this request.",
835
- "optional": true,
836
- "type": "string",
837
- "gnType": "GNArray",
838
- "conditions": {}
839
- }
840
- ]
841
- },
842
- {
843
- "role": "Server",
844
- "requestData": []
845
- },
846
- {
847
- "role": "Admin",
848
- "requestData": []
849
- }
850
- ],
851
- "responseData": [
852
- {
853
- "code": "ErrorCode",
854
- "value": [
855
- "CharacterPlayerNotFound",
856
- "Ok"
857
- ]
858
- },
859
- {
860
- "code": "InfoResponseParameters"
861
- }
862
- ],
863
- "description": "Perform the GetCustomData operation.",
864
- "operationResponse": "CharacterPlayerResponseData"
865
- },
866
- {
867
- "operationCode": "GetDisplayName",
868
- "details": [
869
- {
870
- "role": "Client",
871
- "requestData": [
872
- {
873
- "code": "CharacterId",
874
- "description": "Unique identifier of the character performing the action or being referenced.",
875
- "optional": false,
876
- "type": "string",
877
- "gnType": "String",
878
- "conditions": {
879
- "mustNonNull": true,
880
- "minLength": 11,
881
- "maxLength": 11
882
- }
883
- }
884
- ]
885
- },
886
- {
887
- "role": "Server",
888
- "requestData": []
889
- },
890
- {
891
- "role": "Admin",
892
- "requestData": []
893
- }
894
- ],
895
- "responseData": [
896
- {
897
- "code": "ErrorCode",
898
- "value": [
899
- "CharacterPlayerNotFound",
900
- "Ok"
901
- ]
902
- },
903
- {
904
- "code": "InfoResponseParameters"
905
- }
906
- ],
907
- "description": "Perform the GetDisplayName operation.",
908
- "operationResponse": "CharacterPlayerResponseData"
909
- },
910
- {
911
- "operationCode": "GetFriendStatisticsLeaderboardAroundPlayer",
912
- "details": [
913
- {
914
- "role": "Client",
915
- "requestData": [
916
- {
917
- "code": "CharacterId",
918
- "description": "Unique identifier of the character performing the action or being referenced.",
919
- "optional": false,
920
- "type": "string",
921
- "gnType": "String",
922
- "conditions": {
923
- "mustNonNull": true,
924
- "minLength": 11,
925
- "maxLength": 11
926
- }
927
- },
928
- {
929
- "code": "Key",
930
- "description": "Key used in this request.",
931
- "optional": false,
932
- "type": "string",
933
- "gnType": "String",
934
- "conditions": {
935
- "mustNonNull": true,
936
- "minLength": 2,
937
- "maxLength": 32
938
- }
939
- },
940
- {
941
- "code": "InfoRequestParam",
942
- "description": "Instructions on which additional profile fields to return in the response.",
943
- "optional": false,
944
- "type": "InfoRequestParam",
945
- "gnType": "GNHashtable",
946
- "conditions": {
947
- "mustNonNull": true
948
- }
949
- },
950
- {
951
- "code": "Skip",
952
- "description": "Number of leaderboard entries to skip (used for pagination).",
953
- "optional": true,
954
- "type": "number",
955
- "gnType": "Number",
956
- "defaultValue": "0",
957
- "conditions": {
958
- "mustInt": true,
959
- "minValue": 0
960
- }
961
- },
962
- {
963
- "code": "Limit",
964
- "description": "Maximum number of leaderboard entries to return in the result set.",
965
- "optional": true,
966
- "type": "number",
967
- "gnType": "Number",
968
- "defaultValue": "10",
969
- "conditions": {
970
- "mustInt": true,
971
- "minValue": 1,
972
- "maxValue": 100
973
- }
974
- },
975
- {
976
- "code": "LoadFromCache",
977
- "description": "LoadFromCache used in this request.",
978
- "optional": true,
979
- "type": "boolean",
980
- "gnType": "Boolean",
981
- "defaultValue": "true",
982
- "conditions": {}
983
- }
984
- ]
985
- },
986
- {
987
- "role": "Server",
988
- "requestData": []
989
- },
990
- {
991
- "role": "Admin",
992
- "requestData": []
993
- }
994
- ],
995
- "responseData": [
996
- {
997
- "code": "ErrorCode",
998
- "value": [
999
- "KeyNotFound",
1000
- "CharacterPlayerNotFound",
1001
- "Ok"
1002
- ]
1003
- },
1004
- {
1005
- "code": "Results"
1006
- }
1007
- ],
1008
- "description": "Perform the GetFriendStatisticsLeaderboardAroundPlayer operation.",
1009
- "operationResponse": "GetStatisticsLeaderboardResponseData"
1010
- },
1011
- {
1012
- "operationCode": "GetFriendStatisticsLeaderboard",
1013
- "details": [
1014
- {
1015
- "role": "Client",
1016
- "requestData": [
1017
- {
1018
- "code": "CharacterId",
1019
- "description": "Unique identifier of the character performing the action or being referenced.",
1020
- "optional": false,
1021
- "type": "string",
1022
- "gnType": "String",
1023
- "conditions": {
1024
- "mustNonNull": true,
1025
- "minLength": 11,
1026
- "maxLength": 11
1027
- }
1028
- },
1029
- {
1030
- "code": "Key",
1031
- "description": "Key used in this request.",
1032
- "optional": false,
1033
- "type": "string",
1034
- "gnType": "String",
1035
- "conditions": {
1036
- "mustNonNull": true,
1037
- "minLength": 2,
1038
- "maxLength": 32
1039
- }
1040
- },
1041
- {
1042
- "code": "InfoRequestParam",
1043
- "description": "Instructions on which additional profile fields to return in the response.",
1044
- "optional": false,
1045
- "type": "InfoRequestParam",
1046
- "gnType": "GNHashtable",
1047
- "conditions": {
1048
- "mustNonNull": true
1049
- }
1050
- },
1051
- {
1052
- "code": "Skip",
1053
- "description": "Number of leaderboard entries to skip (used for pagination).",
1054
- "optional": true,
1055
- "type": "number",
1056
- "gnType": "Number",
1057
- "defaultValue": "0",
1058
- "conditions": {
1059
- "mustInt": true,
1060
- "minValue": 0
1061
- }
1062
- },
1063
- {
1064
- "code": "Limit",
1065
- "description": "Maximum number of leaderboard entries to return in the result set.",
1066
- "optional": true,
1067
- "type": "number",
1068
- "gnType": "Number",
1069
- "defaultValue": "10",
1070
- "conditions": {
1071
- "mustInt": true,
1072
- "minValue": 1,
1073
- "maxValue": 100
1074
- }
1075
- },
1076
- {
1077
- "code": "LoadFromCache",
1078
- "description": "LoadFromCache used in this request.",
1079
- "optional": true,
1080
- "type": "boolean",
1081
- "gnType": "Boolean",
1082
- "defaultValue": "true",
1083
- "conditions": {}
1084
- }
1085
- ]
1086
- },
1087
- {
1088
- "role": "Server",
1089
- "requestData": []
1090
- },
1091
- {
1092
- "role": "Admin",
1093
- "requestData": []
1094
- }
1095
- ],
1096
- "responseData": [
1097
- {
1098
- "code": "ErrorCode",
1099
- "value": [
1100
- "KeyNotFound",
1101
- "CharacterPlayerNotFound",
1102
- "Ok"
1103
- ]
1104
- },
1105
- {
1106
- "code": "Results"
1107
- }
1108
- ],
1109
- "description": "Perform the GetFriendStatisticsLeaderboard operation.",
1110
- "operationResponse": "GetStatisticsLeaderboardResponseData"
1111
- },
1112
- {
1113
- "operationCode": "GetIpAddressCreate",
1114
- "details": [
1115
- {
1116
- "role": "Client",
1117
- "requestData": [
1118
- {
1119
- "code": "CharacterId",
1120
- "description": "Unique identifier of the character performing the action or being referenced.",
1121
- "optional": false,
1122
- "type": "string",
1123
- "gnType": "String",
1124
- "conditions": {
1125
- "mustNonNull": true,
1126
- "minLength": 11,
1127
- "maxLength": 11
1128
- }
1129
- }
1130
- ]
1131
- },
1132
- {
1133
- "role": "Server",
1134
- "requestData": []
1135
- },
1136
- {
1137
- "role": "Admin",
1138
- "requestData": []
1139
- }
1140
- ],
1141
- "responseData": [
1142
- {
1143
- "code": "ErrorCode",
1144
- "value": [
1145
- "CharacterPlayerNotFound",
1146
- "Ok"
1147
- ]
1148
- },
1149
- {
1150
- "code": "InfoResponseParameters"
1151
- }
1152
- ],
1153
- "description": "Perform the GetIpAddressCreate operation.",
1154
- "operationResponse": "CharacterPlayerResponseData"
1155
- },
1156
- {
1157
- "operationCode": "GetLastLoginLeaderboard",
1158
- "details": [
1159
- {
1160
- "role": "Client",
1161
- "requestData": [
1162
- {
1163
- "code": "InfoRequestParam",
1164
- "description": "Instructions on which additional profile fields to return in the response.",
1165
- "optional": false,
1166
- "type": "InfoRequestParam",
1167
- "gnType": "GNHashtable",
1168
- "conditions": {
1169
- "mustNonNull": true
1170
- }
1171
- },
1172
- {
1173
- "code": "Skip",
1174
- "description": "Number of leaderboard entries to skip (used for pagination).",
1175
- "optional": true,
1176
- "type": "number",
1177
- "gnType": "Number",
1178
- "defaultValue": "0",
1179
- "conditions": {
1180
- "mustInt": true,
1181
- "minValue": 0
1182
- }
1183
- },
1184
- {
1185
- "code": "Limit",
1186
- "description": "Maximum number of leaderboard entries to return in the result set.",
1187
- "optional": true,
1188
- "type": "number",
1189
- "gnType": "Number",
1190
- "defaultValue": "10",
1191
- "conditions": {
1192
- "mustInt": true,
1193
- "minValue": 1,
1194
- "maxValue": 100
1195
- }
1196
- },
1197
- {
1198
- "code": "LoadFromCache",
1199
- "description": "LoadFromCache used in this request.",
1200
- "optional": true,
1201
- "type": "boolean",
1202
- "gnType": "Boolean",
1203
- "defaultValue": "true",
1204
- "conditions": {}
1205
- }
1206
- ]
1207
- },
1208
- {
1209
- "role": "Server",
1210
- "requestData": []
1211
- },
1212
- {
1213
- "role": "Admin",
1214
- "requestData": []
1215
- }
1216
- ],
1217
- "responseData": [
1218
- {
1219
- "code": "ErrorCode",
1220
- "value": [
1221
- "Ok"
1222
- ]
1223
- },
1224
- {
1225
- "code": "Results"
1226
- }
1227
- ],
1228
- "description": "Perform the GetLastLoginLeaderboard operation.",
1229
- "operationResponse": "GetLastLoginLeaderboardResponseData"
1230
- },
1231
- {
1232
- "operationCode": "GetOwner",
1233
- "details": [
1234
- {
1235
- "role": "Client",
1236
- "requestData": [
1237
- {
1238
- "code": "CharacterId",
1239
- "description": "Unique identifier of the character performing the action or being referenced.",
1240
- "optional": false,
1241
- "type": "string",
1242
- "gnType": "String",
1243
- "conditions": {
1244
- "mustNonNull": true,
1245
- "minLength": 11,
1246
- "maxLength": 11
1247
- }
1248
- }
1249
- ]
1250
- },
1251
- {
1252
- "role": "Server",
1253
- "requestData": []
1254
- },
1255
- {
1256
- "role": "Admin",
1257
- "requestData": []
1258
- }
1259
- ],
1260
- "responseData": [
1261
- {
1262
- "code": "ErrorCode",
1263
- "value": [
1264
- "CharacterPlayerNotFound",
1265
- "Ok"
1266
- ]
1267
- },
1268
- {
1269
- "code": "InfoResponseParameters"
1270
- }
1271
- ],
1272
- "description": "Perform the GetOwner operation.",
1273
- "operationResponse": "CharacterPlayerResponseData"
1274
- },
1275
- {
1276
- "operationCode": "GetPlayerBan",
1277
- "details": [
1278
- {
1279
- "role": "Client",
1280
- "requestData": [
1281
- {
1282
- "code": "CharacterId",
1283
- "description": "Unique identifier of the character performing the action or being referenced.",
1284
- "optional": false,
1285
- "type": "string",
1286
- "gnType": "String",
1287
- "conditions": {
1288
- "mustNonNull": true,
1289
- "minLength": 11,
1290
- "maxLength": 11
1291
- }
1292
- }
1293
- ]
1294
- },
1295
- {
1296
- "role": "Server",
1297
- "requestData": []
1298
- },
1299
- {
1300
- "role": "Admin",
1301
- "requestData": []
1302
- }
1303
- ],
1304
- "responseData": [
1305
- {
1306
- "code": "ErrorCode",
1307
- "value": [
1308
- "CharacterPlayerNotFound",
1309
- "Ok"
1310
- ]
1311
- },
1312
- {
1313
- "code": "InfoResponseParameters"
1314
- }
1315
- ],
1316
- "description": "Perform the GetPlayerBan operation.",
1317
- "operationResponse": "CharacterPlayerResponseData"
1318
- },
1319
- {
1320
- "operationCode": "GetPlayerCurrency",
1321
- "details": [
1322
- {
1323
- "role": "Client",
1324
- "requestData": [
1325
- {
1326
- "code": "CharacterId",
1327
- "description": "Unique identifier of the character performing the action or being referenced.",
1328
- "optional": false,
1329
- "type": "string",
1330
- "gnType": "String",
1331
- "conditions": {
1332
- "mustNonNull": true,
1333
- "minLength": 11,
1334
- "maxLength": 11
1335
- }
1336
- },
1337
- {
1338
- "code": "PlayerCurrencyKeys",
1339
- "description": "PlayerCurrencyKeys used in this request.",
1340
- "optional": true,
1341
- "type": "string",
1342
- "gnType": "GNArray",
1343
- "conditions": {}
1344
- }
1345
- ]
1346
- },
1347
- {
1348
- "role": "Server",
1349
- "requestData": []
1350
- },
1351
- {
1352
- "role": "Admin",
1353
- "requestData": []
1354
- }
1355
- ],
1356
- "responseData": [
1357
- {
1358
- "code": "ErrorCode",
1359
- "value": [
1360
- "CharacterPlayerNotFound",
1361
- "Ok"
1362
- ]
1363
- },
1364
- {
1365
- "code": "InfoResponseParameters"
1366
- }
1367
- ],
1368
- "description": "Perform the GetPlayerCurrency operation.",
1369
- "operationResponse": "CharacterPlayerResponseData"
1370
- },
1371
- {
1372
- "operationCode": "GetPlayerData",
1373
- "details": [
1374
- {
1375
- "role": "Client",
1376
- "requestData": [
1377
- {
1378
- "code": "CharacterId",
1379
- "description": "Unique identifier of the character performing the action or being referenced.",
1380
- "optional": false,
1381
- "type": "string",
1382
- "gnType": "String",
1383
- "conditions": {
1384
- "mustNonNull": true,
1385
- "minLength": 11,
1386
- "maxLength": 11
1387
- }
1388
- },
1389
- {
1390
- "code": "PlayerDataKeys",
1391
- "description": "PlayerDataKeys used in this request.",
1392
- "optional": true,
1393
- "type": "string",
1394
- "gnType": "GNArray",
1395
- "conditions": {}
1396
- }
1397
- ]
1398
- },
1399
- {
1400
- "role": "Server",
1401
- "requestData": []
1402
- },
1403
- {
1404
- "role": "Admin",
1405
- "requestData": []
1406
- }
1407
- ],
1408
- "responseData": [
1409
- {
1410
- "code": "ErrorCode",
1411
- "value": [
1412
- "CharacterPlayerNotFound",
1413
- "Ok"
1414
- ]
1415
- },
1416
- {
1417
- "code": "InfoResponseParameters"
1418
- }
1419
- ],
1420
- "description": "Perform the GetPlayerData operation.",
1421
- "operationResponse": "CharacterPlayerResponseData"
1422
- },
1423
- {
1424
- "operationCode": "GetPlayerFriend",
1425
- "details": [
1426
- {
1427
- "role": "Client",
1428
- "requestData": [
1429
- {
1430
- "code": "CharacterId",
1431
- "description": "Unique identifier of the character performing the action or being referenced.",
1432
- "optional": false,
1433
- "type": "string",
1434
- "gnType": "String",
1435
- "conditions": {
1436
- "mustNonNull": true,
1437
- "minLength": 11,
1438
- "maxLength": 11
1439
- }
1440
- },
1441
- {
1442
- "code": "FriendCatalogIds",
1443
- "description": "FriendCatalogIds used in this request.",
1444
- "optional": true,
1445
- "type": "string",
1446
- "gnType": "GNArray",
1447
- "conditions": {}
1448
- }
1449
- ]
1450
- },
1451
- {
1452
- "role": "Server",
1453
- "requestData": []
1454
- },
1455
- {
1456
- "role": "Admin",
1457
- "requestData": []
1458
- }
1459
- ],
1460
- "responseData": [
1461
- {
1462
- "code": "ErrorCode",
1463
- "value": [
1464
- "CharacterPlayerNotFound",
1465
- "Ok"
1466
- ]
1467
- },
1468
- {
1469
- "code": "InfoResponseParameters"
1470
- }
1471
- ],
1472
- "description": "Perform the GetPlayerFriend operation.",
1473
- "operationResponse": "CharacterPlayerResponseData"
1474
- },
1475
- {
1476
- "operationCode": "GetPlayerGroup",
1477
- "details": [
1478
- {
1479
- "role": "Client",
1480
- "requestData": [
1481
- {
1482
- "code": "CharacterId",
1483
- "description": "Unique identifier of the character performing the action or being referenced.",
1484
- "optional": false,
1485
- "type": "string",
1486
- "gnType": "String",
1487
- "conditions": {
1488
- "mustNonNull": true,
1489
- "minLength": 11,
1490
- "maxLength": 11
1491
- }
1492
- },
1493
- {
1494
- "code": "GroupCatalogIds",
1495
- "description": "GroupCatalogIds used in this request.",
1496
- "optional": true,
1497
- "type": "string",
1498
- "gnType": "GNArray",
1499
- "conditions": {}
1500
- }
1501
- ]
1502
- },
1503
- {
1504
- "role": "Server",
1505
- "requestData": []
1506
- },
1507
- {
1508
- "role": "Admin",
1509
- "requestData": []
1510
- }
1511
- ],
1512
- "responseData": [
1513
- {
1514
- "code": "ErrorCode",
1515
- "value": [
1516
- "CharacterPlayerNotFound",
1517
- "Ok"
1518
- ]
1519
- },
1520
- {
1521
- "code": "InfoResponseParameters"
1522
- }
1523
- ],
1524
- "description": "Perform the GetPlayerGroup operation.",
1525
- "operationResponse": "CharacterPlayerResponseData"
1526
- },
1527
- {
1528
- "operationCode": "GetPlayerInformation",
1529
- "details": [
1530
- {
1531
- "role": "Client",
1532
- "requestData": [
1533
- {
1534
- "code": "CharacterId",
1535
- "description": "Unique identifier of the character performing the action or being referenced.",
1536
- "optional": false,
1537
- "type": "string",
1538
- "gnType": "String",
1539
- "conditions": {
1540
- "mustNonNull": true,
1541
- "minLength": 11,
1542
- "maxLength": 11
1543
- }
1544
- },
1545
- {
1546
- "code": "InfoRequestParam",
1547
- "description": "Instructions on which additional profile fields to return in the response.",
1548
- "optional": false,
1549
- "type": "InfoRequestParam",
1550
- "gnType": "GNHashtable",
1551
- "conditions": {
1552
- "mustNonNull": true
1553
- }
1554
- }
1555
- ]
1556
- },
1557
- {
1558
- "role": "Server",
1559
- "requestData": []
1560
- },
1561
- {
1562
- "role": "Admin",
1563
- "requestData": []
1564
- }
1565
- ],
1566
- "responseData": [
1567
- {
1568
- "code": "ErrorCode",
1569
- "value": [
1570
- "CharacterPlayerNotFound",
1571
- "Ok"
1572
- ]
1573
- },
1574
- {
1575
- "code": "InfoResponseParameters"
1576
- }
1577
- ],
1578
- "description": "Perform the GetPlayerInformation operation.",
1579
- "operationResponse": "CharacterPlayerResponseData"
1580
- },
1581
- {
1582
- "operationCode": "GetPlayerInventory",
1583
- "details": [
1584
- {
1585
- "role": "Client",
1586
- "requestData": [
1587
- {
1588
- "code": "CharacterId",
1589
- "description": "Unique identifier of the character performing the action or being referenced.",
1590
- "optional": false,
1591
- "type": "string",
1592
- "gnType": "String",
1593
- "conditions": {
1594
- "mustNonNull": true,
1595
- "minLength": 11,
1596
- "maxLength": 11
1597
- }
1598
- },
1599
- {
1600
- "code": "ItemCatalogIds",
1601
- "description": "ItemCatalogIds used in this request.",
1602
- "optional": true,
1603
- "type": "string",
1604
- "gnType": "GNArray",
1605
- "conditions": {}
1606
- }
1607
- ]
1608
- },
1609
- {
1610
- "role": "Server",
1611
- "requestData": []
1612
- },
1613
- {
1614
- "role": "Admin",
1615
- "requestData": []
1616
- }
1617
- ],
1618
- "responseData": [
1619
- {
1620
- "code": "ErrorCode",
1621
- "value": [
1622
- "CharacterPlayerNotFound",
1623
- "Ok"
1624
- ]
1625
- },
1626
- {
1627
- "code": "InfoResponseParameters"
1628
- }
1629
- ],
1630
- "description": "Perform the GetPlayerInventory operation.",
1631
- "operationResponse": "CharacterPlayerResponseData"
1632
- },
1633
- {
1634
- "operationCode": "GetPlayerStatistics",
1635
- "details": [
1636
- {
1637
- "role": "Client",
1638
- "requestData": [
1639
- {
1640
- "code": "CharacterId",
1641
- "description": "Unique identifier of the character performing the action or being referenced.",
1642
- "optional": false,
1643
- "type": "string",
1644
- "gnType": "String",
1645
- "conditions": {
1646
- "mustNonNull": true,
1647
- "minLength": 11,
1648
- "maxLength": 11
1649
- }
1650
- },
1651
- {
1652
- "code": "StatisticsKeys",
1653
- "description": "StatisticsKeys used in this request.",
1654
- "optional": true,
1655
- "type": "string",
1656
- "gnType": "GNArray",
1657
- "conditions": {}
1658
- }
1659
- ]
1660
- },
1661
- {
1662
- "role": "Server",
1663
- "requestData": []
1664
- },
1665
- {
1666
- "role": "Admin",
1667
- "requestData": []
1668
- }
1669
- ],
1670
- "responseData": [
1671
- {
1672
- "code": "ErrorCode",
1673
- "value": [
1674
- "CharacterPlayerNotFound",
1675
- "Ok"
1676
- ]
1677
- },
1678
- {
1679
- "code": "InfoResponseParameters"
1680
- }
1681
- ],
1682
- "description": "Perform the GetPlayerStatistics operation.",
1683
- "operationResponse": "CharacterPlayerResponseData"
1684
- },
1685
- {
1686
- "operationCode": "GetPlayersWithDisplayName",
1687
- "details": [
1688
- {
1689
- "role": "Client",
1690
- "requestData": [
1691
- {
1692
- "code": "Keyword",
1693
- "description": "Keyword used in this request.",
1694
- "optional": false,
1695
- "type": "string",
1696
- "gnType": "String",
1697
- "conditions": {
1698
- "minLength": 2,
1699
- "maxLength": 32
1700
- }
1701
- },
1702
- {
1703
- "code": "InfoRequestParam",
1704
- "description": "Instructions on which additional profile fields to return in the response.",
1705
- "optional": false,
1706
- "type": "InfoRequestParam",
1707
- "gnType": "GNHashtable",
1708
- "conditions": {
1709
- "mustNonNull": true
1710
- }
1711
- },
1712
- {
1713
- "code": "Skip",
1714
- "description": "Number of leaderboard entries to skip (used for pagination).",
1715
- "optional": true,
1716
- "type": "number",
1717
- "gnType": "Number",
1718
- "defaultValue": "0",
1719
- "conditions": {
1720
- "mustInt": true,
1721
- "minValue": 0
1722
- }
1723
- },
1724
- {
1725
- "code": "Limit",
1726
- "description": "Maximum number of leaderboard entries to return in the result set.",
1727
- "optional": true,
1728
- "type": "number",
1729
- "gnType": "Number",
1730
- "defaultValue": "10",
1731
- "conditions": {
1732
- "mustInt": true,
1733
- "minValue": 1,
1734
- "maxValue": 100
1735
- }
1736
- }
1737
- ]
1738
- },
1739
- {
1740
- "role": "Server",
1741
- "requestData": []
1742
- },
1743
- {
1744
- "role": "Admin",
1745
- "requestData": []
1746
- }
1747
- ],
1748
- "responseData": [
1749
- {
1750
- "code": "ErrorCode",
1751
- "value": [
1752
- "Ok"
1753
- ]
1754
- },
1755
- {
1756
- "code": "Results"
1757
- }
1758
- ],
1759
- "description": "Perform the GetPlayersWithDisplayName operation.",
1760
- "operationResponse": "CharacterPlayersWithCharacterIdResponseData"
1761
- },
1762
- {
1763
- "operationCode": "GetPlayersWithSegment",
1764
- "details": [
1765
- {
1766
- "role": "Client",
1767
- "requestData": [
1768
- {
1769
- "code": "Value",
1770
- "description": "The specific value of the segment to be assigned to the character.",
1771
- "optional": false,
1772
- "type": "string",
1773
- "gnType": "String",
1774
- "conditions": {
1775
- "mustNonNull": true,
1776
- "minLength": 2,
1777
- "maxLength": 32
1778
- }
1779
- },
1780
- {
1781
- "code": "InfoRequestParam",
1782
- "description": "Instructions on which additional profile fields to return in the response.",
1783
- "optional": false,
1784
- "type": "InfoRequestParam",
1785
- "gnType": "GNHashtable",
1786
- "conditions": {
1787
- "mustNonNull": true
1788
- }
1789
- },
1790
- {
1791
- "code": "Skip",
1792
- "description": "Number of leaderboard entries to skip (used for pagination).",
1793
- "optional": true,
1794
- "type": "number",
1795
- "gnType": "Number",
1796
- "defaultValue": "0",
1797
- "conditions": {
1798
- "mustInt": true,
1799
- "minValue": 0
1800
- }
1801
- },
1802
- {
1803
- "code": "Limit",
1804
- "description": "Maximum number of leaderboard entries to return in the result set.",
1805
- "optional": true,
1806
- "type": "number",
1807
- "gnType": "Number",
1808
- "defaultValue": "10",
1809
- "conditions": {
1810
- "mustInt": true,
1811
- "minValue": 1,
1812
- "maxValue": 100
1813
- }
1814
- }
1815
- ]
1816
- },
1817
- {
1818
- "role": "Server",
1819
- "requestData": []
1820
- },
1821
- {
1822
- "role": "Admin",
1823
- "requestData": []
1824
- }
1825
- ],
1826
- "responseData": [
1827
- {
1828
- "code": "ErrorCode",
1829
- "value": [
1830
- "Ok"
1831
- ]
1832
- },
1833
- {
1834
- "code": "Results"
1835
- }
1836
- ],
1837
- "description": "Perform the GetPlayersWithSegment operation.",
1838
- "operationResponse": "CharacterPlayersWithCharacterIdResponseData"
1839
- },
1840
- {
1841
- "operationCode": "GetPlayersWithTag",
1842
- "details": [
1843
- {
1844
- "role": "Client",
1845
- "requestData": [
1846
- {
1847
- "code": "Key",
1848
- "description": "Key used in this request.",
1849
- "optional": false,
1850
- "type": "string",
1851
- "gnType": "String",
1852
- "conditions": {
1853
- "mustNonNull": true,
1854
- "minLength": 2,
1855
- "maxLength": 32
1856
- }
1857
- },
1858
- {
1859
- "code": "Value",
1860
- "description": "The specific value of the segment to be assigned to the character.",
1861
- "optional": false,
1862
- "type": "string",
1863
- "gnType": "String",
1864
- "conditions": {
1865
- "mustNonNull": true,
1866
- "minLength": 2,
1867
- "maxLength": 32
1868
- }
1869
- },
1870
- {
1871
- "code": "InfoRequestParam",
1872
- "description": "Instructions on which additional profile fields to return in the response.",
1873
- "optional": false,
1874
- "type": "InfoRequestParam",
1875
- "gnType": "GNHashtable",
1876
- "conditions": {
1877
- "mustNonNull": true
1878
- }
1879
- },
1880
- {
1881
- "code": "Skip",
1882
- "description": "Number of leaderboard entries to skip (used for pagination).",
1883
- "optional": true,
1884
- "type": "number",
1885
- "gnType": "Number",
1886
- "defaultValue": "0",
1887
- "conditions": {
1888
- "mustInt": true,
1889
- "minValue": 0
1890
- }
1891
- },
1892
- {
1893
- "code": "Limit",
1894
- "description": "Maximum number of leaderboard entries to return in the result set.",
1895
- "optional": true,
1896
- "type": "number",
1897
- "gnType": "Number",
1898
- "defaultValue": "10",
1899
- "conditions": {
1900
- "mustInt": true,
1901
- "minValue": 1,
1902
- "maxValue": 100
1903
- }
1904
- }
1905
- ]
1906
- },
1907
- {
1908
- "role": "Server",
1909
- "requestData": []
1910
- },
1911
- {
1912
- "role": "Admin",
1913
- "requestData": []
1914
- }
1915
- ],
1916
- "responseData": [
1917
- {
1918
- "code": "ErrorCode",
1919
- "value": [
1920
- "KeyNotFound",
1921
- "Ok"
1922
- ]
1923
- },
1924
- {
1925
- "code": "Results"
1926
- }
1927
- ],
1928
- "description": "Perform the GetPlayersWithTag operation.",
1929
- "operationResponse": "CharacterPlayersWithCharacterIdResponseData"
1930
- },
1931
- {
1932
- "operationCode": "GetRemoveStatus",
1933
- "details": [
1934
- {
1935
- "role": "Client",
1936
- "requestData": [
1937
- {
1938
- "code": "CharacterId",
1939
- "description": "Unique identifier of the character performing the action or being referenced.",
1940
- "optional": false,
1941
- "type": "string",
1942
- "gnType": "String",
1943
- "conditions": {
1944
- "mustNonNull": true,
1945
- "minLength": 11,
1946
- "maxLength": 11
1947
- }
1948
- }
1949
- ]
1950
- },
1951
- {
1952
- "role": "Server",
1953
- "requestData": []
1954
- },
1955
- {
1956
- "role": "Admin",
1957
- "requestData": []
1958
- }
1959
- ],
1960
- "responseData": [
1961
- {
1962
- "code": "ErrorCode",
1963
- "value": [
1964
- "CharacterPlayerNotFound",
1965
- "Ok"
1966
- ]
1967
- },
1968
- {
1969
- "code": "InfoResponseParameters"
1970
- }
1971
- ],
1972
- "description": "Perform the GetRemoveStatus operation.",
1973
- "operationResponse": "CharacterPlayerResponseData"
1974
- },
1975
- {
1976
- "operationCode": "GetSegment",
1977
- "details": [
1978
- {
1979
- "role": "Client",
1980
- "requestData": [
1981
- {
1982
- "code": "CharacterId",
1983
- "description": "Unique identifier of the character performing the action or being referenced.",
1984
- "optional": false,
1985
- "type": "string",
1986
- "gnType": "String",
1987
- "conditions": {
1988
- "mustNonNull": true,
1989
- "minLength": 11,
1990
- "maxLength": 11
1991
- }
1992
- }
1993
- ]
1994
- },
1995
- {
1996
- "role": "Server",
1997
- "requestData": []
1998
- },
1999
- {
2000
- "role": "Admin",
2001
- "requestData": []
2002
- }
2003
- ],
2004
- "responseData": [
2005
- {
2006
- "code": "ErrorCode",
2007
- "value": [
2008
- "CharacterPlayerNotFound",
2009
- "Ok"
2010
- ]
2011
- },
2012
- {
2013
- "code": "InfoResponseParameters"
2014
- }
2015
- ],
2016
- "description": "Perform the GetSegment operation.",
2017
- "operationResponse": "CharacterPlayerResponseData"
2018
- },
2019
- {
2020
- "operationCode": "GetStatisticsLeaderboardAroundPlayer",
2021
- "details": [
2022
- {
2023
- "role": "Client",
2024
- "requestData": [
2025
- {
2026
- "code": "CharacterId",
2027
- "description": "Unique identifier of the character performing the action or being referenced.",
2028
- "optional": false,
2029
- "type": "string",
2030
- "gnType": "String",
2031
- "conditions": {
2032
- "mustNonNull": true,
2033
- "minLength": 11,
2034
- "maxLength": 11
2035
- }
2036
- },
2037
- {
2038
- "code": "Key",
2039
- "description": "Key used in this request.",
2040
- "optional": false,
2041
- "type": "string",
2042
- "gnType": "String",
2043
- "conditions": {
2044
- "mustNonNull": true,
2045
- "minLength": 2,
2046
- "maxLength": 32
2047
- }
2048
- },
2049
- {
2050
- "code": "InfoRequestParam",
2051
- "description": "Instructions on which additional profile fields to return in the response.",
2052
- "optional": false,
2053
- "type": "InfoRequestParam",
2054
- "gnType": "GNHashtable",
2055
- "conditions": {
2056
- "mustNonNull": true
2057
- }
2058
- },
2059
- {
2060
- "code": "Skip",
2061
- "description": "Number of leaderboard entries to skip (used for pagination).",
2062
- "optional": true,
2063
- "type": "number",
2064
- "gnType": "Number",
2065
- "defaultValue": "0",
2066
- "conditions": {
2067
- "mustInt": true,
2068
- "minValue": 0
2069
- }
2070
- },
2071
- {
2072
- "code": "Limit",
2073
- "description": "Maximum number of leaderboard entries to return in the result set.",
2074
- "optional": true,
2075
- "type": "number",
2076
- "gnType": "Number",
2077
- "defaultValue": "10",
2078
- "conditions": {
2079
- "mustInt": true,
2080
- "minValue": 1,
2081
- "maxValue": 100
2082
- }
2083
- },
2084
- {
2085
- "code": "LoadFromCache",
2086
- "description": "LoadFromCache used in this request.",
2087
- "optional": true,
2088
- "type": "boolean",
2089
- "gnType": "Boolean",
2090
- "defaultValue": "true",
2091
- "conditions": {}
2092
- },
2093
- {
2094
- "code": "CatalogId",
2095
- "description": "Identifier of the catalog that contains the character or item data.",
2096
- "optional": true,
2097
- "type": "string",
2098
- "gnType": "String",
2099
- "conditions": {
2100
- "mustNonNull": true,
2101
- "minLength": 2,
2102
- "maxLength": 32
2103
- }
2104
- }
2105
- ]
2106
- },
2107
- {
2108
- "role": "Server",
2109
- "requestData": []
2110
- },
2111
- {
2112
- "role": "Admin",
2113
- "requestData": []
2114
- }
2115
- ],
2116
- "responseData": [
2117
- {
2118
- "code": "ErrorCode",
2119
- "value": [
2120
- "KeyNotFound",
2121
- "Ok"
2122
- ]
2123
- },
2124
- {
2125
- "code": "Results"
2126
- }
2127
- ],
2128
- "description": "Perform the GetStatisticsLeaderboardAroundPlayer operation.",
2129
- "operationResponse": "GetStatisticsLeaderboardResponseData"
2130
- },
2131
- {
2132
- "operationCode": "GetStatisticsLeaderboard",
2133
- "details": [
2134
- {
2135
- "role": "Client",
2136
- "requestData": [
2137
- {
2138
- "code": "Key",
2139
- "description": "Key used in this request.",
2140
- "optional": false,
2141
- "type": "string",
2142
- "gnType": "String",
2143
- "conditions": {
2144
- "mustNonNull": true,
2145
- "minLength": 2,
2146
- "maxLength": 32
2147
- }
2148
- },
2149
- {
2150
- "code": "InfoRequestParam",
2151
- "description": "Instructions on which additional profile fields to return in the response.",
2152
- "optional": false,
2153
- "type": "InfoRequestParam",
2154
- "gnType": "GNHashtable",
2155
- "conditions": {
2156
- "mustNonNull": true
2157
- }
2158
- },
2159
- {
2160
- "code": "Skip",
2161
- "description": "Number of leaderboard entries to skip (used for pagination).",
2162
- "optional": true,
2163
- "type": "number",
2164
- "gnType": "Number",
2165
- "defaultValue": "0",
2166
- "conditions": {
2167
- "mustInt": true,
2168
- "minValue": 0
2169
- }
2170
- },
2171
- {
2172
- "code": "Limit",
2173
- "description": "Maximum number of leaderboard entries to return in the result set.",
2174
- "optional": true,
2175
- "type": "number",
2176
- "gnType": "Number",
2177
- "defaultValue": "10",
2178
- "conditions": {
2179
- "mustInt": true,
2180
- "minValue": 1,
2181
- "maxValue": 100
2182
- }
2183
- },
2184
- {
2185
- "code": "LoadFromCache",
2186
- "description": "LoadFromCache used in this request.",
2187
- "optional": true,
2188
- "type": "boolean",
2189
- "gnType": "Boolean",
2190
- "defaultValue": "true",
2191
- "conditions": {}
2192
- },
2193
- {
2194
- "code": "Version",
2195
- "description": "Version used in this request.",
2196
- "optional": true,
2197
- "type": "string",
2198
- "gnType": "String",
2199
- "conditions": {
2200
- "mustNonNull": true,
2201
- "minLength": 2,
2202
- "maxLength": 32
2203
- }
2204
- },
2205
- {
2206
- "code": "CatalogId",
2207
- "description": "Identifier of the catalog that contains the character or item data.",
2208
- "optional": true,
2209
- "type": "string",
2210
- "gnType": "String",
2211
- "conditions": {
2212
- "mustNonNull": true,
2213
- "minLength": 2,
2214
- "maxLength": 32
2215
- }
2216
- }
2217
- ]
2218
- },
2219
- {
2220
- "role": "Server",
2221
- "requestData": []
2222
- },
2223
- {
2224
- "role": "Admin",
2225
- "requestData": []
2226
- }
2227
- ],
2228
- "responseData": [
2229
- {
2230
- "code": "ErrorCode",
2231
- "value": [
2232
- "KeyNotFound",
2233
- "VersionInvalid",
2234
- "Ok"
2235
- ]
2236
- },
2237
- {
2238
- "code": "Results"
2239
- },
2240
- {
2241
- "code": "TsCreate"
2242
- }
2243
- ],
2244
- "description": "Perform the GetStatisticsLeaderboard operation.",
2245
- "operationResponse": "GetStatisticsLeaderboardResponseData"
2246
- },
2247
- {
2248
- "operationCode": "GetStatisticsLog",
2249
- "details": [
2250
- {
2251
- "role": "Client",
2252
- "requestData": [
2253
- {
2254
- "code": "Keys",
2255
- "description": "Keys used in this request.",
2256
- "optional": true,
2257
- "type": "string",
2258
- "gnType": "GNArray",
2259
- "conditions": {
2260
- "mustNonNull": true,
2261
- "minLength": 1,
2262
- "maxLength": 32
2263
- }
2264
- },
2265
- {
2266
- "code": "CharacterId",
2267
- "description": "Unique identifier of the character performing the action or being referenced.",
2268
- "optional": true,
2269
- "type": "string",
2270
- "gnType": "String",
2271
- "conditions": {
2272
- "mustNonNull": true,
2273
- "minLength": 11,
2274
- "maxLength": 11
2275
- }
2276
- },
2277
- {
2278
- "code": "Limit",
2279
- "description": "Maximum number of leaderboard entries to return in the result set.",
2280
- "optional": true,
2281
- "type": "number",
2282
- "gnType": "Number",
2283
- "defaultValue": "10",
2284
- "conditions": {
2285
- "mustInt": true,
2286
- "minValue": 1,
2287
- "maxValue": 100
2288
- }
2289
- },
2290
- {
2291
- "code": "Token",
2292
- "description": "Token used in this request.",
2293
- "optional": true,
2294
- "type": "string",
2295
- "gnType": "String",
2296
- "conditions": {
2297
- "mustNonNull": true,
2298
- "minLength": 24,
2299
- "maxLength": 24
2300
- }
2301
- }
2302
- ]
2303
- },
2304
- {
2305
- "role": "Server",
2306
- "requestData": []
2307
- },
2308
- {
2309
- "role": "Admin",
2310
- "requestData": []
2311
- }
2312
- ],
2313
- "responseData": [
2314
- {
2315
- "code": "ErrorCode",
2316
- "value": [
2317
- "Ok"
2318
- ]
2319
- },
2320
- {
2321
- "code": "Results"
2322
- },
2323
- {
2324
- "code": "Token"
2325
- }
2326
- ],
2327
- "description": "Perform the GetStatisticsLog operation.",
2328
- "operationResponse": "GetStatisticsLogResponseData"
2329
- },
2330
- {
2331
- "operationCode": "GetTag",
2332
- "details": [
2333
- {
2334
- "role": "Client",
2335
- "requestData": [
2336
- {
2337
- "code": "CharacterId",
2338
- "description": "Unique identifier of the character performing the action or being referenced.",
2339
- "optional": false,
2340
- "type": "string",
2341
- "gnType": "String",
2342
- "conditions": {
2343
- "mustNonNull": true,
2344
- "minLength": 11,
2345
- "maxLength": 11
2346
- }
2347
- },
2348
- {
2349
- "code": "TagKeys",
2350
- "description": "TagKeys used in this request.",
2351
- "optional": false,
2352
- "type": "string",
2353
- "gnType": "GNArray",
2354
- "conditions": {}
2355
- }
2356
- ]
2357
- },
2358
- {
2359
- "role": "Server",
2360
- "requestData": []
2361
- },
2362
- {
2363
- "role": "Admin",
2364
- "requestData": []
2365
- }
2366
- ],
2367
- "responseData": [
2368
- {
2369
- "code": "ErrorCode",
2370
- "value": [
2371
- "CharacterPlayerNotFound",
2372
- "Ok"
2373
- ]
2374
- },
2375
- {
2376
- "code": "InfoResponseParameters"
2377
- }
2378
- ],
2379
- "description": "Perform the GetTag operation.",
2380
- "operationResponse": "CharacterPlayerResponseData"
2381
- },
2382
- {
2383
- "operationCode": "GetTsCreate",
2384
- "details": [
2385
- {
2386
- "role": "Client",
2387
- "requestData": [
2388
- {
2389
- "code": "CharacterId",
2390
- "description": "Unique identifier of the character performing the action or being referenced.",
2391
- "optional": false,
2392
- "type": "string",
2393
- "gnType": "String",
2394
- "conditions": {
2395
- "mustNonNull": true,
2396
- "minLength": 11,
2397
- "maxLength": 11
2398
- }
2399
- }
2400
- ]
2401
- },
2402
- {
2403
- "role": "Server",
2404
- "requestData": []
2405
- },
2406
- {
2407
- "role": "Admin",
2408
- "requestData": []
2409
- }
2410
- ],
2411
- "responseData": [
2412
- {
2413
- "code": "ErrorCode",
2414
- "value": [
2415
- "CharacterPlayerNotFound",
2416
- "Ok"
2417
- ]
2418
- },
2419
- {
2420
- "code": "InfoResponseParameters"
2421
- }
2422
- ],
2423
- "description": "Perform the GetTsCreate operation.",
2424
- "operationResponse": "CharacterPlayerResponseData"
2425
- },
2426
- {
2427
- "operationCode": "GetTsLastLogin",
2428
- "details": [
2429
- {
2430
- "role": "Client",
2431
- "requestData": [
2432
- {
2433
- "code": "CharacterId",
2434
- "description": "Unique identifier of the character performing the action or being referenced.",
2435
- "optional": false,
2436
- "type": "string",
2437
- "gnType": "String",
2438
- "conditions": {
2439
- "mustNonNull": true,
2440
- "minLength": 11,
2441
- "maxLength": 11
2442
- }
2443
- }
2444
- ]
2445
- },
2446
- {
2447
- "role": "Server",
2448
- "requestData": []
2449
- },
2450
- {
2451
- "role": "Admin",
2452
- "requestData": []
2453
- }
2454
- ],
2455
- "responseData": [
2456
- {
2457
- "code": "ErrorCode",
2458
- "value": [
2459
- "CharacterPlayerNotFound",
2460
- "Ok"
2461
- ]
2462
- },
2463
- {
2464
- "code": "InfoResponseParameters"
2465
- }
2466
- ],
2467
- "description": "Perform the GetTsLastLogin operation.",
2468
- "operationResponse": "CharacterPlayerResponseData"
2469
- },
2470
- {
2471
- "operationCode": "JoinGroup",
2472
- "details": [
2473
- {
2474
- "role": "Client",
2475
- "requestData": [
2476
- {
2477
- "code": "CharacterId",
2478
- "description": "Unique identifier of the character performing the action or being referenced.",
2479
- "optional": false,
2480
- "type": "string",
2481
- "gnType": "String",
2482
- "conditions": {
2483
- "mustNonNull": true,
2484
- "minLength": 11,
2485
- "maxLength": 11
2486
- }
2487
- },
2488
- {
2489
- "code": "GroupId",
2490
- "description": "GroupId used in this request.",
2491
- "optional": false,
2492
- "type": "string",
2493
- "gnType": "String",
2494
- "conditions": {
2495
- "mustNonNull": true,
2496
- "minLength": 10,
2497
- "maxLength": 10
2498
- }
2499
- }
2500
- ]
2501
- },
2502
- {
2503
- "role": "Server",
2504
- "requestData": []
2505
- },
2506
- {
2507
- "role": "Admin",
2508
- "requestData": []
2509
- }
2510
- ],
2511
- "responseData": [
2512
- {
2513
- "code": "ErrorCode",
2514
- "value": [
2515
- "GroupNotFound",
2516
- "CharacterPlayerNotFound",
2517
- "Ok"
2518
- ]
2519
- }
2520
- ],
2521
- "description": "Perform the JoinGroup operation.",
2522
- "operationResponse": "EmptyResponseData"
2523
- },
2524
- {
2525
- "operationCode": "LeaveGroup",
2526
- "details": [
2527
- {
2528
- "role": "Client",
2529
- "requestData": [
2530
- {
2531
- "code": "CharacterId",
2532
- "description": "Unique identifier of the character performing the action or being referenced.",
2533
- "optional": false,
2534
- "type": "string",
2535
- "gnType": "String",
2536
- "conditions": {
2537
- "mustNonNull": true,
2538
- "minLength": 11,
2539
- "maxLength": 11
2540
- }
2541
- },
2542
- {
2543
- "code": "GroupId",
2544
- "description": "GroupId used in this request.",
2545
- "optional": false,
2546
- "type": "string",
2547
- "gnType": "String",
2548
- "conditions": {
2549
- "mustNonNull": true,
2550
- "minLength": 10,
2551
- "maxLength": 10
2552
- }
2553
- }
2554
- ]
2555
- },
2556
- {
2557
- "role": "Server",
2558
- "requestData": []
2559
- },
2560
- {
2561
- "role": "Admin",
2562
- "requestData": []
2563
- }
2564
- ],
2565
- "responseData": [
2566
- {
2567
- "code": "ErrorCode",
2568
- "value": [
2569
- "GroupNotFound",
2570
- "CharacterPlayerNotFound",
2571
- "Ok"
2572
- ]
2573
- }
2574
- ],
2575
- "description": "Perform the LeaveGroup operation.",
2576
- "operationResponse": "EmptyResponseData"
2577
- },
2578
- {
2579
- "operationCode": "RemovePlayerFriend",
2580
- "details": [
2581
- {
2582
- "role": "Client",
2583
- "requestData": [
2584
- {
2585
- "code": "CharacterId",
2586
- "description": "Unique identifier of the character performing the action or being referenced.",
2587
- "optional": false,
2588
- "type": "string",
2589
- "gnType": "String",
2590
- "conditions": {
2591
- "mustNonNull": true,
2592
- "minLength": 11,
2593
- "maxLength": 11
2594
- }
2595
- },
2596
- {
2597
- "code": "FriendId",
2598
- "description": "Unique identifier of the friend character being added.",
2599
- "optional": false,
2600
- "type": "string",
2601
- "gnType": "String",
2602
- "conditions": {
2603
- "mustNonNull": true,
2604
- "minLength": 11,
2605
- "maxLength": 11
2606
- }
2607
- }
2608
- ]
2609
- },
2610
- {
2611
- "role": "Server",
2612
- "requestData": []
2613
- },
2614
- {
2615
- "role": "Admin",
2616
- "requestData": []
2617
- }
2618
- ],
2619
- "responseData": [
2620
- {
2621
- "code": "ErrorCode",
2622
- "value": [
2623
- "CharacterPlayerNotFound",
2624
- "Ok"
2625
- ]
2626
- }
2627
- ],
2628
- "description": "Perform the RemovePlayerFriend operation.",
2629
- "operationResponse": "EmptyResponseData"
2630
- },
2631
- {
2632
- "operationCode": "RemovePlayerItem",
2633
- "details": [
2634
- {
2635
- "role": "Client",
2636
- "requestData": [
2637
- {
2638
- "code": "CharacterId",
2639
- "description": "Unique identifier of the character performing the action or being referenced.",
2640
- "optional": false,
2641
- "type": "string",
2642
- "gnType": "String",
2643
- "conditions": {
2644
- "mustNonNull": true,
2645
- "minLength": 11,
2646
- "maxLength": 11
2647
- }
2648
- },
2649
- {
2650
- "code": "ItemId",
2651
- "description": "ItemId used in this request.",
2652
- "optional": false,
2653
- "type": "string",
2654
- "gnType": "String",
2655
- "conditions": {
2656
- "mustNonNull": true,
2657
- "minLength": 12,
2658
- "maxLength": 12
2659
- }
2660
- }
2661
- ]
2662
- },
2663
- {
2664
- "role": "Server",
2665
- "requestData": []
2666
- },
2667
- {
2668
- "role": "Admin",
2669
- "requestData": []
2670
- }
2671
- ],
2672
- "responseData": [
2673
- {
2674
- "code": "ErrorCode",
2675
- "value": [
2676
- "CharacterPlayerNotFound",
2677
- "ItemNotFound",
2678
- "Ok"
2679
- ]
2680
- }
2681
- ],
2682
- "description": "Perform the RemovePlayerItem operation.",
2683
- "operationResponse": "EmptyResponseData"
2684
- },
2685
- {
2686
- "operationCode": "RemoveSegment",
2687
- "details": [
2688
- {
2689
- "role": "Client",
2690
- "requestData": [
2691
- {
2692
- "code": "CharacterId",
2693
- "description": "Unique identifier of the character performing the action or being referenced.",
2694
- "optional": false,
2695
- "type": "string",
2696
- "gnType": "String",
2697
- "conditions": {
2698
- "mustNonNull": true,
2699
- "minLength": 11,
2700
- "maxLength": 11
2701
- }
2702
- },
2703
- {
2704
- "code": "Value",
2705
- "description": "The specific value of the segment to be assigned to the character.",
2706
- "optional": false,
2707
- "type": "string",
2708
- "gnType": "String",
2709
- "conditions": {
2710
- "mustNonNull": true,
2711
- "minLength": 2,
2712
- "maxLength": 32
2713
- }
2714
- }
2715
- ]
2716
- },
2717
- {
2718
- "role": "Server",
2719
- "requestData": []
2720
- },
2721
- {
2722
- "role": "Admin",
2723
- "requestData": []
2724
- }
2725
- ],
2726
- "responseData": [
2727
- {
2728
- "code": "ErrorCode",
2729
- "value": [
2730
- "CharacterPlayerNotFound",
2731
- "Ok"
2732
- ]
2733
- }
2734
- ],
2735
- "description": "Perform the RemoveSegment operation.",
2736
- "operationResponse": "EmptyResponseData"
2737
- },
2738
- {
2739
- "operationCode": "RemoveTag",
2740
- "details": [
2741
- {
2742
- "role": "Client",
2743
- "requestData": [
2744
- {
2745
- "code": "CharacterId",
2746
- "description": "Unique identifier of the character performing the action or being referenced.",
2747
- "optional": false,
2748
- "type": "string",
2749
- "gnType": "String",
2750
- "conditions": {
2751
- "mustNonNull": true,
2752
- "minLength": 11,
2753
- "maxLength": 11
2754
- }
2755
- },
2756
- {
2757
- "code": "Key",
2758
- "description": "Key used in this request.",
2759
- "optional": false,
2760
- "type": "string",
2761
- "gnType": "String",
2762
- "conditions": {
2763
- "mustNonNull": true,
2764
- "minLength": 2,
2765
- "maxLength": 32
2766
- }
2767
- }
2768
- ]
2769
- },
2770
- {
2771
- "role": "Server",
2772
- "requestData": []
2773
- },
2774
- {
2775
- "role": "Admin",
2776
- "requestData": []
2777
- }
2778
- ],
2779
- "responseData": [
2780
- {
2781
- "code": "ErrorCode",
2782
- "value": [
2783
- "CharacterPlayerNotFound",
2784
- "Ok"
2785
- ]
2786
- }
2787
- ],
2788
- "description": "Perform the RemoveTag operation.",
2789
- "operationResponse": "EmptyResponseData"
2790
- },
2791
- {
2792
- "operationCode": "SetAvatar",
2793
- "details": [
2794
- {
2795
- "role": "Client",
2796
- "requestData": [
2797
- {
2798
- "code": "CharacterId",
2799
- "description": "Unique identifier of the character performing the action or being referenced.",
2800
- "optional": false,
2801
- "type": "string",
2802
- "gnType": "String",
2803
- "conditions": {
2804
- "mustNonNull": true,
2805
- "minLength": 11,
2806
- "maxLength": 11
2807
- }
2808
- },
2809
- {
2810
- "code": "Type",
2811
- "description": "Type used in this request.",
2812
- "optional": false,
2813
- "type": "number",
2814
- "gnType": "Number",
2815
- "conditions": {
2816
- "mustInt": true
2817
- }
2818
- },
2819
- {
2820
- "code": "Value",
2821
- "description": "The specific value of the segment to be assigned to the character.",
2822
- "optional": false,
2823
- "type": "string",
2824
- "gnType": "String",
2825
- "conditions": {
2826
- "mustNonNull": true,
2827
- "minLength": 1,
2828
- "maxLength": 128
2829
- }
2830
- }
2831
- ]
2832
- },
2833
- {
2834
- "role": "Server",
2835
- "requestData": []
2836
- },
2837
- {
2838
- "role": "Admin",
2839
- "requestData": []
2840
- }
2841
- ],
2842
- "responseData": [
2843
- {
2844
- "code": "ErrorCode",
2845
- "value": [
2846
- "CharacterPlayerNotFound",
2847
- "Ok"
2848
- ]
2849
- }
2850
- ],
2851
- "description": "Perform the SetAvatar operation.",
2852
- "operationResponse": "EmptyResponseData"
2853
- },
2854
- {
2855
- "operationCode": "SetCountryCode",
2856
- "details": [
2857
- {
2858
- "role": "Client",
2859
- "requestData": [
2860
- {
2861
- "code": "CharacterId",
2862
- "description": "Unique identifier of the character performing the action or being referenced.",
2863
- "optional": false,
2864
- "type": "string",
2865
- "gnType": "String",
2866
- "conditions": {
2867
- "mustNonNull": true,
2868
- "minLength": 11,
2869
- "maxLength": 11
2870
- }
2871
- },
2872
- {
2873
- "code": "CountryCode",
2874
- "description": "CountryCode used in this request.",
2875
- "optional": false,
2876
- "type": "string",
2877
- "gnType": "String",
2878
- "conditions": {
2879
- "minLength": 2,
2880
- "maxLength": 32
2881
- }
2882
- }
2883
- ]
2884
- },
2885
- {
2886
- "role": "Server",
2887
- "requestData": []
2888
- },
2889
- {
2890
- "role": "Admin",
2891
- "requestData": []
2892
- }
2893
- ],
2894
- "responseData": [
2895
- {
2896
- "code": "ErrorCode",
2897
- "value": [
2898
- "CharacterPlayerNotFound",
2899
- "Ok"
2900
- ]
2901
- }
2902
- ],
2903
- "description": "Perform the SetCountryCode operation.",
2904
- "operationResponse": "EmptyResponseData"
2905
- },
2906
- {
2907
- "operationCode": "SetCustomData",
2908
- "details": [
2909
- {
2910
- "role": "Client",
2911
- "requestData": [
2912
- {
2913
- "code": "CharacterId",
2914
- "description": "Unique identifier of the character performing the action or being referenced.",
2915
- "optional": false,
2916
- "type": "string",
2917
- "gnType": "String",
2918
- "conditions": {
2919
- "mustNonNull": true,
2920
- "minLength": 11,
2921
- "maxLength": 11
2922
- }
2923
- },
2924
- {
2925
- "code": "CustomDatas",
2926
- "description": "CustomDatas used in this request.",
2927
- "optional": false,
2928
- "type": "CustomDataParam",
2929
- "gnType": "GNArray",
2930
- "conditions": {
2931
- "mustNonNull": true,
2932
- "minLength": 1,
2933
- "maxLength": 32
2934
- }
2935
- }
2936
- ]
2937
- },
2938
- {
2939
- "role": "Server",
2940
- "requestData": []
2941
- },
2942
- {
2943
- "role": "Admin",
2944
- "requestData": []
2945
- }
2946
- ],
2947
- "responseData": [
2948
- {
2949
- "code": "ErrorCode",
2950
- "value": [
2951
- "CharacterPlayerNotFound",
2952
- "Ok"
2953
- ]
2954
- },
2955
- {
2956
- "code": "InfoResponseParameters"
2957
- }
2958
- ],
2959
- "description": "Perform the SetCustomData operation.",
2960
- "operationResponse": "CharacterPlayerResponseData"
2961
- },
2962
- {
2963
- "operationCode": "SetDisplayName",
2964
- "details": [
2965
- {
2966
- "role": "Client",
2967
- "requestData": [
2968
- {
2969
- "code": "CharacterId",
2970
- "description": "Unique identifier of the character performing the action or being referenced.",
2971
- "optional": false,
2972
- "type": "string",
2973
- "gnType": "String",
2974
- "conditions": {
2975
- "mustNonNull": true,
2976
- "minLength": 11,
2977
- "maxLength": 11
2978
- }
2979
- },
2980
- {
2981
- "code": "DisplayName",
2982
- "description": "The public-facing name of the created group or item.",
2983
- "optional": false,
2984
- "type": "string",
2985
- "gnType": "String",
2986
- "conditions": {
2987
- "mustNonNull": true,
2988
- "minLength": 5,
2989
- "maxLength": 32
2990
- }
2991
- },
2992
- {
2993
- "code": "UniqueDisplayName",
2994
- "description": "UniqueDisplayName used in this request.",
2995
- "optional": true,
2996
- "type": "boolean",
2997
- "gnType": "Boolean",
2998
- "defaultValue": "false",
2999
- "conditions": {}
3000
- }
3001
- ]
3002
- },
3003
- {
3004
- "role": "Server",
3005
- "requestData": []
3006
- },
3007
- {
3008
- "role": "Admin",
3009
- "requestData": []
3010
- }
3011
- ],
3012
- "responseData": [
3013
- {
3014
- "code": "ErrorCode",
3015
- "value": [
3016
- "DisplayNameHasUse",
3017
- "CharacterPlayerNotFound",
3018
- "Ok"
3019
- ]
3020
- }
3021
- ],
3022
- "description": "Perform the SetDisplayName operation.",
3023
- "operationResponse": "EmptyResponseData"
3024
- },
3025
- {
3026
- "operationCode": "SetOwner",
3027
- "details": [
3028
- {
3029
- "role": "Client",
3030
- "requestData": [
3031
- {
3032
- "code": "CharacterId",
3033
- "description": "Unique identifier of the character performing the action or being referenced.",
3034
- "optional": false,
3035
- "type": "string",
3036
- "gnType": "String",
3037
- "conditions": {
3038
- "mustNonNull": true,
3039
- "minLength": 11,
3040
- "maxLength": 11
3041
- }
3042
- },
3043
- {
3044
- "code": "NewOwnerId",
3045
- "description": "NewOwnerId used in this request.",
3046
- "optional": false,
3047
- "type": "string",
3048
- "gnType": "String",
3049
- "conditions": {
3050
- "mustNonNull": true,
3051
- "minLength": 10,
3052
- "maxLength": 10
3053
- }
3054
- }
3055
- ]
3056
- },
3057
- {
3058
- "role": "Server",
3059
- "requestData": []
3060
- },
3061
- {
3062
- "role": "Admin",
3063
- "requestData": []
3064
- }
3065
- ],
3066
- "responseData": [
3067
- {
3068
- "code": "ErrorCode",
3069
- "value": [
3070
- "CharacterPlayerNotFound",
3071
- "OwnerNotFound",
3072
- "Ok"
3073
- ]
3074
- }
3075
- ],
3076
- "description": "Perform the SetOwner operation.",
3077
- "operationResponse": "EmptyResponseData"
3078
- },
3079
- {
3080
- "operationCode": "SetPlayerBan",
3081
- "details": [
3082
- {
3083
- "role": "Client",
3084
- "requestData": [
3085
- {
3086
- "code": "CharacterId",
3087
- "description": "Unique identifier of the character performing the action or being referenced.",
3088
- "optional": false,
3089
- "type": "string",
3090
- "gnType": "String",
3091
- "conditions": {
3092
- "mustNonNull": true,
3093
- "minLength": 11,
3094
- "maxLength": 11
3095
- }
3096
- },
3097
- {
3098
- "code": "TsExpire",
3099
- "description": "TsExpire used in this request.",
3100
- "optional": false,
3101
- "type": "number",
3102
- "gnType": "Number",
3103
- "conditions": {}
3104
- },
3105
- {
3106
- "code": "Reason",
3107
- "description": "Reason used in this request.",
3108
- "optional": false,
3109
- "type": "string",
3110
- "gnType": "String",
3111
- "conditions": {}
3112
- }
3113
- ]
3114
- },
3115
- {
3116
- "role": "Server",
3117
- "requestData": []
3118
- },
3119
- {
3120
- "role": "Admin",
3121
- "requestData": []
3122
- }
3123
- ],
3124
- "responseData": [
3125
- {
3126
- "code": "ErrorCode",
3127
- "value": [
3128
- "CharacterPlayerNotFound",
3129
- "Ok"
3130
- ]
3131
- }
3132
- ],
3133
- "description": "Perform the SetPlayerBan operation.",
3134
- "operationResponse": "EmptyResponseData"
3135
- },
3136
- {
3137
- "operationCode": "SetPlayerData",
3138
- "details": [
3139
- {
3140
- "role": "Client",
3141
- "requestData": [
3142
- {
3143
- "code": "CharacterId",
3144
- "description": "Unique identifier of the character performing the action or being referenced.",
3145
- "optional": false,
3146
- "type": "string",
3147
- "gnType": "String",
3148
- "conditions": {
3149
- "mustNonNull": true,
3150
- "minLength": 11,
3151
- "maxLength": 11
3152
- }
3153
- },
3154
- {
3155
- "code": "PlayerDatas",
3156
- "description": "PlayerDatas used in this request.",
3157
- "optional": false,
3158
- "type": "PlayerDataParam",
3159
- "gnType": "GNArray",
3160
- "conditions": {
3161
- "mustNonNull": true,
3162
- "minLength": 1,
3163
- "maxLength": 32
3164
- }
3165
- }
3166
- ]
3167
- },
3168
- {
3169
- "role": "Server",
3170
- "requestData": []
3171
- },
3172
- {
3173
- "role": "Admin",
3174
- "requestData": []
3175
- }
3176
- ],
3177
- "responseData": [
3178
- {
3179
- "code": "ErrorCode",
3180
- "value": [
3181
- "CharacterPlayerNotFound",
3182
- "Ok"
3183
- ]
3184
- },
3185
- {
3186
- "code": "InfoResponseParameters"
3187
- }
3188
- ],
3189
- "description": "Perform the SetPlayerData operation.",
3190
- "operationResponse": "CharacterPlayerResponseData"
3191
- },
3192
- {
3193
- "operationCode": "SetRemoveStatus",
3194
- "details": [
3195
- {
3196
- "role": "Client",
3197
- "requestData": [
3198
- {
3199
- "code": "CharacterId",
3200
- "description": "Unique identifier of the character performing the action or being referenced.",
3201
- "optional": false,
3202
- "type": "string",
3203
- "gnType": "String",
3204
- "conditions": {
3205
- "mustNonNull": true,
3206
- "minLength": 11,
3207
- "maxLength": 11
3208
- }
3209
- },
3210
- {
3211
- "code": "Reason",
3212
- "description": "Reason used in this request.",
3213
- "optional": true,
3214
- "type": "string",
3215
- "gnType": "String",
3216
- "defaultValue": "\"\"",
3217
- "conditions": {}
3218
- }
3219
- ]
3220
- },
3221
- {
3222
- "role": "Server",
3223
- "requestData": []
3224
- },
3225
- {
3226
- "role": "Admin",
3227
- "requestData": []
3228
- }
3229
- ],
3230
- "responseData": [
3231
- {
3232
- "code": "ErrorCode",
3233
- "value": [
3234
- "CharacterPlayerNotFound",
3235
- "Ok"
3236
- ]
3237
- }
3238
- ],
3239
- "description": "Perform the SetRemoveStatus operation.",
3240
- "operationResponse": "EmptyResponseData"
3241
- },
3242
- {
3243
- "operationCode": "SetTag",
3244
- "details": [
3245
- {
3246
- "role": "Client",
3247
- "requestData": [
3248
- {
3249
- "code": "CharacterId",
3250
- "description": "Unique identifier of the character performing the action or being referenced.",
3251
- "optional": false,
3252
- "type": "string",
3253
- "gnType": "String",
3254
- "conditions": {
3255
- "mustNonNull": true,
3256
- "minLength": 11,
3257
- "maxLength": 11
3258
- }
3259
- },
3260
- {
3261
- "code": "Key",
3262
- "description": "Key used in this request.",
3263
- "optional": false,
3264
- "type": "string",
3265
- "gnType": "String",
3266
- "conditions": {
3267
- "mustNonNull": true,
3268
- "minLength": 2,
3269
- "maxLength": 32
3270
- }
3271
- },
3272
- {
3273
- "code": "Value",
3274
- "description": "The specific value of the segment to be assigned to the character.",
3275
- "optional": false,
3276
- "type": "string",
3277
- "gnType": "String",
3278
- "conditions": {
3279
- "mustNonNull": true,
3280
- "minLength": 2,
3281
- "maxLength": 32
3282
- }
3283
- }
3284
- ]
3285
- },
3286
- {
3287
- "role": "Server",
3288
- "requestData": []
3289
- },
3290
- {
3291
- "role": "Admin",
3292
- "requestData": []
3293
- }
3294
- ],
3295
- "responseData": [
3296
- {
3297
- "code": "ErrorCode",
3298
- "value": [
3299
- "KeyNotFound",
3300
- "CharacterPlayerNotFound",
3301
- "Ok"
3302
- ]
3303
- }
3304
- ],
3305
- "description": "Perform the SetTag operation.",
3306
- "operationResponse": "EmptyResponseData"
3307
- }
3308
- ],
3309
- "models": [
3310
- {
3311
- "name": "CustomDataParam",
3312
- "details": [
3313
- {
3314
- "code": "Key",
3315
- "description": "The name or identifier of the entry.",
3316
- "optional": false,
3317
- "type": "string",
3318
- "gnType": "String",
3319
- "conditions": {
3320
- "mustNonNull": true,
3321
- "minLength": 2,
3322
- "maxLength": 32
3323
- }
3324
- },
3325
- {
3326
- "code": "Value",
3327
- "description": "The numeric or string value associated with the key.",
3328
- "optional": false,
3329
- "type": "any",
3330
- "gnType": "DataMember",
3331
- "conditions": {}
3332
- }
3333
- ],
3334
- "description": "Data model for CustomDataParam."
3335
- },
3336
- {
3337
- "name": "GroupMemberParam",
3338
- "details": [
3339
- {
3340
- "code": "UserId",
3341
- "description": "UserId field used in the GroupMemberParam model.",
3342
- "optional": false,
3343
- "type": "string",
3344
- "gnType": "String",
3345
- "conditions": {
3346
- "mustNonNull": true,
3347
- "minLength": 11,
3348
- "maxLength": 11
3349
- }
3350
- }
3351
- ],
3352
- "description": "Data model for GroupMemberParam."
3353
- },
3354
- {
3355
- "name": "InfoRequestParam",
3356
- "details": [
3357
- {
3358
- "code": "CatalogId",
3359
- "description": "CatalogId field used in the InfoRequestParam model.",
3360
- "optional": true,
3361
- "type": "boolean",
3362
- "gnType": "Boolean",
3363
- "defaultValue": "false",
3364
- "conditions": {}
3365
- },
3366
- {
3367
- "code": "Owner",
3368
- "description": "Owner field used in the InfoRequestParam model.",
3369
- "optional": true,
3370
- "type": "boolean",
3371
- "gnType": "Boolean",
3372
- "defaultValue": "false",
3373
- "conditions": {}
3374
- },
3375
- {
3376
- "code": "RemoveStatus",
3377
- "description": "RemoveStatus field used in the InfoRequestParam model.",
3378
- "optional": true,
3379
- "type": "boolean",
3380
- "gnType": "Boolean",
3381
- "defaultValue": "false",
3382
- "conditions": {}
3383
- },
3384
- {
3385
- "code": "Segments",
3386
- "description": "Segments field used in the InfoRequestParam model.",
3387
- "optional": true,
3388
- "type": "boolean",
3389
- "gnType": "Boolean",
3390
- "defaultValue": "false",
3391
- "conditions": {}
3392
- },
3393
- {
3394
- "code": "CustomDatas",
3395
- "description": "CustomDatas field used in the InfoRequestParam model.",
3396
- "optional": true,
3397
- "type": "boolean",
3398
- "gnType": "Boolean",
3399
- "defaultValue": "false",
3400
- "conditions": {}
3401
- },
3402
- {
3403
- "code": "DisplayName",
3404
- "description": "DisplayName field used in the InfoRequestParam model.",
3405
- "optional": true,
3406
- "type": "boolean",
3407
- "gnType": "Boolean",
3408
- "defaultValue": "false",
3409
- "conditions": {}
3410
- },
3411
- {
3412
- "code": "Avatar",
3413
- "description": "Avatar field used in the InfoRequestParam model.",
3414
- "optional": true,
3415
- "type": "boolean",
3416
- "gnType": "Boolean",
3417
- "defaultValue": "false",
3418
- "conditions": {}
3419
- },
3420
- {
3421
- "code": "TsCreate",
3422
- "description": "TsCreate field used in the InfoRequestParam model.",
3423
- "optional": true,
3424
- "type": "boolean",
3425
- "gnType": "Boolean",
3426
- "defaultValue": "false",
3427
- "conditions": {}
3428
- },
3429
- {
3430
- "code": "Tags",
3431
- "description": "Tags field used in the InfoRequestParam model.",
3432
- "optional": true,
3433
- "type": "boolean",
3434
- "gnType": "Boolean",
3435
- "defaultValue": "false",
3436
- "conditions": {}
3437
- },
3438
- {
3439
- "code": "PlayerBan",
3440
- "description": "PlayerBan field used in the InfoRequestParam model.",
3441
- "optional": true,
3442
- "type": "boolean",
3443
- "gnType": "Boolean",
3444
- "defaultValue": "false",
3445
- "conditions": {}
3446
- },
3447
- {
3448
- "code": "PlayerCurrencies",
3449
- "description": "PlayerCurrencies field used in the InfoRequestParam model.",
3450
- "optional": true,
3451
- "type": "boolean",
3452
- "gnType": "Boolean",
3453
- "defaultValue": "false",
3454
- "conditions": {}
3455
- },
3456
- {
3457
- "code": "PlayerStatistics",
3458
- "description": "PlayerStatistics field used in the InfoRequestParam model.",
3459
- "optional": true,
3460
- "type": "boolean",
3461
- "gnType": "Boolean",
3462
- "defaultValue": "false",
3463
- "conditions": {}
3464
- },
3465
- {
3466
- "code": "PlayerDatas",
3467
- "description": "PlayerDatas field used in the InfoRequestParam model.",
3468
- "optional": true,
3469
- "type": "boolean",
3470
- "gnType": "Boolean",
3471
- "defaultValue": "false",
3472
- "conditions": {}
3473
- },
3474
- {
3475
- "code": "IpAddressCreate",
3476
- "description": "IpAddressCreate field used in the InfoRequestParam model.",
3477
- "optional": true,
3478
- "type": "boolean",
3479
- "gnType": "Boolean",
3480
- "defaultValue": "false",
3481
- "conditions": {}
3482
- },
3483
- {
3484
- "code": "CountryCode",
3485
- "description": "CountryCode field used in the InfoRequestParam model.",
3486
- "optional": true,
3487
- "type": "boolean",
3488
- "gnType": "Boolean",
3489
- "defaultValue": "false",
3490
- "conditions": {}
3491
- },
3492
- {
3493
- "code": "TsLastLogin",
3494
- "description": "TsLastLogin field used in the InfoRequestParam model.",
3495
- "optional": true,
3496
- "type": "boolean",
3497
- "gnType": "Boolean",
3498
- "defaultValue": "false",
3499
- "conditions": {}
3500
- },
3501
- {
3502
- "code": "PlayerInventories",
3503
- "description": "PlayerInventories field used in the InfoRequestParam model.",
3504
- "optional": true,
3505
- "type": "boolean",
3506
- "gnType": "Boolean",
3507
- "defaultValue": "false",
3508
- "conditions": {}
3509
- },
3510
- {
3511
- "code": "PlayerGroups",
3512
- "description": "PlayerGroups field used in the InfoRequestParam model.",
3513
- "optional": true,
3514
- "type": "boolean",
3515
- "gnType": "Boolean",
3516
- "defaultValue": "false",
3517
- "conditions": {}
3518
- },
3519
- {
3520
- "code": "PlayerFriends",
3521
- "description": "PlayerFriends field used in the InfoRequestParam model.",
3522
- "optional": true,
3523
- "type": "boolean",
3524
- "gnType": "Boolean",
3525
- "defaultValue": "false",
3526
- "conditions": {}
3527
- },
3528
- {
3529
- "code": "PlayerDataKeys",
3530
- "description": "PlayerDataKeys field used in the InfoRequestParam model.",
3531
- "optional": true,
3532
- "type": "string",
3533
- "gnType": "GNArray",
3534
- "conditions": {}
3535
- },
3536
- {
3537
- "code": "PlayerCurrencyKeys",
3538
- "description": "PlayerCurrencyKeys field used in the InfoRequestParam model.",
3539
- "optional": true,
3540
- "type": "string",
3541
- "gnType": "GNArray",
3542
- "conditions": {}
3543
- },
3544
- {
3545
- "code": "PlayerStatisticsKeys",
3546
- "description": "PlayerStatisticsKeys field used in the InfoRequestParam model.",
3547
- "optional": true,
3548
- "type": "string",
3549
- "gnType": "GNArray",
3550
- "conditions": {}
3551
- },
3552
- {
3553
- "code": "CustomDataKeys",
3554
- "description": "CustomDataKeys field used in the InfoRequestParam model.",
3555
- "optional": true,
3556
- "type": "string",
3557
- "gnType": "GNArray",
3558
- "conditions": {}
3559
- },
3560
- {
3561
- "code": "TagKeys",
3562
- "description": "TagKeys field used in the InfoRequestParam model.",
3563
- "optional": true,
3564
- "type": "string",
3565
- "gnType": "GNArray",
3566
- "conditions": {}
3567
- },
3568
- {
3569
- "code": "CharacterCatalogIds",
3570
- "description": "CharacterCatalogIds field used in the InfoRequestParam model.",
3571
- "optional": true,
3572
- "type": "string",
3573
- "gnType": "GNArray",
3574
- "conditions": {}
3575
- },
3576
- {
3577
- "code": "ItemCatalogIds",
3578
- "description": "ItemCatalogIds field used in the InfoRequestParam model.",
3579
- "optional": true,
3580
- "type": "string",
3581
- "gnType": "GNArray",
3582
- "conditions": {}
3583
- },
3584
- {
3585
- "code": "GroupCatalogIds",
3586
- "description": "GroupCatalogIds field used in the InfoRequestParam model.",
3587
- "optional": true,
3588
- "type": "string",
3589
- "gnType": "GNArray",
3590
- "conditions": {}
3591
- },
3592
- {
3593
- "code": "FriendCatalogIds",
3594
- "description": "FriendCatalogIds field used in the InfoRequestParam model.",
3595
- "optional": true,
3596
- "type": "string",
3597
- "gnType": "GNArray",
3598
- "conditions": {}
3599
- }
3600
- ],
3601
- "description": "Data model for InfoRequestParam."
3602
- },
3603
- {
3604
- "name": "PlayerCurrencyParam",
3605
- "details": [
3606
- {
3607
- "code": "Key",
3608
- "description": "The name or identifier of the entry.",
3609
- "optional": false,
3610
- "type": "string",
3611
- "gnType": "String",
3612
- "conditions": {
3613
- "mustNonNull": true,
3614
- "minLength": 2,
3615
- "maxLength": 32
3616
- }
3617
- },
3618
- {
3619
- "code": "Amount",
3620
- "description": "Amount field used in the PlayerCurrencyParam model.",
3621
- "optional": false,
3622
- "type": "number",
3623
- "gnType": "Number",
3624
- "conditions": {}
3625
- }
3626
- ],
3627
- "description": "Data model for PlayerCurrencyParam."
3628
- },
3629
- {
3630
- "name": "PlayerDataParam",
3631
- "details": [
3632
- {
3633
- "code": "Key",
3634
- "description": "The name or identifier of the entry.",
3635
- "optional": false,
3636
- "type": "string",
3637
- "gnType": "String",
3638
- "conditions": {
3639
- "mustNonNull": true,
3640
- "minLength": 2,
3641
- "maxLength": 32
3642
- }
3643
- },
3644
- {
3645
- "code": "Value",
3646
- "description": "The numeric or string value associated with the key.",
3647
- "optional": false,
3648
- "type": "any",
3649
- "gnType": "DataMember",
3650
- "conditions": {}
3651
- }
3652
- ],
3653
- "description": "Data model for PlayerDataParam."
3654
- },
3655
- {
3656
- "name": "PlayerStatisticsParam",
3657
- "details": [
3658
- {
3659
- "code": "Key",
3660
- "description": "The name or identifier of the entry.",
3661
- "optional": false,
3662
- "type": "string",
3663
- "gnType": "String",
3664
- "conditions": {
3665
- "mustNonNull": true,
3666
- "minLength": 2,
3667
- "maxLength": 32
3668
- }
3669
- },
3670
- {
3671
- "code": "Value",
3672
- "description": "The numeric or string value associated with the key.",
3673
- "optional": false,
3674
- "type": "number",
3675
- "gnType": "Number",
3676
- "conditions": {}
3677
- }
3678
- ],
3679
- "description": "Data model for PlayerStatisticsParam."
3680
- },
3681
- {
3682
- "name": "InfoResponseParameters",
3683
- "details": [
3684
- {
3685
- "code": "CatalogId",
3686
- "description": "CatalogId field used in the InfoResponseParameters model.",
3687
- "optional": true,
3688
- "type": "string",
3689
- "gnType": "String",
3690
- "conditions": {}
3691
- },
3692
- {
3693
- "code": "Owner",
3694
- "description": "Owner field used in the InfoResponseParameters model.",
3695
- "optional": true,
3696
- "type": "GenericModels.OwnerItem",
3697
- "gnType": "GNHashtable",
3698
- "conditions": {}
3699
- },
3700
- {
3701
- "code": "RemoveStatus",
3702
- "description": "RemoveStatus field used in the InfoResponseParameters model.",
3703
- "optional": true,
3704
- "type": "GenericModels.RemoveStatusItem",
3705
- "gnType": "GNHashtable",
3706
- "conditions": {}
3707
- },
3708
- {
3709
- "code": "Segments",
3710
- "description": "Segments field used in the InfoResponseParameters model.",
3711
- "optional": true,
3712
- "type": "string",
3713
- "gnType": "GNArray",
3714
- "conditions": {}
3715
- },
3716
- {
3717
- "code": "CustomDatas",
3718
- "description": "CustomDatas field used in the InfoResponseParameters model.",
3719
- "optional": true,
3720
- "type": "GenericModels.DataItem",
3721
- "gnType": "GNArray",
3722
- "conditions": {}
3723
- },
3724
- {
3725
- "code": "DisplayName",
3726
- "description": "DisplayName field used in the InfoResponseParameters model.",
3727
- "optional": true,
3728
- "type": "string",
3729
- "gnType": "String",
3730
- "conditions": {}
3731
- },
3732
- {
3733
- "code": "Avatar",
3734
- "description": "Avatar field used in the InfoResponseParameters model.",
3735
- "optional": true,
3736
- "type": "GenericModels.AvatarItem",
3737
- "gnType": "GNHashtable",
3738
- "conditions": {}
3739
- },
3740
- {
3741
- "code": "TsCreate",
3742
- "description": "TsCreate field used in the InfoResponseParameters model.",
3743
- "optional": true,
3744
- "type": "number",
3745
- "gnType": "Number",
3746
- "conditions": {}
3747
- },
3748
- {
3749
- "code": "Tags",
3750
- "description": "Tags field used in the InfoResponseParameters model.",
3751
- "optional": true,
3752
- "type": "GenericModels.TagItem",
3753
- "gnType": "GNArray",
3754
- "conditions": {}
3755
- },
3756
- {
3757
- "code": "PlayerBan",
3758
- "description": "PlayerBan field used in the InfoResponseParameters model.",
3759
- "optional": true,
3760
- "type": "GenericModels.BanItem",
3761
- "gnType": "GNHashtable",
3762
- "conditions": {}
3763
- },
3764
- {
3765
- "code": "PlayerDatas",
3766
- "description": "PlayerDatas field used in the InfoResponseParameters model.",
3767
- "optional": true,
3768
- "type": "GenericModels.DataItem",
3769
- "gnType": "GNArray",
3770
- "conditions": {}
3771
- },
3772
- {
3773
- "code": "PlayerCurrencies",
3774
- "description": "PlayerCurrencies field used in the InfoResponseParameters model.",
3775
- "optional": true,
3776
- "type": "GenericModels.CurrencyItem",
3777
- "gnType": "GNArray",
3778
- "conditions": {}
3779
- },
3780
- {
3781
- "code": "PlayerStatistics",
3782
- "description": "PlayerStatistics field used in the InfoResponseParameters model.",
3783
- "optional": true,
3784
- "type": "GenericModels.StatisticsItem",
3785
- "gnType": "GNArray",
3786
- "conditions": {}
3787
- },
3788
- {
3789
- "code": "PlayerInventories",
3790
- "description": "PlayerInventories field used in the InfoResponseParameters model.",
3791
- "optional": true,
3792
- "type": "GenericModels.InventoryItem",
3793
- "gnType": "GNArray",
3794
- "conditions": {}
3795
- },
3796
- {
3797
- "code": "PlayerGroups",
3798
- "description": "PlayerGroups field used in the InfoResponseParameters model.",
3799
- "optional": true,
3800
- "type": "GenericModels.GroupItem",
3801
- "gnType": "GNArray",
3802
- "conditions": {}
3803
- },
3804
- {
3805
- "code": "PlayerFriends",
3806
- "description": "PlayerFriends field used in the InfoResponseParameters model.",
3807
- "optional": true,
3808
- "type": "GenericModels.FriendItem",
3809
- "gnType": "GNArray",
3810
- "conditions": {}
3811
- },
3812
- {
3813
- "code": "TsLastLogin",
3814
- "description": "TsLastLogin field used in the InfoResponseParameters model.",
3815
- "optional": true,
3816
- "type": "number",
3817
- "gnType": "Number",
3818
- "conditions": {}
3819
- },
3820
- {
3821
- "code": "IpAddressCreate",
3822
- "description": "IpAddressCreate field used in the InfoResponseParameters model.",
3823
- "optional": true,
3824
- "type": "string",
3825
- "gnType": "String",
3826
- "conditions": {}
3827
- },
3828
- {
3829
- "code": "CountryCode",
3830
- "description": "CountryCode field used in the InfoResponseParameters model.",
3831
- "optional": true,
3832
- "type": "string",
3833
- "gnType": "String",
3834
- "conditions": {}
3835
- }
3836
- ],
3837
- "description": "Data model for InfoResponseParameters."
3838
- },
3839
- {
3840
- "name": "CharacterPlayerResponseData",
3841
- "details": [
3842
- {
3843
- "code": "InfoResponseParameters",
3844
- "description": "InfoResponseParameters field used in the CharacterPlayerResponseData model.",
3845
- "optional": false,
3846
- "type": "InfoResponseParameters",
3847
- "gnType": "GNHashtable",
3848
- "conditions": {}
3849
- }
3850
- ],
3851
- "description": "Data model for CharacterPlayerResponseData."
3852
- },
3853
- {
3854
- "name": "CharacterPlayerWithCharacterIdResponseData",
3855
- "details": [
3856
- {
3857
- "code": "CharacterId",
3858
- "description": "CharacterId field used in the CharacterPlayerWithCharacterIdResponseData model.",
3859
- "optional": false,
3860
- "type": "string",
3861
- "gnType": "String",
3862
- "conditions": {}
3863
- },
3864
- {
3865
- "code": "InfoResponseParameters",
3866
- "description": "InfoResponseParameters field used in the CharacterPlayerWithCharacterIdResponseData model.",
3867
- "optional": false,
3868
- "type": "InfoResponseParameters",
3869
- "gnType": "GNHashtable",
3870
- "conditions": {}
3871
- }
3872
- ],
3873
- "description": "Data model for CharacterPlayerWithCharacterIdResponseData."
3874
- },
3875
- {
3876
- "name": "CharacterPlayerLeaderboardResponseData",
3877
- "details": [
3878
- {
3879
- "code": "Position",
3880
- "description": "The character’s rank or position on the leaderboard.",
3881
- "optional": false,
3882
- "type": "number",
3883
- "gnType": "Number",
3884
- "conditions": {}
3885
- },
3886
- {
3887
- "code": "BackupValue",
3888
- "description": "BackupValue field used in the CharacterPlayerLeaderboardResponseData model.",
3889
- "optional": true,
3890
- "type": "number",
3891
- "gnType": "Number",
3892
- "conditions": {}
3893
- },
3894
- {
3895
- "code": "CharacterId",
3896
- "description": "CharacterId field used in the CharacterPlayerLeaderboardResponseData model.",
3897
- "optional": false,
3898
- "type": "string",
3899
- "gnType": "String",
3900
- "conditions": {}
3901
- },
3902
- {
3903
- "code": "InfoResponseParameters",
3904
- "description": "InfoResponseParameters field used in the CharacterPlayerLeaderboardResponseData model.",
3905
- "optional": false,
3906
- "type": "InfoResponseParameters",
3907
- "gnType": "GNHashtable",
3908
- "conditions": {}
3909
- }
3910
- ],
3911
- "description": "Data model for CharacterPlayerLeaderboardResponseData."
3912
- },
3913
- {
3914
- "name": "CharacterPlayerLogResponseData",
3915
- "details": [
3916
- {
3917
- "code": "CharacterId",
3918
- "description": "CharacterId field used in the CharacterPlayerLogResponseData model.",
3919
- "optional": false,
3920
- "type": "string",
3921
- "gnType": "String",
3922
- "conditions": {}
3923
- },
3924
- {
3925
- "code": "TsCreate",
3926
- "description": "TsCreate field used in the CharacterPlayerLogResponseData model.",
3927
- "optional": false,
3928
- "type": "number",
3929
- "gnType": "Number",
3930
- "conditions": {}
3931
- },
3932
- {
3933
- "code": "Log",
3934
- "description": "Log field used in the CharacterPlayerLogResponseData model.",
3935
- "optional": false,
3936
- "type": "string",
3937
- "gnType": "String",
3938
- "conditions": {}
3939
- },
3940
- {
3941
- "code": "Key",
3942
- "description": "The name or identifier of the entry.",
3943
- "optional": false,
3944
- "type": "string",
3945
- "gnType": "String",
3946
- "conditions": {}
3947
- },
3948
- {
3949
- "code": "Amount",
3950
- "description": "Amount field used in the CharacterPlayerLogResponseData model.",
3951
- "optional": false,
3952
- "type": "number",
3953
- "gnType": "Number",
3954
- "conditions": {}
3955
- },
3956
- {
3957
- "code": "StartValue",
3958
- "description": "StartValue field used in the CharacterPlayerLogResponseData model.",
3959
- "optional": false,
3960
- "type": "number",
3961
- "gnType": "Number",
3962
- "conditions": {}
3963
- },
3964
- {
3965
- "code": "FinalValue",
3966
- "description": "FinalValue field used in the CharacterPlayerLogResponseData model.",
3967
- "optional": false,
3968
- "type": "number",
3969
- "gnType": "Number",
3970
- "conditions": {}
3971
- }
3972
- ],
3973
- "description": "Data model for CharacterPlayerLogResponseData."
3974
- },
3975
- {
3976
- "name": "GetStatisticsLeaderboardResponseData",
3977
- "details": [
3978
- {
3979
- "code": "Results",
3980
- "description": "Results field used in the GetStatisticsLeaderboardResponseData model.",
3981
- "optional": false,
3982
- "type": "CharacterPlayerLeaderboardResponseData",
3983
- "gnType": "GNArray",
3984
- "conditions": {}
3985
- },
3986
- {
3987
- "code": "TsCreate",
3988
- "description": "TsCreate field used in the GetStatisticsLeaderboardResponseData model.",
3989
- "optional": true,
3990
- "type": "number",
3991
- "gnType": "Number",
3992
- "conditions": {}
3993
- }
3994
- ],
3995
- "description": "Data model for GetStatisticsLeaderboardResponseData."
3996
- },
3997
- {
3998
- "name": "CharacterPlayersWithCharacterIdResponseData",
3999
- "details": [
4000
- {
4001
- "code": "Results",
4002
- "description": "Results field used in the CharacterPlayersWithCharacterIdResponseData model.",
4003
- "optional": false,
4004
- "type": "CharacterPlayerWithCharacterIdResponseData",
4005
- "gnType": "GNArray",
4006
- "conditions": {}
4007
- }
4008
- ],
4009
- "description": "Data model for CharacterPlayersWithCharacterIdResponseData."
4010
- },
4011
- {
4012
- "name": "GetCurrencyLeaderboardResponseData",
4013
- "details": [
4014
- {
4015
- "code": "Results",
4016
- "description": "Results field used in the GetCurrencyLeaderboardResponseData model.",
4017
- "optional": false,
4018
- "type": "CharacterPlayerLeaderboardResponseData",
4019
- "gnType": "GNArray",
4020
- "conditions": {}
4021
- }
4022
- ],
4023
- "description": "Data model for GetCurrencyLeaderboardResponseData."
4024
- },
4025
- {
4026
- "name": "GetCreateLeaderboardResponseData",
4027
- "details": [
4028
- {
4029
- "code": "Results",
4030
- "description": "Results field used in the GetCreateLeaderboardResponseData model.",
4031
- "optional": false,
4032
- "type": "CharacterPlayerLeaderboardResponseData",
4033
- "gnType": "GNArray",
4034
- "conditions": {}
4035
- }
4036
- ],
4037
- "description": "Contains a list of leaderboard entries and paging metadata."
4038
- },
4039
- {
4040
- "name": "GetLastLoginLeaderboardResponseData",
4041
- "details": [
4042
- {
4043
- "code": "Results",
4044
- "description": "Results field used in the GetLastLoginLeaderboardResponseData model.",
4045
- "optional": false,
4046
- "type": "CharacterPlayerLeaderboardResponseData",
4047
- "gnType": "GNArray",
4048
- "conditions": {}
4049
- }
4050
- ],
4051
- "description": "Data model for GetLastLoginLeaderboardResponseData."
4052
- },
4053
- {
4054
- "name": "GetStatisticsLogResponseData",
4055
- "details": [
4056
- {
4057
- "code": "Results",
4058
- "description": "Results field used in the GetStatisticsLogResponseData model.",
4059
- "optional": false,
4060
- "type": "CharacterPlayerLogResponseData",
4061
- "gnType": "GNArray",
4062
- "conditions": {}
4063
- },
4064
- {
4065
- "code": "Token",
4066
- "description": "Token field used in the GetStatisticsLogResponseData model.",
4067
- "optional": true,
4068
- "type": "string",
4069
- "gnType": "String",
4070
- "conditions": {}
4071
- }
4072
- ],
4073
- "description": "Data model for GetStatisticsLogResponseData."
4074
- },
4075
- {
4076
- "name": "GetCurrencyLogResponseData",
4077
- "details": [
4078
- {
4079
- "code": "Results",
4080
- "description": "Results field used in the GetCurrencyLogResponseData model.",
4081
- "optional": false,
4082
- "type": "CharacterPlayerLogResponseData",
4083
- "gnType": "GNArray",
4084
- "conditions": {}
4085
- },
4086
- {
4087
- "code": "Token",
4088
- "description": "Token field used in the GetCurrencyLogResponseData model.",
4089
- "optional": true,
4090
- "type": "string",
4091
- "gnType": "String",
4092
- "conditions": {}
4093
- }
4094
- ],
4095
- "description": "Data model for GetCurrencyLogResponseData."
4096
- },
4097
- {
4098
- "name": "EmptyResponseData",
4099
- "details": [],
4100
- "description": "Data model for EmptyResponseData."
4101
- }
4102
- ],
4103
- "description": "API requests related to character-level actions, including inventory, groups, friends, and statistics."
4104
- }