Patron Basic Data

Get Patron Basic Data

GET /api/.../patrons/{id}/basicdata

Return patron basic data. Typically called when displaying a patron summary.

The data object contains a property called 'PrivateFieldsCleared'. If set to true, the caller does not have either the 'Patron Status: Access' or 'Patron Registration: Access' permissions. Data is returned for checkout purposes, but the addresses, phone numbers, and username fields are cleared.

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the patron.

Response Information

Example
application/json, text/json
{
  "PatronID": 1,
  "Username": "sample string 2",
  "hasPassword", true,
  "NameFirst": "sample string 4",
  "NameLast": "sample string 5",
  "NameMiddle": "sample string 6",
  "LanguageID": 1,
  "DeliveryOptionID": 1,
  "ReadingListEnabled": true,
  "EmailFormatID": 8,
  "RequestPickupBranchID": 1,
  "PhoneNumber": "sample string 9",
  "Phone1": "sample string 10",
  "Phone2": "sample string 11",
  "Phone3": "sample string 12",
  "EMail": "sample string 13",
  "AltEMail": "sample string 14",
  "PhoneFax": "sample string 15",
  "SMSEnabled": true,
  "CarrierName": "sample string 17",
  "IsActiveORSPatron": true,
  "ItemsOutCount": 19,
  "ItemsOverdueCount": 20,
  "ItemsOutLostCount": 21,
    "HoldRequestsCurrentCount": 0
    "HoldRequestsHeldCount": 2
    "HoldRequestsILLHeldCount": 0
    "HoldRequestsILLTotalCount": 0
    "HoldRequestsLocalHeldCount": 2
    "HoldRequestsLocalTotalCount": 12
    "HoldRequestsShippedCount": 4
    "HoldRequestsTotalCount": 12
    "HoldRequestsUnclaimedCount": 3
  "ChargeBalance": 27.0,
  "CreditBalance": 28.0,
  "DepositBalance": 29.0,
  "Email2SMSAddress": "sample string 30",
  "EReceiptOptionID": 1,
  "Phone1CarrierID": 1,
  "Phone2CarrierID": 1,
  "Phone3CarrierID": 1,
  "TxtPhoneNumber": 1,
  "DMLID": 1,
  "ExcludeFromAlmostOverdueAutoRenew":false,
  "ExcludeFromInactivePatron":false,
  "ExcludeFromPatronRecExpiration":false,
  "RecordStatusID": 1,
  "RecordStatusDate":"2015-05-19T11:53:08.393-04:00",
  "DoNotShowEReceiptPrompt":false,
  "PrivateFieldsCleared": false,
  "StaffAcceptedUseSingleName": false,
  "Addresses": [
    {
      "AddressID": 1,
      "AddressLabelDescription": "sample string 2",
      "StreetOne": "sample string 3",
      "StreetTwo": "sample string 4",
      "StreetThree": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "County": "sample string 8",
      "PostalCode": "sample string 9",
      "ZipPlusFour": "sample string 10",
      "Country": "sample string 11",
      "CountryID": 12,
      "AddressTypeID": 13
    },
    {
      "AddressID": 1,
      "AddressLabelDescription": "sample string 2",
      "StreetOne": "sample string 3",
      "StreetTwo": "sample string 4",
      "StreetThree": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "County": "sample string 8",
      "PostalCode": "sample string 9",
      "ZipPlusFour": "sample string 10",
      "Country": "sample string 11",
      "CountryID": 12,
      "AddressTypeID": 13
    },
    {
      "AddressID": 1,
      "AddressLabelDescription": "sample string 2",
      "StreetOne": "sample string 3",
      "StreetTwo": "sample string 4",
      "StreetThree": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "County": "sample string 8",
      "PostalCode": "sample string 9",
      "ZipPlusFour": "sample string 10",
      "Country": "sample string 11",
      "CountryID": 12,
      "AddressTypeID": 13
    }
  ]
    "PatronCustomData":[
    {
        "PatronID":0,
        "PatronCustomDataDefinitionID":1,
        "PatronDataLabelValue":"Parent/Guardian",
        "PolarisCustomDataTypeID":2,"CustomDataEntry":null,
        "DefaultValue":null,"IsRequired":false,
        "IsEnabled":false,
        "IsDataChanged":false
    },
    {
        "PatronID":0,
        "PatronCustomDataDefinitionID":2,
        "PatronDataLabelValue":"Parent/Guardian birth date",
        "PolarisCustomDataTypeID":3,"CustomDataEntry":null,
        "DefaultValue":null,
        "IsRequired":false,
        "IsEnabled":false,
        "IsDataChanged":false
    },
    {
        "PatronID":0,
        "PatronCustomDataDefinitionID":4,
        "PatronDataLabelValue":"License number",
        "PolarisCustomDataTypeID":1,
        "CustomDataEntry":null,
        "DefaultValue":0,
        "IsRequired":false,
        "IsEnabled":false,
        "IsDataChanged":false
    }
  ]
}

HTTP Response Codes

Code Description
200 OK. Success