LibKey Lending Tool API Documentation

GET

https://public-api.thirdiron.com/public/v1/libraryGroups/:library_group_id/libraries?access_token=ffffffff-ffff-ffff-ffff-ffffffffffff

Replace the :library_group_id portion of the endpoint path with the id # of your library group, which will be provided by support@thirdiron.com

data

Array

An array of Library Result objects is returned if the Fulfillment Request ID and Library Group ID is recognized.

id

string

A unique ID for the library ID.

No

type

string

The value libraries

No

name

string

The human-readable name of the library.

No

GET

https://public-api.thirdiron.com/public/v1/libraryGroups/:library_group_id/libraries/:library_id/articles/doi/:article_doi?access_token=ffffffff-ffff-ffff-ffff-ffffffffffff
-or-
https://public-api.thirdiron.com/public/v1/libraryGroups/:library_group_id/libraries/:library_id/articles/pmid/:article_pmid?access_token=ffffffff-ffff-ffff-ffff-ffffffffffff

Replace the :library_group_id portion of the endpoint path with the id # of your library group, which will be provided by support@thirdiron.com

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

Replace :article_doi with the DOI of an article. Only one DOI can be supplied. (DOI value does not need to be URI encoded)

Replace :article_pmid with the pmid of an article. Only one pmid can be supplied.

Adding this include to your request will cause the response to include information about the journal that the DOI is located within. This includes the name of the journal, ISSN, SJR Value, Cover Image URL, BrowZine Enabled Status and the Link to the Journal (more details below including example response)

Adding this include your request will cause the ILL related fields articulated below to appear even when the request can, according to LibKey data, be filled locally. This feature is included to provide the ability to show a route to request from another library if the local download access doesn’t work. (This could happen for any number of reasons but most likely through clerical error or timing of holdings data accuracy provided to LibKey).

illLibraryId

integer

If an article is available at another library, this property will exist with an ID as its value.

Yes

illLibraryName

string

If an article is available at another library, this displays the human-readable name of the library.

Yes

libraryIllEmail

string

If an article is available at another library, this displays the email where the request will be sent at that library.

Yes

POST

https://lendingtool-api.thirdiron.com/public/v1/libraryGroups/:library_group_id/fulfillmentRequests?access_token=ffffffff-ffff-ffff-ffff-ffffffffffff

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

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

String - This should be the value fulfillment-requests

Integer - The Third Iron ID of the article. Only one ID can be supplied.

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

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

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.

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

GET

https://public-api.thirdiron.com/public/v1/libraryGroups/:library_group_id/fulfillmentRequests/:fulfillment_request_id?access_token=ffffffff-ffff-ffff-ffff-ffffffffffff

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

Replace the :fulfillment_request_id portion of the endpoint path with the ID # of your fulfillment request. This is typically acquired when you create a fulfillment request using the POST endpoint documented above.

Adding this include to your request will cause the response to include information about the journal that the DOI is located within. This includes the name of the journal, ISSN, SJR Value, Cover Image URL, BrowZine Enabled Status and the Link to the Journal (more details below including example response)

data

Object

A Fulfillment Request Result object is returned if the Fulfillment Request ID and Library Group ID is recognized.

No

id

string

The fulfillment request’s unique id in the Third Iron system. It follows a format of YYYYMMDD-{random_unique_id}

No

type

string

The value fulfillment-requests

No

created

date & time

When the fulfillment request was created.

No

lastUpdated

date & time

When the fulfillment request was last updated, such as when its “status” was last changed.

No

status

string

One of the following values:

• pending - the lender library has not determined whether they can complete the lending or will decline it

• complete - the lender library has contacted the requester email with the article

• declined - the lender library declined lending the article. See the declinedReason property for more information about why.

No

articleId

integer

A Third Iron article ID (not a DOI) that helps Third Iron keep track of which article was requested in the system.

No

requesterLibraryId

integer

The ID of the library that is requesting the article.

No

requesterEmail

URL

The email address of the person / entity requesting the article.

No

lenderLibraryId

integer

The ID of the library that has been requested to lend the article.

No

libraryGroupId

integer

The ID of the library group to which the library belongs.

No

declinedReason

string

A value entered by the lender library informing the requester why the article was unable to be lent.

Yes

customReference

string

If the requester library added a custom reference value, it is stored and displayed here.

Yes