Авторизация
HTTP запрос для получения кода действующей сессии (токена). Данный код обязателен к использованию практически во всех запросах API. Стандартное время жизни сессии восемь часов.
GET https://pscw.autoxp.ru/api.aspx
Запрос:
keynumber [String]* - номер лицензии
codesync [String]* - код синхронизации
* - обязательно
Ответ:
ses [String] - код действующей сессии
Отрицательные ответы:
!IncorrectDataEntered - данные указаны неверно или доступ отключен
!SomethingWentWrong - сбой при обработке данных
Получение списка Документов
HTTP запрос для формирования списка документов. Список состоит из двухсот последних отредактированных Документов. Максимальное количество отображаемых строк можно задать в параметрах запроса.
POST https://pscw.autoxp.ru/api.aspx
Запрос:
ses [String]* - код действующей сессии
task [String]* = 'listoflastdocs'
fields [String] - перечень полей, индексы указываются через запятую, полей в запросе должно быть не более десяти
countofdocs [Integer] - количество отображаемых строк с информацией из документа
* - обязательно
Ответ:
Массив в виде таблицы, где первые три колонки содердат: индекс документа, дата и время последнего изменения, основной индекс бланка (используемого при создании документа)
Отрицательные ответы:
!SessionNotValid - сессия не действительна
!InvalidSessionFormat - код сессии указан неверно
!CountOfFieldsVeryLarge - количество полей очень большое
!CountOfDocumentsVeryLarge - код сессии указан неверно
Работа с Документом
Создание нового Документа
HTTP запрос для создания нового Документа в архиве, на основе кода необходимого бланка (конфигурации).
Варианты индексов действующих бланков:
AST00100 - ОСАГО
AXP00100 - КАСКО
ASR00100 - Заказ-наряд
GET https://pscw.autoxp.ru/api.aspx
Запрос:
ses [String]* - код действующей сессии
bnk [String]* - код бланка
* - обязательно
Ответ:
doc [String] - индекс созданного документа
Отрицательные ответы:
!SessionNotValid - сессия не действительна
!InvalidSessionFormat - код сессии указан неверно
Получение содержимого поля Документа
HTTP запрос возвращающий содержимое поля формы.
GET https://pscw.autoxp.ru/api.aspx
Запрос:
ses [String]* - код действующей сессии
doc [String]* - индекс документа
frmfield [String]* - индекс поля
* - обязательно
Ответ:
val [String] - содержимое поля
где: null - пустое значение
Отрицательные ответы:
!SessionNotValid - сессия не действительна
!InvalidSessionFormat - код сессии указан неверно
!NoDocumentSpecified - документ не найден
!FieldNotFound - индекс поля ненайден
Получение содержимого нескольких полей Документа
HTTP запрос возвращающий содержимое нескольких полей формы.
POST https://pscw.autoxp.ru/api.aspx
Запрос:
ses [String]* - код действующей сессии
doc [String]* - индекс документа
frmfields [String]* - перечисленные индексы полей через запятую
* - обязательно
Ответ:
Массив в виде списка с индексами и содержимым соответствующих полей
Отрицательные ответы:
!SessionNotValid - сессия не действительна
!InvalidSessionFormat - код сессии указан неверно
!NoDocumentSpecified - документ не найден
Изменение содержимого поля Документа
HTTP запрос для внесения нового значения в поле формы.
POST https://pscw.autoxp.ru/api.aspx
Запрос:
ses [String]* - код действующей сессии
doc [String]* - индекс документа
frmfield [String]* - индекс поля
val [String]* - новое значение
где: null - пустое значение
* - обязательно
Ответ:
OK - изменение успешно внесено
NC - изменения отсутствуют
Отрицательные ответы:
!SessionNotValid - сессия не действительна
!InvalidSessionFormat - код сессии указан неверно
!NoDocumentSpecified - документ не найден
!FieldNotFound - индекс поля ненайден
!DateFormatIsNotCorrect - формат даты неверный
Изменение содержимого нескольких полей Документа
HTTP запрос для внесения изменений в нескольких полях формы, одновременно.
POST https://pscw.autoxp.ru/api.aspx
Запрос:
ses [String]* - код действующей сессии
doc [String]* - индекс документа
frmfields [String]* - перечисленные индексы полей через запятую
vals [String]* - перечисленные новые значения через разделитель - [s]
где: null - пустое значение
* - обязательно
Ответ:
OK - изменение успешно внесено
NC - изменения отсутствуют
Отрицательные ответы:
!SessionNotValid - сессия не действительна
!InvalidSessionFormat - код сессии указан неверно
!NoDocumentSpecified - документ не найден
!FieldsCountNotMatch - количество полей и значений не равное
!FieldNotFound - индекс поля ненайден
!DateFormatIsNotCorrect - формат даты неверный
Получение содержимого таблицы Документа
HTTP запрос для получения всех записей заданной таблицы.
POST https://pscw.autoxp.ru/api.aspx
Запрос:
ses [String]* - код действующей сессии
doc [String]* - индекс документа
task [String]* - 'tblrows'
table [String]* - индекс таблицы
* - обязательно
Ответ:
Массив в виде таблицы.
Отрицательные ответы:
!SessionNotValid - сессия не действительна
!InvalidSessionFormat - код сессии указан неверно
!NoDocumentSpecified - документ не найден
!TableNotFound - таблица не найдена
!TableNotHaveRows - таблица не содержит записей
Добавление записей в таблицу Документа
HTTP запрос для добавления записей в заданную таблицу.
POST https://pscw.autoxp.ru/api.aspx
Запрос:
ses [String]* - код действующей сессии
doc [String]* - индекс документа
task [String]* - 'tbladdrows'
table [String]* - индекс таблицы
rows [String]* - массив строк в Json
* - обязательно
пример для tblDETAILS:
[
{
"c0": "Запчасть для первой строки",
"c1": 100,
"c3": 1.2,
"c7": "16542684"
},
{
"c0": "Запчасть для второй строки",
"c1": 200,
"c3": 1.7,
"c7": "45876215"
},
{
"c0": "Запчасть для третьей строки",
"c1": 300,
"c3": 2.1,
"c7": "34587642"
}
]
Ответ:
OK - записи успешно добавлены
Отрицательные ответы:
!SessionNotValid - сессия не действительна
!InvalidSessionFormat - код сессии указан неверно
!NoDocumentSpecified - документ не найден
!NewRowsNotFound - строки в массиве отсутствуют
!TableNotFound - тьблица не найдена
!TableUnsupportedAddRows - таблица не поддерживает добавление строк
Удаление записей в таблице Документа
HTTP запрос для удаления записей в заданной таблице.
POST https://pscw.autoxp.ru/api.aspx
Запрос:
ses [S