Execute: различия между версиями

Материал из Wiki ГКБ
Перейти к навигации Перейти к поиску
Строка 12: Строка 12:
 
::3.1.3 [[SetPоlіcy]]
 
::3.1.3 [[SetPоlіcy]]
 
::3.1.4 [[SetСІіеnt]]
 
::3.1.4 [[SetСІіеnt]]
−
::3.1.5 [[SetContractRescinding]]
+
::3.1.5 [[SеtСоntraсtRеscіndіng]]
−
::3.1.6 [[GetPoliciesByNumber]]
+
::3.1.6 [[GеtPоlіcіеsBуNumbеr]]
−
::3.1.7 [[GetUserId]]
+
::3.1.7 [[GеtUsеrІd]]
−
::3.1.8 [[GetClientByID]]
+
::3.1.8 [[GеtCІіentBуІD]]
−
::3.1.9 [[GetClientByRNN]]
+
::3.1.9 [[GеtCІіеntBуRNN]]
 
::3.1.10 [[GetClientByIIN]]
 
::3.1.10 [[GetClientByIIN]]
 
::3.1.11 [[GetClientByFIO]]
 
::3.1.11 [[GetClientByFIO]]

Версия от 09:53, 28 марта 2014

Execute предназначен для выполнения методов интеграционной службы ЕСБД. Входными параметрами данного метода являются: string aSessionId - Идентификатор сессии; EsbdRequest aRequest - запрос на выполнение метода;

1. Описание параметра aRequest
2. Метод возвращает структуру EsbdResponse
3. Перечень типов запросов для использования в Execute
3.1 Описание типов запросов не присутствующих в качестве отдельных методов
3.1.1 SеtPolіcуRescіndіngReasоn
3.1.2 SеtРоlіcуDuplicate
3.1.3 SetPоlіcy
3.1.4 SetСІіеnt
3.1.5 SеtСоntraсtRеscіndіng
3.1.6 GеtPоlіcіеsBуNumbеr
3.1.7 GеtUsеrІd
3.1.8 GеtCІіentBуІD
3.1.9 GеtCІіеntBуRNN
3.1.10 GetClientByIIN
3.1.11 GetClientByFIO
3.1.12 GetClientNonResident
3.1.13 GetTFByID
3.1.14 GetTFByVIN
3.1.15 GetTFByRegNumber
3.1.16 GetTFByEngineNumber
3.1.17 GetClientJuridical
3.1.18 GetClientJuridical
3.1.19 GetVehicleOgpoInfo
3.1.20 GetClientOgpoInfo
3.1.21 GET_OSGPO_DO_AMOUNT
3.1.22 GET_OSRNS_PREMIUM
3.1.23 GET_OSGPO_PASSENGER_PREMIUM
3.1.24 GET_OSGPO_PASSENGER_MCI_AMOUNT
3.1.25 SetClientPBDetails
3.1.26 SEARCH_VEHICLES
3.1.27 SEARCH_CLIENTS
3.1.28 GetPolicyByGlobalID
3.1.29 GetPolicyReport
3.2 Типы запросов (метода Execute) совпадающие с отдельными методами веб-службы

Данные типы запросов совпадают по назначению с отдельными методами описанными в справочнике интеграции. Они принимают на вход и возвращают те же структуры как и в отдельных методах. Таким образом они функционируют аналогично отдельным методам. Тело ответа EsbdResponse.Body будет содержать данные (xml структуру или строку) в кодировке Base64 содержащие информаицю в соответствии с описанием отдельного метода. Тело запроса aRequest.Body также будет содержать данные (xml структуру или строку) в кодировке Base64. Для передачи xml структуры определенного класса необходимо сформировать xml (в кодировке base64) в виде: 

 <Наименование класса>
 <атрибут1></атрибут1>
 <атрибут2></атрибут2>
 <список1>
 	<атрибут3></атрибут3>
 	<атрибут4></атрибут4>
 </список1>
  ...
 </Наименование класса>

Например для типа запроса SetMiddleman: <Middleman> 

 <MIDDLEMAN_ID></MIDDLEMAN_ID>
 <CLIENT_ID></CLIENT_ID>
 <MIDDLEMAN_TYPE_ID></MIDDLEMAN_TYPE_ID>
 <PARENT_MIDDLEMAN_ID></PARENT_MIDDLEMAN_ID>
 <CONTRACT_DATE></CONTRACT_DATE>
 <BRANCH_ID></BRANCH_ID>
 <RECORD_CHANGED_AT></RECORD_CHANGED_AT>
 <CREATED_BY_USER_ID></CREATED_BY_USER_ID>
 <INPUT_DATE></INPUT_DATE>
 <CHANGED_BY_USER_ID></CHANGED_BY_USER_ID>
 <SYSTEM_DELIMITER_ID></SYSTEM_DELIMITER_ID>
 <USER_ID></USER_ID>
 </Middleman>

Остальные параметры (id, даты, номера и т.д.) передаются в виде строки в определенном формате в кодировке base64.

Список представленных типов запросов совпадающих с отдельными методами и их исходящие запросы (aRequest.Body):

3.2.1 SetInsuranceEvent
3.2.2 GetInsuranceEvents
3.2.3 SetMiddleman
3.2.4 SetIE_COMMON
3.2.5 GetIE_COMMON_By_Id
3.2.6 GetIE_COMMON_BY_PARAMS
3.2.7 SetRequest
3.2.8 GetREQUEST_BY_ID
3.2.9 SetContractDuplicate
3.2.10 GetPolicyByID
3.2.11 GetPoliciesByPolicyDate
3.2.12 GetPoliciesInfoByReason
3.2.13 GetPoliciesByCreatedOrChangedDateTime
3.2.14 GetContract_By_AppRescDate
3.2.15 GetClientPBDetailsListByID
3.2.16 GetMarkUpFactorXML
3.2.17 GetPoliciesByNumber_V2 (аналогичен GetPoliciesByNumber)
3.2.18 GetLastContract
3.2.19 GetMiddlemenByKeyFields
3.2.20 GetClientsByKeyFields
3.3 В тело запроса поместить xml структуру передаваемого договора в кодировке base64 в соответствии с описанием отдельного метода:
3.3.1 SetContractOSRNS
3.3.2 SetContractOsgpoTour
3.3.3 SetContractOsgpoAuditors
3.3.4 SetContractOsgpoNotarius
3.3.5 SetContractOsEco
3.3.6 SetContractAgriculture
3.3.7 SetContractOsgpoPassengers
3.3.8 SetContractOsgpoDo
3.3.9 SetContractDsAccident
3.3.10 SetContractDsLoan
3.3.11 SetContractDsMortgage
3.3.12 SetContractDsHealth
3.3.13 SetContractDsLife
3.3.14 SetContractDsAnnuity
3.3.15 SetContractDsAuto
3.3.16 SetContractDsRailways
3.3.17 SetContractDsAir
3.3.18 SetContractDsWater
3.3.19 SetContractDsCargo
3.3.20 SetContractDsProperty
3.3.21 SetContractDsGpoAuto
3.3.22 SetContractDsGpoAir
3.3.23 SetContractDsGpoWater
3.3.24 SetContractDsGpoOther
3.3.25 SetContractDsGuarantee
3.3.26 SetContractDsLosses
3.3.27 SetContractDsOtherLosses
3.3.28 SetContractDsLegalCosts
3.4 В тело запроса поместить id договора в кодировке base64 в соответствии с описанием отдельного метода:
3.4.1 GetContractOSRNS_By_Id
3.4.2 GetContractOsgpoAuditors_By_Id
3.4.3 GetContractOsgpoNotarius_By_Id
3.4.4 GetContractOsEco_By_Id
3.4.5 GetContractAgriculture_By_Id
3.4.6 GetContractOsgpoPassengers_By_Id
3.4.7 GetContractOsgpoDo_By_Id
3.4.8 GetContractDsAccident_By_Id
3.4.9 GetContractDsLoan_By_Id
3.4.10 GetContractDsMortgage_By_Id
3.4.11 GetContractDsHealth_By_Id
3.4.12 GetContractDsLife_By_Id
3.4.13 GetContractDsAnnuity_By_Id
3.4.14 GetContractDsAuto_By_Id
3.4.15 GetContractDsRailways_By_Id
3.4.16 GetContractDsAir_By_Id
3.4.17 GetContractDsWater_By_Id
3.4.18 GetContractDsCargo_By_Id
3.4.19 GetContractDsProperty_By_Id
3.4.20 GetContractDsGpoAuto_By_Id
3.4.21 GetContractDsGpoAir_By_Id
3.4.22 GetContractDsGpoWater_By_Id
3.4.23 GetContractDsGpoOther_By_Id
3.4.24 GetContractDsGuarantee_By_Id
3.4.25 GetContractDsLosses_By_Id
3.4.26 GetContractDsOtherLosses_By_Id
3.4.27 GetContractDsLegalCosts_By_Id
3.5 В тело запроса поместить период в формате (dd.mm.yyyy hh24:mi:ss dd.mm.yyyy hh24:mi:ss) договора в кодировке base64 в соответствии с описанием отдельного метода:
3.5.1 GetContractOSRNS_By_Period
3.5.2 GetContractOsgpoTour_By_Period
3.5.3 GetContractOsgpoAuditors_By_Period
3.5.4 GetContractOsgpoNotarius_By_Period
3.5.5 GetContractOsEco_By_Period
3.5.6 GetContractAgriculture_By_Period
3.5.7 GetContractOsgpoPassengers_By_Period
3.5.8 GetContractOsgpoDo_By_Period
3.5.9 GetContractDsAccident_By_Period
3.5.10 GetContractDsLoan_By_Period
3.5.11 GetContractDsMortgage_By_Period
3.5.12 GetContractDsHealth_By_Period
3.5.13 GetContractDsLife_By_Period
3.5.14 GetContractDsAnnuity_By_Period
3.5.15 GetContractDsAuto_By_Period
3.5.16 GetContractDsRailways_By_Period
3.5.17 GetContractDsAir_By_Period
3.5.18 GetContractDsWater_By_Period
3.5.19 GetContractDsCargo_By_Period
3.5.20 GetContractDsProperty_By_Period
3.5.21 GetContractDsGpoAuto_By_Period
3.5.22 GetContractDsGpoAir_By_Period
3.5.23 GetContractDsGpoWater_By_Period
3.5.24 GetContractDsGpoOther_By_Period
3.5.24 GetContractDsGuarantee_By_Period
3.5.25 GetContractDsLosses_By_Period
3.5.26 GetContractDsOtherLosses_By_Period
3.5.27 GetContractDsLegalCosts_By_Period
3.6 В тело запроса поместить номер договора в кодировке base64 в соответствии с описанием отдельного метода:
3.6.1 GetContractAgriculture_By_Number
3.6.2 GetContractOsgpoTour_By_Number
3.6.3 GetContractOsgpoAuditors_By_Number
3.6.4 GetContractOsgpoNotarius_By_Number
3.6.5 GetContractOsEco_By_Number
3.6.6 GetContractAgriculture_By_Number
3.6.7 GetContractOsgpoPassengers_By_Number
3.6.8 GetContractOsgpoDo_By_Number
3.6.9 GetContractDsAccident_By_Number
3.6.10 GetContractDsLoan_By_Number
3.6.11 GetContractDsMortgage_By_Number
3.6.12 GetContractDsHealth_By_Number
3.6.13 GetContractDsLife_By_Number
3.6.14 GetContractDsAnnuity_By_Number
3.6.15 GetContractDsAuto_By_Number
3.6.16 GetContractDsRailways_By_Number
3.6.17 GetContractDsAir_By_Number
3.6.18 GetContractDsWater_By_Number
3.6.19 GetContractDsCargo_By_Number
3.6.20 GetContractDsProperty_By_Number
3.6.21 GetContractDsGpoAuto_By_Number
3.6.22 GetContractDsGpoAir_By_Number
3.6.23 GetContractDsGpoWater_By_Number
3.6.24 GetContractDsGpoOther_By_Number
3.6.24 GetContractDsGuarantee_By_Number
3.6.25 GetContractDsLosses_By_Number
3.6.26 GetContractDsOtherLosses_By_Number
3.6.27 GetContractDsLegalCosts_By_Number

3.7 В тело запроса поместить дату заключения договора в формате (dd.mm.yyyy) в кодировке base64 в соответствии с описанием отдельного метода:

3.7.1 GetContractOSRNS_By_ContractDate
3.7.2 GetContractOsgpoTour_By_ContractDate
3.7.3 GetContractOsgpoAuditors_By_ContractDate
3.7.4 GetContractOsgpoNotarius_By_ContractDate
3.7.5 GetContractOsEco_By_ContractDate
3.7.6 GetContractAgriculture_By_ContractDate
3.7.7 GetContractOsgpoPassengers_By_ContractDate
3.7.8 GetContractOsgpoDo_By_ContractDate
3.7.9 GetContractDsAccident_By_ContractDate
3.7.10 GetContractDsLoan_By_ContractDate
3.7.11 GetContractDsMortgage_By_ContractDate
3.7.12 GetContractDsHealth_By_ContractDate
3.7.13 GetContractDsLife_By_ContractDate
3.7.14 GetContractDsAnnuity_By_ContractDate
3.7.15 GetContractDsAuto_By_ContractDate
3.7.16 GetContractDsRailways_By_ContractDate
3.7.17 GetContractDsAir_By_ContractDate
3.7.18 GetContractDsWater_By_ContractDate
3.7.19 GetContractDsCargo_By_ContractDate
3.7.20 GetContractDsProperty_By_ContractDate
3.7.21 GetContractDsGpoAuto_By_ContractDate
3.7.22 GetContractDsGpoAir_By_ContractDate
3.7.23 GetContractDsGpoWater_By_ContractDate
3.7.24 GetContractDsGpoOther_By_ContractDate
3.7.25 GetContractDsGuarantee_By_ContractDate
3.7.26 GetContractDsLosses_By_ContractDate
3.7.27 GetContractDsOtherLosses_By_ContractDate
3.7.28 GetContractDsLegalCosts_By_ContractDate


Описание параметра aRequest

     <aRequest>
       <Type>string</Type>
       <Version>int</Version>
       <Body>string</Body>
       <Parameters>int</Parameters>
     </aRequest>
     
     где: 
     <Type>string</Type> - тип запроса;
     <Version>int</Version> - версия запроса;
     <Body>string</Body> - тело запроса в кодировке Base64;
     <Parameters>int</Parameters> - зарезервированный параметр (не используется);

Метод возвращает структуру EsbdResponse

       <ResultCode>int</ResultCode> - код выполнения метода (0 - метод выполнен успешно, иначе ошибка);
       <ErrorMessage>string</ErrorMessage> - Описание ошибки, в случае если ResultCode не равен 0;
       <Body>string</Body> - тело ответа в кодировке Base64

Перечень типов запросов для использования в Execute

SetPolicyRescindingReason

 SetPolicyRescindingReason - выставление причины и даты расторжения полиса;
 Тело запроса в aRequest.Body должно содержать текст Xml документа в кодировке Base64 следующего формата:
 <Body>
   <PolicyId></PolicyId>
   <RescindingReasonId></RescindingReasonId>
   <RescindingDate></RescindingDate>
   <Delimiter></Delimiter>
 </Body>

 где:
 PolicyId - идентификатор полиса;
 RescindingReasonId - идентификатор причины расторжения;
 RescindingDate - дата расторжения;
 Delimiter - идентификатор разделителя учета СК, которой принадлежит расторгаемый полис (используется только при расторжении полисов объединенных СК)

SetPolicyDuplicate

 SetPolicyDuplicate - создание дубликата полиса;
 Тело запроса в aRequest.Body должно содержать текст Xml документа в кодировке Base64 следующего формата:
 <SetPolicyDuplicate>
   <OldPolicyID>int</OldPolicyID>
   <DuplicateNumber>string</DuplicateNumber>
   <DuplicateDate>string</DuplicateDate>
   <Description>string</Description>
 </SetPolicyDuplicate>

 где:
 OldPolicyID - идентификатор оригинального полиса;
 DuplicateNumber - номер полиса-дубликата;
 DuplicateDate - дата дубликата в формате 'DD.MM.YYYY';
 Description - комментарии к полису-дубликату;

 Тело ответа EsbdResponse.Body будет содержать текст Xml документа в кодировке Base64 следующего формата:
 <SetPolicyDuplicate>
   <DuplicateId>int</DuplicateId>
 </SetPolicyDuplicate>

 где:
 DuplicateId - идентификатор нового полиса-дубликата;

SetPolicy

 SetPolicy - передача полиса;
 Тело запроса в aRequest.Body должно содержать текст Xml документа в кодировке Base64 следующего формата:
 <POLICY>
   <POLICY_ID>int</POLICY_ID>
   <RESCINDING_REASON_ID>int</RESCINDING_REASON_ID>
   <REWRITE_BOOL>int</REWRITE_BOOL>
   <REWRITE_POLICY_ID>int</REWRITE_POLICY_ID>
   <POLICY_NUMBER>string</POLICY_NUMBER>
   <DATE_BEG>string</DATE_BEG>
   <DATE_END>string</DATE_END>
   <PREMIUM>int</PREMIUM>
   <CLIENT_ID>int</CLIENT_ID>
   <BRANCH_ID>int</BRANCH_ID>
   <POLICY_DATE>string</POLICY_DATE>
   <RESCINDING_DATE>string</RESCINDING_DATE>
   <CALCULATED_PREMIUM>int</CALCULATED_PREMIUM>
   <DESCRIPTION>string</DESCRIPTION>
   <SYSTEM_DELIMITER_ID>int</SYSTEM_DELIMITER_ID>
   <USER_ID>int</USER_ID>
   <DRIVERS>
     <DRIVER>
       <CLIENT_ID>int</CLIENT_ID>
       <HOUSEHOLD_POSITION_ID>int</HOUSEHOLD_POSITION_ID>
       <AGE_EXPERIENCE_ID>int</AGE_EXPERIENCE_ID>
       <EXPERIANCE>int</EXPERIANCE>
       <DRIVER_CERT>string</DRIVER_CERT>
       <DRIVER_CERT_DATE>string</DRIVER_CERT_DATE>
       <CLASS_ID>int</CLASS_ID>
       <PRIVELEGER_BOOL>int</PRIVELEGER_BOOL>
       <PRIVELEDGER_TYPE>int</PRIVELEDGER_TYPE>
       <PRIVELEDGER_CERTIFICATE>string</PRIVELEDGER_CERTIFICATE>
       <PRIVELEDGER_CERTIFICATE_DATE>string</PRIVELEDGER_CERTIFICATE_DATE>
       <PENSIONER_BOOL>int</PENSIONER_BOOL>
       <PENSIONER_CERTIFICATE>string</PENSIONER_CERTIFICATE>
       <PENSIONER_CERTIFICATE_DATE>string</PENSIONER_CERTIFICATE_DATE>
       <INVALID_BOOL>int</INVALID_BOOL>
       <INVALID_CERTIFICATE>string</INVALID_CERTIFICATE>
       <INVALID_CERTIFICATE_BEG_DATE>string</INVALID_CERTIFICATE_BEG_DATE>
       <INVALID_CERTIFICATE_END_DATE>string</INVALID_CERTIFICATE_END_DATE>
       <WOW_BOOL>int</WOW_BOOL>
       <WOW_CERTIFICATE>string</WOW_CERTIFICATE>
       <WOW_CERTIFICATE_DATE>string</WOW_CERTIFICATE_DATE>
     </DRIVER>
     ...
     <DRIVER>
       ...
     </DRIVER>
   </DRIVERS>
   <VEHICLES>
     <VEHICLE>
       <VEHICLE_ID>int</VEHICLE_ID>
       <VEHICLE_TYPE_ID>int</VEHICLE_TYPE_ID>
       <VEHICLE_AGE_ID>int</VEHICLE_AGE_ID>
       <REG_NUMBER>string</REG_NUMBER>
       <REG_CERT>string</REG_CERT>
       <GIVE_DATE>string</GIVE_DATE>
       <PURPOSE>string</PURPOSE>
       <ODOMETR>int</ODOMETR>
       <REGION_ID>int</REGION_ID>
       <BIG_CITY_BOOL>int</BIG_CITY_BOOL>
     </VEHICLE>
     ...
     <VEHICLE>
       ...
     </VEHICLE>
   </VEHICLES>
 </POLICY>

 где:
 Все значения дат '*_DATE' должны быть представлены в виде строки формата 'DD.MM.YYYY';
 Все булевые значения '*_BOOL' -- это целые числа 0 или 1;

 Тело ответа EsbdResponse.Body будет содержать текст Xml документа в кодировке Base64 следующего формата:
 <body>
   <policy_id>int</policy_id>
   <global_id>int</global_id>
 </body>

 где:
 policy_id - идентификатор сохраненного полиса;
 global_id - глобальный уникальный идентификатор сохраненного полиса;

SetClient

 SetClient - передача клиента;
 Тело запроса в aRequest.Body должно содержать текст Xml документа в кодировке Base64 следующего формата:
 <Client>
    <ID></ID>
    <Last_Name></Last_Name>
    <First_Name></First_Name>
    <Middle_Name></Middle_Name>
    <Juridical_Person_Name></Juridical_Person_Name>
    <Natural_Person_Bool></Natural_Person_Bool>
    <Born></Born>
    <Sex_ID></Sex_ID>
    <TPRN></TPRN>
    <SETTLEMENT_ID></SETTLEMENT_ID>
    <Address></Address>
    <DOCUMENT_TYPE_ID></DOCUMENT_TYPE_ID>
    <DOCUMENT_NUMBER></DOCUMENT_NUMBER>
    <DOCUMENT_GIVED_BY></DOCUMENT_GIVED_BY>
    <DOCUMENT_GIVED_DATE></DOCUMENT_GIVED_DATE>
    <EMAIL></EMAIL>
    <WWW></WWW>
    <PHONES></PHONES>
    <MAIN_CHIEF></MAIN_CHIEF>
    <MAIN_ACCOUNTANT></MAIN_ACCOUNTANT>
    <ACTIVITY_KIND_ID></ACTIVITY_KIND_ID>
    <DESCRIPTION></DESCRIPTION>
    <RESIDENT_BOOL></RESIDENT_BOOL>
    <ECONOMICS_SECTOR_ID></ECONOMICS_SECTOR_ID>
    <SIC></SIC>
    <COUNTRY_ID></COUNTRY_ID>
    <IIN></IIN>
 </Client>


 Тело ответа EsbdResponse.Body будет содержать текст Xml документа в кодировке Base64 следующего формата:
 <Client xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <ID>14000057</ID>
   <Last_Name>ДАНИЛИН</Last_Name>
   <First_Name>АНДРЕЙ</First_Name>
   <Middle_Name>ИГОРЬЕВИЧ</Middle_Name>
   <Natural_Person_Bool>1</Natural_Person_Bool>
   <Born>26.04.1972</Born>
   <Sex_ID>1</Sex_ID>
   <TPRN>600317445718</TPRN>
   <Address>г. Алматы, мкр. Сайран, дом 1, кв.1</Address>
   <DOCUMENT_TYPE_ID>1</DOCUMENT_TYPE_ID>
   <DOCUMENT_NUMBER>011300756</DOCUMENT_NUMBER>
   <DOCUMENT_GIVED_BY>МВД РК</DOCUMENT_GIVED_BY>
   <DOCUMENT_GIVED_DATE>25.03.2001</DOCUMENT_GIVED_DATE>
   <ACTIVITY_KIND_ID>250</ACTIVITY_KIND_ID>
   <RESIDENT_BOOL>1</RESIDENT_BOOL>
   <ECONOMICS_SECTOR_ID>10</ECONOMICS_SECTOR_ID>
   <COUNTRY_ID>1</COUNTRY_ID>
   <IIN>720628801275</IIN>
 </Client>

SetContractRescinding

 SetContractRescinding - выставление причины и даты расторжения договора;
 Тело запроса в aRequest.Body должно содержать текст Xml документа в кодировке Base64 следующего формата:
 <CONTRACT_RESCINDING>
   <CONTRACT_ID></CONTRACT_ID>
   <RESCINDING_REASON_ID></RESCINDING_REASON_ID>
   <RESCINDING_DATE></RESCINDING_DATE>
 </CONTRACT_RESCINDING>

 где:
 CONTRACT_ID - идентификатор договора;
 RESCINDING_REASON_ID - идентификатор причины расторжения;
 RESCINDING_DATE - дата расторжения;


GetPoliciesByNumber

 GetPoliciesByNumber - получение списка полисов по номеру;
 Тело запроса в aRequest.Body должно содержать текст Xml документа в кодировке Base64 следующего формата:
 <GetPoliciesByNumber>
    <PolicyNumber></PolicyNumber>
    <Delimiter></Delimiter>
 </GetPoliciesByNumber>

 где:
 PolicyNumber - номер полиса;
 Delimiter - идентификатор разделителя учета СК, которой принадлежит полис (используется только для получения полисов объединенных СК);



 Тело ответа EsbdResponse.Body будет содержать текст Xml документа в кодировке Base64 следующего формата:
 <POLICY>
   <POLICY_ID></POLICY_ID>
   <RESCINDING_REASON_ID></RESCINDING_REASON_ID>
   <REWRITE_BOOL></REWRITE_BOOL>
   <REWRITE_POLICY_ID></REWRITE_POLICY_ID>
   <POLICY_NUMBER></POLICY_NUMBER>
   <REWRITE_POLICY_NUMBER></REWRITE_POLICY_NUMBER>
   <DATE_BEG></DATE_BEG>
   <DATE_END></DATE_END>
   <PREMIUM></PREMIUM>
   <CALCULATED_PREMIUM></CALCULATED_PREMIUM>
   <CLIENT_ID></CLIENT_ID>
   <BRANCH_ID></BRANCH_ID>
   <POLICY_DATE></POLICY_DATE>
   <RESCINDING_DATE></RESCINDING_DATE>
   <DESCRIPTION></DESCRIPTION>
   <GLOBAL_ID></GLOBAL_ID>
   <PAYMENT_ORDER_TYPE_ID></PAYMENT_ORDER_TYPE_ID>
   <SYSTEM_DELIMITER_ID></SYSTEM_DELIMITER_ID>
   <DRIVERS>
       <DRIVER>
         <CLIENT_ID></CLIENT_ID>
         <HOUSEHOLD_POSITION_ID></HOUSEHOLD_POSITION_ID>
         <AGE_EXPERIENCE_ID></AGE_EXPERIENCE_ID>
         <EXPERIENCE></EXPERIENCE>
         <DRIVER_CERT></DRIVER_CERT>
         <DRIVER_CERT_DATE></DRIVER_CERT_DATE>
         <CLASS_ID></CLASS_ID>
         <PRIVELEGER_BOOL></PRIVELEGER_BOOL>
         <PRIVELEDGER_TYPE></PRIVELEDGER_TYPE>
         <PRIVELEDGER_CERTIFICATE></PRIVELEDGER_CERTIFICATE>
         <PRIVELEDGER_CERTIFICATE_DATE></PRIVELEDGER_CERTIFICATE_DATE>
         <PENSIONER_BOOL></PENSIONER_BOOL>
         <PENSIONER_CERTIFICATE></PENSIONER_CERTIFICATE>
         <PENSIONER_CERTIFICATE_DATE></PENSIONER_CERTIFICATE_DATE>
         <INVALID_BOOL></INVALID_BOOL>
         <INVALID_CERTIFICATE></INVALID_CERTIFICATE>
         <INVALID_CERTIFICATE_BEG_DATE></INVALID_CERTIFICATE_BEG_DATE>
         <INVALID_CERTIFICATE_END_DATE></INVALID_CERTIFICATE_END_DATE>
         <WOW_BOOL></WOW_BOOL>
         <WOW_CERTIFICATE></WOW_CERTIFICATE>
         <WOW_CERTIFICATE_DATE></WOW_CERTIFICATE_DATE>
       </DRIVER>
       ...
       <DRIVER>
         ...
       </DRIVER>
   </DRIVERS>
   <VEHICLES>
     <VEHICLE>
         <VEHICLE_ID></VEHICLE_ID>
         <VEHICLE_TYPE_ID></VEHICLE_TYPE_ID>
         <VEHICLE_AGE_ID></VEHICLE_AGE_ID>
         <REG_NUMBER></REG_NUMBER>
         <REG_CERT></REG_CERT>
         <GIVE_DATE></GIVE_DATE>
         <PURPOSE></PURPOSE>
         <ODOMETR></ODOMETR>
         <REGION_ID></REGION_ID>
         <BIG_CITY_BOOL></BIG_CITY_BOOL>
     </VEHICLE>
     ...
     <VEHICLE>
       ...
     </VEHICLE>
   </VEHICLES>
 </POLICY>


GetUserId

 GetUserId - возвращает идентификатор текущего пользователя;
 Тело запроса в aRequest.Body должно быть пустое

 Тело ответа EsbdResponse.Body будет содержать строку с ID пользователя


GetClientByID

 GetClientByID - получение клиента по идентификатору;
 Тело запроса в aRequest.Body должно содержать текст Xml документа в кодировке Base64 следующего формата:
 <GetClientByID>
   <ClientID>int</ClientID>
 </GetClientByID>

 где:
 ClientID - идентификатор клиента;

 Тело ответа EsbdResponse.Body будет содержать текст Xml документа в кодировке Base64 следующего формата:
 <CLIENTS>
       <CLIENT>
         <CLIENT_ID>int</CLIENT_ID>
         <LAST_NAME>string</LAST_NAME>
         <FIRST_NAME>string</FIRST_NAME>
         <MIDDLE_NAME>string</MIDDLE_NAME>
         <JURIDICAL_PERSON_NAME>string</JURIDICAL_PERSON_NAME>
         <NATURAL_PERSON_BOOL>int</NATURAL_PERSON_BOOL>
         <BORN>string</BORN>
         <SEX_ID>int</SEX_ID>
         <TPRN>string</TPRN>
         <SETTLEMENT_ID>int</SETTLEMENT_ID>
         <ADDRESS>string</ADDRESS>
         <DOCUMENT_TYPE_ID>int</DOCUMENT_TYPE_ID>
         <DOCUMENT_NUMBER>string</DOCUMENT_NUMBER>
         <DOCUMENT_GIVED_BY>string</DOCUMENT_GIVED_BY>
         <DOCUMENT_GIVED_DATE>string</DOCUMENT_GIVED_DATE>
         <PHONES>string</PHONES>
         <ACTIVITY_KIND_ID>int</ACTIVITY_KIND_ID>
         <RESIDENT_BOOL>int</RESIDENT_BOOL>
         <ECONOMICS_SECTOR_ID>int</ECONOMICS_SECTOR_ID>
         <SIC>string</SIC>
         <COUNTRY_ID>int</COUNTRY_ID>
         <IIN>string</IIN>
       </CLIENT>
       ...
       <CLIENT>
         ...
       </CLIENT>
 <CLIENTS>


GetClientByRNN

 GetClientByRNN - получение клиента по РНН;
 Тело запроса в aRequest.Body должно содержать текст Xml документа в кодировке Base64 следующего формата:
 <GetClientByRNN>
   <RNN>string</RNN>
 </GetClientByRNN>

 где:
 RNN - РНН клиента;

 Тело ответа EsbdResponse.Body будет содержать текст Xml документа в кодировке Base64 следующего формата:
 <CLIENTS>
       <CLIENT>
         <CLIENT_ID>int</CLIENT_ID>
         <LAST_NAME>string</LAST_NAME>
         <FIRST_NAME>string</FIRST_NAME>
         <MIDDLE_NAME>string</MIDDLE_NAME>
         <JURIDICAL_PERSON_NAME>string</JURIDICAL_PERSON_NAME>
         <NATURAL_PERSON_BOOL>int</NATURAL_PERSON_BOOL>
         <BORN>string</BORN>
         <SEX_ID>int</SEX_ID>
         <TPRN>string</TPRN>
         <SETTLEMENT_ID>int</SETTLEMENT_ID>
         <ADDRESS>string</ADDRESS>
         <DOCUMENT_TYPE_ID>int</DOCUMENT_TYPE_ID>
         <DOCUMENT_NUMBER>string</DOCUMENT_NUMBER>
         <DOCUMENT_GIVED_BY>string</DOCUMENT_GIVED_BY>
         <DOCUMENT_GIVED_DATE>string</DOCUMENT_GIVED_DATE>
         <PHONES>string</PHONES>
         <ACTIVITY_KIND_ID>int</ACTIVITY_KIND_ID>
         <RESIDENT_BOOL>int</RESIDENT_BOOL>
         <ECONOMICS_SECTOR_ID>int</ECONOMICS_SECTOR_ID>
         <SIC>string</SIC>
         <COUNTRY_ID>int</COUNTRY_ID>
         <IIN>string</IIN>
       </CLIENT>
       ...
       <CLIENT>
         ...
       </CLIENT>
 <CLIENTS>


GetClientByIIN

 GetClientByIIN - получение клиента по ИИН;
 Тело запроса в aRequest.Body должно содержать текст Xml документа в кодировке Base64 следующего формата:
 <GetClientByIIN>
   <IIN>string</IIN>
 </GetClientByIIN>

 где:
 IIN - ИИН клиента;

 Тело ответа EsbdResponse.Body будет содержать текст Xml документа в кодировке Base64 следующего формата:
 <CLIENTS>
       <CLIENT>
         <CLIENT_ID>int</CLIENT_ID>
         <LAST_NAME>string</LAST_NAME>
         <FIRST_NAME>string</FIRST_NAME>
         <MIDDLE_NAME>string</MIDDLE_NAME>
         <JURIDICAL_PERSON_NAME>string</JURIDICAL_PERSON_NAME>
         <NATURAL_PERSON_BOOL>int</NATURAL_PERSON_BOOL>
         <BORN>string</BORN>
         <SEX_ID>int</SEX_ID>
         <TPRN>string</TPRN>
         <SETTLEMENT_ID>int</SETTLEMENT_ID>
         <ADDRESS>string</ADDRESS>
         <DOCUMENT_TYPE_ID>int</DOCUMENT_TYPE_ID>
         <DOCUMENT_NUMBER>string</DOCUMENT_NUMBER>
         <DOCUMENT_GIVED_BY>string</DOCUMENT_GIVED_BY>
         <DOCUMENT_GIVED_DATE>string</DOCUMENT_GIVED_DATE>
         <PHONES>string</PHONES>
         <ACTIVITY_KIND_ID>int</ACTIVITY_KIND_ID>
         <RESIDENT_BOOL>int</RESIDENT_BOOL>
         <ECONOMICS_SECTOR_ID>int</ECONOMICS_SECTOR_ID>
         <SIC>string</SIC>
         <COUNTRY_ID>int</COUNTRY_ID>
         <IIN>string</IIN>
       </CLIENT>
       ...
       <CLIENT>
         ...
       </CLIENT>
 <CLIENTS>


GetClientByFIO

 GetClientByFIO - получение клиента по ФИО;
 Тело запроса в aRequest.Body должно содержать текст Xml документа в кодировке Base64 следующего формата:
 <GetClientByFIO>
   <LastName>string</LastName>
   <FirstName>string</FirstName>
   <MiddleName>string</MiddleName>
 </GetClientByFIO>

 где:
 LastName - Фамилия клиента;
 FirstName - Имя клиента;
 MiddleName - Отчество клиента;

 Тело ответа EsbdResponse.Body будет содержать текст Xml документа в кодировке Base64 следующего формата:
 <CLIENTS>
       <CLIENT>
         <CLIENT_ID>int</CLIENT_ID>
         <LAST_NAME>string</LAST_NAME>
         <FIRST_NAME>string</FIRST_NAME>
         <MIDDLE_NAME>string</MIDDLE_NAME>
         <JURIDICAL_PERSON_NAME>string</JURIDICAL_PERSON_NAME>
         <NATURAL_PERSON_BOOL>int</NATURAL_PERSON_BOOL>
         <BORN>string</BORN>
         <SEX_ID>int</SEX_ID>
         <TPRN>string</TPRN>
         <SETTLEMENT_ID>int</SETTLEMENT_ID>
         <ADDRESS>string</ADDRESS>
         <DOCUMENT_TYPE_ID>int</DOCUMENT_TYPE_ID>
         <DOCUMENT_NUMBER>string</DOCUMENT_NUMBER>
         <DOCUMENT_GIVED_BY>string</DOCUMENT_GIVED_BY>
         <DOCUMENT_GIVED_DATE>string</DOCUMENT_GIVED_DATE>
         <PHONES>string</PHONES>
         <ACTIVITY_KIND_ID>int</ACTIVITY_KIND_ID>
         <RESIDENT_BOOL>int</RESIDENT_BOOL>
         <ECONOMICS_SECTOR_ID>int</ECONOMICS_SECTOR_ID>
         <SIC>string</SIC>
         <COUNTRY_ID>int</COUNTRY_ID>
         <IIN>string</IIN>
       </CLIENT>
       ...
       <CLIENT>
         ...
       </CLIENT>
 <CLIENTS>

GetClientNonResident

 GetClientNonResident - получение клиента-нерезидента по ФИО, дате рождения и идентификатору страны резидентства;
 Тело запроса в aRequest.Body должно содержать текст Xml документа в кодировке Base64 следующего формата:
 <GetClientNonResident>
   <LastName>string</LastName>
   <FirstName>string</FirstName>
   <MiddleName>string</MiddleName>
   <Born>string</Born>
   <CountryId>integer</CountryId>
 </GetClientNonResident>

 где:
 LastName - Фамилия клиента;
 FirstName - Имя клиента;
 MiddleName - Отчество клиента;
 CountryId - Идентификатор страны резидентства

 Тело ответа EsbdResponse.Body будет содержать текст Xml документа в кодировке Base64 следующего формата:
 <CLIENTS>
       <CLIENT>
         <CLIENT_ID>int</CLIENT_ID>
         <LAST_NAME>string</LAST_NAME>
         <FIRST_NAME>string</FIRST_NAME>
         <MIDDLE_NAME>string</MIDDLE_NAME>
         <JURIDICAL_PERSON_NAME>string</JURIDICAL_PERSON_NAME>
         <NATURAL_PERSON_BOOL>int</NATURAL_PERSON_BOOL>
         <BORN>string</BORN>
         <SEX_ID>int</SEX_ID>
         <TPRN>string</TPRN>
         <SETTLEMENT_ID>int</SETTLEMENT_ID>
         <ADDRESS>string</ADDRESS>
         <DOCUMENT_TYPE_ID>int</DOCUMENT_TYPE_ID>
         <DOCUMENT_NUMBER>string</DOCUMENT_NUMBER>
         <DOCUMENT_GIVED_BY>string</DOCUMENT_GIVED_BY>
         <DOCUMENT_GIVED_DATE>string</DOCUMENT_GIVED_DATE>
         <PHONES>string</PHONES>
         <ACTIVITY_KIND_ID>int</ACTIVITY_KIND_ID>
         <RESIDENT_BOOL>int</RESIDENT_BOOL>
         <ECONOMICS_SECTOR_ID>int</ECONOMICS_SECTOR_ID>
         <SIC>string</SIC>
         <COUNTRY_ID>int</COUNTRY_ID>
         <IIN>string</IIN>
       </CLIENT>
       ...
       <CLIENT>
         ...
       </CLIENT>
 <CLIENTS>

GetTFByID

 GetTFByID - получение транспортного средства по идентификатору;
 Тело запроса в aRequest.Body должно содержать текст Xml документа в кодировке Base64 следующего формата:
 <GetTFByID>
   <VehicleID>string</VehicleID>
 </GetTFByID>

 где:
 VehicleID - идентификатор ТС;

 Тело ответа EsbdResponse.Body будет содержать текст Xml документа в кодировке Base64 следующего формата:
 <VEHICLES>
       <VEHICLE>
         <TF_ID>int</TF_ID>
         <TF_TYPE_ID>int</TF_TYPE_ID>
         <VIN>string</VIN>
         <BORN>string</BORN>
         <MODEL>string</MODEL>
         string
         <ENGINE_VOLUME>int</ENGINE_VOLUME>
         <RIGHT_HAND_DRIVE_BOOL>int</RIGHT_HAND_DRIVE_BOOL>
         <ENGINE_NUMBER>string</ENGINE_NUMBER>
         <ENGINE_POWER>int</ENGINE_POWER>
         <COLOR>string</COLOR>
         <BORN_MONTH>int</BORN_MONTH>
         <REG_NUMBER>string</REG_NUMBER>
         <REGION_ID>int</REGION_ID>
       </VEHICLE>
       ...
       <VEHICLE>
         ...
       </VEHICLE>
 <VEHICLES>


GetTFByVIN

 GetTFByVIN - получение транспортного средства по VIN;
 Тело запроса в aRequest.Body должно содержать текст Xml документа в кодировке Base64 следующего формата:
 <GetTFByVIN>
   <VIN>string</VIN>
 </GetTFByVIN>

 где:
 VIN - VIN номер ТС;

 Тело ответа EsbdResponse.Body будет содержать текст Xml документа в кодировке Base64 следующего формата:
 <VEHICLES>
       <VEHICLE>
         <TF_ID>int</TF_ID>
         <TF_TYPE_ID>int</TF_TYPE_ID>
         <VIN>string</VIN>
         <BORN>string</BORN>
         <MODEL>string</MODEL>
         string
         <ENGINE_VOLUME>int</ENGINE_VOLUME>
         <RIGHT_HAND_DRIVE_BOOL>int</RIGHT_HAND_DRIVE_BOOL>
         <ENGINE_NUMBER>string</ENGINE_NUMBER>
         <ENGINE_POWER>int</ENGINE_POWER>
         <COLOR>string</COLOR>
         <BORN_MONTH>int</BORN_MONTH>
         <REG_NUMBER>string</REG_NUMBER>
         <REGION_ID>int</REGION_ID>
       </VEHICLE>
       ...
       <VEHICLE>
         ...
       </VEHICLE>
 <VEHICLES>


GetTFByRegNumber

 GetTFByRegNumber - получение транспортного средства гос. номеру;
 Тело запроса в aRequest.Body должно содержать текст Xml документа в кодировке Base64 следующего формата:
 <GetTFByRegNumber>
   <RegNumber>string</RegNumber>
 </GetTFByRegNumber>

 где:
 RegNumber - Гос. номер ТС;

 Тело ответа EsbdResponse.Body будет содержать текст Xml документа в кодировке Base64 следующего формата:
 <VEHICLES>
       <VEHICLE>
         <TF_ID>int</TF_ID>
         <TF_TYPE_ID>int</TF_TYPE_ID>
         <VIN>string</VIN>
         <BORN>string</BORN>
         <MODEL>string</MODEL>
         string
         <ENGINE_VOLUME>int</ENGINE_VOLUME>
         <RIGHT_HAND_DRIVE_BOOL>int</RIGHT_HAND_DRIVE_BOOL>
         <ENGINE_NUMBER>string</ENGINE_NUMBER>
         <ENGINE_POWER>int</ENGINE_POWER>
         <COLOR>string</COLOR>
         <BORN_MONTH>int</BORN_MONTH>
         <REG_NUMBER>string</REG_NUMBER>
         <REGION_ID>int</REGION_ID>
       </VEHICLE>
       ...
       <VEHICLE>
         ...
       </VEHICLE>
 <VEHICLES>


GetTFByEngineNumber

 GetTFByEngineNumber - получение транспортного средства гос. номеру;
 Тело запроса в aRequest.Body должно содержать текст Xml документа в кодировке Base64 следующего формата:
 <GetTFByEngineNumber>
   <EngineNumber>string</EngineNumber>
 </GetTFByEngineNumber>

 где:
 EngineNumber - Номер двигателя ТС;

 Тело ответа EsbdResponse.Body будет содержать текст Xml документа в кодировке Base64 следующего формата:
 <VEHICLES>
       <VEHICLE>
         <TF_ID>int</TF_ID>
         <TF_TYPE_ID>int</TF_TYPE_ID>
         <VIN>string</VIN>
         <BORN>string</BORN>
         <MODEL>string</MODEL>
         string
         <ENGINE_VOLUME>int</ENGINE_VOLUME>
         <RIGHT_HAND_DRIVE_BOOL>int</RIGHT_HAND_DRIVE_BOOL>
         <ENGINE_NUMBER>string</ENGINE_NUMBER>
         <ENGINE_POWER>int</ENGINE_POWER>
         <COLOR>string</COLOR>
         <BORN_MONTH>int</BORN_MONTH>
         <REG_NUMBER>string</REG_NUMBER>
         <REGION_ID>int</REGION_ID>
       </VEHICLE>
       ...
       <VEHICLE>
         ...
       </VEHICLE>
 <VEHICLES>


Пример использования метода Execute на языке C#

 public void ExecuteMethod()
 {
    icweb.EsbdRequest req = new WinAppWithSSL.icweb.EsbdRequest();
    string requestBody = "<Body><PolicyId>23453</PolicyId><RescindingReasonId>6</RescindingReasonId><RescindingDate>30.12.2009</RescindingDate></Body>";
    byte[] byteArray = System.Text.Encoding.UTF8.GetBytes(textBox19.Text);
    req.Body = Convert.ToBase64String(byteArray);
    req.Type = "SetPolicyRescindingReason"; // Тип запроса
    req.Version = 1; // Версия запроса
           
    icweb.EsbdResponse resp = service.Execute(CurrentUser.SessionID, req);
    if (resp.ResultCode == 0)
    {
      try
      {
        byteArray = Convert.FromBase64String(resp.Body); // Декодируем из Base64
        char[] charArray = Encoding.UTF8.GetChars(byteArray);
        textBox22.Text = new string(charArray); // получаем результат в виде Xml-документа
      }
      catch (Exception ex)
      {
        textBox22.Text = ex.Message;
      }
    }
    else
    {
       textBox22.Text = resp.ErrorMessage;
    }
   }
 }
Источник — https://wiki.gkb.kz/?title=Execute&oldid=2395