Versions Compared

Key

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

...

Response format:

true

Verify

or

Reject

StepDescription
Get pending declarations

External system call E-Health.IL to get all declarations in status Pending.

GET_DeclarationList

Apiary: service description

Query parameters:

No Format
status=Pendingpending_verification
legal_entity_id={ID}

URL example:

No Format
api/declarations?legal_entity_id={ID}status=Pendingpending_verification

Response format:

Code Block
languagejs
themeMidnight
titleResponse body
linenumberstrue
collapsetrue
{
  "meta": {
    "url": "http://example.com/resource",
    "type": "object",
    "code": 200,
    "idempotency_key": "idemp-ssjssdjoa8308u0us0",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
      "start_date": "2017-03-02T10:45:16.000Z",
      "end_date": "2017-03-02T10:45:16.000Z",
      "person": {
        "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
        "first_name": "Петро",
        "last_name": "Іванов",
        "second_name": "Миколайович"
      },
      "employee": {
        "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "position": "лікар",
        "party": {
          "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
          "first_name": "Петро",
          "last_name": "Іванов",
          "second_name": "Миколайович",
          "email": "email@example.com",
          "phones": [
            {
              "type": "MOBILE",
              "number": "+380503410870"
            }
          ]
        }
      },
      "legal_entity": {
        "id": "d290f1ee",
        "name": "Клініка Борис",
        "short_Name": "Борис",
        "legal_form": "ПІДПРИЄМЕЦЬ-ФІЗИЧНА ОСОБА",
        "edrpou": "5432345432"
      }
    }
  ],
  "paging": {
    "limit": 20,
    "cursors": {
      "starting_after": "56c31536a60ad644060041af",
      "ending_before": "56c31536a60ad644060041aa"
    },
    "size": 1000,
    "has_more": false
  }
}


Choose appropriated declarationExternal system starts to processing any element from declaration list received in previous step.
Get declaration_request details by idSystem call E-Health.IL to get specific declaration from previous step.
GET_Declaration_Request

Apiary: service description

Query parameters:

No Format
id={declaration_request_id}

URL example:

No Format
/api/declaration_requests/{id}

Response format:


Get content by IDCall GCS services to download the document by URL
GET_MediaStorageContent
VerificationUser conducts declaration verification according to internal rules, and make decision.
Update declaration status to Verification PassedCall web-service PATH_Declaration to send verification result "Verification PassedACTIVE".
Update declaration status to Verification RejectedCall web-service PATH_Declaration to send verification result "Verification RejectedREJECTED".
PATCH_Declaration


Apiary: service description

Query parameters:

No Format
id={declaration_id}

URL example:

No Format
/api/declarations/{id}

Request format:

Code Block
languagejs
themeRDark
titleResponse body
linenumberstrue
collapsetrue
Code Block
languagejs
themeRDark
titleResponse body
linenumberstrue
collapse