Table of Contents |
---|
Purpose
Use this method to reject previously created Person Request.
Key features
...
Only authenticated and authorized user can use this service
...
New and Approved person request can be rejected
...
.
Specification
Page Properties | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Logic
API paragraph not found
Preconditions
API paragraph not found
Global and configurable parameters
NoKey features:
Only authenticated and authorized user can use this service;
New and Approved person request can be rejected;
The request can be rejected only by the employee who works in the same legal entity in which the request was made.
Input parameters
Input parameter | Values | Type | Description | Example |
---|---|---|---|---|
id | String | Required | eeebb86d-5cba-43c9-885b-6482ecaf826b |
Filters
No
Dictionaries
API paragraph not found
Request structure
...
Dictionaries
GENDER
DOCUMENT_TYPE
ADDRESS_TYPE
COUNTRY
SETTLEMENT_TYPE
STREET_TYPE
PHONE_TYPE
CONFIDANT_PERSON_TYPE
PREFERRED_WAY_COMMUNICATION
DOCUMENT_TYPE
DOCUMENT_RELATIONSHIP_TYPE
AUTHENTICATION_METHOD
Request structure
See on Apiary
Authorize
Verify the validity of access token
Return 401 in case validation fails.
Check scopes in order to perform this action (scope = 'person_request:write')
Return 403 in case invalid scope(s).
Headers
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9{{access_token}}
api-key:uXhEczJ56adsfh3Ri9SUkc4en{{secret}}
Request data validation
Validate person request
Check that person request with such ID exists in the system (is_active = true)
In case of error - return 404.
Check that person request belongs to the same legal entity as the user
In case of error - return 403.
Processing
Change person request
Change entity status in IL_DB.person_request to REJECTED
Set updated_at - now() (Get current date-time)
Set updated_by - user_id (Extract user from token).
Response structure
See on Apiary
Example:
Expand | ||
---|---|---|
| ||
|
Post-processing processes
API paragraph not found
HTTP status codes
Page Properties | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Backward compatibility
...
|