Update patron eReceipt options

Update patron eReceipt options

PUT /api/.../patrons/{patronID}

This method allows the caller to update a patron's eReceipt options.

Request Information

Parameters
Name Type Required Description
patronID Int Yes patron identifier
eReceiptData DtoPatronEReceiptOptionData Yes Define this parameter in the request body.
DtoPatronEReceiptOptionData
Property Type Nullable Description
PatronID Int No Required.
EReceiptOptionID Int No Required. Must be a delivery option allowed by the logged in branch.
EMail String Yes Email Address
PhoneVoice1 Int Yes Phone One
PhoneVoice2 String Yes Phone two
PhoneVoice3 String Yes Phone three
Phone1CarrierID Int Yes Mobile carrier ID for phone one
Phone2CarrierID Int Yes Mobile carrier ID for phone two
Phone3CarrierID Int Yes Mobile carrier ID for phone three
TxtPhoneNumber Int Yes which phone to use for text messaging
Request body
Example
application/json, text/json 
{ 
    PatronID:357374,
    PhoneVoice1:111-123-1234,
    PhoneVoice2:"221-123-1234",
    PhoneVoice3:"331-123-1234",
    EMail:"abc@def.com",
    EReceiptOptionID:2,
    Phone1CarrierID:1,
    Phone2CarrierID:2,
    Phone3CarrierID:3,
    TxtPhoneNumber:2
}

Response Information

Returns status code.

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE. Invalid patron ID.

Update patron's DoNotShowEReceiptPrompt flag

PUT /api/.../patrons/{patronID}?donotShowPrompt=true

This method allows the caller to update a patron's DoNotShowEReceiptPrompt flag.

Request Information

Parameters
Name Type Required Description
patronID Int Yes patron identifier
donotShowPrompt Boolean Yes If set true, "eReceipt Options" prompt will not be displayed while checking out in Leap. Set value to true/false.

Response Information

Returns status code.

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE. Invalid patron ID.