Outils pour utilisateurs

Outils du site


mod:pdcertificate:technique:api

Attestation de formation : Index des web services

Boutique Moodle

mod_pdcertificate_get_certificates( cidsource, cid )

Synopsys : Récupérer les identités complètes des instances d'attestation d'un cours ou du site.

  • cidsource : La source d'identifiant du cours.
  • cid : L'indentiant du cours correspondant à la source.

RETOUR

  • tableau d'enregistrement de descripteurs d'attestation

mod_pdcertificate_get_certificate_file_url( pdcidsource, pdcid, uidsource, uid )

Synopsis : Récupère l'URL de téléchargement d'une attestation générée sous forme PDF. L'url est vide si aucun document ne correspond.

  • pdcidsource : source d'identification de l'attestation
  • pdcid : Identifiant de l'attestation
  • uidsouce : source d'identification de l'utilisateur
  • uid : identifiant de l'utilisateur

RETOUR

  • Une URL de téléchargement du document. Voir la documentation générale de Moodle sur le téléchargement de documents par web services.

mod_pdcertificate_get_certificate_info( pdcidsource, pdcid, uidsource, uid )

  • pdcidsource : source de l'identification de l'attestation (1).
  • pdcid : identifiant de l'attestation.
  • uidsource : source de l'identification de l'utilisateur (2).
  • uid : identifiant de l'utilisateur

(1) : id d'instance (id), numéro identifiant du module de cours (idnumber). (2) : id numérique de l'utilisateur (id), numéro d'identification externe de l'utilisateur (idnumber), login de l'utilisateur (username), courriel de l'utilisateur (email).

RETOUR

  • Une structure de données contenant les indicateurs d'état de l'attestation.

mod_pdcertificate_get_certificate_users_info( pdcidsource, pdcid, uidsource, uids )

  • pdcidsource : source de l'identification de l'attestation (1).
  • pdcid : identifiant de l'attestation.
  • uidsource : source de l'identification de l'utilisateur (2).
  • uids : Tableau d'identifiants de l'utilisateur

Idem précédent mais pour une série d'utilisateurs (scalabilité)

RETOUR

  • Un tableau de structures de données contenant les indicateurs d'état de l'attestation.

mod_pdcertificate_get_certificate_infos( pdcidsource, pdcid)

Synopsys : Réupère toutes les structures d'état de tous les utilisateurs liés à une attestation.

  • pdcidsource : source de l'identification de l'attestation (*).
  • pdcid : identifiant de l'attestation.

(*) : id d'instance (id), numéro identifiant du module de cours (idnumber).

RETOUR

  • Un tableau de structure de données contenant les indicateurs d'état de l'attestation.

Crédits

  • Valéry Frémaux (Valery@activeproLearn.com) : Développement & tests

Revenir à l'index du guide technique - Index du composant - Revenir à l'index des plugins - Revenir au catalogue

mod/pdcertificate/technique/api.txt · Dernière modification : de 127.0.0.1

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki