Начать работу

7 (495) 252-70-42

8 (800) 222-49-42

24/7

ADL42

ADL42

ADL42 (ArchiveAndDocLoader) - это служба, которая автоматически выполняет предварительное распознавание документов и определение их реквизитов, а также позволяет хранить документы в электронном архиве.

Service

Позволяет запрашивать текущий статус сервиса


IsRunning

Проверка состояния сервера

GET
http://adl.42clouds.com/adl42/hs/api_v1/Service/isRunning

Ответ на запрос:

Sample:
<Result>
    <isRunning>true
    <ProtectedMode>false
</Result>
GetTableDataFound

Получение таблицы сделок и документов найденных с использованием указанных отборов

POST
http://adl.42clouds.com/adl42/hs/api_v1/Service/GetTableDataFound

XML тела запроса:

Sample:
  <   Request>
    < SearchSubstring>{SearchSubstring}<  /SearchSubstring>
    < BeginDate>{BeginDate}<  /BeginDate>
    < EndDate>{EndDate}<  /EndDate>
    < AccountDatabaseID>{AccountDatabaseID}<  /AccountDatabaseID>
    < UserID>{UserID}<  /UserID>
    < AccountID>{AccountID}<  /AccountID>
    < Status>{Status}<  /Status>
    < DocumentTypeList>{DocumentlType1;DocumentType2}<  /DocumentTypeList>
    < OrganizationList>{Organization1;Organization2}<  /OrganizationList>
    < ContractorList>{Contractor1;Contractor2}<  /ContractorList>
    < DocumentNumber>{DocumentNumber}<  /DocumentNumber>
    < CommentTextPart>{Text}<  /CommentTextPart>
    < Sum>{Sum}<  /Sum>
    < LinkFull>{LinkFull}</LinkFull>
    < BeginCreateData>{BeginCreateData}<  /BeginCreateData>
    < EndCreateData>{EndCreateData}</EndCreateData>
    < LinkDatabaseID >{LinkDatabaseID}</LinkDatabaseID>
    < RecognitionOld>{RecognitionOld}</RecognitionOld>
 <  /Request>

Ответ на запрос:

Sample:
<Result>
    <TableDataFound Type="Table">
        <Row>
            <DealID>6cbc15c9-240e-43a0-8951-0b7762cbbfc2
            <DocumentID/>
            <PageID/>
            <PageNumber/>
            <SourceFileName/>
            <SourceFileID/>
            <Organization/>
            <Contractor/>
            <DocumentType/>
            <Sum>0</Sum>
            <Status>0</Status>
            <DocumentNumber/>
            <DocumentDate/>
            <CreateData>2015-03-20T16:03:01+03:00</CreateData>
            <Comment/>
            <LinkID/>
            <LinkType/>
            <DocumentFileExtension/>
            <Emanating/>
            <Original/>
            <RecognitionType/>
            <RecognitionStatus/>
            <RecognitionOld/>
            <AccountOrganizationID>5824fba1-8472-474d-a9a3-111111111111
            <Received/>
        </Row>
        <Row>
            ….
            …
        </Row>
    </TableDataFound>
</Result>
СтрокаДанных.RecognitionType = ДокументСсылка.RecognitionType;
СтрокаДанных.RecognitionOld = ДокументСсылка.RecognitionOld;

Параметры службы:


Имя параметра

Тип параметра

Описание параметра

SearchSubstring

String

 

BeginDate

Date

Начальная дата документа

EndDate

Date

Конечная дата документа

AccountDatabaseID

String

Идентификатор базы аккаунта

UserID

String

Идентификатор пользователя

AccountID

String

Идентификатор аккаунта

Status

Numeric

Статус документа

DocumetTypeList

Array

Массив типов документа

OrganizationList

Array

Массив наименований организаций

ContractorList

Array

Массив наименований контрагентов

DocumentNumeber

String

Номер документа

CommentTextPart

String

Комментарий включает указаный текст

Sum

Numeric

Сумма документа

LinkFull

Boolean

 

BeginCreateData

Date

Начальная дата cоздания документа

EndCreateData

Date

Конечная дата создания документа

LinkDatabaseID

String

Идентификатор базы данных для поиска ссылки

RecognitionOld

Boolean

 

AccountUserIncomingFiles

Коллекция файлов очереди атрибутирования


Add

Добавление файла в очередь атрибутирования

POST
http://adl.42clouds.com/adl42/hs/api_v1/AccountUserIncomingFiles/Add

Параметры передаются в заголовке «Content-Disposition» :

Content-Disposition: attachment; UserID="4da0f6d6-2eb2-4ecb-a1f2-a77c5027f5ce"; FileName="Пример СчетФактура.xls"; UserPacketID="926c956c-7267-46d9-bfa2-a535ebac36c8"; LastFile="true"; UserAgent="ESDL1C"

Важно! Если в параметре FileName используются кирилические символы, то параметр с именем файла формируются из следующих блоков:

  1. Имя параметра (FileName),
  2. Символ «*» («звездочка»),
  3. Символ «=» («равно»),
  4. Указание кодировки (например: UTF-8),
  5. Символ «'» («одинарная кавычка»),
  6. Символ «'» (ещё одна «одинарная кавычка»),
  7. Кирилическое имя файла приведенное к формату URL (например: %d1%84%d0%b0%d0%b9%d0%b…).

Пример: FileName*= UTF-8 ' ' %d0%a4%d0%ba%d0%b0%d0%bc%d0%b8.jpg

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

UserID

String

Идентификатор пользователя

FileName

String

Оригинальное наименование файла

UserPacketID

String

Идентификатор пакета пользователя

LastFile

Boolean

Пометка последнего файла пакета

UserAgent

String

Имя агента, использовавшего запрос

BinaryData

BinaryData

Двоичные данные файла (передаются в теле запроса)

Ответ на запрос:

Sample:
<Result>
  <FileID>6f595452-a6ac-40c1-bca4-998603a5a786</FileID>
</Result>

DeleteFile

Удаление файла из очереди атрибутирования

POST
http://adl.42clouds.com/adl42/hs/api_v1/AccountUserIncomingFiles/DeleteFile

Параметры службы:

Имя параметра Тип параметра Описание параметра
FilelID String Идентификатор файла 

Sample:
     <Response>
    <FileID>6f595452-a6ac-40c1-bca4-998603a5a786</FileID>
  </Response>


Sample:
<Result/>


GetFileList

Получение списка идентификаторов файлов в очереди на распознавание

GET
http://adl.42clouds.com/adl42/hs/api_v1/AccountUserIncomingFiles/GetFileList?UserID={UserID}&BeginDate={BeginDate}&EndDate={EndDate}

Параметры службы:

Ответ на запрос:

Sample:
<Result>
        <ListFileID type="list">
            <item>b0ca87c2-3271-4f99-8034-a30352bde221</item>
            <item>e24fc5d9-28d1-4b78-8069-a7937f9e4b83</item>
        </ListFileID>
    </Result>

Имя параметра

Тип параметра

Описание параметра

UserID

String

Идентификатор пользователя

BeginDate

Date

Начальная дата

EndDate

Date

Конечная дата


GetCount

Получение количества файлов в очереди на распознавание

GET
http://adl.42clouds.com/adl42/hs/api_v1/AccountUserIncomingFiles/GetCount?UserID={UserID}&BeginDate={BeginDate}&EndDate={EndDate}&Status={Status}

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

UserID

String

Идентификатор пользователя

BeginDate

Date

Начальная дата

EndDate

Date

Конечная дата

Status

Numeric

Статус файла*

* Status:

0 - Новый

1 - Готов к распознаванию

2 - в обработке (отправлен на сервер распознавания)

3 - обработан (распознан)

4 - ошибочный (неверный тип, превышен размер и т.п.)

5 - отмененный (например не хватило лицензий для распознавания сделки)

6 - готов к атрибутированию

7 - поставлен в очередь для атрибутирования

8 - атрибутирован

9 - помещен в архив пользователя

application/xml, text/xml

Sample:
<Result>
        <Count>43</Count>
    </Result>


GetFileProperties

Получение свойства файла

GET
http://adl.42clouds.com/adl42/hs/api_v1/AccountUserIncomingFiles/GetFileProperties?FileID={FileID}

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

FileID

String

Идентификатор файла

Ответ на запрос:

GetFile

Получение количества файлов в очереди на распознавание

GET
http://adl.42clouds.com/adl42/hs/api_v1/AccountUserIncomingFiles/GetFileProperties?FileID={FileID}

Параметры службы:

Sample:
<Result>
        <UserID>56898366-dadf-4194-9302-2e0d20fa19e1</UserID>
        <Status>6</Status>
        <StatusComment>готов к атрибутированию
        <Size>17783</Size>
        <Placed>2014-11-21T16:53:16+04:00</Placed>
        <Type>TXT</Type>
        <FileName>Img00001.xls_12.txt</FileName>
          <Path>56898366-dadf-4194-9302-2e0d20fa19e1\e24fc5d9-28d1-4b78-8069- a7937f9e4b83.TXT</Path>
        </Result>


GetFile

Получение файла

GET
http://adl.42clouds.com/adl42/hs/api_v1/AccountUserIncomingFiles/GetFile?FileID={FileID}

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

FileID

String

Идентификатор файла

AccountDeals

Коллекция сделок (сделка – это пакет документов, относящихся к одной операции)


Add

Добавление сделки в коллекцию

POST
http://adl.42clouds.com/adl42/hs/api_v1/AccountDeals/Add

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

UserID

String

Идентификатор пользователя

AccountID

String

Идентификатор аккаунта

XML тела запроса:

Sample:
     <Request>
    <UserID>56898366-dadf-4194-9302-2e0d20fa19e1</UserID>
</Request>

Ответ на запрос:

Sample:
<Result>
    <DealID>5824fba1-8472-474d-a9a3-77255cb5c7da</DealID>
 </Result>


Delete

Удаление сделки из коллекции

POST
http://adl.42clouds.com/adl42/hs/api_v1/AccountDeals/Delete

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

DealID

String

Идентификатор сделки

XML тела запроса:

Sample:
<Request>
    <5824fba1-8472-474d-a9a3-77255cb5c7dalt;/DealID>

</Request>

Ответ на запрос:

Sample:
<Result/>

Find

Поиск идентификаторов документов по указанным свойствам

POST
http://adl.42clouds.com/adl42/hs/api_v1/AccountDocumentsDeals/Find

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

UserID

String

Идентификатор пользователя

AccountID

String

Идентификатор аккаунта

OrganizationList

Array

Массив наименований организаций

ContractorList

Array

Массив наименований контрагентов

Sum

Numeric

Сумма документа

Status

Numeric

Статус документа

CommentTextPart

String

Комментарий включает указаный текст

AccountOrganizationID

String

Идентификатор организации аккаунта

XML тела запроса:

Sample:
       <UserlID>{UserID}</UserlID>     <AccountID>{AccountID}</AccountID>  <BeginCreateData>{BeginCreateData}</BeginCreateData>    <EndCreateData>{EndCreateData}</EndCreateData>  <OrganizationList>{Organization1;Organization2}</OrganizationList>  <ContractorList>{Contractor1;Contractor2}</ContractorList>  <Sum>{Sum}</Sum>    <Status>{Status}</Status>   <CommentTextPart>{Text}</CommentTextPart>   <AccountOrganizationID>{AccountOrganizationID}</AccountOrganizationID> </Request>

Ответ на запрос:

Sample:
  <Result>
    <ListDealID type="list">
        <item>49d0c6c2-825a-493d-8759-9d5f022bbef4</item>
        <item>a4d57f55-8810-40d5-98fb-5c3776094f98</item>
    </ListDealID>
    </Result>

SetDealProperties

Установка свойств сделки

POST
http://adl.42clouds.com/adl42/hs/api_v1/AccountDeals/SetDealProperties

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

DealID

String

Идентификатор сделки

DealType

String

Тип сделки

Organization

String

Наименование организации

Contractor

String

Наименование контрагента

Sum

Numeric

Сумма сделки

Status

Numeric

Статус сделки

Comment

String

Комментарий

CreateData

Date

Дата создания сделки

AccountOrganizationID

String

Идентификатор организации аккаунта

XML тела запроса:

Sample:
<Request>
    <AccountOrganizationID>5824fba1-8472-474d-a9a3-111111111111</AccountOrganizationID>
    <AccountOrganizationID>5824fba1-8472-474d-a9a3-111111111111</AccountOrganizationID>
    <DealID>5824fba1-8472-474d-a9a3-77255cb5c7da</DealID>
    <DealName>NameOfDeal</DealName>
    <DealType>TypeOfDeal</DealType>
    <Organization>SomeOrganization</Organization>
    <Contractor>SomeContractor</Contractor>
    <Sum>42</Sum>
    <Status>0</Status>
    <Comment>SomeText</Comment>
</Request>

Ответ на запрос:

Sample:
<Result/>


GetlList

Получение списка сделок

GET
http://adl.42clouds.com/adl42/hs/api_v1/AccountDeals/GetCount?UserlID={UserID}&Status={Status}

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

UserID

String

Идентификатор пользователя

Status

Numeric

Статус сделки

Ответ на запрос:

Sample:
<Result>
    <ListDealID type="list">
        <item>49d0c6c2-825a-493d-8759-9d5f022bbef4</item>
        <item>a4d57f55-8810-40d5-98fb-5c3776094f98</item>
    </ListDealID>
    </Result>


GetDealProperties

Получение свойств сделки

GET
http://adl.42clouds.com/adl42/hs/api_v1/AccountDeals/GetDealProperties?DealID={DealID}

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

DealID

String

Идентификатор сделки

Ответ на запрос:

Sample:
  <Result>
    <AccountOrganizationID>5824fba1-8472-474d-a9a3-111111111111</AccountOrganizationID>
    <DealType>DealType</DealType>
    <Organization>Organization</Organization>
    <Contractor>Contractor</Contractor>
    <Sum>42</Sum>
    <Status>0</Status>
    <Comment>Comment</Comment>
    <CreateData>2014-12-11T16:46:19+04:00</CreateData>
</Result>

GetCount

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

GET
http://adl.42clouds.com/adl42/hs/api_v1/AccountDeals/GetCount?UserlID={UserID}&Status={Status}

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

UserID

String

Идентификатор пользователя

Status

Numeric

Статус сделки


Ответ на запрос:

Sample:
<Result>
    <Count>4</Count>
    </Result>

AccountDealsDocuments

Коллекция электронных документов сделок


Add

Добавление идентификатора электронного документа в коллекцию

POST
http://adl.42clouds.com/adl42/hs/api_v1/AccountDealsDocuments/Add

Параметры службы:

     Имя параметра

Тип параметра

Описание параметра

DealID

String

Идентификатор сделки

DocumentID

String

Идентификатор электронного документа 

Sample:
<Response>
    <DealID>49d0c6c2-825a-493d-8759-9d5f022bbef4</DealID>
    <DocumentID>a4d57f55-8810-40d5-98fb-5c3776094f98

Ответ на запрос:

Sample:
<Result />


Delete

Удаление идентификатора электронного документа из коллекции

POST
http://adl.42clouds.com/adl42/hs/api_v1/AccountDealsDocuments/Delete

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

DealID

String

Идентификатор сделки

DocumentID

String

Идентификатор электронного документа 

Sample:
<Response>
    <DealID>49d0c6c2-825a-493d-8759-9d5f022bbef4</DealID>
    <DocumentID>a4d57f55-8810-40d5-98fb-5c3776094f98</DocumentID>
</Response>

Ответ на запрос:

Sample:
<Result/>


Find

Поиск идентификаторов документов по указанным свойствам

GET
http://adl.42clouds.com/adl42/hs/api_v1/AccountDocumentsDeals/Find 

Sample:
     <Request>
     <UserlID>{UserID}</UserlID>
    <AccountID>{AccountID}</AccountID>
    <Status>{Status}</Status>
    <BeginDate>{BeginDate}</BeginDate>
    <EndDate>{EndDate}</EndDate>
    <DocumentTypeList>={DocumentlType1;DocumentType2}</DocumentTypeList>
    <OrganizationList>{Organization1;Organization2}</OrganizationList>
    <ContractorList>{Contractor1;Contractor2}</ContractorList>
    <Sum>{Sum}</Sum>
    <CommentTextPart>{Text}</CommentTextPart>
    <DocumentNumber>{DocumentNumber}</DocumentNumber>
    <InDeal>{InDeal}</InDeal>
    <BeginCreateData>{BeginCreateData}</BeginCreateData>
    <EndCreateData>{EndCreateData}</EndCreateData>
    <LinkDatabaseID >{LinkDatabaseID}</LinkDatabaseID>
    { AccountOrganizationID }</AccountOrganizationID> </Request>

Ответ на запрос:

Sample:
  <Result>
     <TableDocumentID type="table">
         <row>
             <DealID>a4d57f55-8810-40d5-98fb-5c3776094f98 </DealID>
             <DocumentID>303c1e0c-bd96-4e1c-9df1-d7f90c0d949b </DocumentID>
         </row>
         <row>
             <DealID>a4d57f55-8810-40d5-98fb-5c3776094f98 </DealID>
             <DocumentID>839cef0d-10a2-476e-a186-b2e0f505924f </DocumentID>
         </row>
     </TableDocumentID>
     </Result>

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

UserID

String

Идентификатор пользователя

AccountID

String

Идентификатор аккаунта

BeginDate

Date

Начальная дата документа

EndDate

Date

Конечная дата документа

DocumetTypeList

Array

Массив типов документа

OrganizationList

Array

Массив наименований организаций

ContractorList

Array

Массив наименований контрагентов

Sum

Numeric

Сумма документа

Status

Numeric

Статус документа

CommentTextPart

String

Комментарий включает указаный текст

DocumentNumeber

String

Номер документа

BeginCreateData

Date

Начальная дата cоздания документа

EndCreateData

Date

Конечная дата создания документа

LinkDatabaseID

String

Идентификатор базы данных для поиска ссылки

AccountOrganizationID

String

Идентификатор организации аккаунта


GetlList

Получение списка идентификатора сделок

GET
http://adl.42clouds.com/adl42/hs/api_v1/AccountDealsDocuments/GetList?DeallID={DealID}

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

DealID

String

Идентификатор сделки

Ответ на запрос:

Sample:
  <Result>
    <ListDocumentID type="list">
        <item>303c1e0c-bd96-4e1c-9df1-d7f90c0d949b</item>
        <item>839cef0d-10a2-476e-a186-b2e0f505924f</item>
    </ListDocumentID>
    </Result>


GetTable

Получение таблицы документов сделки

GET
http://adl.42clouds.com/adl42/hs/api_v1/AccountDealsDocuments/GetTable?DeallID={DealID}&LinkDatabaseID={LinkDatabaseID}

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

DealID

String

Идентификатор сделки

LinkDatabaseID

String

Идентификатор базы данных

Ответ на запрос:

Sample:
  <Result>
      <TableDocumentID type="table">
          <row>
              <DealID>{DealID}</DealID>
              <LinkID>{LinkID}</LinkID>
              <LinkType>{LinkType}</LinkType>
          </row>
      </TableDocumentID>
      </Result>


AccountEDocuments

Коллекция электронных документов


Add

Добавление электронного документа в коллекцию

POST
http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocuments/Add

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

DealID

String

Идентификатор сделки

XML тела запроса:

Sample:
<Request>
    <UserID>56898366-dadf-4194-9302-2e0d20fa19e1</UserID>
</Request>

Ответ на запрос:

Sample:
  <Result>
    <DocumentID>4bbdccf0-60f4-4214-9379-57c48142cffa</DocumentID>
</Result>


Delete

Удаление электронного документа из коллекции

POST
http://adl42.42clouds.com/adl42/hs/api_v1/AccountEDocuments/Delete

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

DocumentID

String

Идентификатор электронного документа

XML тела запроса:

Sample:
<Requesr>
    <DocumentID>56898366-dadf-4194-9302-2e0d20fa19e1</DocumentID>
</Request>

Ответ на запрос:

Sample:
<Result/>


RepeatRecognition

Повторное распознавание документа по указанному шаблону

POST
http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocuments/RepeatRecognition

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

DocumentID

String

Идентификатор электронного документа

TemplateName

String

Имя шаблона

XML тела запроса:

Sample:
  <Request>
    <DocumentID>56898366-dadf-4194-9302-2e0d20fa19e1</DocumentID>
    <TemplateName>СФ</TemplateName>
</Request>

Ответ на запрос:

Sample:

</Result>

CheckRecognition

Отправка документа на диагностику

GET
http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocuments/CheckRecognition}

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

DocumentIDList

String

Массив идентификаторов документов

Comment

String

Комментарий

email

String

E-mail получателя ответа от сервиса

XTML тела запроса:

Sample:
  <Request>
      <DocumentIDList>   </DocumentID>
      <Comment>   </Comment>
      <email>   </email>
  </Request>

Ответ на запрос:

Sample:
  </Result>


Find

Поиск документа по указанным свойствам

GET
http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocuments/Find

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

UserID

String

Идентификатор пользователя

AccountID

String

Идентификатор аккаунта

BeginDate

Date

Начальная дата документа

EndDate

Date

Конечная дата документа

DocumetTypeList

Array

Массив типов документа

OrganizationList

Array

Массив наименований организаций

ContractorList

Array

Массив наименований контрагентов

Sum

Numeric

Сумма документа

Status

Numeric

Статус документа

CommentTextPart

String

Комментарий включает указаный текст

DocumentNumeber

String

Номер документа

AccountOrganizationID

String

Идентификатор базы данных

InDeal

Boolean

Признак вхождения документа в сделку

BeginCreateData

Date

Начальная дата cоздания документа

EndCreateData

Date

Конечная дата создания документа

LinkDatabaseID

String

Идентификатор базы данных для поиска ссылки

XML тела запроса:

Sample:
<Request>
    <UserID>{UserID}</UserID>
    <AccountID>{AccountID}</AccountID>
    <Status>{Status}</Status>
    <BeginDate>{BeginDate}</BeginDate>
    <EndDate>{EndDate}</EndDate>
    <DocumentTypeList>{DocumentlType1;DocumentType2}</DocumentTypeList>
    <OrganizationList>{Organization1;Organization2}</OrganizationList>
    <ContractorList>{Contractor1;Contractor2}</ContractorList>
    <Sum>{Sum}
    <CommentTextPart>{Text}</CommentTextPart>
    <DocumentNumber>{DocumentNumber}</DocumentNumber>
    <InDeal>{InDeal}</InDeal>
    <AccountOrganizationID>{AccountOrganizationID}</AccountOrganizationID>
    <BeginCreateData>{BeginCreateData}</BeginCreateData>
    <EndCreateData>{EndCreateData}</EndCreateData>
    <LinkDatabaseID >{LinkDatabaseID}</LinkDatabaseID>
</Request>

Ответ на запрос:

Sample:
             <Result>
    <ListDocumentID type="list">
        <item>ff3d48c5-bb6e-47eb-8073-d28705d69779</item>
        <item>b208cfd8-6c23-41b9-858c-b10cfb172e11</item>
    </ListDocumentID>
    </Result>

SetDocumentProperties

Установка свойств документа

POST
http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocuments/SetDocumentProperties

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

DocumentID

String

Идентификатор документа

DocumentDate

Date

Дата документа

DocumetType

String

Тип документа

Organization

String

Наименование организации

Contractor

String

Наименование контрагента

Sum

Numeric

Сумма документа

Status

Numeric

Статус документа

Comment

String

Комментарий включает указаный текст

DocumentNumber

String

Номер документа

LinkID

String

Идентификатор ссылки в учетной системе

AccountOrganizationID

String

Идентификатор базы данных

Received

Boolean

Пометка возврата документа

RecognitionID

String

Идентификатор файла службы Recognition

Emanating

Boolean

Пометка исходящего документа

Original

Boolean

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

RecognitionType

String

Наложенный шаблон распознавания

XML тела запроса:

Sample:
  <Request>
    <AccountOrganizationID>5824fba1-8472-474d-a9a3-111111111111</AccountOrganizationID>
    <DocumentID>6f595452-a6ac-40c1-bca4-998603a5a786</DocumentID>
    <DocumentDate>2014-12-31T23:59:59+04:00</DocumentDate>
    <DocumentType>TypeOfDocument</DocumentType>
    <Organization>SomeOrganization</Organization>
    <Contractor>SomeContractor</Contractor>
    <Sum>42.24</Sum>
    <Status>0
    <Comment>SomeText</Comment>
    <DocumentNumber>1</DocumentNumber>
    <Received>true</Received>
    <RecognitionID>12345678-a6ac-40c1-bca4-998603a5a786</RecognitionID>
    <Emanating>true</Emanating>
    <Original>true</Original>
    <RecognitionType>Text</RecognitionType>
</Request>

Ответ на запрос:

Sample:

</Result>

SaveDocumentXML

Сохранение xml файла документа

POST
http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocuments/SaveDocumentXML

Параметры передаются в заголовке «Content-Disposition» : Content-Disposition: attachment; DocumentID=”b0ca87c2-3271-4f99-8034-a30352bde221”

Параметры запроса:

Имя параметра

Тип параметра

Описание параметра

DocumentID

String

Идентификатор документа

BinaryData

BinaryData

Двоичные данные файла (передаются в теле запроса)

Ответ на запрос:

Sample:
<Result/>


SaveDocumentFile

Сохранение оригинального файла документа

POST
http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocuments/SaveDocumentFile

Параметры передаются в заголовке «Content-Disposition» :
Content-Disposition: attachment; DocumentID=”b0ca87c2-3271-4f99-8034-a30352bde221”

Имя параметра

Тип параметра

Описание параметра

DocumentID

String

Идентификатор документа

BinaryData

BinaryData

Двоичные данные файла (передаются в теле запроса)

Ответ на запрос:

Sample:
<Result/>

ü GetlList

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

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocuments/GetList?UserID={UserID}

Ответ на запрос:

  <Result>

       <ListDocumentID type="list">

              <item>ff3d48c5-bb6e-47eb-8073-d28705d69779</item>

              <item>b208cfd8-6c23-41b9-858c-b10cfb172e11</item>

       </ListDocumentID>   

    </Result>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

UserID

String

Идентификатор пользователя

 

ü GetListByFileID

Получение списка электронных документов по ИД файла

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocuments/ GetListByFileID?UserID={UserID}& FileID={ FileID}

Ответ на запрос:

  <Result>

       <ListDocumentID type="list">

              <item>ff3d48c5-bb6e-47eb-8073-d28705d69779</item>

              <item>b208cfd8-6c23-41b9-858c-b10cfb172e11</item>

       </ListDocumentID>   

    </Result>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

UserID

String

Идентификатор пользователя

FileID

String

Идентификатор файла

 

ü GetDocumentProperties

Получение свойств документа

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocuments/GetDocumentProperties?DocumentID={DocumentID}

Ответ на запрос:

<Result>

<DocumentID>{DocumentID}</DocumentID>

<Organization>{Organization}</Organization>

<Contractor>{Contractor}</Contractor>

<AccountDatabaseID>{AccountDatabaseID}</AccountDatabaseID>

<AccountOrganizationID>{AccountOrganizationID}</AccountOrganizationID>

<Sum>{Sum}</Sum>

<Status>{Status}</Status>

<DocumentDate>{DocumentDate}</DocumentDate>

<DocumentNumber>{DocumentNumber}</DocumentNumber>

<CreateData>{CreateData}</CreateData>

<DocumentType>{DocumentType}</DocumentType >

<DocumentFileExtension>{DocumentFileExtension}</DocumentFileExtension>

<InDeal>{InDeal}</InDeal>

<Original>{Original}</Original>

<Emanating>{Emanating}</Emanating>

<Comment>{Comment}</Comment>

<Received>{Received}</Received>

<RecognitionType>{RecognitionType}</RecognitionType>

<RecognitionOld>{RecognitionOld}</RecognitionOld>

<RecognitionStatus>{RecognitionStatus}</RecognitionStatus>

<DealID>{DealID}</DealID>

<DocumenеtTitle>{DocumenеtTitle}</DocumenеtTitle>

<DocumentFieldsTable Type="Table">

<Row>

<Name>DocumenеtTitle</Name>

<Synonym>Наименование документа</Synonym>

<ReadOnly>true</ReadOnly>

<Type>string</Type>

<Required>false</Required>

<Visible>true</Visible>

<Value>Сч.Ф вх №083/7652624 от 19.08.2010</Value>

</Row>

…

<Row>

<Name>{Name N}</Name>

<Synonym>{Synonym N}</Synonym>

<ReadOnly>{ReadOnly}</ReadOnly>

<Type> Type N}</Type>

<Required>{Required}</Required>

<Visible>{Visible N}</Visible>

<Value>>{Value N}</Value>

</Row>

</Result>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

DocumentID

String

Идентификатор электронного документа

 

ü GetCount

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

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocuments/GetCount?UserlID={UserID}&Status={Status}

Ответ на запрос:

  <Result>

       <Count>11</Count>

    </Result>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

UserID

String

Идентификатор пользователя

Status

Numeric

Статус сделки

 

ü GetFirstDateForOrganization

Получение даты первого документа по организации

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocuments/ GetFirstDateForOrganization?AccountOrganizationID={AccountOrganizationID}

Ответ на запрос:

  <Result>

       < FirstDate>Date</Count>

    </Result>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

UserID

String

Идентификатор пользователя

Status

Numeric

Статус сделки

 

ü GetDocumentXML

Получение xml файла  документа

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocuments/GetDocumentXML?DocumentID={DocumentID}

Ответ на запрос:  xml c результатом распознавания (BinaryData)

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

DocumentID

String

Идентификатор документа

 

ü GetDocumentFile

Получение ориганального файла  документа

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocuments/GetDocumentFile?DocumentID={DocumentID}

Ответ на запрос:  файл документа (BinaryData)

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

DocumentID

String

Идентификатор документа

 


AccountEDocumentPages

Коллекция страниц электронного документа

ü Move

Перенос  страницы в электронный документ

POST

http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocumentPages/Move

<Request>

     <DocumentID>{DocumentID}</DocumentID>

     <PageID>{PageID}</PageID>

     <Number>{Number}</Number>

</Request>

Ответ на запрос:

  <Result/>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

DocumentID

String

Идентификатор документа

PageID

String

Идентификатор страницы

Number

Numeric

Порядковый номер страницы

 

ü Delete

Удаление страницы из  электронного документа

POST

http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocumentPages/Delete

XML тела запроса:

<Request>

     <DocumentID>b0ca87c2-3271-4f99-8034-a30352bde221</DocumentID>

     <PageID>e24fc5d9-28d1-4b78-8069-a7937f9e4b83</PageID>

</Request>

Ответ на запрос:

  <Result/>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

DocumentID

String

Идентификатор документа

PageID

String

Идентификатор страницы

 

  SetPageProperties

Установить свойства страницы

POST

http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocumentPages/SetPageProperties

XML тела запроса:

<Request>

     <PageID>6f595452-a6ac-40c1-bca4-998603a5a786</PageID>

     <Number>1</Number>

</Request>

Ответ на запрос:

  <Result/>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

PageID

String

Идентификатор страницы

Number

Numeric

Порядковый номер страницы

 

ü GetList

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

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocumentPages/GetList?DocumentID={DocumentID}

Ответ на запрос:

  <Result>

       <ListPageID type="list">

              <item>d4757687-b0b4-4154-a9bc-db55bdaedf1c</item>

       </ListPageID>

    </Result>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

DocumentID

String

Идентификатор документа

 

ü GetPagePreview

Получение уменьшенного изображения страницы

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocumentPages/GetPagePreview?PageID={PageID}

Ответ на запрос: Двоичные данные файла-превью

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

PageID

String

Идентификатор страницы

 

ü GetPage

Получение изображения страницы

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocumentPages/GetPage?PageID={PageID}

Ответ на запрос: Двоичные данные файла страницы

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

PageID

String

Идентификатор страницы


AccountEDocumentLinks

Коллекция ссылок на учетные системы электронного документа

ü Add

Добавление ссылки (связи с УС) в электронный документ

POST

http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocumentLinks/Add

XML тела запроса:

<Request>

     <DocumentID>{DocumentID}</DocumentID>

     <LinkID>{LinkID}</LinkID>

     <LinkType>{LinkType}</LinkType>

     <LinkDate>{LinkDate}</LinkDate>

     <LinkDatabaseID>{LinkDatabaseID}</LinkDatabaseID>

</Request>

Ответ на запрос:

  <Result/>

 

Имя параметра

Тип параметра

Описание параметра

DocumentID

String

Идентификатор документа

LinkID

String

Идентификатор ссылки

LinkType

String

Тип ссылки в УС

LinkDate

Date

Дата создания связи

LinkDatabaseID

String

Идентификатор учетной системы

 

ü Delete

Удаление ссылки

POST

http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocumentLinks/Delete

XML тела запроса:

<Request>

     <DocumentID>{DocumentID}</DocumentID>

     <LinkID>{LinkID}</LinkID>

</Request>

Ответ на запрос:

  <Result/>

 

Имя параметра

Тип параметра

Описание параметра

DocumentID

String

Идентификатор документа

LinkID

String

Идентификатор ссылки

 

ü Find

Поиск ссылки для УС

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocumentLinks/Find?DocumentID={DocumentID}& LinkDatabaseID ={LinkDatabaseID}

 

Ответ на запрос:

<Result>

     <LinkID>{LinkID}</LinkID>

</Result>

 

Имя параметра

Тип параметра

Описание параметра

DocumentID

String

Идентификатор документа

LinkDatabaseID

String

Идентификатор учетной системы

 

ü GetProperties

Получение свойств  ссылки

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccountEDocumentLinks/GetProperties?LinkID={LinkID}

 

Ответ на запрос:

<Result>

     <DocumentID>{DocumentID}</DocumentID>

     <LinkType>{LinkType}</LinkType>

     <LinkDate>{LinkDate}</LinkDate>

     <LinkDatabaseID>{LinkDatabaseID}</LinkDatabaseID>

</Result>

 

Имя параметра

Тип параметра

Описание параметра

LinkID

String

Идентификатор ссылки

 

EDocumentsTypes

Коллекция типов электронных документов

ü GetList

Получить список типов эл. документов

GET

http://adl.42clouds.com/adl42/hs/api_v1/EDocumentsTypes/GetList

 

Ответ на запрос:

<Result>

<ListDocumentType Type="Table">

<Row>

<DocumentTypeName>{DocumentTypeName1}</DocumentTypeName>

<DocumentTypeGroupName>{DocumentTypeGroupName1}</DocumentTypeGroupName>

</Row>

…

<Row>

<DocumentTypeName>{DocumentTypeNameN}</DocumentTypeName>

<DocumentTypeGroupName>{DocumentTypeGroupNameN}</DocumentTypeGroupName>

</Row>

</ListDocumentType>

</Result>

EDocumentTypeFields

Коллекция описаний полей для типов электронных документов

GetTableFieldsProperties

Получить описание атрибутов для типа документа

POST
http://adl.42clouds.com/adl42/hs/api_v1/EDocumentTypeFields/GetTableFieldsProperties?DocumentTypeName={ DocumentTypeName }

XML тела запроса:

Sample:
   <Result>
    <TableFieldsProperties Type="Table">
<Row>
<Name>DocumenеtTitle</Name>
<Synonym>Наименование документа</Synonym>
<ReadOnly>true</ReadOnly>
<Type>string</Type>
<Required>false</Required>
<Visible>true</Visible>
</Row>
…
<Row>
<Name>{Name N}</Name>
<Synonym>{Synonym N}</Synonym>
<ReadOnly>{ReadOnly}</ReadOnly>
<Type> Type N}</Type>
<Required>{Required}</Required>
<Visible>{Visible N}</Visible>
</Row>
    </TableFieldsProperties>
</Result>

AccountOrganizations

Коллекция организаций аккаунта

Add

Добавление новой организации аккаунта

POST
http://adl.42clouds.com/adl42/hs/api_v1/AccountOrganizations/Add

XML тела запроса:

Sample:
<Request>
    <OrganizationName>{OrganizationName}</OrganizationName>
    <OrganizationINN>{OrganizationINN}</OrganizationINN>
    <OrganizationKPP>{OrganizationKPP}</OrganizationKPP>
</Request>

Ответ на запрос:

Sample:

<Result>
    < AccountOrganizationID>{AccountOrganizationID}</AccountOrganizationID>
</Result>

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

OrganizationName

String

Наименование организации

OrganizationINN

String

ИНН организации

OrganizationKPP

String

КПП организации

Delete

Удаление организации аккаунта

POST
http://adl.42clouds.com/adl42/hs/api_v1/AccountOrganizations/Delete

XML тела запроса:

Sample:


<Request>
    < AccountOrganizationID>{AccountOrganizationID}</AccountOrganizationID>
</Request>

Ответ на запрос:

Sample:
<Result/>

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

AccountOrganizationID

String

Идентификатор организации аккаунта


SetAccountOrganizationProperties

Установка свойств организации

POST
http://adl.42clouds.com/adl42/hs/api_v1/AccountOrganizations/SetAccountOrganizationProperties

XML тела запроса:

Sample:

<Request>
    < AccountOrganizationID>{AccountOrganizationID}</AccountOrganizationID>
    <OrganizationName>{OrganizationName}</OrganizationName>
</Request>

Ответ на запрос:

Sample:



<Result/>

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

AccountOrganizationID

String

Идентификатор организации аккаунта

OrganizationName

String

Наименование организации


GetList

Получение списка организаций аккаунта

GET

Ответ на запрос:

Sample:
<Result>
    <ListAccountOrganizationID type="list">
        <item>{AccountOrganizationID1}</item>
        <item>{AccountOrganizationID2}</item>
        …
        <item>{AccountOrganizationIDN}</item>
    </ListAccountOrganizationID>
    </Result>

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

AccountID

String

Идентификатор аккаунта


ü GetTable

Получение таблицы организаций аккаунта со свойствами

GET

ü http://adl.42clouds.com/adl42/hs/api_v1/AccountOrganizations/GetTable?AccountID={AccountID}

Ответ на запрос:

<Result>

     <TableAccOrgAccess Type="Table">

<Row>

<AccountOrganizationID>{AccountOrganizationID}</AccountOrganizationID>

<OrganizationName>{OrganizationName}</OrganizationName>

<OrganizationINN>{OrganizationINN}</OrganizationINN>

<OrganizationKPP>{OrganizationKPP}</OrganizationKPP>

</Row>

<Row>

…

</Row>

     </TableAccOrgAccess>

</Result>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

AccountID

String

Идентификатор аккаунта

 

ü GetAccountOrganizationProperties

Получение свойств организации аккаунта

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccountOrganizations/ GetAccountOrganizationProperties?AccountOrganizationID={AccountOrganizationID}

Ответ на запрос:

  <Result>

     <OrganizationName>{OrganizationName}</OrganizationName>

     <OrganizationINN>{OrganizationINN}</OrganizationINN>

     <OrganizationKPP>{OrganizationKPP}</OrganizationKPP>

    </Result>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

AccountOrganizationID

String

Идентификатор организации аккаунта

AccOrgAccess

Коллекция доступов к организацям аккаунта

ü Add

Добавление нового доступа к организации аккаунта

POST

http://adl.42clouds.com/adl42/hs/api_v1/AccOrgAccess/Add

XML тела запроса:

<Request>

     < AccountOrganizationID>{AccountOrganizationID}</AccountOrganizationID>

     <UserID>{UserID}</UserID>

</Request>

Ответ на запрос:

<Result>

     <AccOrgAccesID>{AccOrgAccesID}</AccOrgAccesID>

</Result>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

AccountOrganizationID

String

Идентификатор организации аккаунта

UserID

String

Идентификатор пользователя

 

ü Delete

Удаление доступа к организации аккаунта

POST

http://adl.42clouds.com/adl42/hs/api_v1/AccOrgAccess/Delete

XML тела запроса:

<Request>

     <AccOrgAccesID>{AccOrgAccesID}</AccOrgAccesID>

</Request>

Ответ на запрос:

<Result/>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

AccOrgAccesID

String

Идентификатор доступа к организации аккаунта

 

ü GetListByUserID

Получение списка доступов к организациям аккаунта по ИД пользователя

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccOrgAccess/GetListByUserID?UserID={UserID}

Ответ на запрос:

  <Result>

       <ListAccOrgAccesID type="list">

              <item>{AccOrgAccesID1}</item>

              <item>{AccOrgAccesID2}</item>

              …

               <item>{AccOrgAccesIDN}</item>

       </ListAccOrgAccesID>

    </Result>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

UserID

String

Идентификатор пользователя

 

ü GetTableByAccountOrganizationID

Получение таблицы доступов к организации аккаунта по ИД организации

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccOrgAccess/GetTableByAccountOrganizationID?AccountOrganizationID={AccountOrganizationID}

Ответ на запрос:

<Result>

  <TableAccOrgAccess Type="Table">

<Row>

<AccOrgAccesID>{AccOrgAccesID}</AccOrgAccesID>

<AccountOrganizationID>{AccountOrganizationID}</AccountOrganizationID>

<OrganizationName>{OrganizationName}</OrganizationName>

<OrganizationINN>{OrganizationINN}</OrganizationINN>

<OrganizationKPP>{OrganizationKPP}</OrganizationKPP>

<UserID>{UserID}</UserID>

<IdOfUserAccount>{IdOfUserAccount}</IdOfUserAccount>

<CaptionOfUserAccount>{CaptionOfUserAccount}</CaptionOfUserAccount>

<UserFullName>{UserFullName}</UserFullName>

<UserEmail>{UserEmail}</UserEmail>

</Row>

<Row>

…

</Row>

  </TableAccOrgAccess>

</Result>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

AccountOrganizationID

String

Идентификатор организации

 

ü GetTableByUserID

Получение таблицы доступов к организациям аккаунта по ИД пользователя

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccOrgAccess/GetTableByUserID?UserID={UserID}

Ответ на запрос:

<Result>

  <TableAccOrgAccess Type="Table">

<Row>

<AccOrgAccesID>{AccOrgAccesID}</AccOrgAccesID>

<AccountOrganizationID>{AccountOrganizationID}</AccountOrganizationID>

<OrganizationName>{OrganizationName}</OrganizationName>

<OrganizationINN>{OrganizationINN}</OrganizationINN>

<OrganizationKPP>{OrganizationKPP}</OrganizationKPP>

<UserID>{UserID}</UserID>

<IdOfUserAccount>{IdOfUserAccount}</IdOfUserAccount>

<OrganizationAccountID>{OrganizationAccountID}</OrganizationAccountID>

<OrganizationAccountCaption>{OrganizationAccountCaption}</OrganizationAccountCaption>

</Row>

<Row>

…

</Row>

  </TableAccOrgAccess>

</Result>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

UserID

String

Идентификатор пользователя

 

ü GetTableByAccountID

Получение таблицы доступов к организациям пользователей аккаунта

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccOrgAccess/GetTableByAccountID?AccountID={AccountID}

Ответ на запрос:

<Result>

  <TableAccOrgAccess Type="Table">

<Row>

<AccOrgAccesID>{AccOrgAccesID}</AccOrgAccesID>

<AccountOrganizationID>{AccountOrganizationID}</AccountOrganizationID>

<OrganizationName>{OrganizationName}</OrganizationName>

<OrganizationINN>{OrganizationINN}</OrganizationINN>

<OrganizationKPP>{OrganizationKPP}</OrganizationKPP>

<UserID>{UserID}</UserID>

<IdOfUserAccount>{IdOfUserAccount}</IdOfUserAccount>

<OrganizationAccountID>{OrganizationAccountID}</OrganizationAccountID>

<OrganizationAccountCaption>{OrganizationAccountCaption}</OrganizationAccountCaption>

</Row>

<Row>

…

</Row>

  </TableAccOrgAccess>

</Result>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

AccountID

String

Идентификатор аккаунта

 

ü GetAccOrgAccesProperties

Получение свойств  доступа к организации аккаунта

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccOrgAccess/GetAccOrgAccesProperties?AccOrgAccesID={AccOrgAccesID}

Ответ на запрос:

<Result>

<AccountOrganizationID>{AccountOrganizationID}</AccountOrganizationID>

<IdOfUserAccount>{IdOfUserAccount}</IdOfUserAccount>

<UserID>{UserID}</UserID>

<AccountCaption>{AccountCaption}</AccountCaption>

<UserFullName>{UserFullName}</UserFullName>

</Result>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

AccOrgAccesID

String

Идентификатор доступа к организации аккаунта

AcUserAccess

Коллекция доступов к документам пользователя

Add

Добавление доступа пользователю

POST

http://adl.42clouds.com/adl42/hs/api_v1/AcUserAccess/Add

XML тела запроса:

<Request>

     <AccesForUserID>{AccesForUserID}</AccesForUserID>

     <AccessByAccount>{AccessByAccount}</AccessByAccount>

</Request>

Ответ на запрос:

<Result>

     <AcUserAccesID>{AcUserAccesID}</AcUserAccesID>

</Result>

 

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

AccesForUserID

String

Идентификатор пользователя аккаунта

AccessByAccount

Boolean

Признак доступности всем пользователям аккаунта

 

Delete

Удаление доступа пользователю

POST

http://adl.42clouds.com/adl42/hs/api_v1/AcUserAccess/Delete

XML тела запроса:

<Request>

     <UserAccesID>{UserAccesID}</UserAccesID>

</Request>

Ответ на запрос:

<Result/>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

UserAccesID

String

Идентификатор доступа пользователя

 

GetListIDsAvailable

Получение списка ИД доступных пользователей аккаунта

GET

http://adl.42clouds.com/adl42/hs/api_v1/AcUserAccess/GetListIDsAvailable

Ответ на запрос:

<Result>

    <ListIDsAvailable Type="list">

<UserID>{UserID 1}</UserID>

<UserID>{UserID 2}</UserID>

…

<UserID>{UserID N}</UserID>

</ListIDsAvailable>

</Result>

 

ü GetTable

Получение таблицы доступов  пользователя

GET

http://adl.42clouds.com/adl42/hs/api_v1/AcUserAccess/GetTable

 

Ответ на запрос:

<Result>

     <TableAcUserAccess Type="Table">

<Row>

<UserAccesID>{UserAccesID}</UserAccesID>

<UserID>{UserID}</UserID>

<AccesForUserID>{AccesForUserID}</AccesForUserID>

<AccessByAccount>{AccessByAccount}</AccessByAccount>

</Row>

<Row>

…

</Row>

</TableAcUserAccess>

</Result>

 

 

AccauntDataBases

Коллекция описаний баз данных

ü IdentifyDatabase

Получение ИД базы данных

POST

http://adl.42clouds.com/adl42/hs/api_v1/AccauntDataBases/IdentifyDatabase

XML тела запроса:

<Request>

     <ListOrganizationsIDs>{ListOrganizationsIDs}</ListOrganizationsIDs>

     <AcDBConnectionString>{AcDBConnectionString}</AcDBConnectionString>

</Request>

Ответ на запрос:

<Result>

     <AccauntDataBaseID>{AccauntDataBaseID}</AccauntDataBaseID>

</Result>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

ListOrganizationsIDs

String

Cписок идентификаторов организаций

AcDBConnectionString

String

Cтрока соединения информационной базы

 

ü SaveBackup

Сохранение бэкапа базы данных перед выполнением нормализации

POST

http://adl.42clouds.com/adl42/hs/api_v1/AccauntDataBases/SaveBackup

XML тела запроса:

<Request>

     <AccauntDataBaseID>{AccauntDataBaseID}</AccauntDataBaseID>

     <UserID>{UserID}</UserID>

     <BackupBinaryData>{BackupBinaryData}</BackupBinaryData>

</Request>

Ответ на запрос:

<Result/>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

AccauntDataBaseID

String

Идентификатор базы данных

UserID

String

Идентфикатор пользователя

BackupBinaryData

BinaryData

База данных

 

ü SetProperties

Установка свойств базы данных

POST

http://adl.42clouds.com/adl42/hs/api_v1/AccauntDataBases/SetProperties

XML тела запроса:

<Request>

     <AccauntDataBaseID>{AccauntDataBaseID}</AccauntDataBaseID>

     < Normalize>{ Normalize}</ Normalize>

     < NormalizeOrRestore>{ NormalizeOrRestore}</ NormalizeOrRestore>

</Request>

Ответ на запрос:

<Result/>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

AccauntDataBaseID

String

Идентификатор базы данных

Normalize

Boolean

Пометка отказа от нормализации

NormalizeOrRestore

Boolean

Пометка прохождения нормализации или восстановления

 

ü SaveUserSettings

Сохранение настроек пользователя

POST

http://adl.42clouds.com/adl42/hs/api_v1/AccauntDataBases/SaveUserSettings

XML тела запроса:

<Request>

     <AccauntDataBaseID>{AccauntDataBaseID}</AccauntDataBaseID>

     <DatabaseUserID>{DatabaseUserID}</DatabaseUserID>

     <DatabaseUserSettings>{DatabaseUserSettings}</DatabaseUserSettings>

</Request>

Ответ на запрос:

<Result/>

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

AccauntDataBaseID

String

Идентификатор базы данных

DatabaseUserID

String

Идентификатор пользователя базы данных

DatabaseUserSettings

?????

Хранилище настроек пользователя базы данных

 

ü GetProperties

Получение свойств базы данных

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccauntDataBases/GetProperties?AccauntDataBaseID={AccauntDataBaseID}

XML тела запроса:

<Request>

     <AccauntDataBaseID>{AccauntDataBaseID}</AccauntDataBaseID>

     <DatabaseUserID>{DatabaseUserID}</DatabaseUserID>

     <DatabaseUserSettings>{DatabaseUserSettings}</DatabaseUserSettings>

</Request>

Ответ на запрос:

<Result>

     <NormalizationLastDate>{NormalizationLastDate}</NormalizationLastDate>

     <Normalize>{Normalize}</Normalize>

     <NormalizeOrRestore>{NormalizeOrRestore}</NormalizeOrRestore>

</Result>

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

AccauntDataBaseID

String

Идентификатор базы данных

 

ü GetBackup

Получение бэкапа базы данных

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccauntDataBases/GetBackup?AccauntDataBaseID={AccauntDataBaseID}

XML тела запроса:

<Request>

     <AccauntDataBaseID>{AccauntDataBaseID}</AccauntDataBaseID>

</Request>

Ответ на запрос:

<Result>

     <BackupBinaryData>{BackupBinaryData}</BackupBinaryData>

</Result>

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

AccauntDataBaseID

String

Идентификатор базы данных

 

ü GetUserSettings

Получение настроек пользователя базы данных

GET

http://adl.42clouds.com/adl42/hs/api_v1/AccauntDataBases/GetUserSettings?AccauntDataBaseID={AccauntDataBaseID}&DatabaseUserID={DatabaseUserID}

XML тела запроса:

<Request>

     <AccauntDataBaseID>{AccauntDataBaseID}</AccauntDataBaseID>

     <DatabaseUserID>{DatabaseUserID}</DatabaseUserID>

</Request>

Ответ на запрос:

<Result>

     <DatabaseUserSettings>{DatabaseUserSettings}</DatabaseUserSettings>

</Result>

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

AccauntDataBaseID

String

Идентификатор базы данных

DatabaseUserID

String

Идентификатор пользователя базы данных

 

AcDbDictionariesMatches

Коллекция записей словаря соответствий

ü Add

Добавление соответсвия

POST

http://adl.42clouds.com/adl42/hs/api_v1/AcDbDictionariesMatches/Add

XML тела запроса:

<Request>

     <LinkDatabaseID>{LinkDatabaseID}</LinkDatabaseID>

     <NameFromDocument>{NameFromDocument}</NameFromDocument>

     <LinkType>{LinkType}</LinkType>

     <LinkID>{LinkID}</LinkID>

     <ConformityFullName>{ConformityFullName}</ConformityFullName>

</Request>

Ответ на запрос:

<Result>

     <MatchingID>{MatchingID}</MatchingID>

</Result>

 

 

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

LinkDatabaseID

String

 

NameFromDocument

String

 

LinkType

String

 

LinkID

String

 

ConformityFullName

String

 

 

ü Delete

Удаление

POST

http://adl.42clouds.com/adl42/hs/api_v1/AcDbDictionariesMatches/Delete

XML тела запроса:

<Request>

     <MatchingID>{MatchingID}</MatchingID>

</Request>

Ответ на запрос:

<Result/>

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

UserAccesID

String

Идентификатор доступа пользователя

 

ü GetDictionary

Получение

GET

http://adl.42clouds.com/adl42/hs/api_v1/AcDbDictionariesMatches/GetDictionary?LinkDatabaseID={LinkDatabaseID}

XML тела запроса:

<Request>

     < LinkDatabaseID>{ LinkDatabaseID}</ LinkDatabaseID>

</Request>

Ответ на запрос:

<Result>

     <TableAcUserAccess Type="Table">

<Row>

<LinkID>{LinkID}</LinkID>

<LinkType>{LinkType}</LinkType>

<LinkDatabaseID>{LinkDatabaseID}</LinkDatabaseID>

<NameFromDocument>{NameFromDocument}</NameFromDocument>

<ConformityFullName>{ConformityFullName}</ConformityFullName>

<MatchingID>{MatchingID}</MatchingID>

</Row>

<Row>

…

</Row>

</TableAcUserAccess>

</Result>

Параметры службы:

Имя параметра

Тип параметра

Описание параметра

LinkDatabaseID

String

 

Комментарии для сайта Cackle