From f042fa534c10c3a1b54648c10f8865f384607714 Mon Sep 17 00:00:00 2001 From: Sascha Szott Date: Sun, 14 Jun 2026 14:39:39 +0200 Subject: [PATCH 1/2] Update item request API documentation --- item-requests.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/item-requests.md b/item-requests.md index 3703f6a3..c0f19a66 100644 --- a/item-requests.md +++ b/item-requests.md @@ -72,7 +72,10 @@ Return codes: ## Creating a Request **POST /api/tools/itemrequests** -Anyone may create an item request. The Content-Type is JSON. Example: +Anyone may create an item request. The Content-Type is JSON. + +Example JSON payload: + ```json { "itemId": "71d9fb0c-cc36-41c1-b1d3-63887b414fca", @@ -83,7 +86,11 @@ Anyone may create an item request. The Content-Type is JSON. Example: "requestMessage": "Please send this to me." } ``` -`bitstreamId` is ignored and may be omitted if `allfiles` is `false`. `requestMessage` is optional. `requestEmail` and `requestName` are ignored and may be omitted if the session is authenticated -- these fields will be filled from the session user's EPerson. If the session is anonymous then `requestEmail` is required. `bitstreamId` is required if `allfiles` is false. `itemId` is always required. + +* `bitstreamId` is ignored and may be omitted if `allfiles` is `true`. `bitstreamId` is required if `allfiles` is false. +* `itemId` is always required. +* `requestMessage` is optional. +* `requestEmail` and `requestName` are ignored and may be omitted if the session is authenticated -- these fields will be filled from the session user's EPerson. If the session is anonymous then `requestEmail` is required. The response is empty, generated token should not be exposed. From db0a94fb67b0f042d6c9c9f27b9d61d4154799db Mon Sep 17 00:00:00 2001 From: Sascha Szott Date: Sun, 14 Jun 2026 14:41:53 +0200 Subject: [PATCH 2/2] Update item request creation documentation --- item-requests.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/item-requests.md b/item-requests.md index c0f19a66..ac0d0998 100644 --- a/item-requests.md +++ b/item-requests.md @@ -72,7 +72,7 @@ Return codes: ## Creating a Request **POST /api/tools/itemrequests** -Anyone may create an item request. The Content-Type is JSON. +Anyone may create an item request (depending on backend configuration parameter `request.item.type`). The Content-Type is JSON. Example JSON payload: