GetReferenceData: DocumentsPhoto — Список документов для фотосъемки
Функция возвращает список документов, подлежащих фотосъёмке, при работе клиента в соответствующем режиме. Полученные данные используются в качестве параметров при вызове других функций веб-сервиса.
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| login | string | логин | |
| password | string | пароль | |
| parameters | Element | список параметров |
Параметр parameters содержит настройки запроса в виде иерархической структуры, соответствующей XML-представлению.
Он должен включать:
Key: строка со значением parameters (обязательное);
List: непустой массив элементов, каждый из которых представляет отдельный параметр и сам является структурой с тремя полями:
- Key: имя параметра (например, Reference);
- Value: значение параметра указывающая на то какой parameters описывается;
- ValueType: тип значения — строка, указывающая тип Value(string, int и т.д.).
Пример одного элемента из List:
<car:List>
<car:Key>Reference</car:Key>
<car:Value>documentsphoto</car:Value>
<car:ValueType>string</car:ValueType>
</car:List>Каждый такой элемент — независимый узел внутри parameters. Если List отсутствует или пуст — запрос отклоняется.
Иерархия структуры parameters:
parameters → List (массив) → каждый элемент List → Key, Value, ValueType.
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| Reference | string | Имя справочника, должно быть равно «documentsphoto» |
Параметр Element в ответе содержит информацию о типах документа для фотосъемки.
Он включает элементы справочника:
Key: идентификатор справочника, к которому относится запись (например, DocumentsPhoto);
List: контейнер записи справочника, каждая запись соответствует одному типу документа для фотосъёмки.
Каждый блок List описывает один тип документа в виде структуры Element и содержит в себе:
- Key: уникальный идентификатор типа документа (например, 48164c03-3056-452b-bb6c-ffea3623012b);
- Value: наименование типа документа( например, Паспорт гражданина РФ);
- ValueType: тип значения — строка, указывающая тип Value (string, dateTime и т.п.).
Структура ответа иерархична:
Element → Key + List (массив) → каждый элемент List → Key + Value +ValueType.
Если во время запроса произошла ошибка, информация о ней будет отражена в свойстве Properties (см. метод GetReferenceData: ErrorCodes — Коды ошибок).
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| Key | string | Индекс элемента | |
| Value | string | Наименование элемента |
<soap:Envelope
xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:car="http://www.cargo3.ru">
<soap:Header/>
<soap:Body>
<car:GetReferenceData>
<car:login>test</car:login>
<car:password>2016</car:password>
<car:parameters>
<car:Key>parameters</car:Key>
<car:List>
<car:Key>Reference</car:Key>
<car:Value>documentsphoto</car:Value>
<car:ValueType>string</car:ValueType>
</car:List>
</car:parameters>
</car:GetReferenceData>
</soap:Body>
</soap:Envelope><soap:Envelope
xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
<soap:Body>
<m:GetReferenceDataResponse
xmlns:m="http://www.cargo3.ru">
<m:return
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<m:Key>DocumentsPhoto</m:Key>
<m:List>
<m:Key>aefe0548-07c5-4c55-afd4-86452517f800</m:Key>
<m:Value xsi:type="xs:string">Водительское удостоверение</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>d1ddf576-4164-49c0-8e0a-587a2fb54c5d</m:Key>
<m:Value xsi:type="xs:string">Военный билет</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>b32813da-971c-4b34-8740-e796ae0ba0bf</m:Key>
<m:Value xsi:type="xs:string">Военный билет офицера запаса</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>996c77d3-8715-4dda-9647-e5ab672f3ce2</m:Key>
<m:Value xsi:type="xs:string">Дипломатический паспорт гражданина РФ</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>706e829d-4b1c-4b04-85f8-1dc193a32ea7</m:Key>
<m:Value xsi:type="xs:string">Загранпаспорт гражданина РФ</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>005e3b80-b069-459b-b964-02716935fa16</m:Key>
<m:Value xsi:type="xs:string">Загранпаспорт гражданина СССР</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>4c123acf-1094-4de2-bcb6-017f1c6e7f9a</m:Key>
<m:Value xsi:type="xs:string">Паспорт гражданина РФ</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>62c97c1b-7376-40e8-a718-a6b0d5ee0e49</m:Key>
<m:Value xsi:type="xs:string">Паспорт гражданина СССР</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>853bbf48-5dfa-4816-bdbe-0a1ab3885c5d</m:Key>
<m:Value xsi:type="xs:string">Паспорт Минморфлота</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>48164c03-3056-452b-bb6c-ffea3623012b</m:Key>
<m:Value xsi:type="xs:string">Паспорт моряка</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>6ab67277-744c-4b8b-bff1-061456899451</m:Key>
<m:Value xsi:type="xs:string">Свидетельство о рождении</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>5e8797c0-09d1-4abc-b45e-8a9e179b121f</m:Key>
<m:Value xsi:type="xs:string">Удостоверение личности офицера</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
</m:return>
</m:GetReferenceDataResponse>
</soap:Body>
</soap:Envelope>