Patch Patron

Patch Patron flags

PATCH /api/.../patrons/{id}?type=flags

Request content Type:

Patch for 'flags' : Patches Patron flag

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the patron.
type string One of the following: 'flags' Discriminator for request content type.
DtoPatronFlag Patron Flag Yes Define in the request body when type=flags
Request body
Example for 'flags'
application/json, text/json 
{
   "Code": "ExtendedLoanPeriods",
   "Value": true
}

HTTP Response Codes

Code Description
204 No Content.
404 Patron not found

Patch Patron membership

PATCH /api/.../patrons/{id}?type=membership

Request content Type:

Patch for 'membership' : Patches Patron membership

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the patron.
type string One of the following: 'membership' Discriminator for request content type.
DtoPatronRenewUpgradeMembership Patron Renew Upgrade Membership Yes Define in the request body when type=membership
Request body
Example for 'membership'
application/json, text/json 
{
   "OverridePolicy": true,
   "PatronCodeID": 1,
   "ExpirationDate": "2023-04-30T00:00:00.000Z",
   "MembershipSubscriptionYears": 1,
   "StatisticalClassCode": "MOE",
   "Fees": [{
    "Fee": 10,
    "FeeReasonCodeID": 7
   }]
}

HTTP Response Codes

Code Description
204 No Content.
404 Patron not found

Patch Patron membership card

PATCH /api/.../patrons/{id}?type=membershipcard

Request content Type:

Patch for 'membershipcard' : Patches Patron membership card

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the patron.
type string One of the following: 'membershipcard' Discriminator for request content type.
DtoPatronUpdateCard Patron Update Card Yes Define in the request body when type=membershipcard
Request body
Example for 'membershipcard'
application/json, text/json 
{
   "Status": "lost-mid"
}

Response Information

Example
application/json, text/json 
{
    "Barcode":"1234556789"
}

HTTP Response Codes

Code Description
200 OK. Success
404 Patron not found

Patch Patron profile

PATCH /api/.../patrons/{id}?type=profile

Request content Type:

Patch for 'profile' : Patches Patron profile

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the patron.
type string One of the following: 'profile' Discriminator for request content type.
DtoPatronProfile Patron Profile Yes Define in the request body when type=profile
Request body
Example for 'profile'
application/json, text/json 
{
   "User3" : "user 3",
   "OverridePolicy": true,
   "PatronCodeID": 1,
   "Birthdate": "1990-06-01 00:00:00",
   "ExpirationDate": "2023-06-01 00:00:00",
   "User1": "S",
   "PatronStopID": 1,
   "MembershipTypeCode": "",
   "Note": "note",
   "GenderID": 1,
   "NameLast": "last name"
}

HTTP Response Codes

Code Description
204 No Content.
404 Patron not found

Patch Patron fees

PATCH /api/.../patrons/{id}?type=payfees

Request content Type:

Patch for 'payfees' : Patches Patron fees

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the patron.
type string One of the following: 'payfees' Discriminator for request content type.
DtoPatronOutstandingAmounts Patron Outstanding fee amounts to pay Yes Define in the request body when type=payfees
Request body
Example for 'profile'
application/json, text/json 
{
   "Date": "1990-06-01 00:00:00",
   "Id": "111",
   "PaymentModeID": 1,
   "Source": "source",
   "TransActionReference": "343435634343",
   "TotalAmount": 16.99,
   "Fees": [
    {
        "TxnID": 1123,
        "Barcode": "787347834734",
        "Amount": 12.99
    },
    {
        "TxnID": 340,
        "Barcode": "787347834734",
        "Amount": 4.00
    },
}

HTTP Response Codes

Code Description
204 No Content.
404 Patron not found

Patch Patron notification

PATCH /api/.../patrons/{id}?type=notification

Request content Type:

Patch for 'notification' : Patches Patron notification options

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the patron.
type string Yes: 'notification' Discriminator for request content type.
DtoPatronUpdateSettings Patron Update Notification options Yes Define in the request body when type=notification
Request body
Example for 'notification'
application/json, text/json 
{
    "NotificationEmail": true,
    "NotificationMobileApp": true, 
    "User2": true,
    "Username": "myusername"
}

Response Information

HTTP Response Codes

Code Description
204 OK. Success
404 Patron not found
Email notification not set and 'true'

Patch Patron Barcode

PATCH /api/.../patrons/{id}?type=barcode

Request content Type:

Patch for 'barcode' : Patches Patron barcode

Request Information

Parameters
Name Type Required Description
string Yes The patron's current barcode.
Request body
Example for 'barcode'
application/json, text/json 
    "P10000001B"

Response Information

HTTP Response Codes

Code Description
200 OK. Success
404 Patron not found