...
Get the status of a fulfillment request
Supported Methods | POSTGET |
---|---|
Endpoint Location |
|
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) |
...
Property | Type | Description | Optional |
---|---|---|---|
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 | 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:
| 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. | NoYes |
customReference | string | If the requester library added a custom reference value, it is stored and displayed here. | Yes |
...