Projects
HubSessions API ask/meetingAnnexes

Le service ask/meetingAnnexes permet de récupérer de l'information concernant toutes les annexes d'une séance; annexes de tous types ou de certains types sélectionnés. Par annexes d'une séance, on entend:

  • toutes les annexes définies à même la séance (si les annexes aux séances sont activées sur l'HubSessions en question);
  • toutes les annexes de tous les points inclus dans la séance.

Au préalable, vous devez connaître l'identifiant d'une séance. Utilisez par exemple le service ask/objects?type=Meeting afin de récupérer les informations sur les séances ayant eu lieu sur un certain intervalle de temps. Parmi les infos retournées par ce service, on retrouve leurs identifiants dans les sous-tags id.

Type de requête

Requête HTTP GET

Données en entrée

Les paramètres de la requête sont les suivants.

  • meetingId (obligatoire) · L'identifiant de la séance pour laquelle on souhaite récupéter les annexes. Comme expliqué ci-dessus, une technique pour obtenir un identifiant de séance est d'utiliser au préalable le service ask/objects.
  • annexTypes (optionnel) · Les identifiants logiques du ou des types d'annexes qui vous intéressent. Si vous spécifiez, dans ce paramètre, un identifiant (ou plusieurs identifiants séparés par des virgules), seules les annexes étant de ce ou ces types feront partie du résultat. Utilisez le service ask/annexTypes pour connaître les types d'annexes définis sur l'HubSessions que vous attaquez. Dans le retour de ce service, les identifiants des types d'annexes à utiliser ici sont stockés dans les sous-tags annexTypeId.

Exemple de requête

<siteUrl>/ask/meetingAnnexes?meetingId=999&annexTypes=note,note-rectificative

Données de retour

Bien qu'exprimées en XML, les données de retour ne se conforment pas au format de retour standardisé.  Voici un exemple. Il s'agit d'un résultat de 17 entrées, tronqué à 2.

<meetingAnnexes type="list" count="17">
 <e type="object" className="Object">
  <id type="int">5706</id>
  <title>Lettre ouverte aux développeurs du langage Python</title>
  <url><siteUrl>/5706/xml</url>
  <itemTitle>Interdiction de l'usage des annotations, jugées contraires à la philosophie du langage</itemTitle>
  <itemNumber type="int">4</itemNumber>
  <annexType>note</annexType>
 </e>
 <e type="object" className="Object">
  <id type="int">5583</id>
  <title>Analyse comparée de 97 moutardes</title>
  <url><siteUrl>/5583/xml</url>
  <itemTitle>Avant-projet de décret instituant une obligation de ne pas dépasser 0,5g de sel par 100g dans les moutardes commercialisées sur le territoire de la Région</itemTitle>
  <itemNumber type="int">5</itemNumber>
  <annexType>note</annexType>
 </e>
 ...
</meetingAnnexes>

Les annexes apparaissent dans l'ordre des points de la séance. Les annexes aux séances, indépendantes des points, apparaissent, si définies, avant celles liées aux points.

Les données suivantes sont disponibles pour chaque annexe.

  • Son identifiant (sous-tag id)
  • Son titre (tag title)
  • L'URL permettant d'accéder au détail complet de l'annexe, y inclus son contenu binaire (tag url)
  • Le titre du point au sein duquel l'annexe se trouve (tag itemTitle). Ce tag n'est bien entendu pas présent s'il s'agit d'une annexe directement définie dans la séance.
  • Le numéro d'ordre, au sein de la séance, du point au sein duquel l'annexe se trouve (tag itemNumber). Ce tag n'est bien entendu pas présent s'il s'agit d'une annexe directement définie dans la séance.
  • Le type logique de l'annexe (tag annexType).

L'URL mentionnée sur chaque entrée est celle du service ‹identifiant_annexe›/xml qui permet de récupérer les détails de chaque annexe, y inclus son contenu encodé en Base64.