Versions Compared

Key

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

...

Supported Methods

POST

Endpoint Location

/public/v1/libraryGroups/:library_group_id/fulfillmentRequests?access_token=ffffffff-ffff-ffff-ffff-ffffffffffff

Endpoint Parameters

:library_group_id

Replace the :library_group_id portion of the endpoint path with the id # of your library group

Mandatory Body data Fields

These must appear in the body of the POST in an element named `data `

type

String - This should be the value fulfillment-requests

articleId

Send the DOI of an Integer - The Third Iron ID of the article. Only one DOI ID can be supplied. DOI value does not need to be URI encoded.

requesterLibraryId

Integer - This is the Third Iron ID of your library, to indicate from where the fulfillment request is arriving.

requesterEmail

String - This is the email address to which you would like the fulfillment response to arrive.

lenderLibraryId

Integer - This is the library ID from which you would like to attempt to borrow the article. This typically should be captured by using the “Check the availability of an article in a library group” endpoint documented above.

Optional Body Fields

customReference

Add a string here String - Empty string, or a value if you would like to store a unique identifier for your fulfillment request.

Example fulfillment request body

Code Block
{
  "data": {
    "type": "fulfillment-requests",
    "articleId": 2349019438,
    "requesterLibraryId": 123,
    "requesterEmail": "me@gmail.com",
    "lenderLibraryId": 4930123
  }
}

Create fulfillment request response

...