Versions Compared

Key

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

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

...

Properties of a REST API method document

...

Purpose

...

Logic

...

Configuration parameters

...

Dictionaries

...

Input parameters

...

Request structure

...

Headers

...

Request data validation

...

Processing

...

Response structure examples

...

HTTP status codes

...

Post-processing processes

...

Table of Contents
stylenone

Properties of a REST API method document

...

  • Verify the validity of access token

    • Return (401, 'Invalid access token') in case of validation fails

  • Verify that token is not expired

    • in case of error - return (401, 'Invalid access token')

  • Check user scopes in order to perform this action (scope = 'specimen:read')

    • Return (403, 'Your scope does not allow to access this resource. Missing allowances: specimen:read') in case of invalid scope(s)

Validate Specimen

  • Get Specimen identifier from the URL

  • Check it exists in DB

    • Return 404 ('Specimen is not found.') in case of error

Processing

N/A

Response structure examples

...