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	Файл з оригіналом	Не обов'язкове поле.

Параметри отримання одного документа:

Приклад:

№	Поле	Тип	Опис	Обов'язкове чи ні	Коментар
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/

Параметри отримання всіх документів:

Приклад:

№	Поле	Тип	Опис	Обов'язкове чи ні	Коментар
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, за допомогою якого браузер здійснює запит веб-сторінки