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

RC_DRACS Trembita methods_ph2 (DRACS 2.0)

Purpose

This page contains documentation on Trembita methods that are provided by Ministry of Justice of Ukraine that are used to get Death certificate of ukrainian citizens with detailed information.

DRACS envelope headers

Headers of SOAP envelope for DRACS methods must be filled with following config parameters:

  • client (objectType="SUBSYSTEM"):

    • xRoadInstance = TREMBITA_SEVDEIR_INSTANCE

    • memberClass = TREMBITA_DRACS_CLIENT_MEMBER_CLASS

    • memberCode - TREMBITA_DRACS_CLIENT_MEMBER_CODE

    • subsystemCode - TREMBITA_DRACS_CLIENT_SUBSYSTEM_CODE

  • service (objectType="SERVICE"):

    • xRoadInstance = TREMBITA_SEVDEIR_INSTANCE

    • memberClass = TREMBITA_DRACS_SERVICE_MEMBER_CLASS

    • memberCode - TREMBITA_DRACS_SERVICE_MEMBER_CODE

    • subsystemCode - TREMBITA_DRACS_SERVICE_SUBSYSTEM_CODE

    • serviceCode - code of service that is being provided

    • serviceVersion - absent from request

  • userId - TREMBITA_SEVDEIR_USERID

  • id - autogenerate request uuid

  • protocolVersion - TREMBITA_SEVDEIR_PROTOCOL_VERSION

More on config parameters: https://e-health-ua.atlassian.net/wiki/spaces/DRACS/pages/17249075330

GetDeathArByRegDatePeriod

Name

Application software interface (service) for downloading data of death act records by registration date period

Service name

GetDeathArByRegDatePeriod

Purpose

Get death act records data by registation date period

Subsystem identifier

3_MJU_DRACS_prod

Operating mode

Around the clock (24/7)

WSDL

 

Input params

Nesting level

Code

Description

Data type (according to XML specification)

Required

Nesting level

Code

Description

Data type (according to XML specification)

Required

1

DateFrom

Start date of the period for which the death act records data is provided

xs:date

yes

1

DateTo

End date of the period for which the death act records data is provided

xs:date

yes

Request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xro="http://x-road.eu/xsd/xroad.xsd" xmlns:iden="http://x-road.eu/xsd/identifiers" xmlns:tem="http://tempuri.org/"> <soapenv:Header> <xro:client iden:objectType="SUBSYSTEM"> <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance> <iden:memberClass>GOV</iden:memberClass> <iden:memberCode>42032422</iden:memberCode> <iden:subsystemCode>50_eHealth_preprod_MPIVerificationDRACS_cons</iden:subsystemCode> </xro:client> <xro:service iden:objectType="SERVICE"> <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance> <iden:memberClass>GOV</iden:memberClass> <iden:memberCode>00015622</iden:memberCode> <iden:subsystemCode>3_MJU_DRACS_prod</iden:subsystemCode> <iden:serviceCode>GetDeathArByRegDatePeriod</iden:serviceCode> </xro:service> <xro:userId>test</xro:userId> <xro:id>58f1c195-8e91-4e73-9512-4d9e140620fe</xro:id> <xro:protocolVersion>4.0</xro:protocolVersion> </soapenv:Header> <soapenv:Body> <tem:ArServiceRequest> <tem:DateFrom>2022-09-22</tem:DateFrom> <tem:DateTo>2022-09-22</tem:DateTo> </tem:ArServiceRequest> </soapenv:Body> </soapenv:Envelope>

Response

Nesting level

Code

Description

Data type (according to XML specification)

Required

Nesting level

Code

Description

Data type (according to XML specification)

Required

1

ResultCode

Result code of request

Values:

  • 0 - successfully completed;

  • 1 - internal error;

  • 2 - not allowed for this client;

  • 3 - more than one active service;

  • 4 - fields are not specified;

  • 5 - incorrect input parameters (validation failed)

xs:string

yes

1

ResultData

XML data with death act records details based on inpuit params, encoded in Base64 (returned if ResultCode = 0)

XML file format is described in https://e-health-ua.atlassian.net/wiki/spaces/DRACS/pages/17249173625/DRACS+Trembita+methods_ph2_EN#DeathArResultData

xs:string

no

1

ErrorInfo

Error information (returned if ResultCode <> 0)

xs:string

no

Response example (success):

<?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xroad="http://x-road.eu/xsd/xroad.xsd" xmlns:id="http://x-road.eu/xsd/identifiers"> <s:Header> <xroad:userId>test</xroad:userId> <xroad:client id:objectType="SUBSYSTEM"> <id:xRoadInstance>SEVDEIR-TEST</id:xRoadInstance> <id:memberClass>GOV</id:memberClass> <id:memberCode>42032422</id:memberCode> <id:subsystemCode>50_eHealth_preprod_MPIVerificationDRACS_cons</id:subsystemCode> </xroad:client> <xroad:service id:objectType="SERVICE"> <id:xRoadInstance>SEVDEIR-TEST</id:xRoadInstance> <id:memberClass>GOV</id:memberClass> <id:memberCode>00015622</id:memberCode> <id:subsystemCode>3_MJU_DRACS_prod</id:subsystemCode> <id:serviceCode>GetDeathArByRegDatePeriod</id:serviceCode> </xroad:service> <xroad:protocolVersion>4.0</xroad:protocolVersion> <xroad:id>bfeeb25b-9b9d-4280-8a1b-b5652b2e5102</xroad:id> <xroad:requestHash algorithmId="http://www.w3.org/2001/04/xmldsig-more#gost34311">tBiYvl17sE6k2ZDw+xA20uMN3DNAf3YEXlpJBP5b1ik=</xroad:requestHash> </s:Header> <s:Body> <ArServiceAnswer xmlns="http://tempuri.org/"> <ErrorInfo></ErrorInfo> <ResultCode>0</ResultCode> <ResultData>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjxBUl9MSVNUIC8+</ResultData> </ArServiceAnswer> </s:Body> </s:Envelope>

Response example (error):

<?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xroad="http://x-road.eu/xsd/xroad.xsd" xmlns:id="http://x-road.eu/xsd/identifiers"> <s:Header> <xroad:userId>test</xroad:userId> <xroad:client id:objectType="SUBSYSTEM"> <id:xRoadInstance>SEVDEIR-TEST</id:xRoadInstance> <id:memberClass>GOV</id:memberClass> <id:memberCode>42032422</id:memberCode> <id:subsystemCode>50_eHealth_preprod_MPIVerificationDRACS_cons</id:subsystemCode> </xroad:client> <xroad:service id:objectType="SERVICE"> <id:xRoadInstance>SEVDEIR-TEST</id:xRoadInstance> <id:memberClass>GOV</id:memberClass> <id:memberCode>00015622</id:memberCode> <id:subsystemCode>3_MJU_DRACS_prod</id:subsystemCode> <id:serviceCode>GetDeathArByRegDatePeriod</id:serviceCode> </xroad:service> <xroad:protocolVersion>4.0</xroad:protocolVersion> <xroad:id>bfeeb25b-9b9d-4280-8a1b-b5652b2e5102</xroad:id> <xroad:requestHash algorithmId="http://www.w3.org/2001/04/xmldsig-more#gost34311">mUIsVWsthqcT+KlnEDW5FbW5heb550p6r/5dR8PwaX4=</xroad:requestHash> </s:Header> <s:Body> <ArServiceAnswer xmlns="http://tempuri.org/"> <ErrorInfo>'Дата з' не може бути пізнішою за 'Дата по'</ErrorInfo> <ResultCode>5</ResultCode> <ResultData></ResultData> </ArServiceAnswer> </s:Body> </s:Envelope>

GetDeathArByFullNameAndBirthDate

Name

Application software interface (service) for downloading data of death act records by name and date of birth of deceased person

Service name

GetDeathArByFullNameAndBirthDate

Purpose

Get death act records data by name and date of birth of deceased person

Subsystem identifier

3_MJU_DRACS_prod

Operating mode

Around the clock (24/7)

WSDL

 

Input params

Nesting level

Code

Description

Data type (according to XML specification)

Required

Nesting level

Code

Description

Data type (according to XML specification)

Required

1

Name

Persons name (first name)

xs:string

yes

1

OnDate

Persons birth date

xs:data

yes

1

Patronymic

Persons patronymic (second name)

xs:string

yes

1

Surname

Persons surname (last name)

xs:string

yes

Request example:

Response

Nesting level

Code

Description

Data type (according to XML specification)

Required

Nesting level

Code

Description

Data type (according to XML specification)

Required

1

ResultCode

Result code of request

Values:

  • 0 - successfully completed;

  • 1 - internal error;

  • 2 - not allowed for this client;

  • 3 - more than one active service;

  • 4 - fields are not specified;

  • 5 - incorrect input parameters (validation failed)

xs:string

yes

1

ResultData

XML data with death act records details based on inpuit params, encoded in Base64 (returned if ResultCode = 0)

XML file format is described in https://e-health-ua.atlassian.net/wiki/spaces/DRACS/pages/17249173625/DRACS+Trembita+methods_ph2_EN#DeathArResultData

xs:string

no

1

ErrorInfo

Error information (returned if ResultCode <> 0)

xs:string

no

Response example (success):

Response example (error):

DeathArResultData

XML file contains AR_LIST array with ACT_RECORD objects, each object contains following fields:

AR_LIST (list of death certificates) example:

 

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