(string idNumber, XmlDocument xmlParams)
Возвращает xml-список типов отчетов, доступных пользователю для получения разных отчетов о субъектах. Список содержит детальную информацию, которая может быть использована для генерирования полного отчета по конкретному типу субъекта, которому принадлежит поддерживаемый идентификатор. Он, например, может быть получен путем вызова метода GetReport. Этот метод использует xml-структуру для идентификации типа номера идентификации, который посылается с помощью параметра idNumber, с целью идентификации субъекта отчета.
SOAP заголовки включают:
username: Имя пользователя.
password: Пароль пользователя.
version: версию запрашиевомой схемы.
culture: Культурапользователя.
POST /Cig. WebService. CigSuite/Service. asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws. /GetAvailableReportsForId"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelopexmlns:xsi="http://www. w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www. w3.org/2001/XMLSchema" xmlns:soap="http://schemas. xmlsoap. org/soap/envelope/">
<soap:Header>
<CigWsHeaderxmlns="http://ws. /">
<UserName>string</UserName>
<Password>string</Password>
<Version>string</Version>
<Culture>string</Culture>
<SecurityToken>string</SecurityToken>
<UserId>int</UserId>
</CigWsHeader>
</soap:Header>
<soap:Body>
<GetAvailableReportsForIdxmlns="http://ws. /">
<idNumber>string</idNumber>
<xmlParams>xml</xmlParams>
</GetAvailableReportsForId>
</soap:Body>
</soap:Envelope>
Параметр | Описание | Пример |
idNumber | Идентификационный номер объекта. | a |
xmlParams | XML документ, содержащий idType, который может быть трех разных форматов, смотрите примеры. | <keyValuexmlns=""> <idType>130</idType> </keyValue> <keyValuexmlns=""> <idTypeExportCode>Entity. Identification. Type. Rnn</idTypeExportCode> </keyValue> <keyValuexmlns=""> <idTypeImportCode>1</idTypeImportCode> </keyValue> <keyValuexmlns=""> <creditinfoId></creditinfoId> </keyValue> |
Возвращенная запись будет содержать следующее:
<Reportid="99993"importcode="1"namenative="Company Basic Report"nameen="Company Basic Report" />
id : Идентификационный код типа отчета. Может быть использован для генерирования отчета по конкретному типу отчетов, например, путем вызова метода GetReport.
importcode : Код импорта является независимым от идентификаторов внутренней базы данных и представляет собой наилучший идентификатор типов в системе КИГ. Код импорта может быть использован для генерирования отчета по конкретному типу отчетов, например, путем вызова метода GetReport.
namenative / nameen : Логическое описание для любого предоставляемого типа отчета.
6.2.3 GetAvailableReportsEx
XmlNode GetAvailableReportsEx
(XmlDocument xmlParams)
В зависимости от результатов поиска возвращает xml-список типов отчетов, доступных пользователю для получения разных отчетов о субъектах, сообщение о том, что найдено более одного субъекта, соответствующего заданным параметрам, сообщение о том, что субъект не найден.. Список доступных отчетов содержит детальную информацию, которая может быть использована для генерирования полного отчета по конкретному типу субъекта, которому принадлежит поддерживаемый идентификатор. Он, например, может быть получен путем вызова метода GetReport. Этот метод использует xml-структуру для идентификации типа номера идентификации, который посылается с помощью параметра idNumber, с целью идентификации субъекта отчета.
SOAP заголовки включают:
username: Имя пользователя.
password: Пароль пользователя.
version: версию запрашиевомой схемы.
culture: Культурапользователя.
<soapenv:Envelope xmlns:soapenv="http://schemas. xmlsoap. org/soap/envelope/" xmlns:ws="http://ws. /">
<soapenv:Header>
<ws:CigWsHeader>
<ws:Culture>ru-RU</ws:Culture>
<ws:Password>[Password]</ws:Password>
<ws:SecurityToken></ws:SecurityToken>
<ws:UserId>0</ws:UserId>
<ws:UserName>[USER]</ws:UserName>
<ws:Version>2</ws:Version>
</ws:CigWsHeader>
</soapenv:Header>
<soapenv:Body>
<ws:GetAvailableReportsEx>
<ws:xmlParams>
<keyValue xmlns="">
<query>
<param name="130" value="" />
<param name="135" value="" />
</query>
</keyValue>
</ws:xmlParams>
</ws:GetAvailableReportsEx>
</soapenv:Body>
</soapenv:Envelope>
Параметр | Описание | Пример |
xmlParams | XMLдокумент, содержащийнабор param, в которых атрибуты содержат тип документа и значение, по которому будет запрашиваться список отчетов. Name – идентификатор документа в справочнике Value–значение(номер) документа Поиск производится по условию ИЛИ. При использовании двух одинаковых документов – произойдет ошибка 1115 (Нельзя указывать два однотипных документа) При указании кода параметра поиска, не существующего в справочнике, произойдет ошибка 1116 «Код параметра поиска указан неверно» | <keyValuexmlns=""> <query> <param name="130"value=""/> <param name="135"value=""/> </query> </keyValue> |
Возвращенная запись будет содержать следующее:
<Reportid="99993"importcode="1"namenative="Company Basic Report"nameen="Company Basic Report" />
id : Идентификационный код типа отчета. Может быть использован для генерирования отчета по конкретному типу отчетов, например, путем вызова метода GetReport.
importcode : Код импорта является независимым от идентификаторов внутренней базы данных и представляет собой наилучший идентификатор типов в системе КИГ. Код импорта может быть использован для генерирования отчета по конкретному типу отчетов, например, путем вызова метода GetReport.
namenative / nameen : Логическое описание для любого предоставляемого типа отчета.
6.2.4 GetReport
XmlNode GetReport(int reportId, XmlDocument doc)
Возвращает отчет о конкретном физическом или юридическом лице
в формате XML.
Cформированный отчет сохраняется в кэше и при его повторном запросе в течение промежутка времени меньшего, чем 10 минут, не формируется повторно, а предоставляется из кэша, т. е. промежуток времени между первым и последующим запросом не должен превышать 10 минут.
При этом повторный отчет не учитывается в биллинге, в случае, если запрос произведен по одному и тому же субъекту и одного и того же типа отчета.
SOAP заголовки включают:
username: Имя пользователя.
password: Пароль пользователя.
version: версию запрашиевомой схемы.
culture: Культурапользователя.
POST /Cig. WebService. CigSuite/Service. asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws. /GetReport"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelopexmlns:xsi="http://www. w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www. w3.org/2001/XMLSchema" xmlns:soap="http://schemas. xmlsoap. org/soap/envelope/">
<soap:Header>
<CigWsHeaderxmlns="http://ws. /">
<UserName>string</UserName>
<Password>string</Password>
<Version>string</Version>
<Culture>string</Culture>
<SecurityToken>string</SecurityToken>
<UserId>int</UserId>
</CigWsHeader>
</soap:Header>
<soap:Body>
<GetReportxmlns="http://ws. /">
<reportId>int</reportId>
<doc>xml</doc>
</GetReport>
</soap:Body>
</soap:Envelope>
Параметр | Описание | Пример |
reportId | Уникальный идентификатор запрашиваемого отчета | 99993 |
doc | Xml документ, содержащий дополнительные параметры. Как минимум должны быть параметры для идентификации объекта и отчета. | <keyValuexmlns=""> <reportImportCode>2</reportImportCode> <idNumber>a</idNumber> <idNumberType>1</idNumberType> </keyValue> |
Эти параметры доступны для идентификации объекта: creditinfoId или idNumber вместе с одним из двух параметров idNumberType или idNumberCode. | <keyValuexmlns=""> <creditinfoId></creditinfoId> </keyValue> <keyValuexmlns=""> <idNumber>a</idNumber> <idNumberType>1</idNumberType> </keyValue> <keyValuexmlns=""> <idNumber>a</idNumber> <idNumberCode>Entity. Identification. Type. Rnn</idNumberCode> </keyValue> Дляфиз. лиц. <keyValuexmlns=""> <creditinfoId></creditinfoId> </keyValue> | |
Подтверждение о наличии согласия субъекта | <keyValuexmlns=""> <ConsentConfirmed>1</ConsentConfirmed> </keyValue> | |
Возможно проигнорировать и переопределить параметр reportId из GetReport путем предоставления параметров reportImportCode в doc. Потом отчет, который имеет importcode, предоставляемый в reportImportCode и reportId, игнорируется и переопределяется. | <keyValuexmlns=""> <reportImportCode>2</reportImportCode> </keyValue> |
6.2.5 GetReports
byte[] GetReports(XmlDocument xmlDoc, int outputFormat)
Возвращает ZIP файл как последовательность байтов. Полученые из метода данные должны быть конвертированы (внесены) в файл получателем. Этот zip файл, доступный после полного конвертирования его получателем из потока байтов, содержит запрошенные получателем отчеты. Метод GetReports предназначен для возврата множества отчетов с помощью вызова одного метода, что позволяет пользователю отправлять в xml-структуре указатели на то, что отчеты должны быть сгенерированы и для какого субъекта в каждом случае. Пользователь также может выбрать формат вывода пакета отчетов.
При вызове метода GetReports происходит фактическое формирование запрашиваемого отчёта, при этом сам сформированный отчет сохраняется в кэше и при его повторном запросе в течение промежутка времени меньшего, чем 10 минут, не формируется повторно, а предоставляется из кэша, т. е. промежуток времени между первым и последующим запросом не должен превышать 10 минут.
При этом повторный отчет не учитывается в биллинге, в случае, если запрос произведен по одному и тому же субъекту и одного и того же типа отчета.
SOAP заголовки включают:
username: Имя пользователя.
password: Пароль пользователя.
version: версию запрашиевомой схемы.
culture: Культурапользователя.
POST /Cig. WebService. CigSuite/Service. asmxHTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws. /GetReports"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelopexmlns:xsi="http://www. w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www. w3.org/2001/XMLSchema" xmlns:soap="http://schemas. xmlsoap. org/soap/envelope/">
<soap:Header>
<CigWsHeaderxmlns="http://ws. /">
<UserName>string</UserName>
<Password>string</Password>
<Version>string</Version>
<Culture>string</Culture>
<SecurityToken>string</SecurityToken>
<UserId>int</UserId>
</CigWsHeader>
</soap:Header>
<soap:Body>
<GetReportsxmlns="http://ws. /">
<xmlDoc>xml</xmlDoc>
<outputFormat>int</outputFormat>
</GetReports>
</soap:Body>
</soap:Envelope>
Параметры | Описание | Пример |
xmlDoc | Каждая строка идентификаторов используется для идентификации типа генерируемого отчета и субъекта отчета. Каждая строка транслируется в один конкретный отчет. Тип отчета может быть идентифицирован, как по id, так и по importcode (смотреть GetAvailableReports) Субъект отчета идентифицируется по уникальному идентификационному номеру, содержащемуся в элементе, который указывает используемый тип id. Тип id может быть идентифицирован как по typeid, так и по importcode для idtype. | <identifiersxmlns=""> <identifierreportImportCode="3"idTypeImportCode="1" ConsentConfirmed="1">a</identifier> <!—or à <identifierreportType="200013"idType="130" ConsentConfirmed="1">a</identifier> <!—or à <identifierConsentConfirmed="1" creditinfoId="1" reportImportCode="4">123456</identifier> </identifiers> |
outputFormat | Целостный код, определяющий формат в котором возвращаются отчеты. Возможные форматы это xml, html, rtf и pdf. Целостный код является уникальным идентификатором искомого значения. | Форматы вывода: 607 = HTML 608 = XML 609 = PDF 840 = XLS |
6.2.6 GetLocations
XmlNodeGetLocations(intparentId)
Предоставляет список всех возможных местоположений для конкретного вышестоящего источника. Например, все страны, области и города для конкретного континента, если идентификационный номер континента был использован как id источника (parentid).
SOAP заголовки включают:
username: Имя пользователя.
password: Пароль пользователя.
version: версию запрашиваемой схемы.
culture: Культурапользователя.
POST /Cig. WebService. CigSuite/Service. asmx HTTP/1.1
Host:
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws. /GetLocations"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelopexmlns:xsi="http://www. w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www. w3.org/2001/XMLSchema" xmlns:soap="http://schemas. xmlsoap. org/soap/envelope/">
<soap:Header>
<CigWsHeaderxmlns="http://ws. /">
<UserName>string</UserName>
<Password>string</Password>
<Version>string</Version>
<Culture>string</Culture>
<SecurityToken>string</SecurityToken>
<UserId>int</UserId>
</CigWsHeader>
</soap:Header>
<soap:Body>
<GetLocationsxmlns="http://ws. /">
<parentId>int</parentId>
</GetLocations>
</soap:Body>
</soap:Envelope>
parentId: Идентификатор местоположения источника. Например, для Казахстана это 110, для Алматинской области это 267 и для города Алматы это 675..
6.2.7 GetLookupValues
XmlNode GetLookupValues(string code)
Предоставляет список значений поиска для данного типа. Тип идентифицируется с помощью кода импорта (importcode), находящегося в параметре codeдля вызова службы. Типы и их коды импорта указаны в пункте 5.1 (Справочники)
SOAP заголовки включают:
username: Имя пользователя.
password: Пароль пользователя.
version: версию запрашиевомой схемы.
culture: Культурапользователя.
POST /Cig. WebService. CigSuite/Service. asmx HTTP/1.1
Host:
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws. /GetLookupValues"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelopexmlns:xsi="http://www. w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www. w3.org/2001/XMLSchema" xmlns:soap="http://schemas. xmlsoap. org/soap/envelope/">
<soap:Header>
<CigWsHeaderxmlns="http://ws. /">
<UserName>string</UserName>
<Password>string</Password>
<Version>string</Version>
<Culture>string</Culture>
<SecurityToken>string</SecurityToken>
<UserId>int</UserId>
</CigWsHeader>
</soap:Header>
<soap:Body>
<GetLookupValuesxmlns="http://ws. /">
<code>string</code>
</GetLookupValues>
</soap:Body>
</soap:Envelope>
code: Код импорта типа значений поиска, которые должны быть возвращены. Типы и их коды импорта указаны в пункте 6.1 (Справочники)
6.2.8 Описание ответов системы и ошибок при получении отчетов
Код ошибки | Сообщение |
1101 | Пользователь получает список доступных отчетов |
1102 | Субъект не найден |
1103 | При передаче параметров при вызове метода указан неверный код культуры (языка) запрашиваемого отчета |
1104 | При передаче параметров при вызове метода указан логин, не зарегистрированный в системе |
1105 | При передаче параметров при вызове метода указан тип отчета не зарегистрированный в системе |
1106 | Пользователь не имеет прав на запрашиваемый тип отчета |
1107 | Тип документа, переданный для идентификации субъекта, не найден в системе |
1108 | Не существует запрашиваемого отчета для данного субъекта |
1109 | Данный тип отчета доступен для другого типа субъекта (запрошен отчет физ. лица для субъекта юр. лицо, либо запрошен отчет юр. лица для субъекта физ. лицо) |
1110 | Не верный пароль, ip-адрес и т. п. |
1111 | В программном обеспечении кредитного бюро произошла ошибка |
1112 | Найдено более одного субъекта |
1115 | Нельзя указывать два однотипных документа |
1116 | Код параметра поиска указан неверно |
При получении результата рекомендуем ориентироваться на коды ошибок, т. к. сообщения могут изменяться. Пример ответа (все ответы кроме 1112):
|
Из за большого объема этот материал размещен на нескольких страницах:
1 2 3 4 5 6 7 8 9 |
