POST api/library/security/login

No documentation available.

Request Information

Parameters

NameDescriptionAdditional information
d 
No documentation available.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample: 
{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "Token": "sample string 3",
  "UserID": "sample string 4"
}

application/xml, text/xml

Sample: 
<LoginCredentials xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Blackpool.Libraries.Models">
  <Token xmlns="http://schemas.datacontract.org/2004/07/Blackpool.Libraries.Models.Base">sample string 3</Token>
  <UserID xmlns="http://schemas.datacontract.org/2004/07/Blackpool.Libraries.Models.Base">sample string 4</UserID>
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</LoginCredentials>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample: 
{
  "userIDField": "sample string 1",
  "sessionTokenField": "sample string 2",
  "userMiscInfoField": {
    "userKeyField": 1,
    "displayNameField": "sample string 2",
    "privilegeLevelField": 0,
    "sharedLoginField": true,
    "libraryIDField": "sample string 4",
    "libraryDescriptionField": "sample string 5",
    "accessIDField": "sample string 6",
    "accessDescriptionField": "sample string 7",
    "environmentIDField": "sample string 8",
    "environmentDescriptionField": "sample string 9",
    "datePrivilegeExpiresField": "2026-03-09T06:06:20.7640242+00:00",
    "userPrivilegeExpiresSoonField": "2026-03-09T06:06:20.7640242+00:00",
    "userPrivilegeExpiresSoonFieldSpecified": true,
    "userAccnClearanceIDField": "sample string 13",
    "userAccnClearanceDescriptionField": "sample string 14",
    "userAccnPatronTypeField": 0,
    "userAccnPatronTypeFieldSpecified": true,
    "PropertyChanged": null
  },
  "PropertyChanged": null
}

application/xml, text/xml

Sample: 
<LoginUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Blackpool.Libraries.Security">
  <PropertyChanged xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel" i:nil="true" />
  <sessionTokenField>sample string 2</sessionTokenField>
  <userIDField>sample string 1</userIDField>
  <userMiscInfoField>
    <PropertyChanged xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.ComponentModel" i:nil="true" />
    <accessDescriptionField>sample string 7</accessDescriptionField>
    <accessIDField>sample string 6</accessIDField>
    <datePrivilegeExpiresField>2026-03-09T06:06:20.7640242+00:00</datePrivilegeExpiresField>
    <displayNameField>sample string 2</displayNameField>
    <environmentDescriptionField>sample string 9</environmentDescriptionField>
    <environmentIDField>sample string 8</environmentIDField>
    <libraryDescriptionField>sample string 5</libraryDescriptionField>
    <libraryIDField>sample string 4</libraryIDField>
    <privilegeLevelField>EXTENDED_PUB</privilegeLevelField>
    <sharedLoginField>true</sharedLoginField>
    <userAccnClearanceDescriptionField>sample string 14</userAccnClearanceDescriptionField>
    <userAccnClearanceIDField>sample string 13</userAccnClearanceIDField>
    <userAccnPatronTypeField>EXTERNAL</userAccnPatronTypeField>
    <userAccnPatronTypeFieldSpecified>true</userAccnPatronTypeFieldSpecified>
    <userKeyField>1</userKeyField>
    <userPrivilegeExpiresSoonField>2026-03-09T06:06:20.7640242+00:00</userPrivilegeExpiresSoonField>
    <userPrivilegeExpiresSoonFieldSpecified>true</userPrivilegeExpiresSoonFieldSpecified>
  </userMiscInfoField>
</LoginUserResponse>