API.Картотека
8 (800) 100-85-50
Звонок по России бесплатный!
Внимание!
Сообщаем Вам о прекращении поддержки API версии 1.0. Версия API 2.0 с 01.01.2016 более не обновляется и в будущем её поддержка может быть прекращена после соответствующего уведомления, рекомендуем пользоваться новой версией API 3.0.

Описание

Справочник описывает API поисковой системы http://www.kartoteka.ru/, доступный через протокол SOAP 1.1.

SOAP (Simple Object Access Protocol) - протокол обмена данными в распределённой вычислительной среде посредством XML-сообщений.

Все методы, URL для доступа, типы и структуры данных описаны с помощью языка WSDL версии 1.1. WDSL-файл доступен по URL http://api.kartoteka.ru/search/v2/soap/search.wsdl.

WSDL (Web Services Description Language) - язык описания веб-сервисов и доступа к ним, основанный на языке XML.

Сервис принимает сообщения и выдает на них ответы в формате SOAP. Элементами логической модели сообщения являются элементы и атрибуты XML.

В описание входных и выходных параметров методов для каждого структурного элемента приводятся следующие сведения:

  • Наименование элемента. Приводится полное наименование элемента.
  • Сокращенное наименование элемента. Приводится сокращенное наименование элемента. Сокращенные наименования могут записываться буквами и цифрами.
  • Признак типа элемента. Может принимать следующие значения:
    • «С» – сложный элемент (имеющий вложенные),
    • «П» – простой элемент (не имеющий вложенных),
    • «А» – атрибут.

Если для определения элемента используется пользовательский тип данных, наименование типа данных (типового элемента) указывается в графе «Дополнительные сведения».

  • Формат элемента. Формат представляется в условных обозначениях, которым соответствуют следующие значения:
    • «Т» – символьная строка,
    • «N» – числовое значение (целое или дробное),
    • «B» – булево значение принимаемое вид: true/false.

Формат символьной строки указывается в виде Т(n-к) или T(=к), где n - минимальное количество знаков в строке, к – максимальное количество знаков, символ «-» – разделитель, символ «=» означает фиксированное количество знаков в строке. В случае, если минимальное количество знаков равно 0, формат имеет вид Т(0-к). В случае, если максимальное количество знаков неограниченно, формат имеет вид Т(n-). Формат числового значения указывается в виде N(m.к), где m – максимальное количество знаков в числе, включая знак (для отрицательного числа), целую и дробную часть числа без разделяющей десятичной точки, а k – максимальное число знаков дробной части числа. Если число знаков дробной части числа равно 0 (т.е. число целое), то формат числового значения имеет вид N(m). Для простых элементов, являющихся базовыми в XML (определенными в http://www.w3.org/TR/xmlschema-0 ), например, элемент с типом «date», поле «Формат элемента» не заполняется. Для таких элементов в поле «Дополнительная информация» указывается тип базового элемента.

  • Признак обязательности элемента. Признак обязательности элемента определяет обязательность наличия элемента в XML сообщении. Признак обязательности элемента может принимать следующие значения:
    • «О» – обязательное наличие элемента (наименование элемента и его значение должны присутствовать в сообщении);
    • «Н» – присутствие элемента необязательно (наименование элемента и его значение в сообщении могут отсутствовать).

Если элемент может принимать ограниченный перечень значений (по классификатору, кодовому словарю и т.п.), то признак обязательности элемента дополняется символом «К». Например: «ОК». В случае если количество реализаций элемента может быть более одной, то признак обязательности элемента дополняется символом «М». Например: «ОМ, ОКМ».

  • Дополнительная информация. Для сложных элементов указывается ссылка на таблицу, в которой описывается состав данного элемента. Для элементов, принимающих ограниченный перечень значений из классификатора (кодового словаря и т.п.), указывается соответствующее наименование классификатора (кодового словаря и т.п.) или приводится перечень возможных значений. Для классификатора (кодового словаря и т.п.) может указываться ссылка на его местонахождение. Для элементов, использующих пользовательский тип данных, указывается наименование типового элемента.

Печать