Properties of a REST API method document

Purpose

This WS allows to generate Printout form by $contract_id. Printout form is generated only for contract requests in status 'PENDING_NHS_SIGN'. Also, it is available for contract requests s in statuses 'NHS_SIGNED' and  'SIGNED'  through Get Contract request details

Logic

This method is designed to get printout content by contract request id. In order to sign contract it's need to invoke Get Contract Request Details and Get Contract Request Printout Content and sign whole data.

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Request structure

See on API-specification

Headers

Request data validation

Authorize

Request to process the request using a token in the headers

Validate request

Request mapping:

curl --request POST \
     --header 'Accept: text/html' \
     --header 'Content-Type: application/json' \
     {:host}/templates/{:contract_printout_id}/actions/render

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_request: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

...

• 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

extract client_id from token. LE employee can see only this legal entities contract requests. NHS employee can see any contract request. 

• if TOKENS_TYPES_PERSONAL

  • Check client_id = contract_request.contractor_legal_entity_id

    • in case error return 403 "User is not allowed to perform this action"

Validate data

• Validate contract request id. Check contract_requests.id = $.id

  • in case error return 404 ("Contract request with id=$id doesn't exist")

Processing

Generate Printout form 

1. Validate contract request status

   1. If contract_request in statuses 'PENDING_NHS_SIGN' - generate printout form.

      1. set nhs_signed_date=now()::date

         1. In case of error (status in 'NEW', 'IN_PROCESS', 'APPROVED', 'DECLINED', 'TERMINATED', 'NHS_SIGNED' ,'SIGNED') return 409 Error ('Incorrect status of contract_request to generate printout form')

   2. In case status was changed either to  'NHS_SIGNED' or 'SIGNED', printout form could be taken through Get Contract request details

2. if contract_type=REIMBURSEMENT - Choose correct print out form, for different medical programs in contract request. Use config file to determine correct template form. 

...

Invoke MAN to render printout form.

Response structure examples

See on API-specification

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "printout_content": "Contract request content"
  }
}

HTTP status codes

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used

...