Versions Compared

Key

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

Table of Contents

Status

Page Properties


Specification
Status
colourGreen
titledone
Apiary
Status
colourGreen
titledone
JSON Schema request
Status
colourRed
titlespecs
JSON Schema response

Status
colourRed
titlespecs


Purpose

This WS is designed to create new medical program.

Specification

http://docs.uaehealthapi.apiary.io/#reference/internal.-nhs-admin/medical-programs/create-medical-program

WS logic

Authorize

  1. Verify the validity of access token
    1. In case error - generate 401 response
  2. Check user scope (scope = 'medical_program:write') in order to perform this action
    1. In case error - generate 403 response

Validate request (JSON schema)

  1. Validate request using JSON schemas (TBD):
    1. Return 422 with list of validation errors in case validation fails (422 EView)

Create new Medical Program

  1. Create new record in Medical_programs 
Destination
Source
Description
id
Autogenerated
nameRequest: $.name
is_activeConst: true
inserted_atTimestamp: now()Get current date-time
inserted_byToken: user_idExtract user from token
updated_atTimestamp: now()Get current date-time
updated_byToken: user_idExtract user from token

Prepare & return response data structure

  1. Fill response WS data structure

...