Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

updated description of API endpoint /eperson/epersons/search/byEmail #261

Merged
merged 2 commits into from
May 3, 2024
Merged

updated description of API endpoint /eperson/epersons/search/byEmail #261

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
628a434
Update epersons.md
saschaszott Apr 16, 2024
c6973dd
Update epersons.md
saschaszott Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions epersons.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down