Request Objects
This section discusses submitting data using Sierrra APIs. To PUT or POST data using the Sierra REST API, you must submit the data as a request object. You can:
- Create a Patron Record
- Create or Update an Item Record
- POST Data Describing a New Acquisition
- POST a New hold
- POST Validate Patron by Barcode and PIN
- POST Validate User by Sierra Login and Password
- PUT New Data to a Hold
- PUT New Data to a Patron Record
- POST Add a Manual Fine to the Patron Record
- PUT Pay Multiple Patron Fines
Create a Patron Record
Use the PatronPatch object to create a new record.
Example
{
"emails": [
"string"
],
"names": [
"string"
],
"addresses": [
"Address"
],
"phones": [
"Phone"
],
"pin": "string",
"barcodes": [
"string"
],
"patronType": "integer",
"expirationDate": "string",
"birthDate": "string",
"homeLibraryCode": "string",
"langPref": "string"
}
Create or Update an Item Record
Use the ItemPatch object to create or update an item record. Click the links below to view the ItemPatch properties and an example.
Properties
All fields in the item record are optional with the exception of bibIds when you are creating an item record (you do not need to specify this property when updating an item record). You can create item records with the following fields:
copyNo
integer (optional)
Indicates which copy of the title corresponds to the item record.
Example:
"copyNo": "1"
itemType
integer (optional)
The item type. This value is used to define groups of items that can circulate differently.
Example:
"itemType": "2"
inventoryDate
string (optional)
The inventory date of the item in ISO 8601 format (either "yyyy-MM-dd'T'HH:mm:ssZZ" or "yyyy-MM-dd"). Note that the current time is used if you use the latter format.
Example:
"inventoryDate": "2021-12-11T19:20:28Z"
price
integer (optional)
The price of the item. Do not include a currency symbol or punctuation marks. For example, $12.40 should be listed as "1240".
Example:
"price": "1240"
agency
integer (optional)
The agency associated with the item. This is used only with the Consortium Management Extensions product.
Example:
"agency": "145"
location
string (optional)
The location code for the item.
Example:
"location": "main1"
barcodes
array (optional)
The item's barcode(s).
Example:
"barcodes": ["b1110000439131"]
itemCode1
integer (optional)
The library determines the name and purpose of this field, its codes, and the codes' definitions.
Example:
"itemCode1": "120"
itemCode2
string (optional)
The library determines the name and purpose of this field, its codes, and the codes' definitions.
Example:
"itemCode2": "3"
status
string (optional)
The item's status.
Example:
"status": "-"
stickyStatus
string (optional)
The item's sticky status code. This code is a more permanent status value for item records.
Example:
"stickyStatus": "$"
itemMessage
string (optional)
A code corresponding to a library-defined item message. The system displays the code's definition (that is, the message) during checkout or checkin of the item. If the code is a space or hyphen, no message appears.
Example:
"itemMessage": "-"
oPACMessage
string (optional)
A code corresponding to an WebPAC message. The library defines the codes and definitions for this field (with the exception of the code for rental (r) and ILL (4) items). The definitions appear as messages in the WebPAC.
Example:
"oPACMessage": "-"
messages
array (optional)
The item's messages. An item record can contain a number of message fields, but only the first one displays in item record displays in circulation functions. This is a non-MARC field. Use varFields to add MARC-tagged data.
Example:
"messages": ["Check for map insert."]
internalNotes
array (optional)
The item's internal notes. This a non-MARC field. Use varFields to add MARC-tagged data.
Example:
"internalNotes": ["Nov 12 2019: Bill $9.95, lost by .p10002832"]
bibIds
array
The bibliographic record number(s) to which this item is linked.
Example:
"bibIds": ["1662321","1673452"]
callNumbers
array (optional)
The call numbers of the item. This is a non-MARC field. Use varFields to add MARC-tagged data.
Example:
"callNumbers": ["PS3569.A787"]
owningLocations
array (optional)
The location code of the branch that originally owned the item. Innovative enables this field for libraries that have acquired the ASRS Interface or Floating Collections product. This is a non-MARC field. Use varFields to add MARC-tagged data.
Example:
"owningLocations": ["lmain"]
volumes
array (optional)
The item's volume numbers. This is a non-MARC field. Use varFields to add MARC-tagged data.
Example:
"volumes": ["9:7 Mar 2018"]
urls
array (optional)
The item's URL(s). This is a non-MARC field. Use varFields to add MARC-tagged data.
Example:
"urls": ["https://www.iii.com"]
reserveNotes
array (optional)
The course reserve notes for the item. This is a non-MARC field. Use varFields to add MARC-tagged data.
Example:
"reserveNotes": ["05-20-21 ON RESERVE FOR Economics 101"]
collectionIds
array (optional)
The collection ID notes for the item. This is a non-MARC field. Use varFields to add MARC-tagged data.
Example:
"collectionIds": ["MOBILE:86:Medieval Warfare:ACTIVE"]
fixedFields
object
The fixedFields property contains a map of FixedField objects, which contain fixed-length data fields for the item record.
Example:
array
The varFields property contains a list of VarField objects, which contain variable-length data fields for the item record.
Example:
See varFields Array
Example
{
"copyNo": 1,
"itemType": "2",
"price": "1250",
"location": "abcfc",
"barcodes": ["b1110000439131"],
"itemCode1": 120,
"itemCode2": "3",
"status": "-",
"stickyStatus": "$",
"itemMessage": "-",
"oPACMessage": "-",
"messages": ["Check insert for map"],
"internalNotes": [ "some note" ],
"bibIds": ["1662321","1673590"],
"callNumbers": ["PS3569.A787"],
"fixedFields": [
{
"label": "COPY #",
"value": 1
},
{
"label": "ICODE1",
"value": "0"
},
{
"label": "ICODE2",
"value": "-"
},
{
"label": "I TYPE",
"value": 0,
"display": "Books"
},
{
"label": "PRICE",
"value": "24.95"
},
{
"label": "LOCATION",
"value": "ccfic",
"display": "Conrad Library Fiction"
},
{
"label": "STATUS",
"value": "-",
"display": "CHECK ON SHELF"
},
{
"label": "IMESSAGE",
"value": "-",
"display": "--"
},
{
"label": "OPACMSG",
"value": "-",
"display": "---"
},
],
"varFields": [
{
"fieldTag": "b",
"content": "b1110000439131"
},
{
"fieldTag": "c",
"marcTag": "092",
"ind1": " ",
"ind2": " ",
"content": [
{
"tag": "a",
"content": "PS3569.A787"
}
]
}
]
}
POST Data Describing a New Acquisition
Use the AcquisitionOrderPost object to add bib and order records to the Sierra system for a new acquisition.
See The Acquisitions API Mapping Table for information on how the API loads records for acquistions.
The AcquisitionOrderPost object includes the following properties:
order
object
The order property contains an AcquisitionOrder object that provides order information and MARC records in application/marc-json, application/marc-in-json, or application/marc-xml format.
Example
{
"order": {
"login": "jdoe",
"allocation": [
{
"location": "01",
"fund": "acnfe",
"copies": 5
},
{
"location": "00",
"fund": "acmer",
"copies":5
}
],
"copies":10,
"vendor": "acade",
"price":1240,
"acquisitionType":"v",
"claim": "e",
"code1": "b",
"code2": "n",
"code3": "c",
"code4": "k",
"format": "x",
"orderNote": "2",
"orderType": "a",
"raction": "i",
"rloc": "k",
"bloc": "p",
"status": "q",
"tloc": "f",
"odate": "04-15-2016",
"language": "eng",
"country": "nyu",
"volume": 1,
"note": ["OrderNote01","OrderNote02","OrderNote03"],
"staffNote": ["staffNote01","staffNote02","staffNote03"],
"vendorNote": ["vendorNote01","vendorNote02", "vendorNote03"],
"vendorIDNumber": ["vendorIDNumber01","vendorIDNumber02", "vendorIDNumber03"],
"selector": ["selector01","selector02", "selector03"],
"vendorAccount": ["vendorAccount01","vendorAccount02", "vendorAccount03"],
"currencyCode": "eur",
"identity": ["identity01","identity02", "identity03"],
"shipTo": ["shipTo01","shipTo02", "shipTo03"],
"requestor": ["requestor01","requestor02", "requestor03"],
"oldOrderNumber": ["oldOrderNumber01","oldOrderNumber02", "oldOrderNumber03"],
"paidNote": ["paidNote01","paidNote02", "paidNote03"],
"vendorAddress": ["vendorAddress01","vendorAddress02", "vendorAddress03"],
"customVarField1": ["customVarField101","customVarField102", "customVarField103"],
"customVarField2": ["customVarField201","customVarField202", "customVarField203"],
"customVarField3": ["customVarField301","customVarField302", "customVarField303"],
"customVarField4": ["customVarField401","customVarField402", "customVarField403"]
},
"marcContentType": "application/marc-json",
"marc": {
"leader": "00000pam 2200000 i 4500",
"controlfield": [
{
"tag": "001",
"data": "BK0013472974"
},
{
"tag": "003",
"data": "DLC"
},
{
"tag": "005",
"data": "20150929110405.0"
},
{
"tag": "007",
"data": "sdubsmennmplu"
},
{
"tag": "008",
"data": "130830s2014 nyu b 001 0 eng pam i "
}
],
"datafield": [
{
"tag": "020",
"ind": "",
"subfield": [
{
"code": "a",
"data": "999102030405060708090"
}
]
},
{
"tag": "035",
"ind": "",
"subfield": [
{
"code": "a",
"data": "999102030405060708090"
}
]
},
{
"tag": "100",
"ind": " ",
"subfield": [
{
"code": "a",
"data": "Thomas Pynchon"
}
]
},
{
"tag": "245",
"ind": " ",
"subfield": [
{
"code": "a",
"data": "Vineland"
}
]
},
{
"tag": "260",
"ind": " ",
"subfield": [
{
"code": "a",
"data": "Boston"
},
{
"code": "b",
"data": "Little Brown"
},
{
"code": "c",
"data": "1990"
}
]
}
]
}
}
Child Properties
login
string
The Sierra username to associate with created orders.
Example:
"login": "jdoe"
copies
integer (optional)
The total number of copies ordered.
With multiple funds and/or multiple locations, this property is required. The copies are allocated until depleted or the multiple funds/location quantities are satisfied. For more information, see Notes on Multiple Funds and Multiple Locations in the Innovative Vendor Documentation.
The maximum number of copies is 1000.
Example:
"copies": 10
allocation
array
The allocation property contains a list of AcquisitionOrderAllocation objects, which identify the locations for which the order is placed, the funds to be charged, and the number of copies allocated to each.
Example
"allocation": [
{
"location": "01",
"fund": "acnfe",
"copies": 5
},
{
"location": "00",
"fund": "acmer",
"copies":5
}
]
Child Properties
location
string
The shelving location or branch for which the order is placed.
The maximum code length is 5 characters.
Example:
"location": "01"
fund
string
The fund code against which the material is encumbered and paid.
The maximum code length is 15 characters.
Example:
"fund": "acnfe"
copies
integer (optional)
The number of copies ordered for this location and fund code.
The maximum number of copies is 1000.
Example:
"copies": 5
vendor
string
The library-defined code for the vendor that handles the order.
This code can be translated during loading by editing the m2btab.oapi load profile
The maximum code length is 5 characters.
Example:
"vendor": "bna"
price
number (optional)
The estimated price per copy.
Do not include a currency symbol or punctuation marks other than a decimal to denote a fractional price (for example, 12.95). You cannot enter negative values . If the estimated price is not in your local currency, you must include the currency code in the currencyCode property.
Example:
"price": 12.40
acquisitionType
string (optional)
The library-defined acquisition type code or the method of paying for the material.
The maximum code length is 1 character.
Example:
"acquisitionType": "p"
claim
string (optional)
The claiming activity code.
The maximum code length is 1 character.
Example:
"claim": "e"
code1
string (optional)
The library-defined order code1.
The maximum code length is 1 character.
Example:
"code1": "b"
code2
string (optional)
The library-defined order code2.
The maximum code length is 1 character.
Example:
"code2": "n"
code3
string (optional)
The library-defined order code3.
The maximum code length is 1 character.
Example:
"code3": "c"
code4
string (optional)
The library-defined order code4.
The maximum code length is 1 character.
Example:
"code4": "k"
format
string (optional)
A code representing the physical form of the material.
The maximum code length is 1 character.
Example:
"format": "b"
orderNote
string (optional)
A code representing an order note to print on the purchase order form.
The maximum code length is 1 character.
Example:
"orderNote": "2"
orderType
string (optional)
A code representing the type of order (the way the material is acquired).
The maximum code length is 1 character.
Example:
"orderType": "a"
raction
string (optional)
A code representing the receiving action.
The maximum code length is 1 character.
Example:
"raction": "-"
rloc
string (optional)
A code representing the receiving location.
The maximum code length is 1 character.
Example:
"rloc": "k"
bloc
string (optional)
A code representing the billing location.
The maximum code length is 1 character.
Example:
"bloc": "p"
status
string (optional)
A system-generated code representing the financial encumbering or disencumbering status of a record.
The maximum code length is 1 character.
Example:
"status": "1"
tloc
string (optional)
A code representing a temporary shelving location.
The maximum code length is 1 character.
Example:
"tloc": "b"
odate
string (optional)
The date the material was ordered, in the format mm-dd-yy
Example:
"odate": "04-15-2016"
language
string (optional)
The language of the material, based on the MARC 21 Code List for Languages (also used by UNIMARC format).
The maximum code length is 3 characters.
Example:
"language": "eng"
country
string (optional)
The country of publication, based on the MARC 21 Code List of Countries, or ISO 3166/MA standard for UNIMARC systems.
The maximum code length is 3 characters.
Example:
"country": "cau"
volume
integer (optional)
The number of volumes for this title.
The range of valid values is 0 - 32767.
Example:
"volume": 1
note
array (optional, repeatable parameter)
The note property contains a list of free-text notes.
The maximum length is 10,000 characters.
Example:
"note": ["Phone call to Al Cline 2/25/16"]
staffNote
array (optional, repeatable parameter)
The staffNote property contains a list of free-text internal (staff) notes.
The maximum length is 10,000 characters.
Example:
"staffNote": ["report: order confirmed, 02-21-16,dm"]
vendorNote
array (optional, repeatable parameter)
The vendorNote property contains a list of free-text notes for vendor order information.
The maximum length is 10,000 characters.
Example:
"vendorNote": ["Cancel at the end of subscription period 12/01/16"]
vendorIDNumber
array (optional, repeatable parameter)
The vendorIDNumber property contains a list of the vendor's identification numbers for the associated titles.
The maximum length is 10,000 characters.
Example:
"vendorIDNumber": ["348572"]
selector
array (optional, repeatable parameter)
The selector property contains a list of free-text notes identifying the selector of the item.
The maximum length is 10,000 characters.
Example:
"selector": ["Doe, John","Smith, John"]
vendorAccount
array (optional, repeatable parameter)
The vendorAccount property contains a list of the vendor account numbers.
The maximum length is 10,000 characters.
Example:
"vendorAccount": ["123-456-789"]
currencyCode
string (optional)
The foreign currency code.
The maximum length is 3 characters. Valid characters include alphabetic characters, a currency symbol, and/or other punctuation mark. Numbers, hyphens ( - ) and periods ( . ) are not allowed. This must be a valid code from the Currency Table and must be included if the price (from 960 subfield s) is not in the local currency.
Example:
"currencyCode": "eur"
identity
array (optional, repeatableparameter)
The identity property contains a list of free-text notes used to distinguish between order records. It is used for complex records where the order does not represent the entire title, rather portions of a title, such as specific volumes, supplements, or special formats.
The maximum length is 10,000 characters.
Example:
"identity": ["Replacement copy"]
shipTo
array (optional, repeatable parameter)
The shipTo property contains a list of the library addresses to which the vendor should ship materials.
The maximum length is 200 characters, divided into a maximum of 4 lines of 28 characters each. A "$" represents a line break.
Example:
"shipTo": ["Main Library$1000 N. State St.$Ann Arbor, MI 46036"]
requestor
array (optional, repeatableparameter)
The requestor property contains a list of requestors for the items in the order.
The maximum length is 10,000 characters.
Example:
"requestor": ["Smith, John"]
oldOrderNumber
array (optional, repeatable parameter)
The oldOrderNumber property contains a list of old order numbers.
The maximum length is 10,000 characters.
Example:
"oldOrderNumber": ["8800000219"]
paidNote
array (optional, repeatable parameter)
The paidNote property contains a list of payment notes. These notes are typically found in the PAID field of an order record.
The maximum length is 35 characters.
Example:
"paidNote": ["Replacement copy"]
vendorAddress
array (optional, repeatable parameter)
The vendorAddress property contains a list of relevant vendor address strings.
The maximum length is 200 characters, divided into a maximum of 5 lines of 28 characters each. A "$" represents a line break.
Example:
"vendorAddress": ["Inst. of Public Policy$Stewart Building$1134 N. College Ave.$Mission, IN 46036"]
customVarField1
array (optional, repeatable parameter)
The customVarField1 property contains a list of strings that represent variable-length data fields. To use this property, your m2btab.oapi file must be customized to map a source field to your intended destination field.
The maximum length is 10,000 characters.
Example:
"customVarField1": ["Custom variable-length content"]
customVarField2
array (optional, repeatable parameter)
The customVarField2 property contains a list of strings that represent variable-length data fields. To use this property, your m2btab.oapi file must be customized to map a source field to your intended destination field.
The maximum length is 10,000 characters.
Example:
"customVarField2": ["Custom variable-length content"]
customVarField3
array (optional, repeatable parameter)
The customVarField3 property contains a list of strings that represent variable-length data fields. To use this property, your m2btab.oapi file must be customized to map a source field to your intended destination field.
The maximum length is 10,000 characters.
Example:
"customVarField3": ["Custom variable-length content"]
customVarField4
array (optional, repeatable parameter)
The customVarField4 property contains a list of strings that represent variable-length data fields. To use this property, your m2btab.oapi file must be customized to map a source field to your intended destination field.
The maximum length is 10,000 characters.
Example:
"customVarField4": ["Custom variable-length content"]
marcContentType
string
The format in which the MARC content is encoded, that is, application/marc-json, application/marc-in-json, or application/marc-xml.
Example:
"marcContentType": "application/marc-json"
marc
object
The MARC data for bibliographic and order record creation.
The maximum length is 100,000 bytes per record.
Example
"marc": {
"leader": "00000pam 2200000 i 4500",
"controlfield": [
{
"tag": "001",
"data": "BK0013472974"
},
{
"tag": "003",
"data": "DLC"
},
{
"tag": "005",
"data": "20150929110405.0"
},
{
"tag": "007",
"data": "sdubsmennmplu"
},
{
"tag": "008",
"data": "130830s2014 nyu b 001 0 eng pam i "
}
],
"datafield": [
{
"tag": "020",
"ind": "",
"subfield": [
{
"code": "a",
"data": "999102030405060708090"
}
]
},
{
"tag": "035",
"ind": "",
"subfield": [
{
"code": "a",
"data": "999102030405060708090"
}
]
},
{
"tag": "100",
"ind": " ",
"subfield": [
{
"code": "a",
"data": "Steven Satelle "
}
]
},
{
"tag": "245",
"ind": " ",
"subfield": [
{
"code": "a",
"data": "Stevens Wonderful QA Book - marcJson "
}
]
},
{
"tag": "260",
"ind": " ",
"subfield": [
{
"code": "a",
"data": "New York, N.Y."
},
{
"code": "b",
"data": "Elsevier"
},
{
"code": "c",
"data": "2016"
}
]
}
]
}
}
POST a New Hold
Use the PatronHoldPost object to place a new hold request. For example:
Example
{
"recordType": "i",
"recordNumber": 7916916,
"pickupLocation": "21",
"neededBy": "2015-08-31",
"numberOfCopies": 1,
"note": "book needed in location 3"
}
The PatronHoldPost object includes the following properties:
recordType
string
The record type code, that is, bib (b), item (i), or volume (j), associated with the hold.
Example:
"recordType": "i"
recordNumber
integer
The held record number.
Example:
"recordNumber": 7916916
pickupLocation
string
The pickup location code.
Example:
"pickupLocation": "21"
neededBy
string (optional)
The date after which the held item is no longer needed, in ISO 8601 format (yyyy-MM-dd).
Example:
"neededBy": "2015-08-31"
numberOfCopies
integer (optional)
The number of copies to hold.
Example:
"numberOfCopies": 1
note
string (optional)
Informational note related to the hold.
Example:
"note": [ "book needed in location 3" ]
POST Validate Patron by Barcode and PIN
Use the PatronValidation object to validate a patron using the barcode and PIN. For example:
{
"barcode": "21197300685699",
"pin": "12345"
}
The PatronValidation object includes the following properties:
barcode
string
The patron's barcode.
pin
string
The patron's pin.
caseSensitivity
boolean (optional
Case sensitivity
Example:
{
"barcode": "G123469",
"pin": "1234"
"caseSensitivity": false
}
POST Validate User by Sierra Login and Password
Use the user object to validate a user with the username and password.
userName
A text string defining the username.
string
Example:
"userName": "iii"
password
A text string defining the password.
string
Example:
"password": "test1"
PUT New Data to a Hold
Use the PatronHoldPut object to modify a hold. For example:
{
"pickupLocation": "21",
"freeze": false
}
The PatronHoldPut object includes the following properties:
pickupLocation
string (optional)
The pickup location code.
Example:
"pickupLocation": "21"
freeze
boolean (optional)
Whether the hold should be frozen (suspended).
Example:
"freeze": false
PUT New Data to a Patron Record
Use the PatronPatch object to update a Patron record.
Example
{
"emails": [
"parker@example.com"
],
"names": [
"parker, john"
],
"addresses": [{
"lines": [
"1234 Main Street",
"Anywhere, CA 94608 USA"
],
"type": "a"
}],
"phones": [{
"number": "510-655-6200",
"type": "t"
}],
"pin": "test12345",
"barcodes": [
"555-1234",
"555-2312"
],
"patronType": 2,
"expirationDate": "2020-05-24",
"birthDate": "1967-01-29",
"patronCodes": {
"pcode1": "f",
"pcode2": "c",
"pcode3": 0,
"pcode4": 2
},
"blockInfo": {
"code": "c"
},
"uniqueIds": [
"201617200",
"201617201"
],
"pMessage" : "e",
"homeLibraryCode" : "9star",
"langPref" : "hun" ,
"varFields": [ {
"fieldTag": "x",
"content": "this is note 2"
}, {
"fieldTag": "m",
"content": "this is message 34"
}, {
"fieldTag": "y",
"content": "url:http://www.wherever.com/pictures/me.jpg"
}
]
}
The PatronPatch object includes the following properties:
emails
array (optional)
A list of strings, which are the patron's email addresses.
Example:
"emails": [ "parker@example.com" ]
names
array (returned only if requested)
A list of strings, which are the patron's names.
Example:
"names": [ "Examplestein, GLORIA", "Examplestein-Einem, GLORIA" ]
addresses
array (returned only if requested)
Contains the patron's addresses.
Example
"addresses": [
{
"lines": [
"1234 Main Street",
"Anywhere, CA 94608 USA"
],
"type": "a"
},
{
"lines": [
"5775 Golden Gate Parkway",
"San Francisco, CA 94129 USA"
],
"type": "h"
}
]
Child Properties
lines
array
A list of strings, which are the lines of an address.
Example:
"lines": [ "1234 Main Street", "Anywhere, CA 94608 USA" ]
types
character
The address type (a - primary address, h - alternate address).
Example:
"type": "a"
phones
array
(Returned only if requested)
The phones property contains a list of Phone objects, which contain the patron's telephone numbers.
Example
"phones": [
{
"number": "510-655-6200",
"type": "t"
}
]
Child Properties
number
string
A telephone number.
Example:
"number": "510-655-6200"
type
character
The telephone number type:
- t - primary phone
- p - alternate phone
- o - mobile phone
Example:
"type": "t"
pin
string
The patron's Personal Identification Number. This field is validated and must contain both characters and numbers.
Example:
"pin": "12345test"
patronType
integer (optional)
The patron type code. Use /v6/patrons/metadata to extract valid data for this field.
Example:
“patronType” : 2
barcodes
array
The patron's barcode(s).
Example:
"barcodes": [
"555-1234",
"555-2312"
]
expirationDate
string
The expiration date of the patron’s borrowing privileges in ISO 8601 (yyyy-MM-dd).
Example:
"expirationDate": "2020-05-24"
birthDate
string
The patron’s birthday in ISO 8601 (yyy-MM-dd).
Example:
"birthDate": "1967-01-29"
patronCodes
array
List of patron codes – pcode1, pcode2, pcode3, and pcode4. Use /v6/patrons/metadata to extract valid data for this field.
Example
"patronCodes": {
"pcode1": "f",
"pcode2": "c",
"pcode3": 0,
"pcode4": 2
}
Child Properties
pcode1
string
Example:
"pcode1": "f"
pcode2
string
Example:
"pcode2": "c"
pcode3
integer
The number of copies ordered.
Example:
"pcode3": 0
pcode4
integer
(Only supported when CME is installed.)
Example:
"pcode4": 2
blockInfo
array
Manual block information.
Example:
"blockInfo": {
"code": "p"
}
Child Properties
code
string
Manual block code. Use /v6/patrons/metadata to extract valid data for this field.
Example:
"code": "p"
until
Not supported when creating a patron.
uniqueIds
array
The patron’s uniqueIds.
Example:
"uniqueIds": [
"201617200",
"201617201",
"pcode3": 0 ]
pMessage
string
Library-defined patron message. Use /v6/patrons/metadata to extract valid data for this field.
Example:
"pMessage": "e"
homeLibraryCode
string
Location code for the patron’s home library. Use /v6/patrons/metadata to extract valid data for this field.
Example:
"homeLibraryCode": "9Star"
langPref
string
Language code that specifies in which the system can generate notices for patrons. Use /v6/patrons/metadata to extract valid data for this field.
Example:
"langPref" : "hun"
FixedFields
array
The fixed length fields from the patron record. The patron ID must be specified. The following fixed-length fields are available:
“43” : expirationDate
"44" : pcode1 (library defined)
"45" : pcode2 (library defined)
"46" : pcode3 (library defined)
"47" : patronType
"51" : birthDate
"56" : mblock
"126" : pcode4 (library defined)
"268" : notice preference
Example
{
"fixedFields": {
"47": {
"label": "Patron Type",
"value": "0"
},
"56": {
"label": "Manual Block",
"value": "-"
},
"126": {
"label": "ZIP Code",
"value": "8000"
}
}
}
varFields
array
Variable length fields. Currently it is possible to:
- add any number of this field type
- create the following variable length fields:
“x” : note
“m” : message
“y” : patron image (PAT IMAGE)
Example
[{
"fieldTag": "x",
"content": "this is note 2"
},{
"fieldTag": "m",
"content": "this is note 2"
},{
"fieldTag": "y",
"content": "url:http://www.wherever.com/pictures/me.jpg"
}]
Child Properties
fieldtag
string
Variable length field to update.
Example:
"fieldTag": "x"
content
string
A string containing the content description.
Example:
"content": "This is note 1"
POST Add a Manual Fine to a Patron Record
Use the Charge object to add a manual fine to a patron's record.
Properties
amount
integer
The charge amount without a fractional separator. For example, if you want to charge $10.50, enter 1050. You cannot enter a negative number.
Example:
"amount": 1000
reason
string (optional)
The note stating the reason for the fine.
Example:
"reason": "Manual processing fee for summer program"
location
string
The location code associated with the entity assessing the fine.
Example:
"location": "aslib"
Example
{
"amount": 1000,
"reason": "Manual processing fee for summer program",
"location": "aslib"
}
PUT Pay Multiple Patron Fines
Use the bulkPayments object to pay multiple patrons' fines in batch. Select the links below to view the bulkPayments properties and an example.
Properties
bulkPayments
array
The bulkPayments property contains a list of fine payments grouped by patron.
Child Properties
patron
integer
The patron record number associated with the fines.
Example:
"patron" : 1001492
payments
array
The payments property contains a list of payments for a specific patron.
Example
"payments" : [
{
"amount" : 225,
"paymentType" : 2,
"invoiceNumber" : "470995",
"initials" : "bcw"
},
{
"amount" : 1250,
"paymentType" : 1,
"invoiceNumber" : "471341",
"initials" : "bcw"
}
]
Child Properties
amount
integer
The payment amount. Do not include currency symbols or separators. For example, to pay an amount of $12.50, enter 1250.
Example:
"amount" : 1250
paymentType
integer
The payment type. Possible values are:
-
1 - Use this value for full payments or partial payments if you want to retain the remainder.
-
2 - Use this value for full, partial, or zero payments if you want to waive the remainder of the fine.
Example:
"paymentType" : 2
invoiceNumber
string
The fine's invoice number.
Example:
"invoiceNumber" : "471341"
initials
string (optional)
The initials of the person who processed the fine.
Example:
"initials" : "bcw"
Example
{
"bulkPayments": [
{
"patron" : 1005244,
"payments" : [
{
"amount" : 1000,
"paymentType" : 1,
"invoiceNumber" : "471039",
"initials" : "frp"
}
]
},
{
"patron" : 1001492,
"payments" : [
{
"amount" : 225,
"paymentType" : 2,
"invoiceNumber" : "470995",
"initials" : "bcw"
},
{
"amount" : 1250,
"paymentType" : 1,
"invoiceNumber" : "471341",
"initials" : "bcw"
}
]
}
]
}