eFlore : ApiIdentiplante01Commentaires

Joindre / Insérer un fichier

** Retour : ** [[PagePrincipale page principale ]] > [[ProjetEfloreVersion5 sommaire eFlore v5]] > [[IdentiPlante Identiplante]] > [[ApiIdentiplante01 Web Services]]
----
====== Identiplante Api v0.1 : Commentaires ======

Ce service fournit des informations sur les commentaires.

== Descriptions des paramètres de requête du service ==

== /commentaires/#id ==
Retourne le commentaire dont l'identifiant est passé dans #id et ses sous commentaires
 - Type de requête : GET
 - Url : http://tela-botanica.org/service:identiplante:0.1/commentaires/11
 - Format retour : 
Défaut (=defaut) : JSON.
##{
    "id_commentaire": "88",
    "texte": "Lorem ipsum dolor sit amet, consectetur adipisicing",
    "auteur.id": "170",
    "auteur.prenom": "Prenom",
    "auteur.courriel": "Courriel",
    "date": "2011-12-21",
    "commentaires": [
        {
            "id_commentaire": "99",
            "texte": "Lorem ipsum dolor sit amet, consectetur adipisicing",
            "auteur.id": "2770",
            "auteur.prenom": "Prenom",
            "auteur.courriel": "Courriel",
            "date": "2011-12-01",
            "commentaires": [ ]
        },
        {
            "id_commentaire": "125",
            "texte": "Lorem ipsum dolor sit amet, consectetur adipisicing",
            "auteur.id": "2770",
            "auteur.prenom": "Prenom",
            "auteur.courriel": "Courriel",
            "date": "2011-12-01",
            "commentaires": [
                {
                    "id_commentaire": "874",
                    "texte": "Lorem ipsum dolor sit amet, consectetur adipisicing",
                    "auteur.id": "666",
                    "auteur.prenom": "Prenom",
                    "auteur.courriel": "Courriel",
                    "date": "2011-12-01",
                    "commentaires": [ ]
                },
                {
                    "id_commentaire": "952",
                    "texte": "Lorem ipsum dolor sit amet, consectetur adipisicing",
                    "auteur.id": "667",
                    "auteur.prenom": "Prenom",
                    "auteur.courriel": "Courriel",
                    "date": "2011-12-01",
                    "commentaires": [ ]
                }
            ]
        }
    ]
}##

== /commentaires/ ==
Retourne une liste de commentaires 
 - Type de requête : GET
 - Url : http://tela-botanica.org/service:identiplante:0.1/commentaires/?masque.id_parent=observation:2555
 - Paramètres de requête disponibles : 
  - masque.id_parent = l'identifiant du parent pour lequel on veut les commentaires, de la forme observation:#id ou proposition:#id ou commentaire#id suivant l'objet auquel s'applique les commentaires

- Format retour : 
Défaut (=defaut) : JSON.
##{
    "entete": {
        "masque": "",
        "depart": "0",
        "limite": "2",
        "total": "2"
    },
    "resultats": [
        {
            "id_commentaire": "0",
            "texte": "Lorem ipsum dolor sit amet, consectetur adipisicing",
            "auteur.id": "250",
            "auteur.nom": "Nom",
            "auteur.prenom": "Prenom",
            "auteur.courriel": "Courriel",
            "date": "2011-12-01",
            "commentaires": [ ]
        },
        {
            "id_commentaire": "1",
            "texte": "Lorem ipsum dolor sit amet, consectetur adipisicing",
            "auteur.id": "170",
            "auteur.prenom": "Prenom",
            "auteur.courriel": "Courriel",
            "date": "2011-12-21",
            "commentaires": [
                {
                    "id_commentaire": "2",
                    "texte": "Lorem ipsum dolor sit amet, consectetur adipisicing",
                    "auteur.id": "2770",
                    "auteur.prenom": "Prenom",
                    "auteur.courriel": "Courriel",
                    "date": "2011-12-01",
                    "commentaires": [ ]
                }
            ]
        }
    ]
}##

== /commentaires/ + POST ==
Ajout un commentaire à l'objet dont l'identifiant est passé en paramètre
 - Type de requête : POST
 - Url : http://tela-botanica.org/service:identiplante:0.1/commentaires/
  - id_parent = l'identifiant du parent sur lequel on ajoute un commentaire, de la forme observation:#id ou proposition:#id ou commentaire#id suivant l'objet auquel s'applique le commentaires
  - texte : le contenu du commentaire
  - id_auteur : identifiant de l'auteur du commentaire
  - prenom_auteur : prenom de l'auteur 
  - nom_auteur : nom de l'auteur 
  - courriel_auteur : courriel de l'auteur 
  (si un identifiant est présent, les informations prenom, nom, courriel, peuvent être prises de la base de données utilisateur)
 - Retour : voir les codes de retour sur la page ApiIdentiplante01

== /commentaires/#id + POST ==
Modifie le commentaire dont l'identifiant est passé dans #id
 - Type de requête : POST
 - Url : http://tela-botanica.org/service:identiplante:0.1/commentaires/14
  - texte : contenu du commentaire
 - Retour : voir les codes de retour sur la page ApiIdentiplante01

== /commentaires/#id + POST contenant action=delete ==
Supprime le commentaire possédant l'identifiant #id
 - Type de requête : POST
 - Url : http://tela-botanica.org/service:identiplante:0.1/commentaires/14
  - action : doit valoir "delete" pour que la requete post soit considérée comme une suppression
 - Retour : voir les codes de retour sur la page ApiIdentiplante01

Thème

Télécharger le fichier

Déjà membre

Nouveau membre

Apparence de la page ApiIdentiplante01Commentaires

Image de fond

Paramètres avancés