Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

This service is designed to obtain list of contract_requests by NHS employee(private API) or by MSP(public API) .

Overview

  1. only nhs only  employee with scope "contract_requests:read" can get list of contract_requests
  2. list of contract_request could be filtered

...

Specification

Public API

Private API

  • GraphQL schema

Capitation Contract Request graphQL schema
Reimbursement Contract Request graphQL schema


  • Features

Capitation Contract Request features

Reimbursement Contract Request features

...

TBD

Specification

  • Apiary
  • json schema
  • websequensediagram

Request

List of contract requests could be filtered by

...

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_requests:read')
    1. Return 403 in case invalid scope(s) -"Your scope does not allow to access this resource. Missing allowances: contract_requests:read"

Validate employee

extract user_id from token

...