Properties of a REST API method document

Purpose

Service returns all Service requests related to the person filtered by submitted parameters.

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

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 Apiary

See on API-specification

Headers

Request data validation

Authorize

• Verify the validity of access token

  • Return (401, 'unauthorized') in case of validation fails

• Verify that token is not expired

  • in case of error - return (401, 'unauthorized')

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

  1. Return (403, 'invalid scopes') in case of invalid scope(s)

Request to process the request using a token in the headers

Processing

1. Get all Service requests by person_id from service_request (MongoDB)

2. Validate data consistency:

   • Ensure that requested Service requests have ABAC context

     • Return 403 ('Access denied') in case of error

3. Filter list above by submitted search parameters

4. Render a response according to specification with found Service requests entities.

Response structure examples

See on Apiary

See on API-specification

...

{
  "meta": {
    "code": 404,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "error": {
    "type": "NOT_FOUND",
    "message": "Patient not found"
  }
}

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

...