Функции веб-сервиса
В этом разделе приводится список всех функций, доступных через Веб-сервис.
Функции, которые используют xml-кодирование таблиц данных
1.
Веб-сервис getXML используется для получения значений переменных контекста SberMobile Serverа.
Параметры функции:
Имя | Тип | Описание |
имя пользователя | Строка | Имя учетной записи пользователя SberMobile Serverа, которое будет использоваться для регистрации на сервере. Операция Получить Переменную будет выполняться с правами доступа данного пользователя. |
пароль | Строка | Пароль для учетной записи пользователя. |
контекст | Строка | Путь к контексту для переменной. |
переменная | Строка | Имя переменной. |
Возвращаемое значение: эта функция возвращает Строку, т.е. Таблицу Данных, содержащую значение запрашиваемой переменной. Это значение закодировано в формате XML. См. Кодирование Таблиц Данных в формате XML. Полученная строка XML закодирована вновь согласно стандарту кодирования URL, определенного RFC 1738 (Унифицированный Указатель Ресурсов). Это необходимо для уверенности, что полученная строка не содержит небезопасные для протокола SOAP символы.
2.
Функция setXML позволяет изменять значение для переменной контекста SberMobile Serverа.
Параметры функции:
Имя | Тип | Описание |
имя пользователя | Строка | Имя учетной записи пользователя SberMobile Server, которое будет использоваться для регистрации на сервере. Операция Установить переменную будет выполняться с правами доступа данного пользователя. |
пароль | Строка | Пароль для учетной записи пользователя. |
контекст | Строка | Путь к контексту переменной. |
переменная | Строка | Имя переменной. |
значение | Строка | Новое значение переменной, закодированной в формате XML. См. Кодирование Таблиц Данных в формате XML. Полученный в результате XML-документы закодирован вновь согласно стандарту шифрования URL, определенного RFC 1738 (Унифицированный Указатель Ресурсов). Это необходимо для уверенности в том, что полученная строка не содержит небезопасные для протокола SOAP символы. |
Возвращаемое значение: никакое.
В большинстве случаев значением аргумента, переданного этой функции, является Таблица Данных, которая была до этого извлечена функцией getXML.
3. Callxml
Функция callXML используется для выполнения функций контекста SberMobile Serverа посредством передачи в функцию закодированной в формате XML Таблицы Данных в качестве аргумента.
Параметры функции:
Имя | Тип | Описание |
имя пользователя | Строка | Имя учетной записи пользователя SberMobile Serverа, которое будет использоваться для регистрации на сервере. Функция будет выполняться с правами доступа данного пользователя |
пароль | Строка | Пароль учетной записи пользователя. |
контекст | Строка | Путь к контексту из которого функция должна вызываться. |
переменная | Строка | Имя функции. |
значение | Строка | Таблица Данных, содержащая параметры ввода функции. Эта таблица закодирована в формате XML. См. Кодирование Таблиц Данных в формате XML. Полученный в формате XML документ кодируется вновь согласно стандарту кодирования URL, определенного RFC 1738 (Унифицированный Указатель Ресурсов). Это необходимо для уверенности в том, что полученная строка не содержит небезопасные для протокола SOAP символы. |
Возвращаемое значение: эта функция веб-сервиса возвращает строку, которая является Таблицей Данных, возвращенной выполненной функцией. Это значение закодировано аналогичным образом, что и входной параметр, упомянутый выше.
Функции, представляющие таблицы данных как массив строк
1. Setbystringarray
Функция setByStringArray используется для изменения значений переменных контекста SberMobile Serverа. Ячейки Таблицы Данных, содержащие новое значение, передаются в нее в виде массива Строк.
Параметры функции:
Имя | Тип | Описание |
имя пользователя | Строка | Имя учетной записи пользователя SberMobile Serverа, которое будет использоваться для регистрации на сервере. Операция Установить переменную будет выполняться с правами доступа данного пользователя |
пароль | Строка | Пароль учетной записи пользователя. |
контекст | Строка | Путь к контексту, где находится переменная. |
переменная | Строка | Имя переменной. |
значения | Строка[] | Массив строк, используемых для заполнения Таблицы Данных с новыми значениями переменной, как описано здесь. |
Возвращаемое значение: нет.
2. Callbystringarray
Функция callByStringArray позволяет выполнять функцию контекста SberMobile Serverа путем передачи ее аргумента в виде массива Строк.
Параметры функции:
Имя | Тип | Описание |
имя пользователя | Строка | Имя учетной записи пользователя SberMobile Server, которое будет использоваться для регистрации на сервере. Операция вызова будет выполняться с правами доступа данного пользователя |
пароль | Строка | Пароль учетной записи пользователя. |
контекст | Строка | Путь к контексту, из которого вызывается функция. |
функция | Строка | Имя функции. |
параметры | Строка[] | Массив Строк, который используется для заполнения Таблицы Данных, представляющей значение ввода функции, как описано здесь. |
Возвращаемое значение: эта функция Веб-сервиса возвращает Строку Таблицы Данных, содержащую значение запрашиваемой переменной. Это значение закодировано в формате XML. См. Кодирование Таблиц Данных в формате XML. Полученная строка XML кодируется вновь согласно стандарту шифрования URL, определенного RFC 1738 (Унифицированный Указатель Ресурсов). Это необходимо для уверенности, что полученная строка не содержит небезопасные для протокола SOAP символы.
3. Addrecordbystringsrray
Функция addRecordByStringSrray используется для создания новых записей в табличной переменной контекста. Поля новой записи Таблицы Данных передаются в нее в виде массива Строк.
Технически функция читает значение переменной, добавляет в нее новую запись и записывает новое значение назад в контекст.
Параметры функции:
Имя | Тип | Описание |
имя пользователя | Строка | Имя учетной записи пользователя SberMobile Server, которое будет использоваться для регистрации на сервере. Операции Получить переменную/Настроить переменную будут выполняться с правами доступа данного пользователя. |
пароль | Строка | Пароль учетной записи пользователя. |
контекст | Строка | Путь к контексту, где находится переменная. |
переменная | Строка | Имя переменной. |
значение | Строка[] | Массив строк, используемый для заполнения новой записи Таблицы Данных со значениями, описанными здесь. |
Возвращаемое значение: нет.
4. Setvariablefield
Функция setVariableField используется для изменения одной ячейки (задано именем поля и номером ряда) переменной контекста. Новое значение ячейки передается в виде Строки.
Технически эта функция читает значение переменной, меняет значение ее ячейки (переменная типа Таблица данных), и записывает новое значение обратно в контекст.
Параметры функции:
Имя | Тип | Описание |
имя пользователя | Строка | Имя учетной записи пользователя SberMobile Serverа, которое будет использоваться для регистрации на сервере. Операции Получить переменную/Настроить переменную будут выполняться с правами доступа данного пользователя. |
пароль | Строка | пароль учетной записи пользователя. |
контекст | Строка | Путь к контексту, где находится переменная. |
переменная | Строка | Имя переменной. |
поле | Строка | Имя поля. |
ряд | int | Номер ряда. |
значение | Строка | Новое значение ячейки в форме Строки. |
Возвращаемое значение: никакое.
Функции, которые используют собственные кодировки таблиц данных
Существуют три функции Веб-сервиса, которые используют собственное кодирование Таблиц Данных :
- get
- set
- call
Эти функции используются для получения/установки значений переменных контекста SberMobile Serverа и вызова соответствующих функций контекста.