| Table of Contents |
|---|
...
- Verify the validity of access token
- Return 401 in case validation fails
- Check user scopes in order to perform this action (scope = 'equipment:write')
- Return 403 in case invalid scope(s)
Validate request
Validate request using JSON schema (TBD)
Validate legal entity
Check that legal entity is active (status = ACTIVE, SUSPENDED)
...
If division_id passed in request body:
- Validate division_id in request body - division exists and is_active = true
- Return 422 in case validation fails
- Check division_id belongs to the same legal_entity_id (from token) as the user
- Return 422 with message "Division is not within current legal entity" in case validation fails.
- Check division status =ACTIVE.
- Return 422 with message "Division is not active" in case validation fails.
...
- Check external_id within the legal_entity_id.
- Return 409 (Duplicated equipment) in case such record already exists
Save object to DB
1. equipments table
| Parameter | Source | Description |
|---|---|---|
| id | UUID | Autogenerated |
| type | Request: type | Get from request body |
| external_id | Request: external_id | Get from request body |
| legal_entity_id | Token: client_id | Extract client from token |
| status | Const: ACTIVE | By default ACTIVE for new records |
| is_active | Const: TRUE | Always TRUE for new records |
| inserted_at | Timestamp: now() | Get current date-time |
| inserted_by | Token: user_id | Extract user from token |
| updated_at | Timestamp: now() | Get current date-time |
| updated_by | Token: user_id | Extract user from token |
...
| Parameter | Source | Description |
|---|---|---|
| id | UUID | Autogenerated |
| equipment_id | UUID | Reference to equipments.id |
| status | Const: ACTIVE | By default ACTIVE for new records |
| inserted_by | Token: user_id | Extract user from token |
| inserted_at | Timestamp: now() | Get current date-time |
3. division_equipment table.
It 's filled only if the fills only if division_id is submitted.
| Parameter | Source | Description |
|---|---|---|
| id | UUID | Autogenerated |
| status | Const: ACTIVE | By default ACTIVE for new records |
| division_id | Request: division_id | Get from request body |
| equipment_id | UUID | Reference to equipments.id |
| is_active | Const: TRUE | Always TRUE for new records |
| inserted_at | Timestamp: now() | Get current date-time |
| inserted_by | Token: user_id | Extract user from token |
| updated_at | Timestamp: now() | Get current date-time |
| updated_by | Token: user_id | Extract user from token |
...