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

RC_Trembita methods description_ph2 (DRACS 2.0)

Owned by Anna Popelysheva (SoE eHealth)
Sep 16, 2024
3 min read

Purpose

This page contains documentation on methods that are used through Trembita system - Ukrainian governments exchange gateway.

Trembita envelope

Trembita system is using SOAP for data transfer.

Each transfer between services (request or response) is using SOAP Envelope, that consists of Header and Body.

Body of Trembita SOAP Envelope is formed depending on method that is used.

Header of Trembita SOAP Envelope consists of the same set of fields:

  • client - client details (entity that is performing the request, attribute objectType="SUBSYSTEM"), mandatory:

    • xRoadInstance - Trembita endpoint instance, mandatory

      • SEVDEIR - prod

      • SEVDEIR-TEST - test

    • memberClass - type of entity that is performing the request, mandatory

      • GOV - by default

    • memberCode - edrpou of entity that is performing the request, mandatory

    • subsystemCode - subsystem of client that is performing the request, optional

  • service - service details (entity that is providing access to data, attribute objectType="SERVICE"), mandatory:

    • xRoadInstance - Trembita endpoint instance, mandatory

      • SEVDEIR - prod

      • SEVDEIR-TEST - test

    • memberClass - type of entity that is providing the service, mandatory

      • GOV - by default

    • memberCode - edrpou of entity that is providing the service, mandatory

    • subsystemCode - subsystem of client that is providing the service, optional

    • serviceCode - code of service that is being provided, mandatory

    • serviceVersion - version of service that is being provided, optional

  • userId - identifier of person who is performing the request (for example, tax_id), mandatory

  • id - identifier of the request (used to compare response to request), mandatory

  • protocolVersion - version of protocol, that is being used to exchange data in Trembita system, mandatory

    • 4.0 - by default

Each request to Trembita exchange way must contain following headers:

  • Content-Type: text/xml; charset=utf-8

  • SOAPAction: with uri of action from wsdl schema of corresponding method

Request envelope example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header> <h:client xmlns="http://x-road.eu/xsd/xroad.xsd" xmlns:a="http://x-road.eu/xsd/identifiers" xmlns:h="http://x-road.eu/xsd/xroad.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" a:objectType="SUBSYSTEM"> <a:xRoadInstance>SEVDEIR-TEST</a:xRoadInstance> <a:memberClass>GOV</a:memberClass> <a:memberCode>22956058</a:memberCode> <a:subsystemCode>TEST_DRAC</a:subsystemCode> <a:serviceCode>eMaliatkoApplication</a:serviceCode> </h:client> <h:id xmlns="http://x-road.eu/xsd/xroad.xsd" xmlns:h="http://x-road.eu/xsd/xroad.xsd">MOZDOC20200821044110 </h:id> <h:protocolVersion xmlns="http://x-road.eu/xsd/xroad.xsd" xmlns:h="http://x-road.eu/xsd/xroad.xsd">4.0 </h:protocolVersion> <h:service xmlns="http://x-road.eu/xsd/xroad.xsd" xmlns:a="http://x-road.eu/xsd/identifiers" xmlns:h="http://x-road.eu/xsd/xroad.xsd" a:objectType="SERVICE"> <a:xRoadInstance>SEVDEIR-TEST</a:xRoadInstance> <a:memberClass>GOV</a:memberClass> <a:memberCode>42032422</a:memberCode> <a:subsystemCode>TEST-NSZU-01</a:subsystemCode> <a:serviceCode>GetComposition</a:serviceCode> </h:service> <h:userId xmlns="http://x-road.eu/xsd/xroad.xsd" xmlns:h="http://x-road.eu/xsd/xroad.xsd"/> </s:Header> <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <GetCompositionRequest xmlns="http://wldd.io/emal/soapgw"> <DocOfBirth> <ChildDocNumb>OX66-2KAH-3M14-51MB</ChildDocNumb> </DocOfBirth> <motherInfo> <IdentityDocument> <documentSerial/> <documentNumber>АВ093845</documentNumber> <passportTypeID>1</passportTypeID> </IdentityDocument> </motherInfo> </GetCompositionRequest> </s:Body> </s:Envelope>

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