Joueurs

Liste Joueurs

Renvoie les personnages du serveur avec leur id et les informations stockées.

RequĂȘte

URL : /api/v1/players

MĂ©thode : GET

Autorisation Requise : Oui

ParamĂȘtres de RequĂȘte

NomTypeDescriptionRequisPar DĂ©faut
pageintDécalage des joueurs en numéro de page:heavy_minus_sign:0
pageSizeintNombre de joueurs par page:heavy_minus_sign:5
limitintLimite du nombre de joueurs renvoyés:heavy_minus_sign:pageSize

Exemple

GET /api/v1/players?page=1&pageSize=5

RĂ©ponse

Status Code: 200 OK
Content-Type: application/json; charset=utf-8
{
    "Total": 151,
    "Page": 1,
    "PageSize": 5,
    "Count": 5,
    "Values": [
        {"Name": "Kassie", "InBank": false, "UserId": "08d655ec-fbdf-aac6-0d22-408e20479301", "MaxVitals":[500,
},
        {"Name": "Euzinho", "InBank": false, "UserId": "08d6c8b4-e33f-feb8-67eb-197306686578", "MaxVitals":[500,
},
        {"Name": "bob", "InBank": false, "UserId": "2662c500-0f7f-479c-b6b0-c51042258d87", "MaxVitals":[500,
},
        {"Name": "Beatz", "InBank": false, "UserId": "08d65649-b98e-9d0a-e0f1-8ba43edb34e2", "MaxVitals":[500,
},
        {"Name": "test1658", "InBank": false, "UserId": "08d64d4a-e86e-d4f8-0c0a-3c6759c5a3f6", "MaxVitals":[500,
}
    ]
}

Rang Joueurs

Renvoie les personnages du serveur avec leur id et les informations stockées, classés par leur Niveau et leur Expérience.

RequĂȘte

URL : /api/v1/players/rank

MĂ©thode : GET

Autorisation Requise : Oui

ParamĂȘtres de RequĂȘte

NomTypeDescriptionRequisPar DĂ©faut
pageintDécalage des joueurs en numéro de page:heavy_minus_sign:0
pageSizeintNombre de joueurs par page:heavy_minus_sign:5
limitintLimite du nombre de joueurs renvoyés:heavy_minus_sign:pageSize
sortDirectionAscending/Descendingdirection de classement:heavy_minus_sign:Descending

Exemple

GET /api/v1/players/rank?page=1&pageSize=5&sortDirection=Descending

RĂ©ponse

Status Code: 200 OK
Content-Type: application/json; charset=utf-8
{
    "Total": 151,
    "Page": 1,
    "PageSize": 5,
    "Count": 5,
    "Values": [
        {"Name": "Kassie", "InBank": false, "UserId": "08d655ec-fbdf-aac6-0d22-408e20479301", "MaxVitals":[500,
},
        {"Name": "Beatz", "InBank": false, "UserId": "08d65649-b98e-9d0a-e0f1-8ba43edb34e2", "MaxVitals":[500,
},
        {"Name": "bob", "InBank": false, "UserId": "2662c500-0f7f-479c-b6b0-c51042258d87", "MaxVitals":[500,
},
        {"Name": "Euzinho", "InBank": false, "UserId": "08d6c8b4-e33f-feb8-67eb-197306686578", "MaxVitals":[500,
},
        {"Name": "test1658", "InBank": false, "UserId": "08d64d4a-e86e-d4f8-0c0a-3c6759c5a3f6", "MaxVitals":[500,
}
    ]
}

Liste Joueurs En Ligne

Renvoie les personnages en ligne du serveur avec leur id et les informations stockées.

RequĂȘte

URL : /api/v1/players/online

MĂ©thode : POST

Autorisation Requise : Oui

Type Contenus : application/json

Corps

NomTypeDescriptionRequis
pageintPage de personnages à récupérer.:heavy_minus_sign:
countintNombre de personnages à récupérer.:heavy_minus_sign:

Exemple

{
	"page": 0,
	"count": 5
}

RĂ©ponse

Condition : NA

Code : 200 OK

Exemple

{
    "total": 1,
    "Page": 0,
    "count": 1,
    "entries":[
        {"Name": "jcsnider", "InBank": false, "UserId": "cf995c16-8c2e-4ab3-a5b8-a39d6051adc6", "MaxVitals":[680,
}
    ]
}

L’exemple est tronquĂ©, pour une rĂ©ponse complĂšte cliquez ici.

Comptes En Ligne

Renvoie le nombre de joueurs en ligne.

RequĂȘte

URL : /api/v1/players/online/count

MĂ©thode : GET

Autorisation Requise : Oui

Type Contenus : NA

Corps : NA

RĂ©ponse

Condition : NA

Code : 200 OK

Exemple

{
	"onlineCount": 1
}

Recherche

Renvoie les personnages en ligne du serveur avec leur id et les informations stockées.

RequĂȘte

URL : /api/v1/players/[lookupKey]

Clé de Recherche: Character's name or id.

MĂ©thode : GET

Autorisation Requise : Yes

Type Contenus : NA

Corps : NA

RĂ©ponse

Condition : NA

Code : 200 OK

Exemple

{
    "Name": "jcsnider",
    "InBank": false,
    "UserId": "cf995c16-8c2e-4ab3-a5b8-a39d6051adc6",
    "MaxVitals":[
        680,
        110
    ],
    ...
}

L’exemple est tronquĂ©, pour une rĂ©ponse complĂšte cliquez ici.

Obtention Variables

Renvoie les variables joueurs et leur valeur pour un personnage.

RequĂȘte

URL : /api/v1/players/[lookupKey]/variables

Clé de Recherche: Character's name or id.

MĂ©thode : GET

Autorisation Requise : Oui

Type Contenus : NA

Corps : NA

RĂ©ponse

Condition : NA

Code : 200 OK

Exemple

[
	{
		"VariableId": "d6f5b6b9-6de9-4893-b028-0c8c386ee05c",
		"Value": true
	},
	{
		"VariableId": "873270c0-924e-467b-b881-a97e2ab92858",
		"Value": 5
	}
]

Obtention Variable

Renvoie une variable joueur et sa valeur pour l’id d’une variable joueur donnĂ©e.

RequĂȘte

URL : /api/v1/players/[lookupKey]/variables/[variableId]

Clé de Recherche: Character's name or id.

MĂ©thode : GET

Autorisation Requise : Oui

Type Contenus : NA

Corps : NA

RĂ©ponse

Condition : NA

Code : 200 OK

Exemple

{
	"VariableId": "d6f5b6b9-6de9-4893-b028-0c8c386ee05c",
	"Value": true
}

Obtention Valeur Variable

Retrieves player variable value for a given player variable id.

RequĂȘte

URL : /api/v1/players/[lookupKey]/variables/[variableId]/value

Clé de Recherche: Character's name or id.

MĂ©thode : GET

Autorisation Requise : Oui

Type Contenus : NA

Corps : NA

RĂ©ponse

Condition : NA

Code : 200 OK

Exemple

{
	"value": true
}

DĂ©finir Valeur Variable

DĂ©fini la valeur d’une variable joueur.

RequĂȘte

URL : /api/v1/players/[lookupKey]/variables/[variableId]

Clé de Recherche: Character's name or id.

MĂ©thode : POST

Autorisation Requise : Oui

Type Contenus : application/json

Corps

NomTypeDescriptionRequis
valueint or booleanValeur désirée de la variable.:heavy_check_mark:

Exemple

{
	"value": 10
}

RĂ©ponse

Condition : NA

Code : 200 OK

Exemple

{
	"VariableId": "d6f5b6b9-6de9-4893-b028-0c8c386ee05c",
	"Value": 10
}

Obtention Objets

Renvoie les objets d’inventaire et de banque pour un joueur.

RequĂȘte

URL : /api/v1/players/[lookupKey]/items

Clé de Recherche: Character's name or id.

MĂ©thode : GET

Autorisation Requise : Oui

Type Contenus : NA

Corps : NA

RĂ©ponse

Condition : NA

Code : 200 OK

Exemple

{
	"inventory": [
		{
			"Slot": 22,
			"BagId": null,
			"ItemId": "1b19803a-6c28-484f-95fe-9c99f967d73f",
			"Quantity": 1,
			"StatBuffs": [0, 0, 0, 0, 0]
		},
		{
			"Slot": 15,
			"BagId": "08d649a8-643f-1bde-0487-3175a8badde2",
			"ItemId": "bda7b222-b549-4e95-982f-cc04e680471e",
			"Quantity": 1,
			"StatBuffs": [0, 0, 0, 0, 0]
		}
	],
	"bank": [
		{
			"Slot": 87,
			"BagId": null,
			"ItemId": "00000000-0000-0000-0000-000000000000",
			"Quantity": 0,
			"StatBuffs": [0, 0, 0, 0, 0]
		},
		{
			"Slot": 91,
			"BagId": null,
			"ItemId": "00000000-0000-0000-0000-000000000000",
			"Quantity": 0,
			"StatBuffs": [0, 0, 0, 0, 0]
		}
	]
}

Obtenir Objets Inventaire

Renvoie les objets de l’inventaire pour un joueur.

RequĂȘte

URL : /api/v1/players/[lookupKey]/items/inventory

Clé de Recherche: Character's name or id.

MĂ©thode : GET

Autorisation Requise : Oui

Type Contenus : NA

Corps : NA

RĂ©ponse

Condition : NA

Code : 200 OK

Exemple

[
	{
		"Slot": 22,
		"BagId": null,
		"ItemId": "1b19803a-6c28-484f-95fe-9c99f967d73f",
		"Quantity": 1,
		"StatBuffs": [0, 0, 0, 0, 0]
	},
	{
		"Slot": 15,
		"BagId": "08d649a8-643f-1bde-0487-3175a8badde2",
		"ItemId": "bda7b222-b549-4e95-982f-cc04e680471e",
		"Quantity": 1,
		"StatBuffs": [0, 0, 0, 0, 0]
	}
]

Obtenir Objets Banque

Renvoie les objets en banque pour un joueur.

RequĂȘte

URL : /api/v1/players/[lookupKey]/items/bank

Clé de Recherche: Character's name or id.

MĂ©thode : GET

Autorisation Requise : Yes

Type Contenus : NA

Corps : NA

RĂ©ponse

Condition : NA

Code : 200 OK

Exemple

[
	{
		"Slot": 87,
		"BagId": null,
		"ItemId": "00000000-0000-0000-0000-000000000000",
		"Quantity": 0,
		"StatBuffs": [0, 0, 0, 0, 0]
	},
	{
		"Slot": 91,
		"BagId": null,
		"ItemId": "00000000-0000-0000-0000-000000000000",
		"Quantity": 0,
		"StatBuffs": [0, 0, 0, 0, 0]
	}
]

Obtenir Informations Sac

Renvoie objets stockĂ©es et donnĂ©es meta d’un sac.

RequĂȘte

URL : /api/v1/players/bag/[bagId]

MĂ©thode : GET

Autorisation Requise : Yes

Type Contenus : NA

Corps : NA

RĂ©ponse

Condition : NA

Code : 200 OK

Exemple

{
	"Id": "08d649a8-643f-1bde-0487-3175a8badde2",
	"SlotCount": 3,
	"Slots": [
		{
			"Slot": 0,
			"BagId": null,
			"ItemId": "be82ae1a-0c50-40c8-a929-7d55335467fc",
			"Quantity": 10,
			"StatBuffs": [0, 0, 0, 0, 0]
		},
		{
			"Slot": 1,
			"BagId": null,
			"ItemId": "0d06aeef-b040-4048-8a85-2821144cc99b",
			"Quantity": 1,
			"StatBuffs": [0, 0, 0, 0, 0]
		},
		{
			"Slot": 2,
			"BagId": null,
			"ItemId": "0d06aeef-b040-4048-8a85-2821144cc99b",
			"Quantity": 1,
			"StatBuffs": [0, 0, 0, 0, 0]
		}
	]
}

Donner Objet

Donne un objet à un joueur avec l’option de transposer à la banque de joueur si leur inventaire est plein.

RequĂȘte

URL : /api/v1/players/[lookupKey]/items/give

Clé de Recherche: Character's name or id.

MĂ©thode : POST

Autorisation Requise : Oui

Type Contenus : application/json

Corps

NomTypeDescriptionRequis
itemidguidId de l’objet à donner.:heavy_check_mark:
quantityintQuantitĂ© de l’objet Ă  donner.:heavy_check_mark:
bankoverflowbooleansi il faut tenter ou non de transposer à la banque si l’inventaire est plein.:heavy_minus_sign:

Exemple

{
	"itemid": "be82ae1a-0c50-40c8-a929-7d55335467fc",
	"quantity": 5,
	"bankoverflow": false
}

RĂ©ponse

Condition : Quand l’(les) objet(s) sont donnĂ©s avec succĂšs, retourne le compte des objets de l’inventaire et de la banque du joueur.

Code : 200 OK

Exemple

{
	"id": "be82ae1a-0c50-40c8-a929-7d55335467fc",
	"quantity": {
		"total": 311,
		"bank": 5,
		"inventory": 306
	}
}

Prendre Objet

Prend un objet de l’inventaire d’un joueur.

RequĂȘte

URL : /api/v1/players/[lookupKey]/items/take

Clé de Recherche: Character's name or id.

MĂ©thode : POST

Autorisation Requise : Yes

Type Contenus : application/json

Corps

NomTypeDescriptionRequis
itemidguidId de l’objet à prendre.:heavy_check_mark:
quantityintQuantitĂ© de l’objet Ă  prendre.:heavy_check_mark:

Exemple

{
	"itemid": "be82ae1a-0c50-40c8-a929-7d55335467fc",
	"quantity": 5
}

RĂ©ponse

Condition : Quand l’(les) objet(s) est(sont) pris avec succĂšs, retourne l’id de l’objet et la quantitĂ© prise.

Code : 200 OK

Exemple

{
	"ItemId": "be82ae1a-0c50-40c8-a929-7d55335467fc",
	"Quantity": 5
}

Obtenir Sorts

Renvoie les sorts connus d’un joueur.

RequĂȘte

URL : /api/v1/players/[lookupKey]/spells

Clé de Recherche: Character's name or id.

MĂ©thode : GET

Autorisation Requise : Oui

Type Contenus : NA

Corps : NA

RĂ©ponse

Condition : NA

Code : 200 OK

Exemple

[
	{
		"Slot": 2,
		"SpellId": "c54378ba-5632-4ad9-a7cf-6ec0b0264b4e"
	}
]

Enseigner Sort

Enseigne un sort Ă  un joueur.

RequĂȘte

URL : /api/v1/players/[lookupKey]/spells/teach

Clé de Recherche: Character's name or id.

MĂ©thode : POST

Autorisation Requise : Oui

Type Contenus : application/json

Corps

NomTypeDescriptionRequis
spellidguidId du sort Ă  enseigner.:heavy_check_mark:

Exemple

{
	"spellid": "c54378ba-5632-4ad9-a7cf-6ec0b0264b4e"
}

RĂ©ponse

Condition : Le sort a été enseigné avec succÚs.

Code : 200 OK

Exemple

{
	"SpellId": "c54378ba-5632-4ad9-a7cf-6ec0b0264b4e"
}

Oublier sort

Fait oublier un sort Ă  un joueur.

RequĂȘte

URL : /api/v1/players/[lookupKey]/spells/forget

Clé de Recherche: Character's name or id.

MĂ©thode : POST

Autorisation Requise : Yes

Type Contenu : application/json

Corps

NomTypeDescriptionRequis
spellidguidId du sort Ă  oublier.:heavy_check_mark:

Exemple

{
	"spellid": "c54378ba-5632-4ad9-a7cf-6ec0b0264b4e"
}

RĂ©ponse

Condition : Le sort a été oublié avec succÚs.

Code : 200 OK

Exemple

{
	"SpellId": "c54378ba-5632-4ad9-a7cf-6ec0b0264b4e"
}

Liste Joueurs (POST) (ObsolĂšte)

Renvoie les personnages du serveur avec leur id et les informations stockées.

RequĂȘte

URL : /api/v1/players

MĂ©thode : POST

Autorisation Requise : Yes

Type Contenus : application/json

Corps

NomTypeDescriptionRequis
pageintPage de personnages à récupérer.:heavy_minus_sign:
countintNombre de personnages à récupérer.:heavy_minus_sign:

Exemple

{
	"page": 0,
	"count": 5
}

RĂ©ponse

Condition : NA

Code : 200 OK

Exemple

{
    "total": 151,
    "Page": 0,
    "count": 5,
    "entries":[
        {"Name": "Kassie", "InBank": false, "UserId": "08d655ec-fbdf-aac6-0d22-408e20479301", "MaxVitals":[500,
},
        {"Name": "Euzinho", "InBank": false, "UserId": "08d6c8b4-e33f-feb8-67eb-197306686578", "MaxVitals":[500,
},
        {"Name": "bob", "InBank": false, "UserId": "2662c500-0f7f-479c-b6b0-c51042258d87", "MaxVitals":[500,
},
        {"Name": "Beatz", "InBank": false, "UserId": "08d65649-b98e-9d0a-e0f1-8ba43edb34e2", "MaxVitals":[500,
},
        {"Name": "test1658", "InBank": false, "UserId": "08d64d4a-e86e-d4f8-0c0a-3c6759c5a3f6", "MaxVitals":[500,
}
    ]
}

L’exemple est tronquĂ©, pour une rĂ©ponse complĂšte cliquez ici.