Skip to end of banner
Go to start of banner

LC User Registration Contract

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Purpose:

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

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”, Address1 as primary address and addressType as work.

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