Purpose

This WS is designed to change status of contract request to APPROVED by NHS ADMIN SIGNER. NHS employee can change status of contract request through Admin portal

Design

TBD

Specification

apiary

json schema

Validation

Validate token

• Verify the validity of access token
  • Return 401 in case validation fails
• Check if token is not expired
  • in case error return 401 - "Token is expired"

Validate user

extract user_id from token

extract client_id from token

• Check if user is active
  • in case error return 403 - (user is not active)
• check nhs_legal_entity is active
  • in case error return 403 - (Client is not active)
• Check user role = "NHS ADMIN SIGNER"
  • in case error return 403 "User is not allowed to perform this action"

Validate scopes

• Check user scopes in order to perform this action (scope = 'contract_requests:update')
  • Return 403 in case invalid scope(s) "Your scope does not allow to access this resource. Missing allowances: contract_requests:update"

Validate data

1. Validate contract request id.
   1. Check contract_requests.id = $.id
      1. in case error return 404 ("Contract request with id=$id doesn't exist")
2. Validate contract_request.status=NEW
   • in case error return 422 - "Incorrect status of contract request to modify it"
3. Validate nhs side fields are not empty - in case error return 422 "Field $ could not be empty"
   1. nhs_signer_id
   2. nhs_legal_entity_id 
   3. nhs_signer_base
   4. nhs_contract_price
   5. nhs_payment_method
   6. issue_city
4. Validate contractor_legal_entity_id
   1. Legal_entities.id = $.contractor_legal_entity_id and Legal_entities.status='ACTIVE',
      1. in case error return 422 ("Legal entity in contract request should be active")
5. Validate contractor_owner_id
   1. Employee is_active=true and status='APPROVED' and employees.legal_entity_id=contractor_legal_entity_id
      1. in case error return 422, $contractor_owner_id (Contractor owner must be active within current legal entity in contract request)
6. Validate contractor_divisions
   1. Check divisions belongs to legal_entity and divisions.status='active'
      1. in case of error return 422  error view $divisions ('Division must be active and within current legal_entity')
7. Validate contractor_employee_divisions
   1. Employees from employee_divisions has employee_type='DOCTOR', status='APPROVED'
      1. in case of error return 422  error view $employee ('Employee must be an active DOCTOR')
   2. Check contractor_employee_divisions.division_id is present in contractor_divisions.id
      1. in case of error return 422 error $divisions ('The division is not belong to contractor_divisions')
   3. Check contract_number is null
      1. in case of error return 422  error view $employee  ('Employee can't be updated via Contract Request')
8. Validate start_date
   1. start_date > now()
      1. in case error return 422 $start_date ("Contract request start date should be in future")

After status was changed (status = APPROVED, DECLINED, TERMINATED or SIGNED) - add new status to event_manager