Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3

Purpose

Method to register new declaration recordThis method to update the declaration status.

Specification

Link

https://uaehealthapi.docs.apiary.io/#reference/internal.-ops-db/declarations/createupdate-declaration

Resource

Scope

Components

Declarations

Using Microservices

Protocol type

Request type

POSTPATCH

Sync/Async

Public/Private/Internal

Internal

...

Preconditions

Request structure

Example:

...

titleRequest example

...

:

...

Authorize

Headers

  • Content-Type:application/json

...

Expand
titleJson schema
Code Block
 {
  "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
  "person_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "employee_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "division_id": "`d290f1ee-6c54-4b01-90e6-d701748f0851`m",
  "legal_entity_id": "`d290f1ee-6c54-4b01-90e6-d701748f0851`m",
  "scope": "family_doctor",
  "start_date": "2017-03-02",
  "end_date": "2017-03-02",
  "signed_at": "2017-03-02T10:45:16.000Z"
}

Request data validation

Processing

...

Expand
titleResponse example (Code 201200)
Code Block
{
  "meta": {
    "code": 201200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
    "person_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "employee_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "division_id": "`d290f1ee-6c54-4b01-90e6-d701748f0851`m",
    "legal_entity_id": "`d290f1ee-6c54-4b01-90e6-d701748f0851`m",
    "scope": "family_doctor",
    "start_date": "2017-03-02",
    "end_date": "2017-03-02",
    "signed_at": "2017-03-02T10:45:16.000Z",
    "inserted_at": "1991-08-19T00:00:00.000Z",
    "inserted_by": "userid",
    "updated_at": "1991-08-19T00:00:00.000Z",
    "updated_by": "userid"
  }
}

...

HTTP status code

Message

What caused the error

201200

 Response

 

Backward compatibility