Liste des prêts

Ce service permet de récupérer la liste complète de vos prêts.

Il vous est possible de préciser une recherche en spécifiant certains paramètres. Vous recevrez alors une liste partielle de résultat répondant aux critères spécifiés.

En fonction du nombre de prêts qui constituerons cette liste, il est possible qu'elle soit composée de plusieurs liste et qu'elle doive être récupérée en plusieurs requêtes. Pour plus d'information, référez-vous à la section « Pagination » de la page « Concepts généraux » du présent guide.

get https://www.pretnumerique.ca/v1/loans.[xml | json]

Paramètres

Nom Obligatoire Description
member_idNonIdentifiant de l'usager.
start_atNonDate de début de la liste de prêts. Doit être au format ISO 8601 étendu. Si aucune valeur n'est indiquée, la liste débute avec le premier prêt.
end_atNonDate de fin de la liste de prêts. Doit être au format ISO 8601 étendu. Si aucune valeur n'est indiquée, la liste se termine avec le dernier prêt.

Réponse réussie

{
   "loans":[
      {
         "id":"522f30dba5f317bf49000004",
         "created_at":"2014-01-01T12:00:00Z",
         "downloads":[
           "2014-01-01T13:00:00Z"
         ],
         "expires_at":"2014-01-21T12:00:00Z",
         "hold_expires_at":null,
         "shippings":[
            "2014-01-01T12:05:00Z"
         ],
         "member_id":"jsmith",
         "resource_id":"ENQC1234",
         "key":"9987654321234",
         "key_type":"isbn"
      }
    ]
}


<loan>
  <id>522f30dba5f317bf49000004</id>
  <created_at>2014-01-01T12:00:00Z</created_at>
  <downloads>
    <download>2014-01-01T13:00:00Z</download>
  </downloads/>
  <expires_at>2014-01-21T12:00:00Z</expires_at>
  <hold_expires_at/>
  <shippings>
    <shipping>2014-01-01T12:05:00Z</shipping>
  </shippings>
  <member_id>jsmith</member_id>
  <resource_id>ENQC1234</resource_id>
  <key>9987654321234</key>
  <key_type>isbn</key_type>
</loan>
Identifiant du prêt
Date de création du prêt (ISO 8601)
Date où il y a eu un téléchargement du livre emprunté (ISO 8601)
Date d'expiration du prêt (ISO 8601)
Élément vide (XML) ou null (JSON)
Date à laquelle le courriel de confirmation de demande de prêt a été envoyé (ISO 8601)
Identifiant de l'usager
Identifiant de la ressource
Identifiant du média
Type d'identifiant (key). Exemples: ISBN, EAN, custom

Création d'un prêt

Ce service Web permet de créer un prêt pour un usager et retourne une URL de téléchargement. Il est aussi possible d'envoyer à l'usager un courriel contenant le lien de téléchargement.

Notez qu'il est obligatoire de fournir un identifiant d'usager unique (member_id) pour cette version du service.

post https://www.pretnumerique.ca/v1/media/[medium_id]/loans.[xml | json]

Paramètres

Nom Obligatoire Description
medium_idOuiIdentifiant du medium.
member_idOuiIdentifiant de l'usager.
expires_atNonDate d'expiration du prêt. La date doit être au format ISO 8601 étendu. Si aucune valeur n'est indiquée, le prêt expirera à la date qui a été configurée par défaut par l'organisation.
notifyNonSi notify est à 1, un courriel sera envoyé à l'usager contenant le lien de récupération du prêt.
emailNonAdresse courriel de l'usager où sera envoyé le lien pour récupérer le prêt. Ce paramètre est obligatoire si notify est à 1.
return_urlNonURL qui sera appelée avec la méthode POST s'il y a un retour anticipé du prêt.

Réponse réussie

Code Description
201 Prêt créé avec succès.
200 Le prêt existe déjà. La date de fin de prêt reste la même que lors de la création. 
{
  "url": "https://www.pretnumerique.ca/loans/123",
  "expires_at": "2011-01-30T13:00:00"
}

<loan>
  <url>https://www.pretnumerique.ca/loans/123</url>
  <expires_at>2011-01-30T13:00:00</expires_at>
</loan>
Lien de téléchargement du prêt.
Date d'expiration du prêt.

Réponse échouée

Code Description
400 Un paramètre obligatoire de la requête est manquant ou la syntaxe est erronée.
403 La quantité limite de prêts a été atteinte pour un usager.
404 La ressource et/ou son média n'existe pas. 
{
  "errors": ["invalid_email","missing_member_id"]
}

<loan>
  <errors>
    <error>invalid_email</error>
    <error>missing_member_id</error>
  </errors>
</loan>

Code : 400

L'adresse courriel est invalide.
L'adresse courriel est déjà utilisée
L'identifiant de l'usager est manquant.

Code : 403

Vous avez atteint le maximum de prêts autorisés par votre bibliothèque.
Cet usager a atteint le nombre maximal de prêts par jour.
Cet usager a atteint le nombre maximal de prêts par mois.
Toutes les ressources sont actuellement prêtées.

Code : 404

Le média est introuvable.

Récupération d'un prêt

Le service de récupération de prêt permet de récupérer le fichier ACSM qui devra être utilisé par l'usager pour le téléchargement de son prêt.

Le service de récupération de prêt ne peut être utilisé qu'après la création d'un prêt, à l'aide du service de création de prêt. Lors de la création d'un prêt, le service de création de prêt retourne l'URL devant être utilisée dans le présent service.

get https://www.pretnumerique.ca/v1/loans/[loan_id]

Paramètres

Nom Obligatoire Description
loan_idOuiIdentifiant du prêt.

Réponse réussie

Code Description
200 Fichier ACS4 téléchargé avec succès
Fichier permettant à l'usager d'accéder au prêt.

Réponse échouée

Code Description
403 Le prêt demandé est expiré.
404 Le prêt demandé n'existe pas. 
{
  "errors": ["loan_not_found"]
}

Code : 404

Le prêt est introuvable.

Code : 403

Le prêt est expiré.
La période de disponibilité de ce prêt est expirée.
Cet usager a atteint le nombre maximal de prêts.
Cet usager a atteint le nombre maximal de prêts par jour.
Cet usager a atteint le nombre maximal de prêts par mois.