...
Get a list of libraries
Supported Methods | | Code Block |
|
|---|---|---|
Endpoint Location | code
| |
Endpoint Parameters | ||
:library_group_id | 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 |
...
Example response body
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"id": "39411",
"name": "First Library in the Group",
"type": "libraries"
},
{
"id": "39412",
"name": "Second Library in the Group",
"type": "libraries"
}
]
} |
Check the availability of an article in a library group
Supported Methods | code
| |
|---|---|---|
Endpoint Location | code
-or- code
| |
Endpoint Parameters | ||
:library_group_id | Replace the :library_group_id portion of the endpoint path with the id # of your library group | |
:library_id | Replace the :library_id portion of the endpoint path with the id # of your library | |
:article_doi | Replace :article_doi with the DOI of an article. Only one DOI can be supplied. (DOI value does not need to be URI encoded) | |
:article_pmid | Replace :article_pmid with the pmid of an article. Only one pmid can be supplied. | |
Optional Includes | ||
?include=journal | 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) |
...
Create a fulfillment request
Supported Methods | code
| |
|---|---|---|
Endpoint Location | | Code Block |
|
Endpoint Parameters | ||
:library_group_id | Replace the :library_group_id portion of the endpoint path with the id # of your library group | |
Mandatory Body Fields | These must appear in the body of the POST | |
type | This should be the value | |
articleId | Send the DOI of an article. Only one DOI can be supplied. DOI value does not need to be URI encoded. | |
requesterLibraryId | This is the Third Iron ID of your library, to indicate from where the fulfillment request is arriving. | |
requesterEmail | This is the email address to which you would like the fulfillment response to arrive. | |
lenderLibraryId | 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 if you would like to store a unique identifier for your fulfillment request. |
...
Get the status of a fulfillment request
Supported Methods | | Code Block |
|
|---|---|---|
Endpoint Location | | Code Block |
|
Endpoint Parameters | ||
:library_group_id | Replace the :library_group_id portion of the endpoint path with the id # of your library group | |
:fulfillment_request_id | 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. | |
Optional Includes | ||
?include=journal | 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) |
...
Example response body
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"id": "20221003-randomid",
"type": "fulfillment-requests",
"created": "2024-10-21T23:58:11.833Z",
"lastUpdated": "2024-10-21T23:58:11.833Z",
"status": "pending",
"articleId": 689611,
"requesterLibraryId": 9875,
"requesterEmail": "requester@foo.somewhere",
"lenderLibraryId": 9876,
"libraryGroupId": 123,
"customReference": "abc-123",
"relationships": {
"article": {
"data": {
"id": 689611,
"type": "articles"
}
},
"journal": {
"data": {
"type": "journals"
}
},
"issue": {
"data": {
"id": 68961,
"type": "issues"
}
},
"requesterLibrary": {
"data": {
"id": 9875,
"type": "libraries"
}
},
"lenderLibrary": {
"data": {
"id": 9876,
"type": "libraries"
}
}
}
}
} |