LC User Registration Contract

Purpose:

This page will provide the API contracts for LC user registration.
POST:
API:https://folio-dev-volaris-edge.ci.folio.org/patron/account/{patronId}? apiKey=eyJzIjoiWDhoYmM1THJDeSIsInQiOiJ0ZXN0ZWRnZWRjYiIsInUiOiJkY2JDbGllbnQifQ==

NOTE:- we can provide any existing id of a patron OR extSystemId of an existing user.(will be used internally to perform operation on behalf of the user)

PAYLOAD:

{
  "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"]
}

RESPONSE:

-A user will be created with userType “patron” and patron_group “Remote Non-circulating“ ,

-Address0 as primary address and addressType as work.

-Address1 as secondary address and addressType as home if present.
-

  {
  "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:
API: https://folio-dev-volaris-edge.ci.folio.org/patron/account/{patronId}/by-email/{emailId}? apiKey=eyJzIjoiWDhoYmM1THJDeSIsInQiOiJ0ZXN0ZWRnZWRjYiIsInUiOiJkY2JDbGllbnQifQ==

PAYLOAD:

{
  "generalInfo": {
    "externalSystemId": "ext-5555",
    "firstName": "sdfdgfsfsd",
    "preferredFirstName": "dfsd",
    "middleName": "bbb",
    "lastName": "DDD"
  },
  "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"]
}

RESPONSE:

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

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

PAYLOAD: none

RESPONSE:

A user will be returned in the form of external_patron .

  "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"]
}