Points d’extrémité du signataire

Points d’extrémité du signataire

  1. Liste des signataires
  2. Accéder aux métadonnées du signataire
  3. Créer un nouveau signataire
  4. Mettre à jour un signataire
  5. Corriger un signataire
  6. Supprimer un signataire


1. Liste des signataires

Obtenir la liste des noms des signataires du site. Lorsque l’en-tête d’autorisation est fournie et que l’utilisateur dispose de droits d’administrateur système, la requête fait également ressortir les organisations dont le statut est en attente.

Point d’extrémité : /organization_list

Méthode : GET

Autorisation : facultatif.

Paramètres :

  • sort (chaîne de caractères) (facultatif) – trie les résultats de la recherche. Par défaut : « title asc » chaîne du nom du champ et ordre de tri. Les champs autorisés sont « name », « package_count » et « title »
  • limit (int) (facultatif) – le nombre maximum d’organisations listées dans les résultats de la recherche. Par défaut : 1200 lorsque all_fields=false et 25 lorsque all_fields=true. Il n’est pas recommandé d’utiliser all_fields=true (utiliser organization_show à la place)
  • offset (int) (facultatif) – lorsque limit est donnée, le décalage à partir duquel la liste des organisations est fournie
  • organizations (liste de chaînes de caractères) (facultatif) – une liste des noms des groupes à fournir. Si ce paramètre est utilisé, seuls les groupes dont les noms figurent dans cette liste ressortiront de la recherche
  • all_fields (bool) (facultatif) – fournir les dictionnaires des signataires au lieu de leurs simples noms. Seuls les champs fondamentaux ressortent de la recherche - on peut en obtenir davantage en utilisant les options include_*. Il est trop lourd de faire ressortir une liste de paquets, si bien que la propriété paquets de chaque groupe n’est plus prise en charge, mais on trouve un décompte des paquets dans la propriété package_count. Par défaut : Faux.
  • include_dataset_count (bool) (facultatif) – si all_fields, inclut le package_count intégral. Par défaut : True
  • include_extras (bool) (facultatif) – si all_fields, inclut les champs supplémentaires de l’organisation. Par défaut : Faux.
  • include_tags (bool) (facultatif) – si all_fields, inclut les étiquettes supplémentaires de l’organisation. Par défaut : Faux.
  • include_groups (bool) (facultatif) – si all_fields, inclut les entités dont les organisations font partie. Par défaut : Faux.
  • include_users (bool) (facultatif) – si all_fields, inclut les utilisateurs de l’organisation. Par défaut : Faux.

Exemples :


2. Accéder aux métadonnées du signataire

Obtenir des informations détaillées sur un signataire. Lorsque l’en-tête d’autorisation et le paramètre include_datasets sont fournis, la requête fait également ressortir les ensembles de données privés.

Point d’extrémité : /organization_show

Méthode : GET

Autorisation : facultatif.

Paramètres :

  • id (chaîne de caractère) (obligatoire)(facultatif) – l’identifiant ou le nom du signataire
  • include_datasets (bool) (facultatif) – inclut une liste tronquée des ensembles de données de l’organisation. Par défaut : Faux.
  • include_dataset_count (bool) (facultatif) – inclut le package_count intégral. Par défaut : True
  • include_extras (bool) (facultatif) – inclut les champs supplémentaires du signataire. Par défaut : True
  • include_users (bool) (facultatif) – inclut les utilisateurs du signataire. Par défaut : True
  • include_groups (bool) (facultatif) – inclut les sous-groupes du signataire. Par défaut : True
  • include_tags (bool) (facultatif) – inclut les étiquettes du signataire. Par défaut : True
  • include_followers (bool) (facultatif) – inclut le nombre d’abonnés du signataire. Par défaut : True

Exemples :


3. Créer un nouveau signataire

Créer une nouvelle organisation. Vous devez avoir l’autorisation de créer de nouvelles organisations. Remarque : tous les signataires nouvellement créés auront le statut « en attente » jusqu’à ce qu’ils soient approuvés par un administrateur système.

Point d’extrémité : /organization_create

Méthode : POST

Autorisation : obligatoire.

Autres en-têtes de la requête : ('Content-Type', 'application/json; charset=utf-8')

Paramètres :

  • name (chaîne de caractères) (obligatoire) – le nom de l’organisation, une chaîne comprenant entre 2 et 100 caractères, contenant uniquement des caractères alphanumériques en minuscule, - et _
  • publisher_iati_id (chaîne de caractères) (obligatoire) - identifiant de signataire de l’IITA.
  • title (chaîne de caractères) (obligatoire) – le titre de l’organisation.
  • publisher_source_type (chaîne de caractères) (obligatoire) – soit « primary_source » soit « secondary_source ».
  • state (chaîne de caractères) (obligatoire) – le statut doit toujours être « approval_needed ».
  • publisher_contact (chaîne de caractères) (obligatoire) – l’adresse électronique du signataire.
  • publisher_description (chaîne de caractères) (facultatif) – la description du signataire.
  • license_id (chaîne de caractères) (facultatif) – le license_id peut être obtenu à cette adresse : https://iatiregistry.org/api/action/license_list.
  • image_display_url b– URL vers une image à afficher sur la page du signataire.
  • publisher_organization_type (chaîne de caractères) (obligatoire) – le type de signataire. La valeur peut être n’importe laquelle des valeurs ci-dessous. Par exemple, publisher_organization_type=”22”
    • (« 80 », « Universités et instituts de formation et de recherche »),
    • (« 60 », « Fondation »),
    • (« 10 », « Gouvernement »),
    • (« 21 », « Organisation non gouvernementale internationale »),
    • (« 40 », « Organisation multilatérale »),
    • (« 22 », « Organisation non gouvernementale nationale »),
    • (« 15 », « Autre entité du secteur public »),
    • (« 70 », « Secteur privé »),
    • (« 30 », « Partenariat public-privé »),
    • (« 23 », « Organisation non gouvernementale régionale ».
  • packages (liste de dictionnaires) – les ensembles de données (paquets) qui appartiennent à l’organisation, une liste de dictionnaires comportant chacun les clés « name » (chaîne de caractères, identifiant ou nom de l’ensemble de données) et, en option, « title » (chaîne de caractères, titre de l’ensemble de données).
  • users (liste de dictionnaires) – les utilisateurs qui appartiennent à l’organisation, une liste de dictionnaires comportant chacun les clés « name » (chaîne de caractères, identifiant ou nom de l’utilisateur) et, en option, « capacity » (chaîne de caractères, capacité en laquelle l’utilisateur est membre de l’organisation). La capacité peut être « admin », « member » ou « éditeur ».
  • publisher_country (chaîne de caractères) (facultatif) - code pays du signataire.
  • publisher_url (chaîne de caractères) (facultatif) - URL externe vers le site Internet du signataire.
  • publisher_contact_email (chaîne de caractères) (facultatif) - adresse électronique pour contacter le signataire.
  • publisher_implementation_schedule (chaîne de caractères) (facultatif) - URL du calendrier de mise en œuvre.
  • publisher_agencies (chaîne de caractères) (facultatif) - quelles organisations/agences sont couvertes par vos données IITA ? (Quel pourcentage de la totalité de vos flux de développement sont ainsi couverts ? Que manque-t-il ?)
  • publisher_timeliness(chaîne de caractères) (facultatif) - avec quelle rapidité les données consignées et disponibles en interne seront-elles publiées ?
  • publisher_frequency_select(chaîne de caractères) (facultatif) - à quelle fréquence les données de l’IITA sont-elles mises à jour ? La valeur peut être monthly ou quarterly ou six_monthly ou annually ou lt_annually.
  • publisher_frequency (chaîne de caractères) (facultatif) - toute information supplémentaire concernant la fréquence d’activité du signataire.
  • publisher_units (chaîne de caractères) (facultatif) - comment une activité est-elle définie, par exemple projets et programme ou autre structure ? Les structures de projet sont-elles multiniveaux, avec, par exemple, des projets et sous-projets ou des composantes ? À quel niveau entend-on publier des données détaillées ?
  • publisher_segmentation(chaîne de caractères) (facultatif) - les données de l’IITA sont-elles publiées sous forme de fichiers distincts par pays ou région ?
  • publisher_refs (chaîne de caractères) (facultatif) - liens vers des guides, des explications et des listes de codes sur le propre site du signataire qui donnent des précisions sur ses données.
  • publisher_field_exclusions (chaîne de caractères) (facultatif) - quels champs recommandés dans la norme n’utilisez-vous jamais, et pourquoi ?
  • publisher_record_exclusions (chaîne de caractères) (facultatif) - quelles politiques appliquez-vous pour exclure des données relatives à des activités particulières ou à des parties d’une activité ?
  • publisher_thresholds(chaîne de caractères) (facultatif) - quels sont les seuils en dessous desquels des données ou des activités tout entières ne sont pas publiées ?
  • publisher_constraints (chaîne de caractères) (facultatif) - autres politiques ou circonstances qui limitent votre pleine conformité avec la norme.
  • publisher_data_quality(chaîne de caractères) (facultatif) - observation du signataire concernant l’état et l’exactitude des données - ayant fait l’objet d’un audit/vérifiées, opérationnelles/sujettes à des changements, etc.
  • publisher_ui (chaîne de caractères) (facultatif) - les données de l’IITA seront-elles accessibles aux utilisateurs finaux au moyen d’une interface utilisateur existante ou nouvelle sur votre site Internet ?
  • publisher_ui_url (chaîne de caractères) (facultatif) - si disponible, veuillez fournir l’adresse URL complète du site Internet où vos données IITA sont accessibles.

Exemples :

  • Cas 1 : créer un signataire appelé « my-test-publisher » (mon signataire test) dont le statut est « En attente d’approbation ».

Point d’extrémité : https://iatiregistry.org/api/action/organization_create

headers = {"Content-Type": "application/json; charset=utf-8", "Authorization": “XXX”}

payload = { "name": "my-test-publisher", "publisher_iati_id": "XD-DAC-6-5", "title": "My Test Publisher", "publisher_contact_email": "[email protected]", "license_id": "odc-pddl", "publisher_organization_type": "80", "state": "approval_needed" }

  • Cas 2 : créer un signataire appelé « my-test-publisher-2 » (mon signataire test 2) et ajouter des utilisateurs avec des capacités respectives au sein du signataire.

Point d’extrémité : https://iatiregistry.org/api/action/organization_create

headers = {"Content-Type": "application/json; charset=utf-8", "Authorization": “XXX”}

payload = { "name": "my-test-publisher-2", "publisher_iati_id": "XDM-DAC-6-5", "title": "My Test Publisher 2", "publisher_contact_email": "[email protected]", "license_id": "odc-pddl", "publisher_organization_type": "80", "state": "approval_needed", "users": [ { "name": "swaroop", "capacity": "member" } ] }


4. Mettre à jour un signataire

Mettre à jour une organisation. Vous devez avoir l’autorisation de modifier l’organisation.

Différence entre les méthodes de mise à jour ( organization_update) et de correction ( organization_patch) : la correction mettra à jour les paramètres précisés sans modifier les autres paramètres, tandis que la mise à jour supprimera tous les paramètres qui ne sont pas explicitement fournis dans le dictionnaire de données (data_dict).

Point d’extrémité : /organization_update

Méthode : POST

Autorisation : obligatoire.

Autres en-têtes de la requête : ('Content-Type', 'application/json; charset=utf-8')

Paramètres :

  • id (chaîne de caractères) (obligatoire) – le nom ou l’identifiant de l’organisation à mettre à jour.
  • Pour plus de paramètres, voir organization_create().

Exemples :

  • Cas 1 : Mettons à jour le type d’organisation (« publisher_organization_type ») en faisant passer le signataire « my-test-publisher-3 » de 80 à 22. Remarque : il est recommandé d’utiliser la fonction organization_update de concert avec la fonction organization_show.

Point d’extrémité : https://iatiregistry.org/api/action/organization_update

headers = {"Content-Type": "application/json; charset=utf-8", "Authorization": “XXX”}

payload = {'publisher_iati_id': 'XDMD-DAC-6-5', 'description': '', 'publisher_organization_type': '22', 'image_display_url': '', 'package_count': 0, 'title': 'My Test Publisher 3', 'is_organization': True, 'state': 'approval_needed', 'publisher_contact_email': '[email protected]', 'image_url': '', 'groups': [], 'type': 'organization', 'license_id': 'odc-pddl', 'users': [{'capacity': 'admin', 'name': 'admin'}, {'capacity': 'member', 'name': 'swaroop'}], 'num_followers': 0, 'id': '71a7698a-b14f-43c2-b113-b8eb884da7af', 'tags': [], 'name': 'my-test-publisher-3'}


5. Corriger un signataire

Corriger une organisation.

Différence entre les méthodes de mise à jour ( organization_update) et de correction ( organization_patch) : la correction mettra à jour les paramètres précisés sans modifier les autres paramètres, tandis que la mise à jour supprimera tous les paramètres qui ne sont pas explicitement fournis dans le dictionnaire de données (data_dict).

Point d’extrémité : /organization_patch

Méthode : POST

Autorisation : obligatoire.

Autres en-têtes de la requête : ('Content-Type', 'application/json; charset=utf-8')

Paramètres :

  • id (chaîne de caractères) (obligatoire) – le nom ou l’identifiant de l’organisation à mettre à jour.
  • Pour plus de paramètres, voir organization_create().

Exemples :

  • Cas 1 : Corrigeons le « license_id » de odc-pddl à odc-by pour le signataire « my-test-publisher-3 ».

Point d’extrémité : https://iatiregistry.org/api/action/organization_patch

headers = {"Content-Type": "application/json; charset=utf-8", "Authorization": “XXX”}

payload = {id: '71a7698a-b14f-43c2-b113-b8eb884da7af', ‘license_id’: ‘odc-by’ }

  • Cas 2 : Ajoutons « publisher_country » au signataire « my-test-publisher-3 ».

Point d’extrémité : https://iatiregistry.org/api/action/organization_patch

headers = {"Content-Type": "application/json; charset=utf-8", "Authorization": “XXX”}

payload = {id: '71a7698a-b14f-43c2-b113-b8eb884da7af',”publisher_country”: “ie” }


6. Supprimer un signataire

Corriger une organisation. Vous devez avoir l’autorisation de supprimer l’organisation et aucun ensemble de données ne doit appartenir à l’organisation.

Différence entre les méthodes de mise à jour ( organization_update) et de correction ( organization_patch) : la correction mettra à jour les paramètres précisés sans modifier les autres paramètres, tandis que la mise à jour supprimera tous les paramètres qui ne sont pas explicitement fournis dans le dictionnaire de données (data_dict).

Point d’extrémité : /organization_delete

Méthode : POST

Autorisation : obligatoire.

Autres en-têtes de la requête : ('Content-Type', 'application/json; charset=utf-8')

Paramètres :

  • id (chaîne de caractères) (obligatoire) – le nom ou l’identifiant de l’organisation à supprimer.

Exemples :

  • Cas 1 : Supprimons le signataire « my-test-publisher-3 ».

Point d’extrémité : https://iatiregistry.org/api/action/organization_delete

headers = {"Content-Type": "application/json; charset=utf-8", "Authorization": “XXX”}

payload = {id: '71a7698a-b14f-43c2-b113-b8eb884da7af' }