Merge pull request DSpace#261 from saschaszott/patch-2

updated description of API endpoint /eperson/epersons/search/byEmail
4Science · May 3, 2024 · d34e1bd · d34e1bd
2 parents 84ab116 + c6973dd
commit d34e1bd
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/epersons.md b/epersons.md
@@ -65,12 +65,13 @@
 **/api/eperson/epersons/search/byEmail?email=<:string>**
 
 The supported parameters are:
-* email: mandatory, EPerson's email to search
+* email: mandatory, EPerson's email address to search
 
 It returns the EPersonRest instance, if any, matching the user query
 
 Return codes:
-* 200 OK - if the operation succeed
+* 200 OK - if the search operation succeeds and an EPerson with the given email address exists
+* 204 OK - if the search operation succeeds, but an EPerson with the given email address does not exist
 * 400 Bad Request - if the email parameter is missing or invalid
 * 401 Unauthorized - if you are not authenticated
 * 403 Forbidden - if you are not logged in with sufficient permissions. Only system administrators and users with READ rights on the target EPerson can use the endpoint