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

Добавление документа в процесс, метод: /api/document/add/

Параметры

Пример:

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 templateid integer Идентификатор шаблона документа Обязательное поле. Укажите идентификатор шаблона документов для создания документа.
4 orderid integer Идентификатор процесса Обязательное поле. Укажите идентификатор или внешний код процесса, для которого Вы хотите создать документ
5 ordercode integer Внешний код процесса Обязательное поле. Укажите идентификатор или внешний код процесса, для которого Вы хотите создать документ
6 name string название документа Не обязательное поле.  
7 clientview 1 / 0 Доступен к просмотру в кабинете клиента Не обязательное поле. Что бы документ был доступен для просмотра в кабинете клиента, укажите в этом поле 1
8 fileoriginal string Файл с оригиналом Не обязательное поле.  

Получение одного документа и получение всех документов, метод: /api/document/get/

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

Пример:

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

Поле Тип Описание Обязательное или нет Коментарий
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&part=1
http://myboxurl/api/document/get/?login=LOGIN&password=PASSWORD&part=2

Поле Тип Описание Обязательное или нет Коментарий
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/

Возможные варианты ответа на запрос

Подробнее
Статус Сообщение Описание сообщения
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, с помощью которого браузер осуществляет запрос веб-страницы
["OneBox production","SheBo","\u041a\u0422\u0421","Team Sales OneBox","OneBox CORP","\u0418\u043d\u0442\u0435\u0433\u0440\u0430\u0442\u043e\u0440","\u041a\u043e\u043c\u0430\u043d\u0434\u0430 \u0417\u0430\u0433\u0430\u0442\u043d\u043e\u0433\u043e \u041a\u0438\u0440\u0438\u043b\u043b\u0430","Yurchuk Sales Partner","VSI partner OneBox","OneBox Insiders","\u0424\u041e\u041f \u041f\u0435\u0442\u0440\u0435\u0447\u043a\u043e \u0412\u0430\u0441\u0438\u043b\u0438\u0439 \u0410\u043d\u0430\u0442\u043e\u043b\u044c\u0435\u0432\u0438\u0447","iCOLOR OneBox (\u0424\u041b\u041f \u041b\u0415\u0413\u0415\u0417\u0410 \u0412\u042f\u0427\u0415\u0421\u041b\u0410\u0412 \u0412\u0410\u041b\u0415\u0420\u0418\u0410\u041d\u041e\u0412\u0418\u0427) ","\u0424\u041b\u041f \u041c\u0438\u0440\u043e\u043d\u0435\u043d\u043a\u043e \u0414\u043c\u0438\u0442\u0440\u0438\u0439","AIRConstruct","Nspace","\u0424\u041e\u041f \u041f\u0435\u0440\u0435\u0433\u0438\u043d\u044f\u043a \u041e.\u041f.","\u041e\u043f\u0442\u0438\u0443\u043c","\u0424\u041e\u041f \u0421\u0438\u0434\u043e\u0440\u0447\u0443\u043a \u0412\u0430\u043b\u0435\u043d\u0442\u0438\u043d \u0413\u0430\u0440\u0438\u0435\u0432\u0438\u0447","AUTOMATA","TKB ","\u041a\u043e\u043d\u0441\u0430\u043b\u0442\u0438\u043d\u0433\u043e\u0432\u0430\u044f \u043a\u043e\u043c\u043f\u0430\u043d\u0438\u044f \"\u0411\u0418\u0422\"","\u0427\u0423\u0411\u0415\u041d\u041a\u041e \u041c\u0418\u0425\u0410\u0418\u041b","OneBox Sales GV","Didisoft ","\u0421\u0435\u0440\u0433\u0435\u0439 \u041c\u043e\u0440\u043e\u0437\u043e\u0432","\u0424\u041b\u041f \u0418\u0432\u0430\u043d\u043e\u0432\u0430 \u0418\u0440\u0438\u043d\u0430 \u0410\u043b\u0435\u043a\u0441\u0430\u043d\u0434\u0440\u043e\u0432\u043d\u0430","PM Digital Transformation","Aniart","\u0412\u0415\u041b\u0415\u0421 ","ProfiCRM","Intelco ","\u0410\u0441\u0442\u0435\u043b\u0438\u0442 \u0413\u0440\u0443\u043f\u043f","Prime Lab - CRM Agency","iPOST","Olmonic - \u0424\u041b\u041f \u041c\u041e\u0420\u041e\u0417\u041e\u0412\u0410 \u041e.\u041f.","\u041c\u0430\u0440\u0438\u044f , OneBox production #8","\u0423\u0441\u0442\u0438\u043c\u0435\u043d\u043a\u043e \u0418\u0433\u043e\u0440\u044c , OneBox production #9","Derkach Dmytriy , OneBox production #10","\u0427\u0438\u0436\u0438\u043a \u0410\u043b\u0435\u043a\u0441\u0430\u043d\u0434\u0440 \u0421\u0435\u0440\u0433\u0435\u0435\u0432\u0438\u0447 , OneBox production #20","\u0411\u043e\u043b\u043e\u0442\u044f\u043d \u042e\u0440\u0438\u0439 \u0410\u043b\u0435\u043a\u0441\u0430\u043d\u0434\u0440\u043e\u0432\u0438\u0447 , SheBo #21","\u0413\u0443\u0431\u043a\u043e \u0410\u043b\u0435\u043a\u0441\u0430\u043d\u0434\u0440 \u0421\u0435\u0440\u0433\u0435\u0435\u0432\u0438\u0447 , SheBo #23","\u041c\u0443\u043b\u0430\u0447 \u041c\u0430\u0440\u0438\u043d\u0430 \u0410\u043d\u0430\u0442\u043e\u043b\u044c\u0435\u0432\u043d\u0430 , SheBo #24","\u0411\u0443\u0448\u0443\u0435\u0432 \u0421\u0432\u044f\u0442\u043e\u0441\u043b\u0430\u0432 \u042e\u0440\u044c\u0435\u0432\u0438\u0447 , SheBo #25","\u0429\u0430\u0441\u043d\u0430\u044f \u0410\u043d\u0430\u0441\u0442\u0430\u0441\u0438\u044f \u041f\u0430\u0432\u043b\u043e\u0432\u043d\u0430 , SheBo #26","\u041a\u043e\u0440\u043e\u043f \u0412\u043b\u0430\u0434\u0438\u0441\u043b\u0430\u0432 \u041f\u0430\u0432\u043b\u043e\u0432\u0438\u0447 , \u041a\u0422\u0421 #28","\u0421\u0442\u0440\u0438\u043b\u0435\u0446 \u0410\u043d\u0442\u043e\u043d \u041d\u0438\u043a\u043e\u043b\u0430\u0435\u0432\u0438\u0447 , \u041a\u0422\u0421 #29","\u0412\u043e\u043d\u0430\u0440\u0445 \u0410\u0440\u0442\u0435\u043c , Team Sales OneBox #31","\u041c\u0430\u0442\u044e\u0448\u043a\u043e \u0414\u0435\u043d\u0438\u0441 , Team Sales OneBox #33","\u041c\u0430\u0440\u043a\u043e\u0432 \u0415\u0432\u0433\u0435\u043d\u0438\u0439 \u0418\u0433\u043e\u0440\u0435\u0432\u0438\u0447 , SheBo #34","\u041b\u0443\u0446 \u0411\u043e\u0433\u0434\u0430\u043d \u0410\u043b\u0435\u043a\u0441\u0430\u043d\u0434\u0440\u043e\u0432\u0438\u0447 , OneBox CORP #35","\u041a\u0440\u0430\u0441\u043a\u043e\u0432\u0441\u043a\u0438\u0439 \u0412\u043b\u0430\u0434\u0438\u0441\u043b\u0430\u0432 \u0421\u0435\u0440\u0433\u0435\u0435\u0432\u0438\u0447 , SheBo #37","\u0421\u0443\u0445\u0430\u043d\u0438\u0446\u043a\u0438\u0439 \u0410\u043d\u0434\u0440\u0435\u0439 , \u0418\u043d\u0442\u0435\u0433\u0440\u0430\u0442\u043e\u0440 #42","\u0417\u0430\u0433\u0430\u0442\u043d\u044b\u0439 \u041a\u0438\u0440\u0438\u043b\u043b , \u041a\u043e\u043c\u0430\u043d\u0434\u0430 \u0417\u0430\u0433\u0430\u0442\u043d\u043e\u0433\u043e \u041a\u0438\u0440\u0438\u043b\u043b\u0430 #56","\u041a\u043e\u0432\u0430\u043b\u044c\u0447\u0443\u043a \u0414\u0435\u043d\u0438\u0441 \u041b\u0435\u043e\u043d\u0438\u0434\u043e\u0432\u0438\u0447 , OneBox CORP #58","\u042e\u0440\u0447\u0443\u043a \u0412\u043b\u0430\u0434\u0438\u043c\u0438\u0440 , Yurchuk Sales Partner #61","\u0412\u0434\u043e\u0432\u0435\u043d\u043a\u043e \u0421\u0442\u0430\u043d\u0438\u0441\u043b\u0430\u0432 \u0418\u0433\u043e\u0440\u0435\u0432\u0438\u0447 , VSI partner OneBox #66","\u041f\u044f\u0442\u0435\u0446\u043a\u0438\u0439 \u041d\u0438\u043a\u043e\u043b\u0430\u0439 \u041d\u0438\u043a\u043e\u043b\u0430\u0435\u0432\u0438\u0447 , OneBox Insiders #77","anonymous duck , OneBox production #82","\u0422\u0438\u043c\u043e\u0448\u0435\u043d\u043a\u043e \u0415\u0432\u0433\u0435\u043d\u0438\u0439 , Team Sales OneBox #88","\u0422\u0430\u0441\u0443\u043d \u0421\u0435\u0440\u0433\u0435\u0439 \u0412\u043b\u0430\u0434\u0438\u043c\u0438\u0440\u043e\u0432\u0438\u0447 , OneBox production #132","\u041f\u0435\u0442\u0440\u0435\u0447\u043a\u043e \u0412\u0430\u0441\u0438\u043b\u0438\u0439 , \u0424\u041e\u041f \u041f\u0435\u0442\u0440\u0435\u0447\u043a\u043e \u0412\u0430\u0441\u0438\u043b\u0438\u0439 \u0410\u043d\u0430\u0442\u043e\u043b\u044c\u0435\u0432\u0438\u0447 #136","\u041b\u0435\u0433\u0435\u0437\u0430 \u0412\u044f\u0447\u0435\u0441\u043b\u0430\u0432 \u0412\u0430\u043b\u0435\u0440\u0438\u0430\u043d\u043e\u0432\u0438\u0447 , iCOLOR OneBox (\u0424\u041b\u041f \u041b\u0415\u0413\u0415\u0417\u0410 \u0412\u042f\u0427\u0415\u0421\u041b\u0410\u0412 \u0412\u0410\u041b\u0415\u0420\u0418\u0410\u041d\u041e\u0412\u0418\u0427) #145","\u041c\u0438\u0440\u043e\u043d\u0435\u043d\u043a\u043e \u0414\u043c\u0438\u0442\u0440\u0438\u0439 , \u0424\u041b\u041f \u041c\u0438\u0440\u043e\u043d\u0435\u043d\u043a\u043e \u0414\u043c\u0438\u0442\u0440\u0438\u0439 #180","\u0422\u044b\u043d\u0434\u044b\u043a \u041c\u0430\u043a\u0441\u0438\u043c \u0412\u0430\u0434\u0438\u043c\u043e\u0432\u0438\u0447 , OneBox production #200","\u0417\u0430\u043c\u043e\u0433\u0438\u043b\u044c\u043d\u044b\u0439 \u0414\u043c\u0438\u0442\u0440\u0438\u0439 , OneBox production #246","\u0414\u043c\u0438\u0442\u0440\u0438\u0439 , AIRConstruct #257","\u0421\u0430\u043b\u0430\u043c\u0430\u043d\u0434\u044b\u043a \u042e\u0440\u0438\u0439 , Nspace #318","\u041f\u0435\u0440\u0435\u0433\u0438\u043d\u044f\u043a \u0410\u043b\u0435\u043a\u0441\u0430\u043d\u0434\u0440 , \u0424\u041e\u041f \u041f\u0435\u0440\u0435\u0433\u0438\u043d\u044f\u043a \u041e.\u041f. #325","\u0417\u0443\u0431\u0430\u0440\u0435\u0432 \u0421\u0435\u0440\u0433\u0435\u0439 , \u041e\u043f\u0442\u0438\u0443\u043c #329","\u0421\u0443\u0441\u044f\u043a \u0406\u0433\u043e\u0440 , \u0418\u043d\u0442\u0435\u0433\u0440\u0430\u0442\u043e\u0440 #334","\u0421\u0438\u0434\u043e\u0440\u0447\u0443\u043a \u0412\u0430\u043b\u0435\u043d\u0442\u0438\u043d , \u0424\u041e\u041f \u0421\u0438\u0434\u043e\u0440\u0447\u0443\u043a \u0412\u0430\u043b\u0435\u043d\u0442\u0438\u043d \u0413\u0430\u0440\u0438\u0435\u0432\u0438\u0447 #341","\u0417\u0430\u0433\u0438\u0434\u0443\u043b\u0438\u043d \u041d\u0430\u0438\u043b\u044c \u041d\u0430\u0438\u043b\u044c\u0435\u0432\u0438\u0447 , AUTOMATA #429","\u0413\u0435\u043a\u0430\u043b\u043e \u041c\u0430\u043a\u0441\u0438\u043c \u0412\u043b\u0430\u0434\u0438\u043c\u0438\u0440\u043e\u0432\u0438\u0447 , Team Sales OneBox #434","\u0418\u0437\u044e\u043c\u043d\u0438\u043a\u043e\u0432\u0430 \u042e\u043b\u0438\u044f , TKB #487","integrator , \u0418\u043d\u0442\u0435\u0433\u0440\u0430\u0442\u043e\u0440 #527","\u0422\u0438\u043c\u043e\u0444\u0435\u0435\u0432 \u0410\u0440\u0442\u0435\u043c \u041e\u043b\u0435\u0433\u043e\u0432\u0438\u0447 , \u041a\u0422\u0421 #556","\u041f\u0430\u043d\u044c\u0448\u0438\u043d \u0421\u0435\u0440\u0433\u0435\u0439 \u0412\u043b\u0430\u0434\u0438\u043c\u0438\u0440\u043e\u0432\u0438\u0447 , \u041a\u043e\u043d\u0441\u0430\u043b\u0442\u0438\u043d\u0433\u043e\u0432\u0430\u044f \u043a\u043e\u043c\u043f\u0430\u043d\u0438\u044f \"\u0411\u0418\u0422\" #574","\u0427\u0443\u0431\u0435\u043d\u043a\u043e \u041c\u0438\u0445\u0430\u0438\u043b , \u0427\u0423\u0411\u0415\u041d\u041a\u041e \u041c\u0418\u0425\u0410\u0418\u041b #580","\u0413\u0440\u0438\u0448\u0438\u043d\u0430 \u0412\u0438\u043a\u0442\u043e\u0440\u0438\u044f \u0412\u0430\u0441\u0438\u043b\u044c\u0435\u0432\u043d\u0430 , OneBox Sales GV #642","Didisoft Dmitriy , Didisoft #826","\u041c\u043e\u0440\u043e\u0437\u043e\u0432 \u0421\u0435\u0440\u0433\u0435\u0439 \u0421\u0435\u0440\u0433\u0435\u0435\u0432\u0438\u0447 , \u0421\u0435\u0440\u0433\u0435\u0439 \u041c\u043e\u0440\u043e\u0437\u043e\u0432 #859","\u042e\u043b\u0438\u044f , TKB #1007","\u0418\u0432\u0430\u043d\u043e\u0432\u0430 \u0418\u0440\u0438\u043d\u0430 , \u0424\u041b\u041f \u0418\u0432\u0430\u043d\u043e\u0432\u0430 \u0418\u0440\u0438\u043d\u0430 \u0410\u043b\u0435\u043a\u0441\u0430\u043d\u0434\u0440\u043e\u0432\u043d\u0430 #1054","\u0410\u043d\u0434\u0440\u0435\u0439 , PM Digital Transformation #1149","\u0425\u043e\u043c\u0435\u043d\u043a\u043e \u0410\u043d\u043d\u0430 \u042e\u0440\u044c\u0435\u0432\u043d\u0430 , OneBox Sales GV #1233","\u042f\u0440\u0438\u043d\u0430 , \u0418\u043d\u0442\u0435\u0433\u0440\u0430\u0442\u043e\u0440 #1324","\u0424\u043e\u043c\u0438\u0447\u0435\u0432 \u0410\u043d\u0434\u0440\u0435\u0439 , Aniart #1704","\u0415\u043a\u0430\u0442\u0435\u0440\u0438\u043d\u0430 , \u0412\u0415\u041b\u0415\u0421 #1992","\u0415\u0432\u0433\u0435\u043d\u0438\u0439 , ProfiCRM #2045","\u0413\u0443\u0434 \u0415\u0432\u0433\u0435\u043d\u0438\u0439 , ProfiCRM #2059","\u0428\u0435\u0439\u043a\u043e \u0410\u043b\u0435\u043a\u0441\u0435\u0439 \u0418\u0433\u043e\u0440\u0435\u0432\u0438\u0447 , SheBo #2128","\u0414\u0430\u043d\u0430 \u041f\u043e\u0442\u044f\u0442\u0438\u043d\u043d\u0438\u043a , \u0418\u043d\u0442\u0435\u0433\u0440\u0430\u0442\u043e\u0440 #2245","\u0421\u043e\u043b\u043e\u043c\u0438\u044f , Intelco #2302","\u042e\u0440\u0438\u0439 \u041d\u0435\u0442\u0435\u0441\u0430\u043d\u044b\u0439 , \u0410\u0441\u0442\u0435\u043b\u0438\u0442 \u0413\u0440\u0443\u043f\u043f #8029","\u041a\u0430\u0441\u044c\u044f\u043d\u0435\u043d\u043a\u043e \u0417\u0430\u0445\u0430\u0440 , Prime Lab - CRM Agency #9596","\u041a\u043e\u0446\u044e\u0431\u0438\u043d\u0441\u043a\u0438\u0439 \u0420\u043e\u043c\u0430\u043d \u0410\u043b\u0435\u043a\u0441\u0430\u043d\u0434\u0440\u043e\u0432\u0438\u0447 , \u0410\u0441\u0442\u0435\u043b\u0438\u0442 \u0413\u0440\u0443\u043f\u043f #101336","\u041c\u0430\u0437\u0443\u0440 \u0412\u0438\u043a\u0442\u043e\u0440 \u0412\u0438\u043a\u0442\u043e\u0440\u043e\u0432\u0438\u0447 , SheBo #101348","\u0421\u0435\u0440\u0433\u0435\u0439 , iPOST #101485","\u0425\u0440\u043e\u043f\u0430\u0442\u044b\u0439 \u0414\u043c\u0438\u0442\u0440\u0438\u0439 , OneBox CORP #101701","\u041c\u043e\u0440\u043e\u0437\u043e\u0432\u0430 \u041e\u043b\u0435\u0441\u044f , Olmonic - \u0424\u041b\u041f \u041c\u041e\u0420\u041e\u0417\u041e\u0412\u0410 \u041e.\u041f. #101740","\u041f\u0430\u043d\u044c\u0448\u0438\u043d\u0430 \u0415\u043a\u0430\u0442\u0435\u0440\u0438\u043d\u0430 , OneBox CORP #101767","\u041f\u0438\u043a\u0443\u043b\u0430 \u0420\u0443\u0441\u043b\u0430\u043d \u0410\u043b\u0435\u043a\u0441\u0430\u043d\u0434\u0440\u043e\u0432\u0438\u0447 , OneBox Insiders #101833","\u0422\u0440\u0435\u0442\u044f\u043a \u0410\u0440\u0442\u0443\u0440 , OneBox Insiders #101852"]