...
Description: Create patron.
API: https://folio-dev-volaris-edge.ci.folio.org/patron/account/{patronIdexternalSystemID}? apiKeyapikey=eyJzIjoiWDhoYmM1THJDeSIsInQiOiJ0ZXN0ZWRnZWRjYiIsInUiOiJkY2JDbGllbnQifQeyJzIjoieHFpNzNjNEZzOSIsInQiOiJkaWt1IiwidSI6ImRpa3VfYWRtaW4ifQ==
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:
| Code Block |
|---|
{
"generalInfo": {
"externalSystemId": "ext-5555-kapil-new-record-100",
"firstName": "sdfdgfsfsdnew-record-100",
"preferredFirstName": "dfsdNew Record",
"middleName": "bbb",
"lastName": "cccnew-record-100"
},
"address0addressInfo": {
"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-112233123456",
"mobilePhone": "555-5678",
"email": "test@maivffglnew-record-100@test.com"
},
"preferredEmailCommunication": ["ProgramsSupport", "SupportPrograms", "ServiceServices"]
}
|
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.
-
addressInfo is stored in Folio as Home
-
| Code Block |
|---|
{
"generalInfo": {
"externalSystemId": "ext-5555kapil-new-record-100",
"firstName": "sdfdgfsfsdnew-record-100",
"preferredFirstName": "dfsdNew Record",
"middleName": "bbb",
"lastName": "ccc"new-record-100"
},
"address0addressInfo": {
"addressLine0": "123 Main St",
"addressLine1": "Apt 4B",
"city": "Metropolis",
"province": "NY",
"zip": "12345",
"country": "USA"
},
"address1contactInfo": {
"addressLine0": "456 Side St", "addressLine1phone": "Suite 500555-123456",
"city": "Metropolis", "provincemobilePhone": "NY555-5678",
"zip": "12346", "countryemail": "USAnew-record-100@test.com"
},
"contactInfopreferredEmailCommunication": [
{ "phone": "555-112233Support",
"mobilePhone": "555-5678Programs",
"email": "test@maivffglServices"
}, "preferredEmailCommunication": ["Programs","Support","Service"]
} |
PUT:
Description: Update patron by email.
API: https://folio-dev-volaris-edge.ci.folio.org/patron/account/{patronId}1122/by-email/{emailId}? apiKey=eyJzIjoiWDhoYmM1THJDeSIsInQiOiJ0ZXN0ZWRnZWRjYiIsInUiOiJkY2JDbGllbnQifQext-kapil-2@test.com?apikey=eyJzIjoieHFpNzNjNEZzOSIsInQiOiJkaWt1IiwidSI6ImRpa3VfYWRtaW4ifQ==
PAYLOAD:
| Code Block |
|---|
{
"generalInfo": {
"externalSystemId": "ext-5555kapil-2",
"firstName": "sdfdgfsfsd", "preferredFirstNamefirstName": "dfsdKapil2",
"middleName": "bbb", "lastNamepreferredFirstName": "DDD"Inactive or },Expired "address0": {
"addressLine0": "123 Main St",
"addressLine1and Remote Non-circulation",
"middleName": "Apt 4B",
"city": "Metropolis", "provincelastName": "NYSony",
"zip": "12345" },
"countryaddressInfo": "USA"{
}, "address1": {
"addressLine0": "456123 SideMain St",
"addressLine1": "SuiteApt 5004B",
"city": "Metropolis",
"province": "NY",
"zip": "1234612345",
"country": "USA"
},
"contactInfo": {
"phone": "555-112233123456",
"mobilePhone": "555-5678",
"email": "test@maivffglext-kapil-2@test.com"
},
"preferredEmailCommunication": ["Programs","Support", "ServicePrograms"]
}
|
RESPONSE:
A user will be updated with provided payload with API response 204
...
Description: Get patron by email.
API: https://folio-dev-volaris-edge.ci.folio.org/patron/account/{patronId}1122/by-email/{emailId}? apiKey=eyJzIjoiWDhoYmM1THJDeSIsInQiOiJ0ZXN0ZWRnZWRjYiIsInUiOiJkY2JDbGllbnQifQext-kapil-2@test.com?apikey=eyJzIjoieHFpNzNjNEZzOSIsInQiOiJkaWt1IiwidSI6ImRpa3VfYWRtaW4ifQ==
PAYLOAD: none
RESPONSE:
A user will be returned in the form of external_patron .
| Code Block |
|---|
{ "city "generalInfo": { "externalSystemId": "ext-kapil-new-record-100", "firstName": "Metropolisnew-record-100", "provincepreferredFirstName": "NYNew Record", "zipmiddleName": "12345", "countrylastName": "USA" new-record-100" }, "address1addressInfo": { "addressLine0": "456123 SideMain St", "addressLine1": "SuiteApt 5004B", "city": "Metropolis", "province": "NY", "zip": "1234612345", "country": "USA" }, "contactInfo": { "phone": "555-112233123456", "mobilePhone": "555-5678", "email": "test@maivffglnew-record-100@test.com" }, "preferredEmailCommunication": ["Programs","Support","Service"] } "Support", "Programs", "Services" ] } |
GET:
Description: Get expired LC patrons.
API: https://folio-dev-volaris-edge.ci.folio.org/patron/account/{patronId}? apiKey=eyJzIjoiWDhoYmM1THJDeSIsInQiOiJ0ZXN0ZWRnZWRjYiIsInUiOiJkY2JDbGllbnQifQ==1122/external-patrons?apikey=eyJzIjoieHFpNzNjNEZzOSIsInQiOiJkaWt1IiwidSI6ImRpa3VfYWRtaW4ifQ==&expired=true
PAYLOAD: noneNOTE: 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": { "externalSystemIdgeneralInfo": "ext123",{
"firstName": "John", "preferredFirstNameexternalSystemId": "Johnnyext-kapil-2",
"middleName": "Michael", "lastNamefirstName": "Doe"
}Kapil2",
"address0": { "addressLine0preferredFirstName": "123 Main StInactive or Expired and Remote Non-circulation",
"addressLine1": "", "citylastName": "AnytownKapil2",
"province": "California", },
"zip": "12345", "countryaddressInfo": "USA"{
}, "contactInfo": { "phone"addressLine0": "123-456-7890 Main St",
"mobilePhone": "987-654-3210", "emailaddressLine1": "john.doe@example.com"Apt 4B",
}, "preferredEmailCommunicationcity": ["SupportMetropolis",
"Programs"] }, { "country": "generalInfo":
{ "externalSystemId": "ext456", },
"firstNamecontactInfo": "Jane",{
"preferredFirstName": "Janey", "lastNamephone": "Smith"
}555-123456",
"address0": { "addressLine0mobilePhone": "456 Oak Ave555-5678",
"addressLine1": "Apt 2B", "cityemail": "Smallville",ext-kapil-2@test.com"
"province": "Kansas", },
"zip": "54321",
"countrypreferredEmailCommunication": "USA"[
},
"contactInfo": { "phone": "987-654-3210Programs",
"mobilePhone": "123-456-7890", "emailSupport":
"jane.smith@example.com" }, ]
"preferredEmailCommunication": ["Programs", "Service"] }
],
"totalRecords": 1 2
} |