Versions Compared

Key

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

...

Zen Section
id1117766572

Users

Get user by username

  • HTTP Verb: GET
  • Authorization: Secured
  • Supports OData: No
  • Minimum API Version: 1
  • Minimum Web Platform Version: 8.7.2.0

Returns user details for a given username.

Code Block
titleExample Get User by Username Request
linenumberstrue
languagexml
collapsetrue
GET https://your.illiad.edu/ILLiadWebPlatform/Users/msmith
Accept-Type: application/json

Response

Code Block
titleExample Get User by Username Response
linenumberstrue
languagetext
collapsetrue
  {
      "UserName":"msmith",
      "ExternalUserId":"123456789",
      "LastName":"Smith",
      "FirstName":"Michael",
      "SSN":987654321,
      "Status":"Staff",
      "EMailAddress":"msmith@your.illiad.edu",
      "Phone":"555-1212",
      "MobilePhone":"NULL",
      "Department":"Computer Science",
      "NVTGC":"ILL",
      "Password":"10471281899082626783",
      "NotificationMethod":"Electronic",
      "DeliveryMethod":"Hold for Pickup",
      "LoanDeliveryMethod":"Hold for Pickup",
      "LastChangedDate":"2016-06-01T08:30:35.15",
      "AuthorizedUsers":"NULL",
      "Cleared":"BO",
      "Web":"Yes",
      "Address":"123 Main St",
      "Address2":"",
      "City":"Virginia Beach",
      "State":"VA",
      "Zip":"23464",
      "Site":null,
      "ExpirationDate":"2017-06-01T08:30:35.15",
      "Number":"8765670098",
      "UserRequestLimit":null,
      "Organization":null,
      "Fax":null,
      "ShippingAcctNo":null,
      "ArticleBillingCategory":"Default",
      "LoanBillingCategory":"Default",
      "Country":null,
      "SAddress":null,
      "SAddress2":null,
      "SCity":null,
      "SState":null,
      "SZip":null,
      "PasswordHint":null,
      "SCountry":null,
      "RSSID":"10098718781900019",
      "AuthType":"ILLiad",
      "UserInfo1":"PY12345",
      "UserInfo2":null,
      "UserInfo3":null,
      "UserInfo4":null,
      "UserInfo5":null
   }
HTTP Status CodeDescription
Status
colourGreen
title200
subtletrue
OK
Status
colourRed
title401
subtletrue
Unauthorized
Status
colourRed
title404
subtletrue
Resource Not Found
Status
colourRed
title500
subtletrue
Internal Server Error

 

Get user by external user id

  • HTTP Verb: GET
  • Authorization: Secured
  • Supports OData: No
  • Minimum API Version: 1
  • Minimum Web Platform Version: 8.7.2.0

Returns user details for a given external user id.

Code Block
titleExample Get User by External User Id Request
linenumberstrue
languagetext
collapsetrue
GET https://your.illiad.edu/ILLiadWebPlatform/Users/ExternalUserId/123456789
Accept-Type: application/json
Info
titleExternal User Id
Anchor
ExternalUserId
ExternalUserId
The external user id is a configurable field that maps to an existing ILLiad field in the Users table. The external user id mapping is configured to be specific for each Web Platform API key that is generated allowing each Web Platform API consumer to have it's own external user id. The default mapping is set to the Username field. Staff at the ILLiad library will need to use the customization manager to modify the mapping for the ExternalUserId. ILLiad libraries are responsible to ensure that the external user id value is unique. The API will error if multiple records are found for the same external user id. 

 

Response

Code Block
titleExample Get User by External User Id Response
linenumberstrue
languagetext
collapsetrue
 {
      "UserName":"msmith",
      "ExternalUserId":"123456789",
      "LastName":"Smith",
      "FirstName":"Michael",
      "SSN":987654321,
      "Status":"Staff",
      "EMailAddress":"msmith@your.illiad.edu",
      "Phone":"555-1212",
      "MobilePhone":"NULL",
      "Department":"Computer Science",
      "NVTGC":"ILL",
      "Password":"10471281899082626783",
      "NotificationMethod":"Electronic",
      "DeliveryMethod":"Hold for Pickup",
      "LoanDeliveryMethod":"Hold for Pickup",
      "LastChangedDate":"2016-06-01T08:30:35.15",
      "AuthorizedUsers":"NULL",
      "Cleared":"BO",
      "Web":"Yes",
      "Address":"123 Main St",
      "Address2":"",
      "City":"Virginia Beach",
      "State":"VA",
      "Zip":"23464",
      "Site":null,
      "ExpirationDate":"2017-06-01T08:30:35.15",
      "Number":"8765670098",
      "UserRequestLimit":null,
      "Organization":null,
      "Fax":null,
      "ShippingAcctNo":null,
      "ArticleBillingCategory":"Default",
      "LoanBillingCategory":"Default",
      "Country":null,
      "SAddress":null,
      "SAddress2":null,
      "SCity":null,
      "SState":null,
      "SZip":null,
      "PasswordHint":null,
      "SCountry":null,
      "RSSID":"10098718781900019",
      "AuthType":"ILLiad",
      "UserInfo1":"PY12345",
      "UserInfo2":null,
      "UserInfo3":null,
      "UserInfo4":null,
      "UserInfo5":null
   }
HTTP Status CodeDescription
Status
colourGreen
title200
subtletrue
OK
Status
colourRed
title401
subtletrue
Unauthorized
Status
colourRed
title404
subtletrue

Resource Not Found

Code Block
titleExample Resource Not Found
linenumberstrue
collapsetrue
{
    "Message": "Could not find unique user with external user id 123123123."
}
Status
colourRed
title500
subtletrue
Internal Server Error

     

 

Create User

 

  • HTTP Verb: POST
  • Authorization: Secured
  • Supports OData: No
  • Minimum API Version: 1
  • Minimum Web Platform Version: 9.0.1.0

 

Creates a new user. 

 

Info

A note will be added for the user to indicate the user was created via the Web Platform and which API key created the record.

 

Code Block
titleExample Get User by External User Id Request
linenumberstrue
languagetext
collapsetrue
POST https://your.illiad.edu/ILLiadWebPlatform/Users
Accept-Type: application/json
{
  "Username" : "bdoe",  
  "ExternalUserId": "Z20181116",
  "FirstName":"Bailey",
  "LastName":"Doe",
  "EmailAddress" : "bailey@test.com" ,
  "DeliveryMethod" : "Hold for Pickup",
  "LoanDeliveryMethod" : "Mail to Address",
  "NotificationMethod" : "Electronic",
  "Phone" : "757-123-4568",
  "Status" : "Graduate",
  "PlainTextPassword": "MySpecialPassword1234!",
  "AuthType" : "ILLiad",
  "Department" : "Music",
  "Web" : true,
  "Address" : "123 Oak St",
  "Address2" : "Apt 4E",
  "City" : "Virgia Beach",
  "State" : "VA",
  "Zip" : "23462"
}

Parameters

FieldTypeDefault if not providedNote
Usernamestring Required field.
ExternalUserIdstring 

The ExternalUserId field is a dynamic field configured by the institution for each API Key.

Info

An ExternalUserId will always override the a value supplied for the mapped field. A user note will be added if the two values conflict and what the original mapped value was set to.

LastNamestring  
FirstNamestring  
SSNstring  
Statusstring  
EMailAddressstring  
Phonestring  
MobilePhonestring  
Departmentstring  
NVTGCstringThe NVTGC associated with the API Key.Each institution may have unique values. Consult with institution for allowed values.
NotificationMethodenumElectronic
Allowed Values
Electronic
Phone
Mail
DeliveryMethodenumHold for Pickup
Allowed Values
Hold for Pickup
Mail to Address
LoanDeliveryMethodenumHold for Pickup
Allowed Values
Hold for Pickup
Mail to Address
AuthorizedUsersstring  
ClearedenumNo
Allowed ValuesDescription
YesThe user is allowed to use the system.
NoThe user has not yet been vetted by staff.
NewUser is new to the system and has not completed their user profile. On their first login they will be forced to complete their user profile.
DISThe user is disavowed and not authorized to log in.
BThe user is blocked.
BOThe user is blocked due to an overdue. Overdue blocks are removed when the user no longer has overdue materials checked out.
BXThe user is blocked by an external system.
WebbooltrueWhen true, the user will receive articles electronically.
Addressstring  
Address2string  
Citystring  
Statestring  
Zipstring  
Countrystring  
Sitestring  
ExpirationDatedatetimeThe User Expiration Date is set based upon system rules. 
Numberstring  
UserRequestLimitinteger This field should only be set if the user has a custom request limit.
Organizationstring  
Faxstring  
ShippingAcctNostring  
ArticleBillingCategorystring  
LoanBillingCategorystring  
SAddressstring This is for a secondary address.
SAddress2string This is for a secondary address.
SCitystring This is for a secondary address.
SStatestring This is for a secondary address.
SZipstring This is for a secondary address.
SCountrystring This is for a secondary address.
AuthTypeenum 
Allowed ValuesNote
DefaultThe user will login with the default user authentication system.
ILLiad

The user will login with their ILLiad username and password.

Consider supplying a PlainTextPassword so the user can access their web account. If a password is not provided, the user will need to reset their password or contact staff for assistance.

PlainTextPasswordstring The password the user will use for authenticating to the web interface.
UserInfo1string  
UserInfo2string  
UserInfo3string  
UserInfo4string  
UserInfo5string  
NotificationPreferencesArray of NotificationPreferencesEmail Notification preferences are added for all available activities.

Each NotificationPreference consists of an ActivityType and NotificationType.

Allowed NotificationTypes
ValueDescription
SMSIndicates the user wants an SMS notification, when available. A MobilePhone value should be provided.
EmailIndicated the user wants an Email notification, when available. An EmailAddress should be provided.
Allowed NotificationTypes
ValueDescription
ClearedUserThe type of notification received when the user is cleared to use the system.
PasswordResetThe type of notification received when the user requested a password reset.
RequestPickupThe type of notification received when material is available to be picked up by the user at the library.
RequestShippedThe type of notification received when material is shipped to the user.
RequestElectronicDeliveryThe type of notification received when the user receives material via electronic delivery.
RequestOverdueThe type of notification received when the user has material checked out that is overdue.
RequestCancelledThe type of notification received when a request placed by the user is cancelled.
RequestOtherThe type of notification received for any other notification generated by the system that is not listed above.
Code Block
titleSample NotificationPreferences
languagejs
"NotificationPreferences" : [
    {
    "ActivityType" : "RequestPickup",
    "NotificationType" : "SMS"
  	},
    {
    "ActivityType" : "RequestPickup",
    "NotificationType" : "Email"
  	},
    {
    "ActivityType" : "RequestOther",
    "NotificationType" : "Email"
  	},
  ]  

Required Parameters

Username

Indicates the username of the new transaction

Response

Code Block
titleExample Create User Response
linenumberstrue
languagetext
collapsetrue
{
    "UserName": "bdoe",
    "ExternalUserId": "Z20181116",
    "LastName": "Doe",
    "FirstName": "Bailey",
    "SSN": "Z20181116",
    "Status": "Graduate",
    "EMailAddress": "bailey@test.com",
    "Phone": "757-123-4568",
    "Department": "Music",
    "NVTGC": "ADAMS",
    "NotificationMethod": "Electronic",
    "DeliveryMethod": "Hold for Pickup",
    "LoanDeliveryMethod": "Mail to Address",
    "LastChangedDate": "2018-11-26T12:00:01.000",
    "AuthorizedUsers": null,
    "Cleared": "No",
    "Web": true,
    "Address": "123 Oak St",
    "Address2": "Apt 4E",
    "City": "Virgia Beach",
    "State": "VA",
    "Zip": "23462",
    "Site": null,
    "ExpirationDate": "2019-05-15T12:00:01.000",
    "Number": null,
    "UserRequestLimit": null,
    "Organization": null,
    "Fax": null,
    "ShippingAcctNo": null,
    "ArticleBillingCategory": null,
    "LoanBillingCategory": null,
    "Country": null,
    "SAddress": null,
    "SAddress2": null,
    "SCity": null,
    "SState": null,
    "SZip": null,
    "SCountry": null,
    "RSSID": null,
    "AuthType": "ILLiad",
    "UserInfo1": null,
    "UserInfo2": null,
    "UserInfo3": null,
    "UserInfo4": null,
    "UserInfo5": null,
    "MobilePhone": null
}

 

 

HTTP Status CodeDescription
Status
colourGreen
title200
subtletrue
OK (Successfully created request)

Status
colourRed
title400
subtletrue

Bad Request

Code Block
titleExample Bad Request
languagetext
collapsetrue
{
    "Message": "The request is invalid.",
    "ModelState": {
        "model.NVTGC": [
            "The NVTGC is invalid."
        ]
    }
}
Status
colourRed
title401
subtletrue
Unauthorized
Status
colourRed
title500
subtletrue
Internal Server Error (Unexpected error)
Zen Section
id1117745298

Zen Section
id1117721618

...