Purpose

This service is designed to obtain list of capitation or reimbursement  contracts  by NHS or Legal Entity employee.
Contract type should be declared in the url.

Overview

1. only employees with scope "contract:read" can get list of contracts
2. list of contracts can be filtered

Specification

Public API

• Apiary

Private API

• GraphQL API
  Capitation Contract
  Reimbursement Contract
• Features

Validation

Validate token

• Verify the validity of access token
  • Return 401 in case validation fails
• token is not expired
  • in case error return 401 

Validate scopes

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

Validate employee

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"

Validate context

Return response to user limited by context from user's token

• if TOKENS_TYPES_PERSONAL
  • return response limited by contractor_legal_entity_id
• if TOKENS_TYPES_NHS
  • return non limitted response