server/README.md
changeset 82 bf1c38268e25
child 95 8ecee14c6d81
equal deleted inserted replaced
81:24cf59559959 82:bf1c38268e25
       
     1 # Accès aux vues scénario
       
     2 
       
     3 Pour générer une vue de scénario, il suffit d'appeler les url suivantes en source d'une iframe. Les url contiennent : 
       
     4 
       
     5 * un identifiant de projet d’annotation (voir ci-dessus pour récupérer manuellement l’identifiant d’un projet)
       
     6 * un ticket d’authentification CAS
       
     7 
       
     8 ### Scénario élève/annotation de segment en mode individuel
       
     9 
       
    10     https://appiri.enteduc.fr/remie/remie/workunit/segments_single?project_id=<:id>&casticket=<:ticket> 
       
    11 
       
    12 * <:id> est l'id du projet considéré
       
    13 * <:ticket> est le ticket d'authentification CAS 
       
    14 
       
    15 ### Scénario élève/annotation de segment en mode groupe    
       
    16 
       
    17     https://appiri.enteduc.fr/remie/remie/workunit/segments_group?project_id=<:id>&group_mode=true&casticket=<:ticket>
       
    18 
       
    19 * <:id> est l'id du projet considéré
       
    20 * <:ticket> est le ticket d'authentification CAS
       
    21 Note: Le nom du paramètre du ticket CAS (par défaut “casticket”) est configurable de notre côté, si jamais il ne respecte pas les conventions de nommage d’Itop.
       
    22 
       
    23 ### Scénario professeur
       
    24 (à implémenter)
       
    25 
       
    26 ### Scénario “marqueurs”
       
    27 (à implémenter)
       
    28 
       
    29 # Dupliquer un projet existant lors de l’instanciation d’un grain:
       
    30 
       
    31 Un endpoint de l’API permet de dupliquer un projet existant. Pour cela il faut faire une requête POST à l’adresse suivante: 
       
    32 
       
    33     https://appiri.enteduc.fr/remie/api/ldt/1.0/projects?format=json&source=<:project_id>&publish=true&casticket=<:ticket>
       
    34 
       
    35 * <:ticket> est le ticket d'authentification CAS
       
    36 * <:project_id>: L’id du projet que l’on souhaite dupliquer
       
    37 
       
    38 La requête POST doit être accompagnée de données sous la forme d’une chaîne de caractère de type json, selon le format suivant: 
       
    39 
       
    40 	{
       
    41 	“meta”: { 
       
    42 	“dc:creator”: “<:user>”,
       
    43 	“dc:contributor”: “<:user>”,
       
    44 	“dc:title”: “<:title>”, 
       
    45 	“dc:description”: “<:description>”, 
       
    46 	"dc:created": "",
       
    47 	            "dc:modified": "",
       
    48 	            "dc:description": "",
       
    49 	            "iricle:status": 2'
       
    50 	},  
       
    51 	"views": [],
       
    52 	"lists": [],
       
    53 	"annotation-types": [],
       
    54 	"medias": [],
       
    55 	"tags": [],
       
    56 	"annotations": []
       
    57 	}
       
    58 
       
    59 * <:user>: L’utilisateur considéré comme “créateur” du nouveau projet. Cet utilisateur doit avoir accès en lecture au projet d’origine
       
    60 * <:title>: Le titre que prendra la copie du projet dupliqué (optionnel, prendra le même titre que le projet initial si non-renseigné)
       
    61 * <:description> : La description que prendea la copie du projet dupliqué (optionnelle, prendra le même titre que le projet initial si non-renseigné)
       
    62 
       
    63 Dans la réponse à cette requête POST, le header “Location” contient l’URL à requêter (GET) pour obtenir les informations sur le projet créé. Il est possible d’en extraire l’id du projet afin de générer les scénario.