Versions Compared

Key

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

  • Status
  • Purpose
  • APIary
  • Input parameters (filters)
  • Logic WS
  • Validate PK Medication
  • Validate status
  • Prepare & return response data structure
  • Table of Contents

    Status


    Page Properties


    Specification

    DONE

    Apiary

    DONE

    JSON Schema request

    ABSENT

    JSON Schema response
    SPECS


    Purpose

    This WS is designed to return Program _medications detailmedication detail.

    APIary

    Get Program medications by id                                               

    Input parameters (filters)

    • id 

    ...

    Specification

    Apiary

    WS Logic

    Authorize

    1. Verify the validity of access token
      1. In case of error - generate 401 response
    2. Check user

    ...

    1. scope (scope = 'program_

    ...

    1. medication:read') in order to perform this action
      1. In case of error - generate 403 response

    Validate

    ...

    PK Program Medications

    1. Check the Medication within the Medical program

    ...

    1. Check exist  participant "Program_medications" by $.id($.id) exists in PRM.program_medications

      1. if invalid - return 404 error (message: "Participant with such ID Medication within the Medical program is not found!")

    Logic WS

    1. Verify the validity of access token
    2. Check user scopes in order to perform this action (scope = 'program_medications:read'
      1. )

    Prepare & return response data structure

    1. Fill response WS data structure 
    2. Validate response using JSON schemas (!!! TBD)
      1. Return 422 with list of validation errors in case validation fails (422 EView)