Global

Methods

GET /api/baseId/:id()

Retourne la baseUrl d'une baseId de sesatheque (connue par configuration ou déclarée ici par un client)
Source:

notifyError(data)

Ajoute une erreur dans les logs
Parameters:
Name Type Description
data Object Si propriété rid ira dans dataError.log (error.log sinon)
Source:

POST /api/checkSesalab()

Valide la configuration d'un sesalab Si tout est bon, retournera {success: true, baseId: 'laBaseId assignée au sesalab appelant'} sinon un {success: false, errors: ['error 1', …]}
Source:

POST /api/checkSesatheque()

Valide la configuration d'une sésatheque (qui nous envoie ses sesatheques et sesalabs)
Source:

Type Definitions

reponseDeleted

Format de la réponse à une demande de suppression
Type:
  • Object
Properties:
Name Type Attributes Description
success boolean
error string <optional>
 Message d'erreur éventuel (si success vaut false)
deleted string L'id passé en argument (DEPRECATED, pour compatibilité avec les versions anterieures)
Source:

reponseListe

Format de la réponse à une demande de liste
Type:
  • Object
Properties:
Name Type Attributes Description
success boolean
error string <optional>
 Message d'erreur éventuel
liste Array.<Ref> | Array.<Ressource> Une liste de Ref (ou de Ressource si on le demande)
Source:

reponseListesByPid

Format de la réponse à une demande de liste
Type:
  • Object
Properties:
Name Type Attributes Description
success boolean
error string <optional>
 Message d'erreur éventuel
warnings Array.<string> <optional>
 Éventuelle liste de warnings (auteurs inconnus)
pidXX object Objet contenant les ressources de pidXX
Properties
Name Type Description
pid string rappel de son pid
label string prénom & nom
liste Array.<Ref> Ses ressources (lisibles par le demandeur)
Source:

reponseRessource

La réponse à une demande de ressource
Type:
  • Object
Properties:
Name Type Attributes Description
success boolean
error string <optional>
 Message d'erreur éventuel
warnings Array.<string> <optional>
 Avertissements éventuels sur la ressource (incohérences ne justifiant pas une erreur et le rejet de l'enregistrement)
oid Integer
titre string
categories Array.<Integer>
type string
… Autre propriétés d'une ressource
Source:

reponseRessourceOid

La réponse à un post pour enregistrer une ressource (ou une modif)
Type:
  • Object
Properties:
Name Type Attributes Description
success boolean
error string <optional>
 Message d'erreur éventuel
warnings Array.<string> <optional>
 Avertissements éventuels sur la ressource (incohérences ne justifiant pas une erreur et le rejet de l'enregistrement)
oid Integer
Source: