Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning

Atlas product documentation has undergone a migration to the Atlas Systems Support page. We are working internally to try and redirect Prometheus articles. Please take this time to fix any links you have directing users to Prometheus as soon as possible. We will provide an update on deadlines for Prometheus access when we have more information on how that will work. If you have any questions please contact support@atlas-sys.com.

Zen Section
id833498521

The ILLiad Web Platform provides programmatic access to your ILLiad installation. The data is available in either JSON or XML formatted over HTTP.

Note

The ILLiad Web Platform was introduced in ILLiad version 8.4.

...

Zen Section
id1232501465

Transactions

Retrieving Requests by Transaction Number

  • Authorization: Secured
  • Supports OData: No
  • Minimum API Version: 1
  • Minimum Web Platform Version: 8.6.0.0

The transaction request will retrieve transaction details for a given transaction number.

Code Block
titleExample Transaction Request
linenumberstrue
languagexml
collapsetrue
curl -H 'Accept: application/json'
https://your.illiad.edu/ILLiadWebPlatform/Transaction/6
Code Block
titleExample Transaction Response
linenumberstrue
languagexml
collapsetrue
{
"TransactionNumber": 6,
"Username": "jdoe",
"RequestType": "Article",
"LoanAuthor": null,
"LoanTitle": null,
"LoanPublisher": null,
"LoanPlace": null,
"LoanDate": null,
"LoanEdition": null,
"PhotoJournalTitle": "The electronic library : the international journal for 
	minicomputer, microcomputer, and software applications in libraries.",
"PhotoJournalVolume": null,
"PhotoJournalIssue": null,
"PhotoJournalMonth": null,
"PhotoJournalYear": null,
"PhotoJournalInclusivePages": "23-34",
"PhotoArticleAuthor": "Cohen, Calsada",
"PhotoArticleTitle": "Web accessible Databases",
"CitedIn": null,
"CitedTitle": null,
"CitedDate": null,
"CitedVolume": null,
"CitedPages": null,
"NotWantedAfter": null,
"AcceptNonEnglish": false,
"AcceptAlternateEdition": true,
"ArticleExchangeUrl": null,
"ArticleExchangePassword": null,
"TransactionStatus": "Request Sent",
"TransactionDate": "2013-06-07T09:05:37.19",
"ISSN": "0264-0473",
"ILLNumber": "500XXXXXXX/5YYZZOO,
"ESPNumber": "9172203",
"LendingString": null,
"BaseFee": null,
"PerPage": null,
"Pages": null,
"DueDate": null,
"RenewalsAllowed": false,
"SpecIns": null,
"Pieces": null,
"LibraryUseOnly": "Yes",
"AllowPhotocopies": false,
"LendingLibrary": "GETIT",
"ReasonForCancellation": null,
"CallNumber": null,
"Location": null,
"Maxcost": "24.00",
"ProcessType": "Borrowing",
"ItemNumber": null,
"LenderAddressNumber": 1,
"Ariel": false,
"Patron": null,
"PhotoItemAuthor": null,
"PhotoItemPlace": null,
"PhotoItemPublisher": null,
"PhotoItemEdition": null,
"DocumentType": "Article",
"InternalAcctNo": null,
"PriorityShipping": null,
"Rush": "Regular",
"CopyrightAlreadyPaid": "Yes",
"WantedBy": null,
"SystemID": "OTH",
"ReplacementPages": null,
"IFMCost": null,
"CopyrightPaymentMethod": null,
"ShippingOptions": null,
"CCCNumber": null,
"IntlShippingOptions": null,
"ShippingAcctNo": null,
"ReferenceNumber": null,
"CopyrightComp": "US:CCL",
"TAddress": null,
"TAddress": null,
"TAddress2": null,
"TCity": null,
"TState": null,
"TZip": null,
"TCountry": null,
"TFax": null,
"TEMailAddress": null,
"TNumber": null,
"HandleWithCare": false,
"CopyWithCare": false,
"RestrictedUse": false,
"ReceivedVia": null,
"CancellationCode": null,
"BillingCategory": null,
"CCSelected": "No",
"OriginalTN": null,
"OriginalNVTGC": null,
"InProcessDate": null,
"InvoiceNumber": null,
"BorrowerTN": null,
"WebRequestForm": null,
"TName": null,
"TAddress3": null,
"IFMPaid": null,
"BillingAmount": null,
"ConnectorErrorStatus": null,
"BorrowerNVTGC": null,
"CCCOrder": null,
"ShippingDetail": null,
"ISOStatus": null,
"OdysseyErrorStatus": null,
"WorldCatLCNumber": null,
"Locations": null,
"FlagType": null,
"FlagNote": "",
"CreationDate": "2013-06-07T09:01:22.47",
"ItemInfo1": null,
"ItemInfo2": null,
"ItemInfo3": null,
"ItemInfo4": null,
"ItemInfo5": "Yes",
"SpecialService": null,
"DeliveryMethod": null,
"Web": null,
"PMID": null,
"DOI": null,
"LastOverdueNoticeSent": null,
"ExternalRequest": null
}

Retrieving Requests for User

  • Authorization: Secured
  • Supports OData: Yes
  • Minimum API Version: 1
  • Minimum Web Platform Version: 8.5.0.0

The UserRequests request will retrieve all transactions associated with a given username. This request is secured and requires an API key. This request has OData Support for filtering, ordering, and limiting results.

Code Block
titleExample User Requests Request
linenumberstrue
languagexml
collapsetrue
curl -H 'Accept: application/json'
https://your.illiad.edu/ILLiadWebPlatform/Transaction/UserRequests/jdoe
Code Block
titleExample User Requests Response
linenumberstrue
languagexml
collapsetrue
[{
"TransactionNumber": 6,
"Username": "jdoe",
"RequestType": "Article",
"LoanAuthor": null,
"LoanTitle": null,
"LoanPublisher": null,
"LoanPlace": null,
"LoanDate": null,
"LoanEdition": null,
"PhotoJournalTitle": "The electronic library",
"PhotoJournalVolume": null,
"PhotoJournalIssue": null,
"PhotoJournalMonth": null,
"PhotoJournalYear": null,
"PhotoJournalInclusivePages": "23-34",
"PhotoArticleAuthor": "Cohen, Calsada",
"PhotoArticleTitle": "Web accessible Databases",
"CitedIn": null,
"CitedTitle": null,
"CitedDate": null,
"CitedVolume": null,
"CitedPages": null,
"NotWantedAfter": null,
"AcceptNonEnglish": false,
"AcceptAlternateEdition": true,
"ArticleExchangeUrl": null,
"ArticleExchangePassword": null,
"TransactionStatus": "Request Sent",
"TransactionDate": "2013-06-07T09:05:37.19",
"ISSN": "0264-0473",
"ILLNumber": "500XXXXXXX/5YYZZOO,
"ESPNumber": "9172203",
"LendingString": null,
"BaseFee": null,
"PerPage": null,
"Pages": null,
"DueDate": null,
"RenewalsAllowed": false,
"SpecIns": null,
"Pieces": null,
"LibraryUseOnly": "Yes",
"AllowPhotocopies": false,
"LendingLibrary": "GETIT",
"ReasonForCancellation": null,
"CallNumber": null,
"Location": null,
"Maxcost": "24.00",
"ProcessType": "Borrowing",
"ItemNumber": null,
"LenderAddressNumber": 1,
"Ariel": false,
"Patron": null,
"PhotoItemAuthor": null,
"PhotoItemPlace": null,
"PhotoItemPublisher": null,
"PhotoItemEdition": null,
"DocumentType": "Article",
"InternalAcctNo": null,
"PriorityShipping": null,
"Rush": "Regular",
"CopyrightAlreadyPaid": "Yes",
"WantedBy": null,
"SystemID": "OTH",
"ReplacementPages": null,
"IFMCost": null,
"CopyrightPaymentMethod": null,
"ShippingOptions": null,
"CCCNumber": null,
"IntlShippingOptions": null,
"ShippingAcctNo": null,
"ReferenceNumber": null,
"CopyrightComp": "US:CCL",
"TAddress": null,
"TAddress2": null,
"TCity": null,
"TState": null,
"TZip": null,
"TCountry": null,
"TFax": null,
"TEMailAddress": null,
"TNumber": null,
"HandleWithCare": false,
"CopyWithCare": false,
"RestrictedUse": false,
"ReceivedVia": null,
"CancellationCode": null,
"BillingCategory": null,
"CCSelected": "No",
"OriginalTN": null,
"OriginalNVTGC": null,
"InProcessDate": null,
"InvoiceNumber": null,
"BorrowerTN": null,
"WebRequestForm": null,
"TName": null,
"TAddress3": null,
"IFMPaid": null,
"BillingAmount": null,
"ConnectorErrorStatus": null,
"BorrowerNVTGC": null,
"CCCOrder": null,
"ShippingDetail": null,
"ISOStatus": null,
"OdysseyErrorStatus": null,
"WorldCatLCNumber": null,
"Locations": null,
"FlagType": null,
"FlagNote": "",
"CreationDate": "2013-06-07T09:01:22.47",
"ItemInfo1": null,
"ItemInfo2": null,
"ItemInfo3": null,
"ItemInfo4": null,
"ItemInfo5": "Yes",
"SpecialService": null,
"DeliveryMethod": null,
"Web": null,
"PMID": null,
"DOI": null,
"LastOverdueNoticeSent": null,
"ExternalRequest": null
}]

 

Routing transaction request

  • HTTP Verb: PUT
  • Authorization: Secured
  • Supports OData: No
  • Minimum API Version: 1
  • Minimum Web Platform Version: 8.7.2.0

The route transaction request will route a transaction to a specified transaction status.  The action will also add a tracking entry and mark an update to the history table to indicate a change was made to the request. Routing rules associated with the status will be processed. The username of the tracking and history entries will be set to the WebPlatformDescription associated with the API key making the request. 

Required parameters

Status

The status the transaction should be routed to

Code Block
titleExample Route Transaction Request
linenumberstrue
languagexml
collapsetrue
PUT https://your.illiad.edu/ILLiadWebPlatform/transaction/4567/route
Content-Type: application/json
{ "Status" : "Awaiting Request Processing" }

Response

Code Block
titleExample Route Transaction Response
linenumberstrue
languagetext
collapsetrue
{
"TransactionNumber": 6,
"Username": "jdoe",
"RequestType": "Article",
"LoanAuthor": null,
"LoanTitle": null,
"LoanPublisher": null,
"LoanPlace": null,
"LoanDate": null,
"LoanEdition": null,
"PhotoJournalTitle": "The electronic library : the international journal for
minicomputer, microcomputer, and software applications in libraries.",
"PhotoJournalVolume": null,
"PhotoJournalIssue": null,
"PhotoJournalMonth": null,
"PhotoJournalYear": null,
"PhotoJournalInclusivePages": "23-34",
"PhotoArticleAuthor": "Cohen, Calsada",
"PhotoArticleTitle": "Web accessible Databases",
"CitedIn": null,
"CitedTitle": null,
"CitedDate": null,
"CitedVolume": null,
"CitedPages": null,
"NotWantedAfter": null,
"AcceptNonEnglish": false,
"AcceptAlternateEdition": true,
"ArticleExchangeUrl": null,
"ArticleExchangePassword": null,
"TransactionStatus": "Awaiting Request Processing",
"TransactionDate": "2013-06-07T09:05:37.19",
"ISSN": "0264-0473",
"ILLNumber": "500XXXXXXX/5YYZZOO,
"ESPNumber": "9172203",
"LendingString": null,
"BaseFee": null,
"PerPage": null,
"Pages": null,
"DueDate": null,
"RenewalsAllowed": false,
"SpecIns": null,
"Pieces": null,
"LibraryUseOnly": "Yes",
"AllowPhotocopies": false,
"LendingLibrary": "GETIT",
"ReasonForCancellation": null,
"CallNumber": null,
"Location": null,
"Maxcost": "24.00",
"ProcessType": "Borrowing",
"ItemNumber": null,
"LenderAddressNumber": 1,
"Ariel": false,
"Patron": null,
"PhotoItemAuthor": null,
"PhotoItemPlace": null,
"PhotoItemPublisher": null,
"PhotoItemEdition": null,
"DocumentType": "Article",
"InternalAcctNo": null,
"PriorityShipping": null,
"Rush": "Regular",
"CopyrightAlreadyPaid": "Yes",
"WantedBy": null,
"SystemID": "OTH",
"ReplacementPages": null,
"IFMCost": null,
"CopyrightPaymentMethod": null,
"ShippingOptions": null,
"CCCNumber": null,
"IntlShippingOptions": null,
"ShippingAcctNo": null,
"ReferenceNumber": null,
"CopyrightComp": "US:CCL",
"TAddress": null,
"TAddress": null,
"TAddress2": null,
"TCity": null,
"TState": null,
"TZip": null,
"TCountry": null,
"TFax": null,
"TEMailAddress": null,
"TNumber": null,
"HandleWithCare": false,
"CopyWithCare": false,
"RestrictedUse": false,
"ReceivedVia": null,
"CancellationCode": null,
"BillingCategory": null,
"CCSelected": "No",
"OriginalTN": null,
"OriginalNVTGC": null,
"InProcessDate": null,
"InvoiceNumber": null,
"BorrowerTN": null,
"WebRequestForm": null,
"TName": null,
"TAddress3": null,
"IFMPaid": null,
"BillingAmount": null,
"ConnectorErrorStatus": null,
"BorrowerNVTGC": null,
"CCCOrder": null,
"ShippingDetail": null,
"ISOStatus": null,
"OdysseyErrorStatus": null,
"WorldCatLCNumber": null,
"Locations": null,
"FlagType": null,
"FlagNote": "",
"CreationDate": "2013-06-07T09:01:22.47",
"ItemInfo1": null,
"ItemInfo2": null,
"ItemInfo3": null,
"ItemInfo4": null,
"ItemInfo5": "Yes",
"SpecialService": null,
"DeliveryMethod": null,
"Web": null,
"PMID": null,
"DOI": null,
"LastOverdueNoticeSent": null,
"ExternalRequest": null
}


 

HTTP Status CodeDescription
Status
colourGreen
title200
subtletrue
OK (Successfully routed request)

Status
colourRed
title400
subtletrue

Bad Request

Code Block
titleExample Bad Request
languagetext
collapsetrue
{
    "Message": "Arguments cannot be null: model"
}
Status
colourRed
title401
subtletrue
Unauthorized
Status
colourRed
title404
subtletrue
Resource Not Found
Status
colourRed
title500
subtletrue
Internal Server Error (Unexpected error)

 

Marking transaction filled

  • HTTP Verb: PUT
  • Authorization: Secured
  • Supports OData: No
  • Minimum API Version: 1
  • Minimum Web Platform Version: 8.7.2.0

The borrowing request will be marked as being filled by the lender. 

  •  A history entry will be added to indicate the lender has shipped the request. 
Info
Note the username of the history entry will be set to the WebPlatformDescription associated with the API key making the request. 

Required parameters

Lender

Indicates the lender that filled the request

Code Block
titleExample Fill Transaction Request
linenumberstrue
languagexml
collapsetrue
PUT https://your.illiad.edu/ILLiadWebPlatform/transaction/4567/filled
Content-Type: application/json
{ "Lender" : "OSU" }

Response

Code Block
titleExample Fill Transaction Response
linenumberstrue
languagetext
collapsetrue
{
"TransactionNumber": 4567,
"Username": "jdoe",
"RequestType": "Article",
"LoanAuthor": null,
"LoanTitle": null,
"LoanPublisher": null,
"LoanPlace": null,
"LoanDate": null,
"LoanEdition": null,
"PhotoJournalTitle": "The electronic library : the international journal for
minicomputer, microcomputer, and software applications in libraries.",
"PhotoJournalVolume": null,
"PhotoJournalIssue": null,
"PhotoJournalMonth": null,
"PhotoJournalYear": null,
"PhotoJournalInclusivePages": "23-34",
"PhotoArticleAuthor": "Cohen, Calsada",
"PhotoArticleTitle": "Web accessible Databases",
"CitedIn": null,
"CitedTitle": null,
"CitedDate": null,
"CitedVolume": null,
"CitedPages": null,
"NotWantedAfter": null,
"AcceptNonEnglish": false,
"AcceptAlternateEdition": true,
"ArticleExchangeUrl": null,
"ArticleExchangePassword": null,
"TransactionStatus": "Request Sent",
"TransactionDate": "2013-06-07T09:05:37.19",
"ISSN": "0264-0473",
"ILLNumber": "500XXXXXXX/5YYZZOO,
"ESPNumber": "9172203",
"LendingString": null,
"BaseFee": null,
"PerPage": null,
"Pages": null,
"DueDate": null,
"RenewalsAllowed": false,
"SpecIns": null,
"Pieces": null,
"LibraryUseOnly": "Yes",
"AllowPhotocopies": false,
"LendingLibrary": "OSU",
"ReasonForCancellation": null,
"CallNumber": null,
"Location": null,
"Maxcost": "24.00",
"ProcessType": "Borrowing",
"ItemNumber": null,
"LenderAddressNumber": 1,
"Ariel": false,
"Patron": null,
"PhotoItemAuthor": null,
"PhotoItemPlace": null,
"PhotoItemPublisher": null,
"PhotoItemEdition": null,
"DocumentType": "Article",
"InternalAcctNo": null,
"PriorityShipping": null,
"Rush": "Regular",
"CopyrightAlreadyPaid": "Yes",
"WantedBy": null,
"SystemID": "OTH",
"ReplacementPages": null,
"IFMCost": null,
"CopyrightPaymentMethod": null,
"ShippingOptions": null,
"CCCNumber": null,
"IntlShippingOptions": null,
"ShippingAcctNo": null,
"ReferenceNumber": null,
"CopyrightComp": "US:CCL",
"TAddress": null,
"TAddress": null,
"TAddress2": null,
"TCity": null,
"TState": null,
"TZip": null,
"TCountry": null,
"TFax": null,
"TEMailAddress": null,
"TNumber": null,
"HandleWithCare": false,
"CopyWithCare": false,
"RestrictedUse": false,
"ReceivedVia": null,
"CancellationCode": null,
"BillingCategory": null,
"CCSelected": "No",
"OriginalTN": null,
"OriginalNVTGC": null,
"InProcessDate": null,
"InvoiceNumber": null,
"BorrowerTN": null,
"WebRequestForm": null,
"TName": null,
"TAddress3": null,
"IFMPaid": null,
"BillingAmount": null,
"ConnectorErrorStatus": null,
"BorrowerNVTGC": null,
"CCCOrder": null,
"ShippingDetail": null,
"ISOStatus": null,
"OdysseyErrorStatus": null,
"WorldCatLCNumber": null,
"Locations": null,
"FlagType": null,
"FlagNote": "",
"CreationDate": "2013-06-07T09:01:22.47",
"ItemInfo1": null,
"ItemInfo2": null,
"ItemInfo3": null,
"ItemInfo4": null,
"ItemInfo5": "Yes",
"SpecialService": null,
"DeliveryMethod": null,
"Web": null,
"PMID": null,
"DOI": null,
"LastOverdueNoticeSent": null,
"ExternalRequest": null
}

 

 

HTTP Status CodeDescription
Status
colourGreen
title200
subtletrue
OK (Successfully routed request)

Status
colourRed
title400
subtletrue

Bad Request

Code Block
titleExample Bad Request
languagetext
collapsetrue
{
    "Message": "The request is invalid.",
    "ModelState": {
        "model.Lender": [
            "The Lender field is required."
        ]
    }
}
Status
colourRed
title401
subtletrue
Unauthorized
Status
colourRed
title404
subtletrue
Resource Not Found
Status
colourRed
title500
subtletrue
Internal Server Error (Unexpected error)

 

Marking transaction unfilled

  • HTTP Verb: PUT
  • Authorization: Secured
  • Supports OData: No
  • Minimum API Version: 1
  • Minimum Web Platform Version: 8.7.2.0

Marks a borrowing request as being unfilled.

  • The ILLiad request will be routed to the Awaiting Unfilled Processing queue. 
  • The reason will be added as a note to the request. 
Info
Note the username of the tracking and history entries will be set to the WebPlatformDescription associated with the API key making the request. 

Required parameters

Reason

Indicates a reason the request is being marked unfilled

Code Block
titleExample Unfilled Transaction Request
linenumberstrue
languagexml
collapsetrue
PUT https://your.illiad.edu/ILLiadWebPlatform/transaction/4567/unfilled
Content-Type: application/json
{ "Reason" : "Not available on shelf" }

Response

Code Block
titleExample Unfilled Transaction Response
linenumberstrue
languagetext
collapsetrue
{
"TransactionNumber": 4567,
"Username": "jdoe",
"RequestType": "Article",
"LoanAuthor": null,
"LoanTitle": null,
"LoanPublisher": null,
"LoanPlace": null,
"LoanDate": null,
"LoanEdition": null,
"PhotoJournalTitle": "The electronic library : the international journal for
minicomputer, microcomputer, and software applications in libraries.",
"PhotoJournalVolume": null,
"PhotoJournalIssue": null,
"PhotoJournalMonth": null,
"PhotoJournalYear": null,
"PhotoJournalInclusivePages": "23-34",
"PhotoArticleAuthor": "Cohen, Calsada",
"PhotoArticleTitle": "Web accessible Databases",
"CitedIn": null,
"CitedTitle": null,
"CitedDate": null,
"CitedVolume": null,
"CitedPages": null,
"NotWantedAfter": null,
"AcceptNonEnglish": false,
"AcceptAlternateEdition": true,
"ArticleExchangeUrl": null,
"ArticleExchangePassword": null,
"TransactionStatus": "Awaiting Unfilled Processing",
"TransactionDate": "2013-06-07T09:05:37.19",
"ISSN": "0264-0473",
"ILLNumber": "500XXXXXXX/5YYZZOO,
"ESPNumber": "9172203",
"LendingString": null,
"BaseFee": null,
"PerPage": null,
"Pages": null,
"DueDate": null,
"RenewalsAllowed": false,
"SpecIns": null,
"Pieces": null,
"LibraryUseOnly": "Yes",
"AllowPhotocopies": false,
"LendingLibrary": "OSU",
"ReasonForCancellation": null,
"CallNumber": null,
"Location": null,
"Maxcost": "24.00",
"ProcessType": "Borrowing",
"ItemNumber": null,
"LenderAddressNumber": 1,
"Ariel": false,
"Patron": null,
"PhotoItemAuthor": null,
"PhotoItemPlace": null,
"PhotoItemPublisher": null,
"PhotoItemEdition": null,
"DocumentType": "Article",
"InternalAcctNo": null,
"PriorityShipping": null,
"Rush": "Regular",
"CopyrightAlreadyPaid": "Yes",
"WantedBy": null,
"SystemID": "OTH",
"ReplacementPages": null,
"IFMCost": null,
"CopyrightPaymentMethod": null,
"ShippingOptions": null,
"CCCNumber": null,
"IntlShippingOptions": null,
"ShippingAcctNo": null,
"ReferenceNumber": null,
"CopyrightComp": "US:CCL",
"TAddress": null,
"TAddress": null,
"TAddress2": null,
"TCity": null,
"TState": null,
"TZip": null,
"TCountry": null,
"TFax": null,
"TEMailAddress": null,
"TNumber": null,
"HandleWithCare": false,
"CopyWithCare": false,
"RestrictedUse": false,
"ReceivedVia": null,
"CancellationCode": null,
"BillingCategory": null,
"CCSelected": "No",
"OriginalTN": null,
"OriginalNVTGC": null,
"InProcessDate": null,
"InvoiceNumber": null,
"BorrowerTN": null,
"WebRequestForm": null,
"TName": null,
"TAddress3": null,
"IFMPaid": null,
"BillingAmount": null,
"ConnectorErrorStatus": null,
"BorrowerNVTGC": null,
"CCCOrder": null,
"ShippingDetail": null,
"ISOStatus": null,
"OdysseyErrorStatus": null,
"WorldCatLCNumber": null,
"Locations": null,
"FlagType": null,
"FlagNote": "",
"CreationDate": "2013-06-07T09:01:22.47",
"ItemInfo1": null,
"ItemInfo2": null,
"ItemInfo3": null,
"ItemInfo4": null,
"ItemInfo5": "Yes",
"SpecialService": null,
"DeliveryMethod": null,
"Web": null,
"PMID": null,
"DOI": null,
"LastOverdueNoticeSent": null,
"ExternalRequest": null
}

 

 

HTTP Status CodeDescription
Status
colourGreen
title200
subtletrue
OK (Successfully marked request unfilled)

Status
colourRed
title400
subtletrue

Bad Request

Code Block
titleExample Bad Request
languagetext
collapsetrue
{
    "Message": "The Transaction is at an invalid state. Request 12345 is not assigned to Borrowing process type."
}
Status
colourRed
title401
subtletrue
Unauthorized
Status
colourRed
title404
subtletrue
Resource Not Found
Status
colourRed
title500
subtletrue
Internal Server Error (Unexpected error)

 

Create a transaction request

  • HTTP Verb: POST
  • Authorization: Secured
  • Supports OData: No
  • Minimum API Version: 1
  • Minimum Web Platform Version: 8.7.2.0

Creates a new request. Routing rules will be applied to the transaction after it is created. 

Info
Note the username of the tracking and history entries will be set to the WebPlatformDescription associated with the API key making the request. 

Parameters

Parameters can be set from any existing field from the ILLiad transactions table

Required parameters

Username

Indicates the username of the new transaction

ProcessType

Indicates the ILLiad ProcessType.

Allowed values:

    • Borrowing
    • DocDel
    • Lending
*LendingLibrary
Info

LendingLibrary is only required if ProcessType is Lending.

Ignored parameters

The following fields are valid transaction fields but are ignored when creating a transaction. Developers should not send these fields when creating a transaction.

  • TransactionNumber
  • TransactionDate
  • CreationDate
  • ConnectorErrorStatus
  • OdysseyErrorStatus
  • ExternalRequest
  • CCSelected
  • OriginalTN
  • OriginalNVTGC
  • InvoiceNumber
  • FlagType
  • FlagNote

Default parameters

If the request does not contain values for the following fields, the Web Platform will assume default values.

Defaults for All requests
RequestType

Article

AcceptAlternateEditiontrue

 

AcceptNonEnglishfalse
TransactionStatusWhen transaction status is not set explicitly the web platform will use the default system initial transaction status depending on the ProcessType and RequestType.
Defaults for lending requests
SystemId

If ProcessType is Lending, the default value is

    • OTH

If ProcessType is Borrowing, the default value is
set to the BorrowingSystemIDDefault customization key.

DueDateCalculated based on LendingDueDateDays customization key and if the LendingLibrary is associated with a group that has a Due Date Override.
ShippingOptions

If RequestType is Article, the default value is set based on the LendingDefaultArticleShipping customization key.

If RequestType is Loan, the default value is set based on the LendingDefaultLoanShipping customization key.

LibraryUseOnlySet based on the LendingRestrictDefaultLibraryUseOnly customization key.
AllowPhotocopiesSet based on the LendingRestrictDefaultAllowPhotocopies  customization key.
RenewalsAllowedSet based on the LendingRestrictDefaultAllowRenewals  customization key.
LenderAddressNumberSet to the LenderAddressNumber associated with the LendingAddress record when only 1 record exists for the associated LendingLibrary.
Code Block
titleExample Create Transaction Request
linenumberstrue
languagetext
collapsetrue
POST https://your.illiad.edu/ILLiadWebPlatform/transaction/
Content-Type: application/json
{
 "Username" : "jdoe",
 "RequestType" : "Article",
 "ProcessType" : "Borrowing",
 "PhotoJournalTitle" : "Journal of Interlibrary Loan,Document Delivery & Electronic Reserve",
 "PhotoArticleTitle" : "Interlibrary Loan in the United States: An Analysis of Academic Libraries in a Digital Age",
 "PhotoArticleAuthor" : "Williams, Joseph; Woolwine, David",
 "PhotoJournalVolume" : "21",
 "PhotoJournalIssue" : "4",
 "PhotoJournalYear" : "2011",
 "PhotoJournalInclusivePages" : "165-183",
 "ISSN": "1072-303X",
 "TransactionStatus": "Awaiting Request Processing",
 "CopyrightAlreadyPaid": "Yes",
}

Response

Code Block
titleExample Create Transaction Response
linenumberstrue
languagetext
collapsetrue
{
"TransactionNumber": 125,
"Username": "jdoe",
"RequestType": "Article",
"LoanAuthor": null,
"LoanTitle": null,
"LoanPublisher": null,
"LoanPlace": null,
"LoanDate": null,
"LoanEdition": null,
"PhotoJournalTitle" : "Journal of Interlibrary Loan,Document Delivery & Electronic Reserve",
"PhotoJournalVolume": null,
"PhotoJournalIssue": null,
"PhotoJournalMonth": null,
"PhotoJournalYear": null,
"PhotoJournalInclusivePages": "165-183",
"PhotoArticleAuthor" : "Williams, Joseph; Woolwine, David",
"PhotoArticleTitle" : "Interlibrary Loan in the United States: An Analysis of Academic Libraries in a Digital Age",
"CitedIn": null,
"CitedTitle": null,
"CitedDate": null,
"CitedVolume": null,
"CitedPages": null,
"NotWantedAfter": null,
"AcceptNonEnglish": false,
"AcceptAlternateEdition": true,
"ArticleExchangeUrl": null,
"ArticleExchangePassword": null,
"TransactionStatus": "Awaiting Request Processing",
"TransactionDate": "2016-10-01T10:25:37.19",
"ISSN": "1072-303X",
"ILLNumber": null,
"ESPNumber": null,
"LendingString": null,
"BaseFee": null,
"PerPage": null,
"Pages": null,
"DueDate": null,
"RenewalsAllowed": false,
"SpecIns": null,
"Pieces": null,
"LibraryUseOnly": null,
"AllowPhotocopies": false,
"LendingLibrary": null,
"ReasonForCancellation": null,
"CallNumber": null,
"Location": null,
"Maxcost": null,
"ProcessType": "Borrowing",
"ItemNumber": null,
"LenderAddressNumber": null,
"Ariel": false,
"Patron": null,
"PhotoItemAuthor": null,
"PhotoItemPlace": null,
"PhotoItemPublisher": null,
"PhotoItemEdition": null,
"DocumentType": "Article",
"InternalAcctNo": null,
"PriorityShipping": null,
"Rush": "Regular",
"CopyrightAlreadyPaid": "Yes",
"WantedBy": null,
"SystemID": "OTH",
"ReplacementPages": null,
"IFMCost": null,
"CopyrightPaymentMethod": null,
"ShippingOptions": null,
"CCCNumber": null,
"IntlShippingOptions": null,
"ShippingAcctNo": null,
"ReferenceNumber": null,
"CopyrightComp": "US:CCL",
"TAddress": null,
"TAddress": null,
"TAddress2": null,
"TCity": null,
"TState": null,
"TZip": null,
"TCountry": null,
"TFax": null,
"TEMailAddress": null,
"TNumber": null,
"HandleWithCare": false,
"CopyWithCare": false,
"RestrictedUse": false,
"ReceivedVia": null,
"CancellationCode": null,
"BillingCategory": null,
"CCSelected": null,
"OriginalTN": null,
"OriginalNVTGC": null,
"InProcessDate": null,
"InvoiceNumber": null,
"BorrowerTN": null,
"WebRequestForm": null,
"TName": null,
"TAddress3": null,
"IFMPaid": null,
"BillingAmount": null,
"ConnectorErrorStatus": null,
"BorrowerNVTGC": null,
"CCCOrder": null,
"ShippingDetail": null,
"ISOStatus": null,
"OdysseyErrorStatus": null,
"WorldCatLCNumber": null,
"Locations": null,
"FlagType": null,
"FlagNote": "",
"CreationDate": "2016-10-01T10:25:37.19",
"ItemInfo1": null,
"ItemInfo2": null,
"ItemInfo3": null,
"ItemInfo4": null,
"ItemInfo5": null,
"SpecialService": null,
"DeliveryMethod": null,
"Web": null,
"PMID": null,
"DOI": null,
"LastOverdueNoticeSent": null,
"ExternalRequest": null
}

 

 

HTTP Status CodeDescription
Status
colourGreen
title200
subtletrue
OK (Successfully created request)

Status
colourRed
title400
subtletrue

Bad Request

Code Block
titleExample Bad Request
languagetext
collapsetrue
{
    "Message": "The request is invalid.",
    "ModelState": {
        "model.ProcessType": [
            "The ProcessType property is required."
        ]
    }
}
Status
colourRed
title401
subtletrue
Unauthorized
Status
colourRed
title500
subtletrue
Internal Server Error (Unexpected error)
Zen Section
id1117692315
 
Zen Section
id1057027841

Transaction History

Add transaction history entry to a transaction

  • HTTP Verb: POST
  • Authorization: Secured
  • Supports OData: No
  • Minimum API Version: 1
  • Minimum Web Platform Version: 8.7.2.0

The add transaction history request will add a transaction history entry for a given transaction number. The entry's username is set to the WebPlatformDescription associated with the API key making the request.

Required parameters

EntryThe history entry to be added
Code Block
titleExample Add Transaction History Request
linenumberstrue
languagexml
collapsetrue
POST https://your.illiad.edu/ILLiadWebPlatform/transaction/4567/histories
SendLibraryNotification
Content-Type: application/json
{ "Entry" : "Request could not be filled" }

 

Response

Code Block
titleExample Add Transaction History Response
linenumberstrue
languagexml
collapsetrue
{
	"TransactionNumber" : 4567,
	"DateTime" : "2016-10-05T08:15:37.19",
	"Entry" : "Request could not be filled",
	"Username" : "WebPlatform Config Description"
}
HTTP Status CodeDescription
Status
colourGreen
title200
subtletrue
OK

Status
colourRed
title400
subtletrue

Bad Request
Status
colourRed
title401
subtletrue
Unauthorized
Status
colourRed
title404
subtletrue
Resource Not Found
Status
colourRed
title500
subtletrue
Internal Server Error

...

Zen Section
id1117766572

Users

Get user by username

  • HTTP Verb: GET
  • Authorization: Secured
  • Supports OData: No
  • Minimum API Version: 1
  • Minimum Web Platform Version: 8.7.2.0

Returns user details for a given username.

Code Block
titleExample Get User by Username Request
linenumberstrue
languagexml
collapsetrue
GET https://your.illiad.edu/ILLiadWebPlatform/Users/msmith
Accept-Type: application/json

Response

Code Block
titleExample Get User by Username Response
linenumberstrue
languagetext
collapsetrue
  {
      "UserName":"msmith",
      "ExternalUserId":"123456789",
      "LastName":"Smith",
      "FirstName":"Michael",
      "SSN":987654321,
      "Status":"Staff",
      "EMailAddress":"msmith@your.illiad.edu",
      "Phone":"555-1212",
      "MobilePhone":"NULL",
      "Department":"Computer Science",
      "NVTGC":"ILL",
      "Password":"10471281899082626783",
      "NotificationMethod":"Electronic",
      "DeliveryMethod":"Hold for Pickup",
      "LoanDeliveryMethod":"Hold for Pickup",
      "LastChangedDate":"2016-06-01T08:30:35.15",
      "AuthorizedUsers":"NULL",
      "Cleared":"BO",
      "Web":"Yes",
      "Address":"123 Main St",
      "Address2":"",
      "City":"Virginia Beach",
      "State":"VA",
      "Zip":"23464",
      "Site":null,
      "ExpirationDate":"2017-06-01T08:30:35.15",
      "Number":"8765670098",
      "UserRequestLimit":null,
      "Organization":null,
      "Fax":null,
      "ShippingAcctNo":null,
      "ArticleBillingCategory":"Default",
      "LoanBillingCategory":"Default",
      "Country":null,
      "SAddress":null,
      "SAddress2":null,
      "SCity":null,
      "SState":null,
      "SZip":null,
      "PasswordHint":null,
      "SCountry":null,
      "RSSID":"10098718781900019",
      "AuthType":"ILLiad",
      "UserInfo1":"PY12345",
      "UserInfo2":null,
      "UserInfo3":null,
      "UserInfo4":null,
      "UserInfo5":null
   }
HTTP Status CodeDescription
Status
colourGreen
title200
subtletrue
OK
Status
colourRed
title401
subtletrue
Unauthorized
Status
colourRed
title404
subtletrue
Resource Not Found
Status
colourRed
title500
subtletrue
Internal Server Error

 

Get user by external user id

  • HTTP Verb: GET
  • Authorization: Secured
  • Supports OData: No
  • Minimum API Version: 1
  • Minimum Web Platform Version: 8.7.2.0

Returns user details for a given external user id.

Code Block
titleExample Get User by External User Id Request
linenumberstrue
languagetext
collapsetrue
GET https://your.illiad.edu/ILLiadWebPlatform/Users/ExternalUserId/123456789
Accept-Type: application/json
Info
titleExternal User Id
Anchor
ExternalUserId
ExternalUserId
The external user id is a configurable field that maps to an existing ILLiad field in the Users table. The external user id mapping is configured to be specific for each Web Platform API key that is generated allowing each Web Platform API consumer to have it's own external user id. The default mapping is set to the Username field. Staff at the ILLiad library will need to use the customization manager to modify the mapping for the ExternalUserId. ILLiad libraries are responsible to ensure that the external user id value is unique. The API will error if multiple records are found for the same external user id. 

 

Response

Code Block
titleExample Get User by External User Id Response
linenumberstrue
languagetext
collapsetrue
 {
      "UserName":"msmith",
      "ExternalUserId":"123456789",
      "LastName":"Smith",
      "FirstName":"Michael",
      "SSN":987654321,
      "Status":"Staff",
      "EMailAddress":"msmith@your.illiad.edu",
      "Phone":"555-1212",
      "MobilePhone":"NULL",
      "Department":"Computer Science",
      "NVTGC":"ILL",
      "Password":"10471281899082626783",
      "NotificationMethod":"Electronic",
      "DeliveryMethod":"Hold for Pickup",
      "LoanDeliveryMethod":"Hold for Pickup",
      "LastChangedDate":"2016-06-01T08:30:35.15",
      "AuthorizedUsers":"NULL",
      "Cleared":"BO",
      "Web":"Yes",
      "Address":"123 Main St",
      "Address2":"",
      "City":"Virginia Beach",
      "State":"VA",
      "Zip":"23464",
      "Site":null,
      "ExpirationDate":"2017-06-01T08:30:35.15",
      "Number":"8765670098",
      "UserRequestLimit":null,
      "Organization":null,
      "Fax":null,
      "ShippingAcctNo":null,
      "ArticleBillingCategory":"Default",
      "LoanBillingCategory":"Default",
      "Country":null,
      "SAddress":null,
      "SAddress2":null,
      "SCity":null,
      "SState":null,
      "SZip":null,
      "PasswordHint":null,
      "SCountry":null,
      "RSSID":"10098718781900019",
      "AuthType":"ILLiad",
      "UserInfo1":"PY12345",
      "UserInfo2":null,
      "UserInfo3":null,
      "UserInfo4":null,
      "UserInfo5":null
   }
HTTP Status CodeDescription
Status
colourGreen
title200
subtletrue
OK
Status
colourRed
title401
subtletrue
Unauthorized
Status
colourRed
title404
subtletrue

Resource Not Found

Code Block
titleExample Resource Not Found
linenumberstrue
collapsetrue
{
    "Message": "Could not find unique user with external user id 123123123."
}
Status
colourRed
title500
subtletrue
Internal Server Error

     

 

Create User

 

  • HTTP Verb: POST
  • Authorization: Secured
  • Supports OData: No
  • Minimum API Version: 1
  • Minimum Web Platform Version: 9.0.1.0

 

Creates a new user. 

 

Info

A note will be added for the user to indicate the user was created via the Web Platform and which API key created the record.

 

Code Block
titleExample Get User by External User Id Request
linenumberstrue
languagetext
collapsetrue
POST https://your.illiad.edu/ILLiadWebPlatform/Users
Accept-Type: application/json
{
  "Username" : "bdoe",  
  "ExternalUserId": "Z20181116",
  "FirstName":"Bailey",
  "LastName":"Doe",
  "EmailAddress" : "bailey@test.com" ,
  "DeliveryMethod" : "Hold for Pickup",
  "LoanDeliveryMethod" : "Mail to Address",
  "NotificationMethod" : "Electronic",
  "Phone" : "757-123-4568",
  "Status" : "Graduate",
  "PlainTextPassword": "MySpecialPassword1234!",
  "AuthType" : "ILLiad",
  "Department" : "Music",
  "Web" : true,
  "Address" : "123 Oak St",
  "Address2" : "Apt 4E",
  "City" : "Virgia Beach",
  "State" : "VA",
  "Zip" : "23462"
}

Parameters

FieldTypeDefault if not providedNote
Usernamestring Required field.
ExternalUserIdstring 

The ExternalUserId field is a dynamic field configured by the institution for each API Key.

Info

An ExternalUserId will always override the a value supplied for the mapped field. A user note will be added if the two values conflict and what the original mapped value was set to.

LastNamestring  
FirstNamestring  
SSNstring  
Statusstring  
EMailAddressstring  
Phonestring  
MobilePhonestring  
Departmentstring  
NVTGCstringThe NVTGC associated with the API Key.Each institution may have unique values. Consult with institution for allowed values.
NotificationMethodenumElectronic
Allowed Values
Electronic
Phone
Mail
DeliveryMethodenumHold for Pickup
Allowed Values
Hold for Pickup
Mail to Address
LoanDeliveryMethodenumHold for Pickup
Allowed Values
Hold for Pickup
Mail to Address
AuthorizedUsersstring  
ClearedenumNo
Allowed ValuesDescription
YesThe user is allowed to use the system.
NoThe user has not yet been vetted by staff.
NewUser is new to the system and has not completed their user profile. On their first login they will be forced to complete their user profile.
DISThe user is disavowed and not authorized to log in.
BThe user is blocked.
BOThe user is blocked due to an overdue. Overdue blocks are removed when the user no longer has overdue materials checked out.
BXThe user is blocked by an external system.
WebbooltrueWhen true, the user will receive articles electronically.
Addressstring  
Address2string  
Citystring  
Statestring  
Zipstring  
Countrystring  
Sitestring  
ExpirationDatedatetimeThe User Expiration Date is set based upon system rules. 
Numberstring  
UserRequestLimitinteger This field should only be set if the user has a custom request limit.
Organizationstring  
Faxstring  
ShippingAcctNostring  
ArticleBillingCategorystring  
LoanBillingCategorystring  
SAddressstring This is for a secondary address.
SAddress2string This is for a secondary address.
SCitystring This is for a secondary address.
SStatestring This is for a secondary address.
SZipstring This is for a secondary address.
SCountrystring This is for a secondary address.
AuthTypeenum 
Allowed ValuesNote
DefaultThe user will login with the default user authentication system.
ILLiad

The user will login with their ILLiad username and password.

Consider supplying a PlainTextPassword so the user can access their web account. If a password is not provided, the user will need to reset their password or contact staff for assistance.

PlainTextPasswordstring The password the user will use for authenticating to the web interface.
UserInfo1string  
UserInfo2string  
UserInfo3string  
UserInfo4string  
UserInfo5string  
NotificationPreferencesArray of NotificationPreferencesEmail Notification preferences are added for all available activities.

Each NotificationPreference consists of an ActivityType and NotificationType.

Allowed NotificationTypes
ValueDescription
SMSIndicates the user wants an SMS notification, when available. A MobilePhone value should be provided.
EmailIndicated the user wants an Email notification, when available. An EmailAddress should be provided.
Allowed NotificationTypes
ValueDescription
ClearedUserThe type of notification received when the user is cleared to use the system.
PasswordResetThe type of notification received when the user requested a password reset.
RequestPickupThe type of notification received when material is available to be picked up by the user at the library.
RequestShippedThe type of notification received when material is shipped to the user.
RequestElectronicDeliveryThe type of notification received when the user receives material via electronic delivery.
RequestOverdueThe type of notification received when the user has material checked out that is overdue.
RequestCancelledThe type of notification received when a request placed by the user is cancelled.
RequestOtherThe type of notification received for any other notification generated by the system that is not listed above.
Code Block
titleSample NotificationPreferences
languagejs
"NotificationPreferences" : [
    {
    "ActivityType" : "RequestPickup",
    "NotificationType" : "SMS"
  	},
    {
    "ActivityType" : "RequestPickup",
    "NotificationType" : "Email"
  	},
    {
    "ActivityType" : "RequestOther",
    "NotificationType" : "Email"
  	},
  ]  

Required Parameters

Username

Indicates the username of the new transaction

Response

Code Block
titleExample Create User Response
linenumberstrue
languagetext
collapsetrue
{
    "UserName": "bdoe",
    "ExternalUserId": "Z20181116",
    "LastName": "Doe",
    "FirstName": "Bailey",
    "SSN": "Z20181116",
    "Status": "Graduate",
    "EMailAddress": "bailey@test.com",
    "Phone": "757-123-4568",
    "Department": "Music",
    "NVTGC": "ADAMS",
    "NotificationMethod": "Electronic",
    "DeliveryMethod": "Hold for Pickup",
    "LoanDeliveryMethod": "Mail to Address",
    "LastChangedDate": "2018-11-26T12:00:01.000",
    "AuthorizedUsers": null,
    "Cleared": "No",
    "Web": true,
    "Address": "123 Oak St",
    "Address2": "Apt 4E",
    "City": "Virgia Beach",
    "State": "VA",
    "Zip": "23462",
    "Site": null,
    "ExpirationDate": "2019-05-15T12:00:01.000",
    "Number": null,
    "UserRequestLimit": null,
    "Organization": null,
    "Fax": null,
    "ShippingAcctNo": null,
    "ArticleBillingCategory": null,
    "LoanBillingCategory": null,
    "Country": null,
    "SAddress": null,
    "SAddress2": null,
    "SCity": null,
    "SState": null,
    "SZip": null,
    "SCountry": null,
    "RSSID": null,
    "AuthType": "ILLiad",
    "UserInfo1": null,
    "UserInfo2": null,
    "UserInfo3": null,
    "UserInfo4": null,
    "UserInfo5": null,
    "MobilePhone": null
}

 

 

HTTP Status CodeDescription
Status
colourGreen
title200
subtletrue
OK (Successfully created request)

Status
colourRed
title400
subtletrue

Bad Request

Code Block
titleExample Bad Request
languagetext
collapsetrue
{
    "Message": "The request is invalid.",
    "ModelState": {
        "model.NVTGC": [
            "The NVTGC is invalid."
        ]
    }
}
Status
colourRed
title401
subtletrue
Unauthorized
Status
colourRed
title500
subtletrue
Internal Server Error (Unexpected error)
Zen Section
id1117745298
 
Zen Section
id1117721618
 
Zen Section
id1232589473

Notifications

Retrieve Email Details

  • Authorization: Secured
  • Supports OData: No
  • Minimum API Version: 1
  • Minimum Web Platform Version: 8.6.0.0

The Email Details request will retrieve a single e-mail for a specified email id. This request is secured and requires an API key.

Code Block
titleExample Email Details Request
linenumberstrue
languagexml
collapsetrue
curl -H 'Accept: application/json'
https://your.illiad.edu/ILLiadWebPlatform/Notification/EmailDetails/1234
Code Block
titleExample Email Details Response
linenumberstrue
languagexml
collapsetrue
{
ID: 1234,
TransactionNumber: 0,
EMailDate: "2014-06-01T12:34:57.001",
ReferenceType: "Symbol",
Reference: "OCLC_ATL",
EMailTo: "borrowing@library.oclc_atl.edu",
EMailFrom: "\"ILLiad System\" <from.illiad@atlas-sys.com>",
EMailCC: null,
EMailBCC: null,
Subject: "This e-mail was generated on the Web Platform",
Body: "This is a sample e-mail body.",
Staff: null,
Status: "Pending",
Note: null,
NVTGC: "ILL"
}

Retrieve SMS Details

  • Authorization: Secured
  • Supports OData: No
  • Minimum API Version: 1
  • Minimum Web Platform Version: 8.6.0.0

The SMS Details request will retrieve a single SMS notification for a specified id. This request is secured and requires an API key.

Code Block
titleExample SMS Details Request
linenumberstrue
languagexml
collapsetrue
curl -H 'Accept: application/json'
https://your.illiad.edu/ILLiadWebPlatform/Notification/SMSDetails/12
Code Block
titleExample SMS Details Response
linenumberstrue
languagexml
collapsetrue
{
"ID": 12,
"NotificationDate": "2014-06-01T12:34:57.001",
ReferenceType: "Transaction",
Reference: "12345",
"To": "2125551212",
"Message": "This is a sample message",
"Staff": "System",
"Status": "Pending",
"Note": null,
"NVTGC": "ILL"
}

Send Transaction Notification

  • HTTP Verb: POST
  • Authorization: Secured
  • Supports OData: No
  • Minimum API Version: 1
  • Minimum Web Platform Version: 8.6.0.0

The SendTransactionNotification request will generate a notification using a notification template for a specified transaction. If an e-mail notification is generated, it will be placed into a pending status and will be sent by the System Manager. If an SMS notification is generated, it will be placed into a pending status and will be handled by a server addon.

Required parameters

TransactionNumberThe transaction number to send the notification for
TemplateNameThe name of the notification template to be used for the template

Optional parameters

ToThe To address for the e-mail. If To is not provided, the To address will default to the NotificationTemplate's ToAddress if provided or the User or Lender's e-mail address.
FromThe From address for the e-mail. If From is not provided, the From address will default to the NotificationTemplate's FromAddress if provided or the From address in Customization (EmailFromAddress, DocDelEmailFromAddress, or LendingEmailFromAddress depending on ProcessType).
CCThe CC address for the e-mail.
BCCThe BCC address for the e-mail.
SubjectThe subject for the e-mail. If Subject is not provided, the subject will default to the NotificationTemplate's Subject.
StaffUsernameThe staff username associated with sending the notification.
CustomTags

An array of custom tags that can be used as replacement values for Special tags in a notification template. CustomTags are considered to be a part of the Special table name if a table name is not provided.

In the following example, <#Special.CustomApplicationField> in a template would be replaced with ABC and <#CustomApplicationTable.Field> would be replaced with XYZ. `CustomTags:{"CustomApplicationField":"ABC","CustomApplicationTable.Field":"XYZ"} `

 

Code Block
titleExample SendTransactionNotification Request using JSON
linenumberstrue
languagexml
collapsetrue
POST https://your.illiad.edu/ILLiadWebPlatform/Notification/
SendTransactionNotificationContent-Type: application/json
{ TransactionNumber: 12345, TemplateName:"Demo Template", Subject: 
"This e-mail was generated on the Web Platform", CustomTags:
{"Test1":"123","Test2":"abc"}}}

SendTransactionNotification Response

If the transaction number or template name do not exist, the response will be a 404 Not Found.

If the notification was handled successfully, the Web Platform will respond with an HTTP 201 Created status code (Status: 201 Created). It is possible that a user will opt-out of specific types of notifications where an e-mail and/or an SMS will not be generated. Lending transactions will not generate SMS notifications. Check to ensure data was returned for an Email and SMS before using the result.

Code Block
titleExample SendTransactionNotification Response
linenumberstrue
languagexml
collapsetrue
{
"Email": {
ID: 101,
TransactionNumber: 12345,
EMailDate: "2014-06-01T12:34:57.001",
ReferenceType: "Transaction",
Reference: "12345",
EMailTo: "test.user@your.illiad.edu",
EMailFrom: "\"ILLiad System\" <from.illiad@atlas-sys.com>",
EMailCC: null,
EMailBCC: null,
Subject: "This e-mail was generated on the Web Platform",
Body: "This is a sample e-mail body.",
Staff: "System",
Status: "Pending",
Note: null,
NVTGC: "ILL"
},
"SMS": { 
"ID": 12,
"NotificationDate": "2014-06-01T12:34:57.001",
ReferenceType: "Transaction",
Reference: "12345",
"To": "2125551212",
"Message": "This is a sample message",
"Staff": "System",
"Status": "Pending",
"Note": null,
"NVTGC": "ILL"
}
}

Send User Notification

  • HTTP Verb: POST
  • Authorization: Secured
  • Supports OData: No
  • Minimum API Version: 1
  • Minimum Web Platform Version: 8.6.0.0

The CreateUserEmail request will generate notification using a notification template for a specified user. If an e-mail notification is generated, it will be placed into a pending status and will be sent by the System Manager. If an SMS notification is generated, it will be placed into a pending status and will be handled by a server addon.

Required parameters

UsernameThe username of the user to associate the notification with
TemplateNameThe name of the e-mail template to be used for the template

Optional parameters

ToThe To address for the e-mail. If To is not provided, the To address will default to the NotificationTemplate's ToAddress if provided or the User or Lender's e-mail address.
FromThe From address for the e-mail. If From is not provided, the From address will default to the NotificationTemplate's FromAddress if provided or the From address in Customization (EmailFromAddress).
CCThe CC address for the e-mail.
BCCThe BCC address for the e-mail.
SubjectThe subject for the e-mail. If Subject is not provided, the subject will default to the EmailTemplate's Subject.
StaffUsernameThe staff username associated with sending the e-mail.
CustomTags

An array of custom tags that can be used as replacement values for Special tags in an e-mail template. CustomTags are considered to be a part of the Special table name if a table name is not provided.

In the following example, <#Special.CustomApplicationField> in a template would be replaced with ABC and <#CustomApplicationTable.Field> would be replaced with XYZ. `CustomTags:{"CustomApplicationField":"ABC","CustomApplicationTable.Field":"XYZ"} `

 

Code Block
titleExample SendUserNotification Request using JSON
linenumberstrue
languagexml
collapsetrue
POST https://your.illiad.edu/ILLiadWebPlatform/Notification/
SendUserNotificationContent-Type: application/json
{ Username: "jdoe", TemplateName:"Demo Template", Subject: 
"This e-mail was generated on the Web Platform", CustomTags:
{"Test1":"123","Test2":"abc"}}}

SendUserNotification Response

If the user or template name do not exist, the response will be a 404 Not Found.

If the notification was handled successfully, the Web Platform will respond with an HTTP 201 Created status code (Status: 201 Created). It is possible that a user will opt-out of specific types of notifications where an e-mail and/or an SMS will not be generated. Check to ensure data was returned for an Email and SMS before using the result.

Code Block
titleExample SendUserNotification Response
linenumberstrue
languagexml
collapsetrue
{
"Email": {
ID: 102,
TransactionNumber: 0,
EMailDate: "2014-06-01T12:34:57.001",
ReferenceType: "User",
EMailReference: "jdoe",
EMailTo: "jdoe@your.illiad.edu",
EMailFrom: "\"ILLiad System\" <from.illiad@atlas-sys.com>",
EMailCC: null,
EMailBCC: null,
Subject: "This e-mail was generated on the Web Platform",
Body: "This is a sample e-mail body.",
Staff: null,
Status: "Pending",
Note: null,
NVTGC: "ILL"
},
"SMS": { 
"ID": 12,
"NotificationDate": "2014-06-01T12:34:57.001",
ReferenceType: "User",
Reference: "jdoe",
"To": "2125551213",
"Message": "This is a sample message",
"Staff": "System",
"Status": "Pending",
"Note": null,
"NVTGC": "ILL"
}
}

Send Library Notification

  • HTTP Verb: POST
  • Authorization: Secured
  • Supports OData: No
  • Minimum API Version: 1
  • Minimum Web Platform Version: 8.6.0.0

The SendLibraryNotification request will generate notification using a notification template for a specified library. If an e-mail notification is generated, it will be placed into a pending status and will be sent by the System Manager. SMS messages are not supported for lending/library e-mails.

Required parameters

LibrarySymbolThe symbol of the library to associate the notification with
AddressNumberThe address number of the library to associate the notification with
TemplateNameThe name of the notification template to be used for the template

Optional parameters

NVTGCThe NVTGC associated with the library address. If not provided the NVTGC will be the default site code (i.e. ILL). This parameter should be provided in shared server environments.
ToThe To address for the e-mail. If To is not provided, the To address will default to the NotificationTemplate's ToAddress if provided or the User or Lender's e-mail address.
FromThe From address for the e-mail. If From is not provided, the From address will default to the NotificationTemplate's FromAddress if provided or the From address in Customization (LendingEmailFromAddress).
CCThe CC address for the e-mail.
BCCThe BCC address for the e-mail.
SubjectThe subject for the e-mail. If Subject is not provided, the subject will default to the NotificationTemplate's Subject.
StaffUsernameThe staff username associated with sending the notification.
CustomTags

An array of custom tags that can be used as replacement values for Special tags in a notification template. CustomTags are considered to be a part of the Special table name if a table name is not provided.

In the following example, <#Special.CustomApplicationField> in a template would be replaced with ABC and <#CustomApplicationTable.Field> would be replaced with XYZ. `CustomTags:{"CustomApplicationField":"ABC","CustomApplicationTable.Field":"XYZ"} `

 

Code Block
titleExample SendLibraryNotification Request using JSON
linenumberstrue
languagexml
collapsetrue
POST https://your.illiad.edu/ILLiadWebPlatform/Notification/
SendLibraryNotification
Content-Type: application/json
{ LibrarySymbol: "OCLC_ATL", AddressNumber : 1, NVTGC : "ILL", 
TemplateName:"Demo Template", Subject: "This e-mail was generated 
on the Web Platform", CustomTags:{"Test1":"123","Test2":"abc"}}}

SendLibraryNotification Response

If the library or template name do not exist, the response will be a 404 Not Found.

If the notification was handled successfully, the Web Platform will respond with an HTTP 201 Created status code (Status: 201 Created).

Code Block
titleExample SendLibraryNotification Response
linenumberstrue
languagexml
collapsetrue
{
"Email": {
ID: 102,
TransactionNumber: 0,
EMailDate: "2014-06-01T12:34:57.001",
ReferenceType: "Symbol",
EMailReference: "OCLC_ATL",
EMailTo: "borrowing@library.oclc_atl.edu",
EMailFrom: "\"ILLiad System\" <from.illiad@atlas-sys.com>",
EMailCC: null,
EMailBCC: null,
Subject: "This e-mail was generated on the Web Platform",
Body: "This is a sample e-mail body.",
Staff: null,
Status: "Pending",
Note: null,
NVTGC: "ILL"
},
"SMS": null
}