Table des matières

API Nooble - Documentation

Détails

Documentation de l'API

Appeler la requête

Request here
Response to request here

Ajouter un compte

Arguments

  • mail
    : l'adresse mail du nouveau compte
  • first_name
    : le prénom du profil de l'utilisateur
  • last_name
    : le nom de famille du profil de l'utilisateur

Valide lorsque

  • aucun compte utilisateur ne contient cette adresse mail

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est un administrateur

Retours

  • new_account
    : l'identifiant du nouvel utilisateur

Exemples

Requête:

{
    "mail": "john.doe@gmail.com",
    "first_name": "John",
    "last_name": "Doe"
}

Réponse:

{
    "new_account": "df94d92e40"
}

Appeler la requête

mail
first_name
last_name
Request here
Response to request here

Supprimer un compte

Arguments

  • user_id
    : identifiant du compte utilisateur

Valide lorsque

  • un compte utilisateur est bien décrit par l'identifiant

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est un administrateur
  • l'administrateur ne tente pas de se supprimer lui-même

Retours

Aucun retour pour cette action

Exemples

Requête:

{
    "user_id": "de62c209a"
}

Réponse:

null

Appeler la requête

user_id
Request here
Response to request here

Accéder aux informations de compte d'un utilisateur.

Arguments

  • user_id
    : l'utilisateur à considérer

Valide lorsque

  • l'identifiant renseigné désigne bien un utilisateur existant

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est un administrateur

Exemples

Requête:

{
    "user_id": "8482f9209deb"
}

Réponse:

{
    "id": "8482f9209deb",
    "profile": {
        "first_name": "John",
        "last_name": "Doe",
        "active_decoration": "3bd8527cf",
        "active_badges": [
            [
                "here_for_long",
                3
            ]
        ],
        "classes": [
            "abc2934",
            "cb293cdb23f",
            "..."
        ],
        "profile_image": "abc837b23",
        "description": "Ssalut toi"
    },
    "role": "admin_teacher",
    "mail": "john.doe@utbm.fr"
}

Appeler la requête

user_id
Request here
Response to request here

Modifier l'adresse courriel d'un compte utilisateur

Arguments

  • user_id
    : identifiant du compte utilisateur
  • mail
    : nouvelle adresse mail à appliquer au compte

Valide lorsque

  • un compte utilisateur est bien décrit par l'identifiant
  • l'adresse n'est pas déjà définie

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est un administrateur

Retours

Aucun retour pour cette action

Exemples

Requête:

{
    "user_id": "de62c209a",
    "mail": "foo.bar@utbm.fr"
}

Réponse:

null

Appeler la requête

user_id
mail
Request here
Response to request here

Modifier le rôle d'un compte

Arguments

  • user_id
    : identifiant du compte utilisateur
  • role
    : role à appliquer au compte

Valide lorsque

  • le rôle est bien un rôle connu (admin, teacher, teacher_admin ou student)
  • un compte utilisateur est bien décrit par l'identifiant

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est un administrateur
  • l'administrateur ne tente pas de modifier son propre rôle

Retours

Aucun retour pour cette action

Exemples

Requête:

{
    "user_id": "de62c209a",
    "role": "teacher_admin"
}

Réponse:

null

Appeler la requête

user_id
role
Request here
Response to request here

Chercher un compte

Arguments

  • pattern
    : le motif à chercher dans le compte
  • count
    : le nombre de comptes à retourner
  • offset
    : le nombre de comptes à ignorer

Valide lorsque

  • le compte est supérieur à 0
  • le nombre de comptes à ignorer est supérieur ou égal à 0

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est un administrateur

Exemples

Requête:

{
    "count": 20,
    "offset": 20,
    "pattern": "ohn"
}

Réponse:

[
    {
        "id": "8482f9209deb",
        "profile": {
            "first_name": "John",
            "last_name": "Doe",
            "active_decoration": "3bd8527cf",
            "active_badges": [
                [
                    "here_for_long",
                    3
                ]
            ],
            "classes": [
                "abc2934",
                "cb293cdb23f",
                "..."
            ],
            "profile_image": "abc837b23",
            "description": "Ssalut toi"
        },
        "role": "admin_teacher",
        "mail": "john.doe@utbm.fr"
    }
]

Appeler la requête

pattern
count
offset
Request here
Response to request here

Mettre à jour son mot de passe

Arguments

  • last_password
    : l'ancien mot de passe
  • new_password
    : le nouveau mot de passe

Valide lorsque

  • le nouveau mot de passe n'est pas vide

Permis lorsque

  • l'utilisateur est connecté
  • l'ancien mot de passe est correct

Retours

Aucun retour pour cette action

Exemples

Requête:

{
    "last_password": "de62c209a",
    "new_password": "J'aimeLeRizAh!EtBootstrapAussi"
}

Réponse:

null

Appeler la requête

last_password
new_password
Request here
Response to request here

Initializer une nouvelle activité

Arguments

  • activity_name
    : le nom de l'activité à initialiser

Valide lorsque

  • le nom d'acitivté désigne bien un activité existante

Permis lorsque

  • l'utilisateur est connecté
  • l'utiliser est un administrateur ou un professeur

Retours

  • new_file
    : l'identifiant du nouveau fichier d'activité
  • css
    : le fichier css de l'activité
  • javascript
    : le fichier javascript en mode lecture de l'activité
  • editable_javascript
    : le fichier javascript en mode écriture de l'áctivité

Exemples

Requête:

{
    "activity_name": "homework"
}

Réponse:

{
    "new_file": "3bd2a7c8bd3",
    "css": "p{color:red}",
    "javascript": "...",
    "editable_javascript": "..."
}

Appeler la requête

activity_name
Request here
Response to request here

Obtenir la liste des activités possibles

Permis lorsque

  • l'utilisateur est connecté

Exemples

Requête:

null

Réponse:

[
    "click-me-button",
    "homework",
    "..."
]

Appeler la requête

Request here
Response to request here
Aucune information disponible pour cette action

Appeler la requête

Request here
Response to request here
Aucune information disponible pour cette action

Appeler la requête

Request here
Response to request here
Aucune information disponible pour cette action

Appeler la requête

Request here
Response to request here
Aucune information disponible pour cette action

Appeler la requête

Request here
Response to request here

Acheter un badge

Arguments

  • name
    : nom du badge

Valide lorsque

  • le nom de badge désigne un badge existant
  • il est possible d'obtenir un nouveau niveau de ce badge
  • l'utilisateur est elligible à ce badge

Permis lorsque

  • l'utilisateur est connecté

Retours

  • new_quota
    : le nombre de nooblards présents dans le porte monnaie après achat
  • new_level
    : le nouveau niveau correspondant au badge acheté (0 pour le premier niveau)

Exemples

Requête:

{
    "name": "here_for_long"
}

Réponse:

{
    "new_quota": 32,
    "new_level": 2
}

Appeler la requête

name
Request here
Response to request here

Obtenir des informations sur un badge

Arguments

  • name
    : nom du badge
  • level
    : niveau du badge

Valide lorsque

  • le nom de badge désigne un badge existant
  • le badge est capable de s'étendre à ce niveau

Permis lorsque

  • l'utilisateur est connecté

Retours

  • max_level
    : le niveau maximum du badge
  • title
    : le titre de ce badge
  • description
    : la description de ce badge
  • price
    : le prix du badge

Exemples

Requête:

{
    "name": "here_for_long",
    "level": 4
}

Réponse:

{
    "max_level": 5,
    "title": "Citizen",
    "description": "You have been here for 10 years",
    "price": 20
}

Appeler la requête

name
level
Request here
Response to request here

Obtenir la vignette d'un badge

Arguments

  • name
    : nom du badge
  • level
    : niveau du badge

Valide lorsque

  • le nom de badge désigne un badge existant
  • le badge est capable de s'étendre à ce niveau

Permis lorsque

  • l'utilisateur est connecté

Appeler la requête

name
level
Request here
Response to request here

Lister les badges disponibles

Permis lorsque

  • l'utilisateur est connecté

Retours

  • reached
    : la liste des badges atteints
  • unreached
    : la liste des badges qui ne peuvent pas encore être achetés

Exemples

Requête:

null

Réponse:

{
    "reached": [
        {
            "name": "here_for_long",
            "level": 3,
            "price": 30,
            "title": "Resident",
            "description": "You have been here for 3 years"
        }
    ],
    "unreached": []
}

Appeler la requête

Request here
Response to request here

Lier un compte à un cours

Arguments

  • user_id
    : identifiant du compte
  • class_id
    : identifiant du cours

Valide lorsque

  • l'identifiant du compte désigne bien un compte existant
  • l'identifiant de la classe désigne bien un cours existante
  • l'utilisateur n'a pas encore accès à ce cours

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est un administrateur

Retours

Aucun retour pour cette action

Exemples

Requête:

{
    "user_id": "cc2b3492",
    "class_id": "c273df84f"
}

Réponse:

null

Appeler la requête

user_id
class_id
Request here
Response to request here

Créer un nouveau cours

Arguments

  • name
    : le nom du nouveau cours
  • description
    : une description brève du contenu du cours

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est un administrateur

Retours

  • new_class
    : l'identifiant du nouveau cours

Exemples

Requête:

{
    "name": "WE4B",
    "description": "Angular Tah les fous"
}

Réponse:

{
    "new_class": "cb264b9c2ef"
}

Appeler la requête

name
description
Request here
Response to request here

Obtenir les informations d'un cours

Arguments

  • class_id
    : l'identifiant du cours

Valide lorsque

  • l'identifiant désigne bien un cours existant

Permis lorsque

  • l'utilisateur est connecté

Retours

  • description
    : la description du cours
  • last_modification
    : l'heure de dernière modification
  • last_modifier
    : l'identifiant du dernier compte ayant modifié le cours
  • name
    : le nom du cours

Exemples

Requête:

{
    "class_id": "fdcb23b428"
}

Réponse:

{
    "description": "Angular",
    "last_modification": 2948759329234,
    "last_modifier": "dbfc327493",
    "name": "WE4B"
}

Appeler la requête

class_id
Request here
Response to request here

Supprimer un ancien cours

Arguments

  • class_id
    : l'identifiant du cours

Valide lorsque

  • l'identifiant désigne bien un cours existant

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est un administrateur

Retours

Aucun retour pour cette action

Exemples

Requête:

{
    "class_id": "fdcb23b428"
}

Réponse:

null

Appeler la requête

class_id
Request here
Response to request here

Modifier les informations d'un cours

Arguments

  • id
    : l'identifiant du cours
  • title
    : le titre du cours
  • description
    : la description du cours
  • content
    : le contenu du cours

Valide lorsque

  • le contenu est défini correctement
  • l'identifiant désigne bien un cours existant

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est un administrateur ou alors
  • l'utilisateur est un enseignant ayant accès à ce cours

Retours

Aucun retour pour cette action

Exemples

Requête:

{
    "id": "fdcb23b428",
    "title": "WE4B",
    "description": "Angular Tah les fou",
    "content": {
        "type": "container",
        "data": {
            "is_horizontal": false,
            "is_wrapping": false,
            "children": [
                "..."
            ]
        }
    }
}

Réponse:

null

Appeler la requête

id
title
description
content
Request here
Response to request here

Obtenir la liste des comptes associés à une classe

Arguments

  • class_id
    : l'identifiant du cours

Valide lorsque

  • l'identifiant désigne bien un cours existant

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est un administrateur ou
  • l'utilisateur a accès à ce cours

Exemples

Requête:

{
    "class_id": "fdcb23b428"
}

Réponse:

[
    "3948f829e",
    "b23bc5783",
    "..."
]

Appeler la requête

class_id
Request here
Response to request here

Obtenir le contenu d'un cours

Arguments

  • class_id
    : l'identifiant du cours

Valide lorsque

  • l'identifiant désigne bien un cours existant

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est un administrateur ou
  • l'utilisateur a accès à ce cours

Retours

  • content
    : le contenu du cours

Exemples

Requête:

{
    "class_id": "fdcb23b428"
}

Réponse:

{
    "content": {
        "type": "section",
        "data": "..."
    }
}

Appeler la requête

class_id
Request here
Response to request here

Dissocier un compte d'un cours

Arguments

  • class_id
    : l'identifiant du cours
  • user_id
    : l'identifiant de l'utilisateur

Valide lorsque

  • l'identifiant désigne bien un cours existant

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est un administrateur ou
  • l'utilisateur a accès à ce cours

Retours

Aucun retour pour cette action

Exemples

Requête:

{
    "user_id": "cc2b3492",
    "class_id": "c273df84f"
}

Réponse:

null

Appeler la requête

class_id
user_id
Request here
Response to request here

Chercher un cours

Arguments

  • pattern
    : le motif à chercher dans le cours
  • count
    : le nombre de cours à retourner
  • offset
    : le nombre de cours à ignorer

Valide lorsque

  • le compte est supérieur à 0
  • le nombre de cours à ignorer est supérieur ou égal à 0

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est un administrateur

Exemples

Requête:

{
    "count": 20,
    "offset": 20,
    "pattern": "gula"
}

Réponse:

[
    {
        "id": "bcdf284879c8d2",
        "content": {
            "type": "section",
            "data": "..."
        },
        "description": "Angular",
        "last_modification": 2948759329234,
        "last_modifier": "dbfc327493",
        "name": "WE4B"
    }
]

Appeler la requête

pattern
count
offset
Request here
Response to request here

Restaurer son mot de passe et envoyer le nouveau mot de passe par mail. Cette URL permet de définir un nouveau mot de passe pour le compte et de l'envoyer par mail à l'utilisateur. Cette option est une faille de sécurité car elle ne vérifie pas l'identité de l'utilisateur avant de modifier son mot de passe. L'idéal aurait été d'envoyer un lien de modification par mail au preálable, mais le temps a été cours et cette option n'est pas nécessaire à petite échelle.

Arguments

  • username
    : l'adresse mail du compte

Valide lorsque

  • il existe bien un compte possédant cette adresse mail

Permis lorsque

  • l'utilisateur n'est pas connecté

Retours

  • first_name
    : le prénom du compte
  • last_name
    : le nom de famille du compte

Exemples

Requête:

{
    "username": "john.doe@utbm.fr"
}

Réponse:

{
    "first_name": "John",
    "last_name": "Doe"
}

Appeler la requête

username
Request here
Response to request here

Obtenir des informations de connection

Retours

  • connected
    : vrai lorsque l'utilisateur est connecté
  • account
    : si connecté, les informations de compte

Exemples

Requête:

null

Réponse:

{
    "connected": true,
    "account": {
        "id": "8482f9209deb",
        "profile": {
            "first_name": "John",
            "last_name": "Doe",
            "active_decoration": "3bd8527cf",
            "active_badges": [
                [
                    "here_for_long",
                    3
                ]
            ],
            "classes": [
                "abc2934",
                "cb293cdb23f",
                "..."
            ],
            "profile_image": "abc837b23",
            "description": "Ssalut toi"
        },
        "safe": {
            "quota": 30,
            "decorations": [
                "3bd8527cf",
                "8cab2940c3d"
            ],
            "badges": [
                [
                    "here_for_long",
                    30
                ],
                [
                    "...",
                    394
                ],
                "..."
            ]
        },
        "role": "admin_teacher",
        "mail": "john.doe@utbm.fr"
    }
}

Appeler la requête

Request here
Response to request here

Se connecter

Arguments

  • username
    : l'adresse mail du compte
  • password
    : le mot de passe

Permis lorsque

  • l'utilisateur n'est pas connecté

Retours

  • first_name
    : le prénom du compte
  • last_name
    : le nom de famille du compte

Exemples

Requête:

{
    "username": "john.doe@utbm.fr"
}

Réponse:

{
    "first_name": "John",
    "last_name": "Doe"
}

Appeler la requête

username
password
Request here
Response to request here

Se déconnecter

Permis lorsque

  • l'utilisateur est connecté

Retours

Aucun retour pour cette action

Appeler la requête

Request here
Response to request here

Acheter une décoration

Arguments

  • decoration
    : l'identifiant de la décoration

Valide lorsque

  • l'identifiant de la décoration est bien valide
  • la décoration n'est pas encore présente dans le coffre-fort

Permis lorsque

  • l'utilisateur est connecté

Retours

  • new_quota
    : le nouveau solde de nooblards

Exemples

Requête:

{
    "decoration": "b279d810d9f"
}

Réponse:

{
    "new_quota": 40
}

Appeler la requête

decoration
Request here
Response to request here

Créer une nouvelle décoration

Arguments

  • name
    : le nom de la décoration
  • price
    : le prix de la décoration
  • image_id
    : l'identifiant de l'image de la décoration

Valide lorsque

  • l'image de décoration existe
  • l'image est bien une image de décoration

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est un administrateur
  • l'utilisateur est le propriétaire de l'image

Retours

  • new_decoration
    : l'identifiant de la nouvelle décoration

Exemples

Requête:

{
    "name": "Clair de lune",
    "price": 200,
    "image_id": "2834fa0b28"
}

Réponse:

{
    "new_decoration": "8bcd3a40182"
}

Appeler la requête

name
price
image_id
Request here
Response to request here

Supprimer une décoration

Arguments

  • decoration_id
    : l'identifiant de la décoration

Valide lorsque

  • l'identifiant de décoration désigne bien une décoration existante

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est un administrateur

Retours

Aucun retour pour cette action

Exemples

Requête:

{
    "decoration_id": "8bcd3a40182"
}

Réponse:

null

Appeler la requête

decoration_id
Request here
Response to request here

Obtenir les informations sur une décoration

Arguments

  • decoration
    : l'identifiant de la décoration

Valide lorsque

  • l'identifiant de décoration désigne bien une décoration existante

Permis lorsque

  • l'utilisateur est connecté

Retours

  • name
    : le nom de la décoration
  • price
    : le prix de la décoration
  • image
    : l'identifiant de l'image de la décoration

Exemples

Requête:

{
    "decoration_id": "8bcd3a40182"
}

Réponse:

{
    "name": "Clair de lune",
    "price": 200,
    "image": "2834fa0b28"
}

Appeler la requête

decoration
Request here
Response to request here

Obtenir la liste des décorations

Permis lorsque

  • l'utilisateur est connecté

Retours

  • id
    : l'identifiant de la décoration
  • name
    : le nom de la décoration
  • price
    : le prix de la décoration
  • image
    : l'identifiant de l'image de la décoration

Exemples

Requête:

null

Réponse:

[
    {
        "id": "8bcd3a40182",
        "price": 200,
        "name": "Clair de lune",
        "image": "2834fa0b28"
    }
]

Appeler la requête

Request here
Response to request here

Modifier une décoration

Arguments

  • decoration_id
    : l'identifiant de la décoration
  • name
    : le nom de la décoration (optionnel)
  • price
    : le prix de la décoration (optionel)
  • image
    : l'identifiant de l'image de la décoration (optionel)

Valide lorsque

  • l'identifiant de décoration désigne bien une décoration existante
  • au moins le nouveau nom, prix ou la nouvelle image a été renseigné
  • l'identifiant de l'image désigne bien une image de décoration existante, si présente

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est un administrateur

Retours

Aucun retour pour cette action

Exemples

Requête:

{
    "decoration_id": "8bcd3a40182",
    "name": "Clair de soleil"
}

Réponse:

null

Appeler la requête

decoration_id
name
price
image
Request here
Response to request here

Obtenir les informations sur le profil d'un utilisateur

Arguments

  • user_id
    : l'identifiant de l'utilisateur (optionnel); si non renseigné, désignera l'utilisateur effectuant la requête

Permis lorsque

  • l'utilisateur est connecté

Retours

  • first_name
    : le prénom de l'utilisateur
  • last_name
    : le nom de famille de l'utilisateur
  • profile_image
    : l'identifiant de l'image de profil de l'utilisateur
  • active_decoration
    : la décoration présente sur le profil de l'utilisateur
  • active_badges
    : les badges présents sur le profil de l'utilisateur
  • description
    : la description de l'utilisateur
  • classes
    : si l'utilisateur n'est pas un administrateur, la liste des cours auxquels l'utilisateur participe

Exemples

Requête:

{
    "user_id": "429d7c938"
}

Réponse:

{
    "first_name": "John",
    "last_name": "doe",
    "profile_image": "abc837b23",
    "active_decoration": "8bcd3a40182",
    "active_badges": [
        [
            "here_for_long",
            3
        ],
        [
            "...",
            1
        ],
        "..."
    ],
    "description": "Ssalut toi",
    "classes": [
        "bc3849dec2"
    ]
}

Appeler la requête

user_id
Request here
Response to request here

Modifier le profil d'un utilisateur

Arguments

  • user_id
    : l'identifiant de l'utilisateur
  • first_name
    : le prénom de l'utilisateur
  • last_name
    : le nom de famille de l'utilisateur
  • profile_image
    : l'identifiant de l'image de profil de l'utilisateur
  • active_decoration
    : la décoration présente sur le profil de l'utilisateur
  • active_badges
    : les badges présents sur le profil de l'utilisateur
  • description
    : la description de l'utilisateur

Valide lorsque

  • l'identifiant du compte désigne bien un compte existant
  • les badges sont bel et bien possédés par cet utiilsateur
  • l'identifiant d'image de profil désigne bel et un bien une image de profil existante
  • l'identifiant de décoration désigne bel et bien une décoration déjà existante

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est un administrateur
  • l'utilisateur ne modifie pas son propre profil (voir /profile/update)

Retours

Aucun retour pour cette action

Exemples

Requête:

{
    "user_id": "429d7c938",
    "first_name": "John",
    "last_name": "Doe",
    "profile_image": "bd349283c",
    "active_decoration": "8bcd3a40182",
    "active_badges": [
        "here_for_long"
    ],
    "description": "Foobar"
}

Réponse:

null

Appeler la requête

user_id
first_name
last_name
profile_image
active_decoration
active_badges
description
Request here
Response to request here

Mettre à jour son propre profil

Arguments

  • first_name
    : le prénom de l'utilisateur
  • last_name
    : le nom de famille de l'utilisateur
  • profile_image
    : l'identifiant de l'image de profil de l'utilisateur
  • active_decoration
    : la décoration présente sur le profil de l'utilisateur
  • active_badges
    : les badges présents sur le profil de l'utilisateur
  • description
    : la description de l'utilisateur

Valide lorsque

  • l'identifiant d'image de profil désigne bel et un bien une image de profil existante
  • l'identifiant de décoration désigne bel et bien une décoration déjà existante

Permis lorsque

  • l'utilisateur est connecté
  • les badges sont bel et bien possédés par cet utiilsateur
  • la décoration est bel et bien possédée par cet utiilsateur
  • l'utilisateur est propriétaire de l'image de profil

Retours

Aucun retour pour cette action

Exemples

Requête:

{
    "first_name": "John",
    "last_name": "Doe",
    "profile_image": "bd349283c",
    "active_decoration": "8bcd3a40182",
    "active_badges": [
        "here_for_long"
    ],
    "description": "Foobar"
}

Réponse:

null

Appeler la requête

first_name
last_name
profile_image
active_decoration
active_badges
description
Request here
Response to request here

Supprimer un fichier

Arguments

  • id
    : l'identifiant du fichier

Valide lorsque

  • l'identifiant de fichier désigne bien un fichier existant
  • s'il s'agit d'une image de décoration, aucune décoration n'est liée à cette image
  • il ne s'agit pas d'un fichier géré par une section

Permis lorsque

  • l'utilisateur est connecté
  • l'utilisateur est propriétaire du fichier

Retours

Aucun retour pour cette action

Exemples

Requête:

{
    "id": "cb294387dc"
}

Réponse:

null

Appeler la requête

id
Request here
Response to request here

Télécharger un fichier

Arguments

  • id
    : l'identifiant du fichier
  • type
    : le type de fichier à télécharger

Valide lorsque

  • l'identifiant de fichier désigne bien un fichier existant
  • le type de fichier correspond parfaitement à celui indiqué en argument

Permis lorsque

  • l'utilisateur est connecté

Exemples

Requête:

{
    "id": "cb294387dc",
    "type": "profile image"
}

Réponse:

null

Appeler la requête

id
type
Request here
Response to request here

Obtenir ses propres fichiers. Seuls les fichiers non gérés par des sections sont référencés ici.

Arguments

  • type
    : le type de fichier à appliquer au filtre (optionel)

Valide lorsque

  • le type de fichier indiqué est un type de fichier valide (profile icon, section file, decoration banner)

Permis lorsque

  • l'utilisateur est connecté

Retours

  • id
    : l'identifiant du fichier
  • name
    : le nom personnalisé du fichier
  • filename
    : le nom (avec extension) du fichier
  • sent_date
    : la date d'envoi du fichier
  • sender
    : l'identifiant de l'exportateur du fichier
  • size
    : la taille du fichier
  • filetype
    : le type de fichier

Exemples

Requête:

{
    "type": "profile image"
}

Réponse:

[
    {
        "id": "bcd9238de",
        "name": "clair_de_lune",
        "filename": "clair_de_lune.png",
        "sent_date": 294837948123,
        "sender": "cbd298d784",
        "size": 2449,
        "filetype": "decoration banner"
    }
]

Appeler la requête

type
Request here
Response to request here

Charger un fichier dans le serveur. Un fichier doit accompagner cette requête

Arguments

  • name
    : le nom personnalisé du fichier
  • type
    : le type de fichier (profile icon, decoration banner)
  • file
    : un fichier requis

Valide lorsque

  • le type de fichier spécifié correspond bien à un type de fichier valide
  • le type de fichier renseigné n'est pas un fichier de section
  • le fichier est fourni
  • le fichier fourni possède un nom
  • si le fichier est une image de profile, alors elle doit être carrée
  • si le fichier est une décoration, alors elle doit mesurer 900x300px

Permis lorsque

  • l'utilisateur est connecté

Retours

  • new_file
    : l'identifiant du fichier
  • date
    : la date de chargement du fichier
  • size
    : la taille du fichier

Exemples

Requête:

{
    "name": "bootstraaaaap",
    "type": "profile icon"
}

Réponse:

{
    "id": "bcd9238de",
    "sent_date": 294837948123,
    "size": 2449
}

Appeler la requête

name
type
Fichier:
Request here
Response to request here

Obtenir son coffre-fort

Permis lorsque

  • l'utilisateur est connecté

Retours

  • quota
    : solde de nooblards
  • badges
    : badges possédés
  • decorations
    : décorations achetées

Exemples

Requête:

null

Réponse:

{
    "quota": 249,
    "badges": [
        [
            "here_for_long",
            2
        ]
    ],
    "decorations": [
        "abcd6484fdbc",
        "9ab238dc638d"
    ]
}

Appeler la requête

Request here
Response to request here

Obtenir les badges présents dans le coffre-fort

Permis lorsque

  • l'utilisateur est connecté

Exemples

Requête:

null

Réponse:

[
    [
        "here_for_long",
        2
    ]
]

Appeler la requête

Request here
Response to request here

Obtenir les décorations présentes dans le coffre-fort

Permis lorsque

  • l'utilisateur est connecté

Exemples

Requête:

null

Réponse:

[
    "abcd6484fdbc",
    "9ab238dc638d"
]

Appeler la requête

Request here
Response to request here

Obtenir son solde de nooblards

Permis lorsque

  • l'utilisateur est connecté

Exemples

Requête:

null

Réponse:

429

Appeler la requête

Request here
Response to request here

Obtenir son flux d'activités

Arguments

  • notreadonly
    : vrai s'il faut uniquement retourner les activités non lues
  • count
    : le nombre d'activités à retourner
  • offset
    : le nombre d'activités à sauter

Valide lorsque

  • le compte est supérieur à 0
  • l'offset n'est pas négatif

Permis lorsque

  • l'utilisateur est connecté

Retours

  • activity_id
    : l'identifiant de l'activité
  • read
    : vrai lorsque l'activité a été lue
  • activity_data
    : les données de l'activité

Exemples

Requête:

{
    "notreadonly": 4,
    "count": 20,
    "offset": 40
}

Réponse:

[
    {
        "activity_id": "8cdc823bd",
        "read": false,
        "activity_data": {
            "title": "Nouvelle notification",
            "content": "Il s'est pass\u00e9 quelque chose \u00e0 ce moment l\u00e0",
            "creator": "dcb823dcb85",
            "date": 6540479450,
            "icon": "account"
        }
    }
]

Appeler la requête

notreadonly
count
offset
Request here
Response to request here

Marquer des activités comme lues

Arguments

  • activities
    : les activités à marquer comme lues

Valide lorsque

  • le compte a bien été notifié de cette activité

Permis lorsque

  • l'utilisateur est connecté

Retours

Aucun retour pour cette action

Exemples

Requête:

{
    "activities": [
        "bc3948bcd",
        "cbafc9834",
        "2938c985b3"
    ]
}

Réponse:

null

Appeler la requête

activities
Request here
Response to request here