@xmobitea/gn-server/apiReferences/Inventory.json

GearN Server by XmobiTea (Pro)

{"requestType":"Inventory","operations":[{"operationCode":"AddSegment","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}},{"code":"Value","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":6,"maxLength":32}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]}],"description":""},{"operationCode":"ChangeItemStatistics","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}},{"code":"ItemStatistics","description":"","optional":false,"type":"ItemStatisticsParam","gnType":"GNArray","conditions":{"mustNonNull":true,"minLength":1,"maxLength":32}},{"code":"Log","description":"","optional":true,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":1,"maxLength":256}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"GetAmount","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"GetAvatar","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"GetCatalogId","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"GetClassId","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"GetCreateLeaderboard","details":[{"role":"Client","requestData":[{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}},{"code":"Skip","description":"","optional":true,"type":"number","gnType":"Number","defaultValue":"0","conditions":{"mustInt":true,"minValue":0}},{"code":"Limit","description":"","optional":true,"type":"number","gnType":"Number","defaultValue":"10","conditions":{"mustInt":true,"minValue":1,"maxValue":100}},{"code":"LoadFromCache","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"true","conditions":{}}]}],"responseData":[{"code":"ErrorCode","value":["Ok"]},{"code":"Results"}],"description":""},{"operationCode":"GetCustomData","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}},{"code":"CustomDataKeys","description":"","optional":true,"type":"string","gnType":"GNArray","conditions":{}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"GetDisplayName","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"GetItemData","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}},{"code":"ItemDataKeys","description":"","optional":true,"type":"string","gnType":"GNArray","conditions":{}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"GetItemInformation","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"GetItemStatistics","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}},{"code":"StatisticsKeys","description":"","optional":true,"type":"string","gnType":"GNArray","conditions":{}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"GetItemsWithDisplayName","details":[{"role":"Client","requestData":[{"code":"Keyword","description":"","optional":false,"type":"string","gnType":"String","conditions":{"minLength":2,"maxLength":32}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}},{"code":"Skip","description":"","optional":true,"type":"number","gnType":"Number","defaultValue":"0","conditions":{"mustInt":true,"minValue":0}},{"code":"Limit","description":"","optional":true,"type":"number","gnType":"Number","defaultValue":"10","conditions":{"mustInt":true,"minValue":1,"maxValue":100}}]}],"responseData":[{"code":"ErrorCode","value":["Ok"]},{"code":"Results"}],"description":""},{"operationCode":"GetItemsWithSegment","details":[{"role":"Client","requestData":[{"code":"Value","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":2,"maxLength":32}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}},{"code":"Skip","description":"","optional":true,"type":"number","gnType":"Number","defaultValue":"0","conditions":{"mustInt":true,"minValue":0}},{"code":"Limit","description":"","optional":true,"type":"number","gnType":"Number","defaultValue":"10","conditions":{"mustInt":true,"minValue":1,"maxValue":100}}]}],"responseData":[{"code":"ErrorCode","value":["Ok"]},{"code":"Results"}],"description":""},{"operationCode":"GetItemsWithTag","details":[{"role":"Client","requestData":[{"code":"Key","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":2,"maxLength":32}},{"code":"Value","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":2,"maxLength":32}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}},{"code":"Skip","description":"","optional":true,"type":"number","gnType":"Number","defaultValue":"0","conditions":{"mustInt":true,"minValue":0}},{"code":"Limit","description":"","optional":true,"type":"number","gnType":"Number","defaultValue":"10","conditions":{"mustInt":true,"minValue":1,"maxValue":100}}]}],"responseData":[{"code":"ErrorCode","value":["KeyNotFound","Ok"]},{"code":"Results"}],"description":""},{"operationCode":"GetItemType","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"GetOwner","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"GetRemoveStatus","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"GetSegment","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"GetStatisticsLeaderboardAroundItem","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}},{"code":"Key","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":2,"maxLength":32}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}},{"code":"Skip","description":"","optional":true,"type":"number","gnType":"Number","defaultValue":"0","conditions":{"mustInt":true,"minValue":0}},{"code":"Limit","description":"","optional":true,"type":"number","gnType":"Number","defaultValue":"10","conditions":{"mustInt":true,"minValue":1,"maxValue":100}},{"code":"LoadFromCache","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"true","conditions":{}},{"code":"CatalogId","description":"","optional":true,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":2,"maxLength":32}}]}],"responseData":[{"code":"ErrorCode","value":["KeyNotFound","Ok"]},{"code":"Results"}],"description":""},{"operationCode":"GetStatisticsLeaderboard","details":[{"role":"Client","requestData":[{"code":"Key","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":2,"maxLength":32}},{"code":"InfoRequestParam","description":"","optional":false,"type":"InfoRequestParam","gnType":"GNHashtable","conditions":{"mustNonNull":true}},{"code":"Skip","description":"","optional":true,"type":"number","gnType":"Number","defaultValue":"0","conditions":{"mustInt":true,"minValue":0}},{"code":"Limit","description":"","optional":true,"type":"number","gnType":"Number","defaultValue":"10","conditions":{"mustInt":true,"minValue":1,"maxValue":100}},{"code":"LoadFromCache","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"true","conditions":{}},{"code":"Version","description":"","optional":true,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":2,"maxLength":32}},{"code":"CatalogId","description":"","optional":true,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":2,"maxLength":32}}]}],"responseData":[{"code":"ErrorCode","value":["KeyNotFound","VersionInvalid","Ok"]},{"code":"Results"},{"code":"TsCreate"}],"description":""},{"operationCode":"GetStatisticsLog","details":[{"role":"Client","requestData":[{"code":"Keys","description":"","optional":true,"type":"string","gnType":"GNArray","conditions":{"mustNonNull":true,"minLength":1,"maxLength":32}},{"code":"ItemId","description":"","optional":true,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}},{"code":"Limit","description":"","optional":true,"type":"number","gnType":"Number","defaultValue":"10","conditions":{"mustInt":true,"minValue":1,"maxValue":100}},{"code":"Token","description":"","optional":true,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":24,"maxLength":24}}]}],"responseData":[{"code":"ErrorCode","value":["Ok"]},{"code":"Results"},{"code":"Token"}],"description":""},{"operationCode":"GetTag","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}},{"code":"TagKeys","description":"","optional":false,"type":"string","gnType":"GNArray","conditions":{}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"GetTsCreate","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"RemoveSegment","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}},{"code":"Value","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":2,"maxLength":32}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]}],"description":""},{"operationCode":"RemoveTag","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}},{"code":"Key","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":2,"maxLength":32}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]}],"description":""},{"operationCode":"SetAmount","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}},{"code":"Amount","description":"","optional":false,"type":"number","gnType":"Number","conditions":{"mustInt":true}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","ItemNotStackable","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"SetAvatar","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}},{"code":"Type","description":"","optional":false,"type":"number","gnType":"Number","conditions":{"mustInt":true}},{"code":"Value","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":1,"maxLength":128}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]}],"description":""},{"operationCode":"SetCustomData","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}},{"code":"CustomDatas","description":"","optional":false,"type":"CustomDataParam","gnType":"GNArray","conditions":{"mustNonNull":true,"minLength":1,"maxLength":32}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"SetDisplayName","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}},{"code":"DisplayName","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":5,"maxLength":32}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]}],"description":""},{"operationCode":"SetItemData","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}},{"code":"ItemDatas","description":"","optional":false,"type":"ItemDataParam","gnType":"GNArray","conditions":{"mustNonNull":true,"minLength":1,"maxLength":32}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]},{"code":"InfoResponseParameters"}],"description":""},{"operationCode":"SetOwner","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":11,"maxLength":11}},{"code":"NewOwnerId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":10,"maxLength":12}},{"code":"NewOwnerType","description":"","optional":false,"type":"number","gnType":"Number","conditions":{"mustInt":true}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","OwnerNotFound","OwnerTypeNotSupport","Ok"]}],"description":""},{"operationCode":"SetRemoveStatus","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}},{"code":"Reason","description":"","optional":true,"type":"string","gnType":"String","defaultValue":"\"\"","conditions":{}}]}],"responseData":[{"code":"ErrorCode","value":["ItemNotFound","Ok"]}],"description":""},{"operationCode":"SetTag","details":[{"role":"Client","requestData":[{"code":"ItemId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":12,"maxLength":12}},{"code":"Key","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":2,"maxLength":32}},{"code":"Value","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"minLength":2,"maxLength":32}}]}],"responseData":[{"code":"ErrorCode","value":["KeyNotFound","ItemNotFound","Ok"]}],"description":""}],"models":[{"name":"CustomDataParam","details":[{"code":"Key","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"mustInt":false,"minLength":2,"maxLength":32}},{"code":"Value","description":"","optional":false,"type":"any","gnType":"DataMember","conditions":{"mustNonNull":false,"mustInt":false}}]},{"name":"InfoRequestParam","details":[{"code":"CatalogId","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"ClassId","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"ItemType","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"Amount","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"Owner","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"RemoveStatus","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"Segments","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"CustomDatas","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"DisplayName","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"Avatar","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"TsCreate","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"Tags","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"ItemStatistics","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"ItemDatas","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"ItemDataKeys","description":"","optional":true,"type":"string","gnType":"GNArray","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"ItemStatisticsKeys","description":"","optional":true,"type":"string","gnType":"GNArray","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"CustomDataKeys","description":"","optional":true,"type":"string","gnType":"GNArray","conditions":{"mustNonNull":false,"mustInt":false}},{"code":"TagKeys","description":"","optional":true,"type":"string","gnType":"GNArray","conditions":{"mustNonNull":false,"mustInt":false}}]},{"name":"ItemDataParam","details":[{"code":"Key","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"mustInt":false,"minLength":2,"maxLength":32}},{"code":"Value","description":"","optional":false,"type":"any","gnType":"DataMember","conditions":{"mustNonNull":false,"mustInt":false}}]},{"name":"ItemStatisticsParam","details":[{"code":"Key","description":"","optional":false,"type":"string","gnType":"String","conditions":{"mustNonNull":true,"mustInt":false,"minLength":2,"maxLength":32}},{"code":"Value","description":"","optional":false,"type":"number","gnType":"Number","conditions":{"mustNonNull":false,"mustInt":false}}]}]}