Versions Compared

Version Old Version 2 New Version 3
Changes made by

Adesh Singh

Adesh Singh

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This page will provide the API contracts for LC user registration.
POST:

Description: Create patron.
API:https://folio-dev-volaris-edge.ci.folio.org/patron/account/{patronId}? apiKey=eyJzIjoiWDhoYmM1THJDeSIsInQiOiJ0ZXN0ZWRnZWRjYiIsInUiOiJkY2JDbGllbnQifQ==

...

Code Block
  {
  "generalInfo": {
    "externalSystemId": "ext-5555",
    "firstName": "sdfdgfsfsd",
    "preferredFirstName": "dfsd",
    "middleName": "bbb",
    "lastName": "ccc"
  },
  "address0": {
    "addressLine0": "123 Main St",
    "addressLine1": "Apt 4B",
    "city": "Metropolis",
    "province": "NY",
    "zip": "12345",
    "country": "USA"
  },
  "address1": {
    "addressLine0": "456 Side St",
    "addressLine1": "Suite 500",
    "city": "Metropolis",
    "province": "NY",
    "zip": "12346",
    "country": "USA"
  },
  "contactInfo": {
    "phone": "555-112233",
    "mobilePhone": "555-5678",
    "email": "test@maivffgl"
  },
  "preferredEmailCommunication": ["Programs","Support","Service"]
}

PUT:

Description: Update patron by email.
API: https://folio-dev-volaris-edge.ci.folio.org/patron/account/{patronId}/by-email/{emailId}? apiKey=eyJzIjoiWDhoYmM1THJDeSIsInQiOiJ0ZXN0ZWRnZWRjYiIsInUiOiJkY2JDbGllbnQifQ==

...

A user will be updated with provided payload with API response 204

GET:

Description: Get patron by email.
API: https://folio-dev-volaris-edge.ci.folio.org/patron/account/{patronId}/by-email/{emailId}? apiKey=eyJzIjoiWDhoYmM1THJDeSIsInQiOiJ0ZXN0ZWRnZWRjYiIsInUiOiJkY2JDbGllbnQifQ==

...

Code Block
  "city": "Metropolis",
    "province": "NY",
    "zip": "12345",
    "country": "USA"
  },
  "address1": {
    "addressLine0": "456 Side St",
    "addressLine1": "Suite 500",
    "city": "Metropolis",
    "province": "NY",
    "zip": "12346",
    "country": "USA"
  },
  "contactInfo": {
    "phone": "555-112233",
    "mobilePhone": "555-5678",
    "email": "test@maivffgl"
  },
  "preferredEmailCommunication": ["Programs","Support","Service"]
}

GET:

Description: Get LC patrons.
API: https://folio-dev-volaris-edge.ci.folio.org/patron/account/{patronId}? apiKey=eyJzIjoiWDhoYmM1THJDeSIsInQiOiJ0ZXN0ZWRnZWRjYiIsInUiOiJkY2JDbGllbnQifQ==

PAYLOAD: none

NOTE: Request parameter expired=true can be passed in order to get expired LC users.

RESPONSE:

A collection of LC users will be returned in the form of external_patron_collection .

Code Block
{
  "externalPatrons": [
    {
      "generalInfo": {
        "externalSystemId": "ext123",
        "firstName": "John",
        "preferredFirstName": "Johnny",
        "middleName": "Michael",
        "lastName": "Doe"
      },
      "address0": {
        "addressLine0": "123 Main St",
        "addressLine1": "",
        "city": "Anytown",
        "province": "California",
        "zip": "12345",
        "country": "USA"
      },
      "contactInfo": {
        "phone": "123-456-7890",
        "mobilePhone": "987-654-3210",
        "email": "john.doe@example.com"
      },
      "preferredEmailCommunication": ["Support", "Programs"]
    },
    {
      "generalInfo": {
        "externalSystemId": "ext456",
        "firstName": "Jane",
        "preferredFirstName": "Janey",
        "lastName": "Smith"
      },
      "address0": {
        "addressLine0": "456 Oak Ave",
        "addressLine1": "Apt 2B",
        "city": "Smallville",
        "province": "Kansas",
        "zip": "54321",
        "country": "USA"
      },
      "contactInfo": {
        "phone": "987-654-3210",
        "mobilePhone": "123-456-7890",
        "email": "jane.smith@example.com"
      },
      "preferredEmailCommunication": ["Programs", "Service"]
    }
  ],
  "totalRecords": 2
}