API - Руководство

Авторизация

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]* = 'listofdocs'
fields [String] - перечень полей, индексы указываются через запятую, полей в запросе должно быть не более десяти
countofdocs [Integer] - количество отображаемых строк с информацией из документа
* - обязательно
Ответ:
Массив в виде таблицы, где первые три колонки содердат: индекс документа, дата и время последнего изменения, основной индекс бланка (используемого при создании документа)
Отрицательные ответы:
!SessionNotValid - сессия не действительна
!InvalidSessionFormat - код сессии указан неверно
!CountOfFieldsVeryLarge - количество полей очень большое
!CountOfDocumentsVeryLarge - код сессии указан неверно

Создание нового Документа

HTTP запрос для создания нового Документа в архиве, на основе кода необходимого бланка (конфигурации).
Варианты индексов действующих бланков:
ACT00100 - Акт-осмотра
AST00100 - ОСАГО
AXP00100 - КАСКО
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 запрос возвращающий текущий статус Документа.
GET https://pscw.autoxp.ru/api.aspx
Запрос:
ses [String]* - код действующей сессии
doc [String]* - индекс документа
task [String]* = 'getdocstatus'
* - обязательно
Ответ:
docstatus [String] - текущий статус
    где: null - пустое значение
Отрицательные ответы:
!SessionNotValid - сессия не действительна
!InvalidSessionFormat - код сессии указан неверно
!NoDocumentSpecified - документ не найден

Получение статуса Документа, включая время

HTTP запрос возвращающий текущий статус Документа, включая время его установки.
GET https://pscw.autoxp.ru/api.aspx
Запрос:
ses [String]* - код действующей сессии
doc [String]* - индекс документа
task [String]* = 'getdocstatuswtime'
* - обязательно
Ответ:
docstatusname [String] - текущий статус
    где: null - пустое значение
docstatustime [String] - время установки статуса
Отрицательные ответы:
!SessionNotValid - сессия не действительна
!InvalidSessionFormat - код сессии указан неверно
!NoDocumentSpecified - документ не найден

Изменение статуса Документа

HTTP запрос для изменения текущего статуса Документа.
GET https://pscw.autoxp.ru/api.aspx
Запрос:
ses [String]* - код действующей сессии
doc [String]* - индекс документа
task [String]* = 'setdocstatus'
val [String]* - новое значение
    где: null - пустое значение
* - обязательно
Ответ:
OK - изменение успешно внесено
Отрицательные ответы:
!SessionNotValid - сессия не действительна
!InvalidSessionFormat - код сессии указан неверно
!NoDocumentSpecified - документ не найден

Получение символа признака Документа

HTTP запрос возвращающий текущий символ признака Документа.
GET https://pscw.autoxp.ru/api.aspx
Запрос:
ses [String]* - код действующей сессии
doc [String]* - индекс документа
task [String]* = 'getdocsymbol'
* - обязательно
Ответ:
docsymbol [String] - текущий символ
    где: null - пустое значение
Отрицательные ответы:
!SessionNotValid - сессия не действительна
!InvalidSessionFormat - код сессии указан неверно
!NoDocumentSpecified - документ не найден

Изменение символа признака Документа

HTTP запрос для изменения текущего символа признака Документа.
GET https://pscw.autoxp.ru/api.aspx
Запрос:
ses [String]* - код действующей сессии
doc [String]* - индекс документа
task [String]* = 'setdocsymbol'
val [String]* - новое значение
где: null - пустое значение
доступные варианты: alert, express, phone, print, flag, light
* - обязательно
Ответ:
OK - изменение успешно внесено
Отрицательные ответы:
!SessionNotValid - сессия не действительна
!InvalidSessionFormat - код сессии указан неверно
!NoDocumentSpecified - документ не найден
!DocSymbolIsNotCorrect - формат символа неверный

Добавление изображения в Документ

HTTP запрос для включения изображений (*.jpeg, *.jpg, *.png) в Документ используя многокомпонентный формат MIME с 'Content-Type' заголовком HTTP 'multipart/form-data'.
POST https://pscw.autoxp.ru/api.aspx
Запрос:
ses [String]* - код действующей сессии
doc [String]* - индекс документа
task [String]* = 'addimage'
gallery [String]* - индекс раздела (галереи) в документе
comment [String] - текстовое описание изображения
geoposlat [String] - геопозиция по широте
geoposlon [String] - геопозиция по долготе
* - обязательно
Ответ:
OK - файл успешно добавлен
Отрицательные ответы:
!SessionNotValid - сессия не действительна
!InvalidSessionFormat - код сессии указан неверно
!NoDocumentSpecified - документ не найден
!ImageMissing - файл с изображением отсутствует
!FileIsNotImage - файл не является изображением
!TooManyImages - файлов слишком много, должно быть не более одного

Получение списка изображений из Документа

HTTP запрос для получения списка изображений из Документа.
GET https://pscw.autoxp.ru/api.aspx
Запрос:
ses [String]* - код действующей сессии
doc [String]* - индекс документа
task [String]* = 'listofimages'
gallery [String]* - индекс раздела (галереи) в документе
* - обязательно
Ответ:
Массив в виде таблицы, где колонки содержат: индекс изображения, описание, геоданные, дата и время добавления
Отрицательные ответы:
!SessionNotValid - сессия не действительна
!InvalidSessionFormat - код сессии указан неверно
!NoDocumentSpecified - документ не найден

Получение изображения из Документа

HTTP запрос для получения изображения из Документа. Формат изображения - Jpeg.
GET https://pscw.autoxp.ru/api.aspx
Запрос:
ses [String]* - код действующей сессии
doc [String]* - индекс документа
image [String]* - индекс изображения
* - обязательно
Ответ:
Массив с 'ContentType' заголовком 'image/jpg'
Отрицательные ответы:
!SessionNotValid - сессия не действительна
!InvalidSessionFormat - код сессии указан неверно
!NoDocumentSpecified - документ не найден
!ImageNotFound - изображение ненайдено

Добавление файла в Документ

HTTP запрос для включения файлов (*.doc, *.docx, *.xls, *.xlsx, *.pdf, *.jpg, *.jpeg, *.png, *.bmp, *.psc, *.mp4) в Документ используя многокомпонентный формат MIME с 'Content-Type' заголовком HTTP 'multipart/form-data'.
POST https://pscw.autoxp.ru/api.aspx
Запрос:
ses [String]* - код действующей сессии
doc [String]* - индекс документа
task [String]* = 'addfile'
* - обязательно
Ответ:
OK - файл успешно добавлен
Отрицательные ответы:
!SessionNotValid - сессия не действительна
!InvalidSessionFormat - код сессии указан неверно
!NoDocumentSpecified - документ не найден
!FileMissing - файл отсутствует
!UnsupportedFormat - неподдерживаемый формат файла
!FileIsVeryLarge - файл слишком большого рамера, рамер не должен превышать 30MB
!FileNameExists - файл с таким именем уже существует