API документов (Document)

Параметры получения одного документа:

№	Поле	Тип	Описание	Обязательное или нет	Коментарий
1	login	string	Логин в системе BOX	Обязательное поле.
2	password	string	Пароль в формате md5	Обязательное поле.	Напишите в техподдержку и мы выдадим вам hash для API
3	templateid	integer	Идентификатор шаблона документа	Обязательное поле.	Укажите идентификатор шаблона документов для создания документа.
4	orderid	integer	Идентификатор процесса	Обязательное поле.	Укажите идентификатор или внешний код процесса, для которого Вы хотите создать документ
5	ordercode	integer	Внешний код процесса	Обязательное поле.	Укажите идентификатор или внешний код процесса, для которого Вы хотите создать документ
6	name	string	Название документа	Не обязательное поле.
7	clientview	1 / 0	Доступен к просмотру в кабинете клиента	Не обязательное поле.	Что бы документ был доступен для просмотра в кабинете клиента, укажите в этом поле 1
8	fileoriginal	string	Файл с оригиналом	Не обязательное поле.

Пример:

http://myboxurl/api/document/add/?login=LOGIN&password=PASSWORD&ordercode=1&templateid=14&name=TEST

        и тд..

Параметры получения одного документа:

№	Поле	Тип	Описание	Обязательное или нет	Коментарий
1	login	string	Логин в системе BOX	Обязательное поле.
2	password	string	Пароль в формате md5	Обязательное поле.	Напишите в техподдержку и мы выдадим вам hash для API
3	documentid	string	Идентификатор документа	Обязательное поле.	Если вам нужен конкретный заказ то вы в это поле передаёте либо id документа или номер документа. Движок сам найдёт этот вёрнёт его. Значения возвращаемых полей id - id документа number - номер документа, name - название документа, contractorid - id юридического лица в системе BOX, contactorname - имя юридического лица, templateid - id шаблона документа, templatename - название шаблона документа, userid - id пользователя, создавшего документ, cdate - дата создания документа, sdate - дата отправки документа, bdate - дата получения документа обратно, adate - дата архивации документа, edate - дата изменения документа, fileoriginal - ссылка на файл оригинала, file - ссылка на скан-копию, content - содержимое документа в HTML, clientview - доступен для просмотра в личном кабинете, clientpay - доступен для оплаты в личном кабинете, sum - сумма документа, currencyid - id валюты документа, currencyname - название валюты документа, orderid - id процесса документа
4	clientinfo	boolean	Массив данных о клиенте процесса	Не обязательное поле.	В массив попадут все системные и дополнительные поля клиента процесса, в котором был создан документ, указанные в ответе запроса /api/contact-get/json/

Пример:

http://myboxurl/api/document/get/?login=LOGIN&password=PASSWORD&documentid=7927

Параметры получения всех документов:

№	Поле	Тип	Описание	Обязательное или нет	Коментарий
1	login	string	Логин в системе BOX	Обязательное поле.
2	password	string	Пароль в формате md5	Обязательное поле.	Напишите в техподдержку и мы выдадим вам hash для API
3	orderid	string	ID процесса	Не обязательное поле.	Укажите ID процесса, документы которого Вы хотите получить
4	templateid	string	ID шаблона документов	Не обязательное поле.	Укажите id шаблона документов, по которому отфильтровать документы.
5	cdate	date	Дата создания документа	Не обязательное поле.	Укажите дату создания и в итоговую выборку попадут только те документы, у которых дата создания больше или равно заданной
6	part	integer	Часть документов	Обязательное поле.	API выдаёт в 1й части до 1000 документов, чтобы получить следующие 1000 документов передайте туда 2 (получается часть 2) и тд. Значения возвращаемых полей id - id документа number - номер документа, name - название документа, contractorid - id юридического лица в системе BOX, contactorname - имя юридического лица, templateid - id шаблона документа, templatename - название шаблона документа, userid - id пользователя, создавшего документ, cdate - дата создания документа, sdate - дата отправки документа, bdate - дата получения документа обратно, adate - дата архивации документа, edate - дата изменения документа, fileoriginal - ссылка на файл оригинала, file - ссылка на скан-копию, content - содержимое документа в HTML, clientview - доступен для просмотра в личном кабинете, clientpay - доступен для оплаты в личном кабинете, sum - сумма документа, currencyid - id валюты документа, currencyname - название валюты документа, orderid - id процесса документа
7	clientinfo	boolean	Массив данных о клиенте процесса	Не обязательное поле.	В массив попадут все системные и дополнительные поля клиента процесса, в котором был создан документ, указанные в ответе запроса /api/contact-get/json/

Пример:

http://myboxurl/api/document/get/?login=LOGIN&password=PASSWORD&part=1

http://myboxurl/api/document/get/?login=LOGIN&password=PASSWORD&part=2

        и тд..

№	Статус	Сообщение	Описание сообщения
1	fail	login_empty	Отсутствует логин
2	fail	password_empty	Отсутствует пароль
3	fail	Bad user level!	Низкий уровень пользователя, для выполнения данного действия(нужен level 2 и выше)
4	fail	Login or password not correct!	Логин или пароль введены неверно

Также могут возникать ошибки:

502 Bad Gateway - Если возникла данная ошибка необходимо:
1. Проверить, имеется ли доступ к Интернету (зайти на любой другой сайт).
2. Если проблем с доступом нет — можно удалить файлы cookies.
Если указанное выше не помогло — проблема на стороне сервера. Следует обратиться к системному администратору сайта.

503 (Service Temporarily Unavailable) - данная ошибка может возникать в результате слишком большого количества запросов к серверу. Если вы увидели такую ошибку, стоит подождать пару минут и попробовать снова.

504 Gateway Timeout - cкорее всего дело в возросшей нагрузке на сайт, при которой Apache не успевает отдавать HTTP-ответы, и новые запросы встают в очередь. Чтобы решить проблему, можно добавить ресурсов серверу, в частности оперативной памяти, и увеличить количество процессов httpd (Apache).
Другая возможная причина возникновения ошибки 504 - исполняемый скрипт не укладывается в отведенный лимит времени. Это бывает, когда запрос слишком тяжелый. Попробуйте разбить свой запрос на несколько более маленьких.

Ошибка 505 HTTP Version not supported означает, что веб-сайт не поддерживает версию протокола HTTP, с помощью которого браузер осуществляет запрос веб-страницы.