API v1.0 : Usagers - www.pretnumerique.ca

Recherche d'un usager

get https://www.pretnumerique.ca/v1/providers/[provider_id]/members.[xml | json]

Paramètres

Nom	Obligatoire	Description
provider_id	Oui	Votre identifiant d'organisation
q	Non	Terme de recherche général
email	Non	Adresse courriel de l'usager
identifier	Non	Identifiant de l'usager

Réponse réussie

Code	Description
200	Recherche effectuée avec succès.

{
  members: [
    {
      "identifier": "20120116205323sVtOoOCU",
      "email": "[email protected]",
      "name": "John Smith",
      "phone": "555-555-5555",
      "created_at": "2011-06-22T18:06:26-04:00",
      "library_name": "Library of Neverland",
      "library_identifier": "library_of_neverland",
      "network_library":"Sub Library name",
      "network_library_id":"Sub Library identifier",
      "last_loan_at": "2012-01-16T15:57:42-05:00",
      "last_login_at": "2012-01-16T15:53:23-05:00",
      "total_loans": "5",
      "active_loans": "2",
      "total_bookings": "7",
      "active_bookings": "4"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<members type="array">
  <member>
    <identifier>20120116205323sVtOoOCU</identifier>
    <email>[email protected]</email>
    <name>John Smith</name>
    <phone>555-555-5555</phone>
    <created_at>2011-06-22T18:06:26-04:00<created_at>
    <library_name>Library of Neverland</library_name>
    <library_identifier>library_of_neverland</library_identifier>
    <network_library>Sub Library name</network_library>
    <network_library_id>Sub Library identifier</network_library>
    <last_loan_at>2012-01-16T15:57:42-05:00</last_loan_at>
    <last_login_at>2012-01-16T15:53:23-05:00</last_login_at>
    <total_loans>5</total_loans>
    <active_loans>2</active_loans>active_loans
    <total_bookings>7</total_bookings>
    <active_bookings>4</active_bookings>
  </member>
</members>

Récupération d'un usager

get https://www.pretnumerique.ca/v1/providers/[provider_id]/members[identifier].[xml | json]

Paramètres

Nom	Obligatoire	Description
provider_id	Oui	Votre identifiant d'organisation
identifier	Oui	Identifiant de l'usager

Réponse réussie

Code	Description
200	Usager récupéré avec succès.

{
  "identifier": "20120116205323sVtOoOCU",
  "email": "[email protected]",
  "name": "John Smith",
  "phone": "555-555-5555",
  "created_at": "2011-06-22T18:06:26-04:00",
  "library_name": "Library of Neverland",
  "library_identifier": "library_of_neverland",
  "network_library":"Sub Library name",
  "network_library_id":"Sub Library identifier",
  "last_loan_at": "2012-01-16T15:57:42-05:00",
  "last_login_at": "2012-01-16T15:53:23-05:00",
  "total_loans": "5",
  "active_loans": "2",
  "total_bookings": "7",
  "active_bookings": "4"
}

<?xml version="1.0" encoding="UTF-8"?>
<member>
  <identifier>20120116205323sVtOoOCU</identifier>
  <email>[email protected]</email>
  <name>John Smith</name>
  <phone>555-555-5555</phone>
  <created_at>2011-06-22T18:06:26-04:00<created_at>
  <library_name>Library of Neverland</library_name>
  <library_identifier>library_of_neverland</library_identifier>
  <network_library>Sub Library name</network_library>
  <network_library_id>Sub Library identifier</network_library>
  <last_loan_at>2012-01-16T15:57:42-05:00</last_loan_at>
  <last_login_at>2012-01-16T15:53:23-05:00</last_login_at>
  <total_loans>5</total_loans>
  <active_loans>2</active_loans>active_loans
  <total_bookings>7</total_bookings>
  <active_bookings>4</active_bookings>
</member>

Création d'un compte d'usager

post https://www.pretnumerique.ca/v1/providers/[provider_id]/members.[xml | json]

Paramètres

Nom	Obligatoire	Description
provider_id	Oui	Votre identifiant d'organisation
email	Oui	Adresse courriel de l'usager
force_auth	Oui	Toujours inscrire 1
identifier	Non	Identifiant de l'usager
name	Non	Nom de l'usager
networked_library_id	Non	Identifiant de la bibliothèque du réseau

Réponse réussie

Code	Description
200	Le compte d'usager a été créé avec succès.

{
  "state": "success"
  "identifier": "abc123"
}

<member>
  <state>success</state>
  <identifier>abc123</identifier>
</member>

Réponse échouée

Code	Description
400	Un paramètre obligatoire de la requête est manquant ou la syntaxe est erronée.

{
  "errors": [
    { "id": "invalid_email", "message": "L'adresse courriel est invalide."}
  ]
}

<member>
  <errors>
    <error>
      <id>invalid_email</id>
      <message>L'adresse courriel est invalide.</message>
    </error>
  </errors>
</member>

Code : 400

identifier_already_existsL'identifiant existe déjà.

email_blankUne adresse courriel est requise.

invalid_emailL'adresse courriel est invalide.

email_already_existsL'adresse courriel est déjà utilisée.

Mise à jour d'un compte d'usager

put https://www.pretnumerique.ca/v1/providers/[provider_id]/members/[member_id].[xml | json]

Paramètres

Nom	Obligatoire	Description
provider_id	Oui	Votre identifiant d'organisation
member_id	Oui	Identifiant de l'usager
name	Non	Nom de l'usager
email	Non	Adresse courriel de l'usager
networked_library_id	Non	Identifiant de la bibliothèque du réseau

Réponse réussie

Code	Description
200	Le compte d'usager a été mis à jour avec succès.

{
  "state": "success"
}

<member>
  <state>success</state>
</member>

Réponse échouée

Code	Description
400	Un paramètre obligatoire de la requête est manquant ou la syntaxe est erronée.
404	L'usager n'existe pas.

{
  "errors": [
    { "id": "invalid_email", "message": "Le courriel est invalide"}
  ]
}

<member>
  <errors>
    <error>
      <id>invalid_email</id>
      <message>Le courriel est invalide</message>
    </error>
  </errors>
</member>

Code : 400

invalid_emailL'adresse courriel est invalide.

email_already_existsL'adresse courriel est déjà utilisée.

Code : 404

member_does_not_existL'usager n'existe pas.

Suppression d'un compte d'usager

delete https://www.pretnumerique.ca/v1/providers/[provider_id]/members/[member_id].[xml | json]

Paramètres

Nom	Obligatoire	Description
provider_id	Oui	Votre identifiant d'organisation
member_id	Oui	Identifiant de l'usager

Réponse réussie

Code	Description
200	Le compte d'usager a été supprimé avec succès.

{
  "state": "success"
}

<member>
  <state>success</state>
</member>

Réponse échouée

Code	Description
404	L'usager n'existe pas

{
    "errors": [
        {
            "id": "member_does_not_exist",
            "message": "L'usager n'a pu être trouvé"
        }
    ]
}

<?xml version="1.0" encoding="UTF-8"?>
<member>
    <errors type="array">
        <error>
            <id>member_does_not_exist</id>
            <message>L'usager n'a pu être trouvé</message>
        </error>
    </errors>
</member>

Code : 404

member_does_not_existL'usager n'a pu être trouvé