ЕСОЗ - публічна документація

Create new party

Owned by Georgiy Lysenko (Unlicensed)
Last updated: Jul 17, 2023
5 min read

Purpose

Method to create new party record.

Specification

Link

https://uaehealthapi.docs.apiary.io/#reference/internal.-partner-relationship-management/party/create-new-party

Посилання на Apiary або Swagger

Resource

/party

Посилання на ресурс, наприклад: /api/persons/create

Scope

 

Scope для доступу

Components

Employees

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

il/api

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

REST

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

POST

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Sync

Метод є синхронним чи асинхронним?

Public/Private/Internal

Private

Потрібно зазначити тип методу за ступенем доступності

Logic

Input parameters

See on Apiary

Dictionaries

  • GENDER

  • +DOCUMENT_TYPE

  • PHONE_TYPE

  • COUNTRY

  • EDUCATION_DEGREE

  • QUALIFICATION_TYPE

  • SPEC_QUALIFICATION_TYPE

  • SPECIALITY_TYPE

  • SPECIALITY_LEVEL

Request structure*

See on Apiary

Example:

{ "party": { "first_name": "Петро", "last_name": "Іванов", "second_name": "Миколайович", "birth_date": "1991-08-19T00:00:00.000Z", "gender": "MALE", "no_tax_id": false, "tax_id": "3126509816", "documents": [ { "type": "PASSPORT", "number": "АА120518", "issued_by": "Рокитнянським РВ ГУ МВС Київської області", "issued_at": "2017-02-28" } ], "phones": [ { "type": "MOBILE", "number": "+380503410870" } ], "working_experience": 10, "about_myself": "Закінчив всі можливі курси", "educations": [ { "country": "UA", "city": "Київ", "institution_name": "Академія Богомольця", "issued_date": "2017-02-28", "diploma_number": "DD123543", "degree": "MASTER", "speciality": "Педіатр" } ], "qualifications": [ { "type": "SPECIALIZATION", "institution_name": "Академія Богомольця", "speciality": "Педіатр", "issued_date": "2017-02-28", "certificate_number": "2017-02-28", "valid_to": "2017-02-28", "additional_info": "додаткова інофрмація" } ], "specialities": [ { "speciality": "THERAPIST", "level": "FIRST", "qualification_type": "AWARDING", "attestation_name": "Академія Богомольця", "attestation_date": "2017-02-28", "valid_to_date": "2020-02-28", "certificate_number": "AB/21331" } ], "science_degree": { "country": "UA", "city": "Київ", "degree": "", "institution_name": "Академія Богомольця", "diploma_number": "DD123543", "speciality": "Педіатр", "issued_date": "2017-02-28" } }, "users": [ { "user_id": "2de19358-0062-4f14-8a50-9dff015ed165" } ] }

Authorize

Request to process the request using a token in the headers

Headers

Content-Type:application/json

Request data validation

Processing

Response structure

See on Apiary

Example:

{ "meta": { "code": 201, "url": "https://example.com/resource", "type": "object", "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810" }, "data": { "party": { "id": "d290f1ee", "first_name": "Петро", "last_name": "Іванов", "second_name": "Миколайович", "birth_date": "1991-08-19T00:00:00.000Z", "gender": "MALE", "no_tax_id": false, "tax_id": "3126509816", "documents": [ { "type": "PASSPORT", "number": "АА120518", "issued_by": "Рокитнянським РВ ГУ МВС Київської області", "issued_at": "2017-02-28" } ], "phones": [ { "type": "MOBILE", "number": "+380503410870" } ], "working_experience": 10, "about_myself": "Закінчив всі можливі курси", "educations": [ { "country": "UA", "city": "Київ", "institution_name": "Академія Богомольця", "issued_date": "2017-02-28", "diploma_number": "DD123543", "degree": "MASTER", "speciality": "Педіатр" } ], "qualifications": [ { "type": "SPECIALIZATION", "institution_name": "Академія Богомольця", "speciality": "Педіатр", "issued_date": "2017-02-28", "certificate_number": "2017-02-28", "valid_to": "2017-02-28", "additional_info": "додаткова інофрмація" } ], "specialities": [ { "speciality": "THERAPIST", "level": "FIRST", "qualification_type": "AWARDING", "attestation_name": "Академія Богомольця", "attestation_date": "2017-02-28", "valid_to_date": "2020-02-28", "certificate_number": "AB/21331" } ], "science_degree": { "country": "UA", "city": "Київ", "degree": "", "institution_name": "Академія Богомольця", "diploma_number": "DD123543", "speciality": "Педіатр", "issued_date": "2017-02-28" }, "inserted_at": "1991-08-19T00:00:00.000Z", "inserted_by": "userid", "updated_at": "1991-08-19T00:00:00.000Z", "updated_by": "userid" }, "users": [ { "user_id": "2de19358-0062-4f14-8a50-9dff015ed165" } ] } }

 

 

HTTP status codes

HTTP status code

Message

What caused the error

HTTP status code

Message

What caused the error

 201

 Response

 

 

 

 

 

ЕСОЗ - публічна документація