...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Purpose
This method searches and returns request for registration employee by id. This method uses scopes and context.
...
The legal entity (Owner, HR) can see only employee_requests that were made by this legal entity.
NHS Admin can see all employee_requests
Specification
Page Properties | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Logic
API paragraph not found
Input parameters
Input parameter | Values | Type | Description | Example |
---|---|---|---|---|
id |
| String | Required | d290f1ee-6c54-4b01-90e6-d701748f0851 |
Authorize
Request to process the request using a token in the headers
Headers
Authorization:Bearer c2778f3064753ea70de870a53795f5c9 (string, optional)
Request data validation
Validate request
Verify the validity of access token
in case error return 401
Check user scopes in order to perform this action (scope = 'employee_request:read')
in case error return 403
Validate id
Verify id - employee_request_id exists
in case error return 404 (not found employee request in DB with this ID)
Validate context
Get legal_entity.id from '$.context'. Filter employee requests by legal_entity.id
in case error return 404
Response structure
See on Apiary
Example:
Expand | ||
---|---|---|
| ||
|
Post-processing processes
API paragraph not found
HTTP status codes
HTTP status code | Message | What caused the error |
---|---|---|
200 | Response |
|
401 | Error | Access token validation failed |
403 | Error | Check user scopes in order to perform this action failed |
404 |
| 2. Get legal_entity.id from '$.context'. Filter employee requests by legal_entity.id failed |
...