Core42

Core42

Core42 – центральная служба 42Облака, обеспечивающая аутентификацию и авторизацию пользователей, формирующая структуру аккаунтов, пользователей, баз данных и различных ресурсов. Обеспечивает их взаимодействие и доступ к этим данным для других служб.

Архитектурным стандартом построения API ядра является REST.
Входные параметры GET-методов передаются в строке запроса.
Входные параметры POST-методов передаются в теле запроса в формате XML (Content-type: application/xml).
В заголовке каждого ответа передается код его статуса.
В теле ответа возвращается результат запроса в формате XML (Content-type: application/xml).
В случае возникновения ошибки (код статуса ответа 400 и выше) в теле ответа возвращается информация об ошибке в формате XML (Content-type: application/xml).


Accounts

Содержит аккаунты облака, представляющие собой группировки пользователей, баз данных и других объектов и данных


Add

Создание и добавление нового аккаунта. Одновременно происходит создание пользователя с ролью администратора данного аккаунта

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountCaption String наименование аккаунта (например, название компании)
Login String логин пользователя с ролью администратора аккаунта
Password String пароль пользователя с ролью администратора
Email String электронный адрес пользователя с ролью администратора
PhoneCountry String код страны пользователя с ролью администратора
PhoneNumber String номер телефона пользователя с ролью администратора
FirstName String имя пользователя с ролью администратора аккаунта
LastName String фамилия пользователя с ролью администратора аккаунта
MiddleName String отчество пользователя с ролью администратора аккаунта
ReferralAccountID Guid идентификатор партнерского аккаунта

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор нового аккаунта

Возможные ошибки метода:

Код ошибки Описание ошибки
409 пользователь с одним из указанных уникальных свойств уже существует
412 значение свойства аккаунта или пользователя не указано или не соответствует необходимому формату

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <AccountId>c6c77817-fce1-4305-9dbc-3a56a0976ba9</AccountId>
  <Login>testlogin</Login>
  <Password>testpassword</Password>
  <Email>test@email.ru</Email>
  <PhoneCountry>RU</PhoneCountry>
  <PhoneNumber>0970979797</PhoneNumber>
  <FirstName>Иван</FirstName>
  <LastName>Федоров</LastName>
  <MiddleName>Евгеньевич</MiddleName>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <Code>07914c1a-e91b-4e42-a483-53297d3f77b9</Code>
</Result>


GetIDs

Возвращает список идентификаторов аккаунтов в заданном диапазоне по времени их создания. Максимально количество возвращаемых идентификаторов – 1000.

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
RegistrationDateFrom datetime дата начала диапазона времени создания аккаунта
RegistrationDateTo datetime дата конца диапазона времени создания аккаунта

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountIDs list [guid] список идентификаторов аккаунтов

Возможные ошибки метода:

Код ошибки Описание ошибки
412 возвращаемое количество идентификаторов аккаунтов более 1000

XML-формат тела ответа:

application/xml, text/xml

  Sample:

<Result>
  <AccountIDs>
    <Item>4513cdb1-7f45-4bdc-8167-bae7c65f9c3e</Item>
    <Item>fabc2906-145f-4c85-b292-a2cbcb3d2a16</Item>
    <Item>99cd1c9a-15e7-4ea0-9d8b-ff203dd03d09</Item>
  </AccountIDs>
</Result>


GetProperties

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

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор аккаунта

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountCaption String наименование аккаунта
ReferralAccountID guid идентификатор партнерского аккаунта
RegistrationDate datetime дата создания аккаунта
IndexNumber integer уникальный целочисленный номер аккаунта

Возможные ошибки метода:

Код ошибки Описание ошибки
404 аккаунта с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AccountCaption>ООО ТоргСофт</AccountCaption>
  <ReferralAccountID>cc1d477c-3900-4149-bd78-79fb4b36384a</ReferralAccountID>
  <RegistrationDate>2014-11-21T16:53:16+04:00</RegistrationDate>
  <IndexNumber>4256</IndexNumber>
  <Removed>true</Removed>
</Result>


Delete

Удаление аккаунта

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор аккаунта

Возможные ошибки метода:

Код ошибки Описание ошибки
404 аккаунта с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <AccountID>620ab1b3-943b-453f-a73a-73c70cda716e</AccountID>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


Count

Возвращает общее количество аккаунтов в ядре

GET

Результат метода:

Имя параметра Тип параметра Описание параметра
Count int количество элементов списка

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <Count>1</Count>
</Result>


SetAccountCaption

Создание и добавление нового аккаунта. Одновременно происходит создание пользователя с ролью администратора данного аккаунта

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор аккаунта
AccountCaption string новое значение наименования аккаунта

Возможные ошибки метода:

Код ошибки Описание ошибки
404 аккаунта с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <AccountID>f6c268ee-38ba-4c73-9403-31082c001532</AccountID>
  <AccountCaption>ТоргСофт</AccountCaption>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetAccountCaption

Получает значение наименования аккаунта (названия компании)

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор аккаунта

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountCaption string наименование аккаунта

Возможные ошибки метода:

Код ошибки Описание ошибки
404 аккаунта с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AccountCaption>ТоргСофт</AccountCaption>
</Result>


SetReferralAccountID

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

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор аккаунта
ReferralAccountID guid новое значение идентификатора партнерского аккаунта

Возможные ошибки метода:

Код ошибки Описание ошибки
404 аккаунта с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <AccountID>d0973ab3-03ed-4418-b431-9f572169b3be</AccountID>
  <AccountCaption>3429ca0b-e3a7-4bba-87dd-a8b8a191ea14</AccountCaption>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetReferralAccountID

Создание и добавление нового аккаунта. Одновременно происходит создание пользователя с ролью администратора данного аккаунта

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор аккаунта

Результат метода:

Имя параметра Тип параметра Описание параметра
ReferralAccountID guid идентификатор партнерского аккаунта

Возможные ошибки метода:

Код ошибки Описание ошибки
404 аккаунта с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <ReferralAccountID>07914c1a-e91b-4e42-a483-53297d3f77b9</ReferralAccountID>
</Result>


GetIndexNumber

Создание и добавление нового аккаунта. Одновременно происходит создание пользователя с ролью администратора данного аккаунта

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор аккаунта

Результат метода:

Имя параметра Тип параметра Описание параметра
IndexNumber integer уникальный целочисленный номер аккаунта

Возможные ошибки метода:

Код ошибки Описание ошибки
404 аккаунта с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <IndexNumber>1</IndexNumber>
</Result>



GetRegistrationDate

Создание и добавление нового аккаунта. Одновременно происходит создание пользователя с ролью администратора данного аккаунта

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор аккаунта

Результат метода:

Имя параметра Тип параметра Описание параметра
RegistrationDate datetime дата создания аккаунта

Возможные ошибки метода:

Код ошибки Описание ошибки
404 аккаунта с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <RegistrationDate>2014-11-21T16:53:16+04:00</RegistrationDate>
</Result>


AccountUsers

Содержит информацию о пользователях аккаунтов 42 Облака


CheckAdminUserRole

Создание и добавление нового аккаунта. Одновременно происходит создание пользователя с ролью администратора данного аккаунта

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
AdminUserRole boolean признак роли администратора аккаунта

Возможные ошибки метода:

Код ошибки Описание ошибки
404 аккаунта с указанным идентификатором не существует

XML-формат тела

application/xml, text/xml

  Sample:
<Result />


GetIDByLogin

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

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
Login stirng логин пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует
412 значение эл.адреса не соответствует необходимому формату/маске

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AccountUserID>2987ec4f-323d-438c-9e24-b5fd73d72c0a</AccountUserID>
</Result>


GetIDByEmail

Возвращает идентификатор пользователя по его электронной почте

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
Email stirng электронная почта пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует
412 значение эл.адреса не соответствует необходимому формату/маске

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AccountUserID>8a7ccff2-cf82-43a8-be7a-61e2286aff27</AccountUserID>
</Result>


GetIDByPhoneNumber

Возвращает идентификатор пользователя по его коду страны и номеру телефона

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
PhoneCountry stirng код страны пользователя
PhoneNumber stirng номер телефона пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует
412 значение эл.адреса не соответствует необходимому формату/маске

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AccountUserID>ae97e927-5cff-4610-8d34-fd2d49935883</AccountUserID>
</Result>

GetAccountID

Создание и добавление нового аккаунта. Одновременно происходит создание пользователя с ролью администратора данного аккаунта

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя
Login stirng логин пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор аккаунта

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AccountID>102572f3-379a-49f1-b439-08395a0c9f11</AccountID>
</Result>

GetIDs

Возвращает список идентификаторов пользователей указанного аккаунта

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор пользователя
Login stirng логин пользователя
Password stirng пароль пользователя
Email stirng электронный адрес пользователя
PhoneCountry stirng код страны
PhoneNumber stirng номер телефона пользователя
FirstName stirng имя пользователя
LastName stirng фамилия пользователя
MiddleName stirng отчество пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
409 пользователь с одним из указанных уникальных свойств уже существует
412 значение эл.адреса не соответствует необходимому формату/маске

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AccountUserIDs >
    <Item>4513cdb1-7f45-4bdc-8167-bae7c65f9c3e</Item>
    <Item>fabc2906-145f-4c85-b292-a2cbcb3d2a16</Item>
    <Item>99cd1c9a-15e7-4ea0-9d8b-ff203dd03d09</Item>
  </AccountUserIDs>
</Result>

VerificationUserByComfirmationCode

Подтверждение активации нового пользователя аккаунта

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя
ComfirmationCode stirng код подтвеждения

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор подтверждаемого пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Result />

GetProperties

Возвращает основные свойства пользователя аккаунта

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор пользователя
Login stirng логин пользователя
Email stirng электронный адрес польз ователя
PhoneCountry stirng код страны
PhoneNumber stirng номер телефона пользователя
FirstName stirng имя пользователя
LastName stirng фамилия пользователя
MiddleName stirng отчество пользователя
CorpUserID guid идентификатор пользователя в системе Корп
CorpUserSyncStatus stirng статус синхронизации пользователя в системе Корп
Removed boolean признак удаления пользователя аккаунта в облаке

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AccountID>2ccbcf9c-9bda-4cab-aaa6-e3104ee3e66f</AccountID>
  <Login>testlogin</Login>
  <Email>test@email</Email>
  <PhoneCountry>RU</PhoneCountry>
  <PhoneNumber>0970979797</PhoneNumber>
  <FirstName>Иван</FirstName>
  <LastName>Федоров</LastName>
  <MiddleName>Сергеевич</MiddleName>
  <CorpUserID>ed095d47-aad0-4160-a91b-bba5a7cd1ccf</CorpUserID>
  <CorpUserSyncStatus>sync</CorpUserSyncStatus>
  <Removed>true</Removed>
</Result>

Delete

Удаление пользователя аккаунта

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <AccountUserID>b7bec704-4800-4e7a-9c8c-88daa805bbe6</AccountUserID>
</Request>

XML-формат тела ответа:

application/xml, text/xml

<Result />


Count

Возвращает количество пользователей в указанном аккаунте

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
Count int количество элементов списка

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <Count>1</Count>
</Result>


SetPassword

Установка нового пароль пользователя

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя
NewPassword string новый пароль
OldPassword stirng старый пароль

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует
412 значение пароля не соответствует необходимому формату/маске

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <AccountUserID_x0020_>62682d3a-569c-40ea-bc11-99b9f598edc6</AccountUserID_x0020_>
  <NewPassword>testpassword</NewPassword>
  <OldPassword_x0020_>testpassword2</OldPassword_x0020_>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


SetLogin

Установка нового логина пользователя

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя
Login stirng новый логин пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует
409 пользователь с указанным логином уже существует
412 значение логина не соответствует необходимому формату/маске

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <Login>testlogin</Login>
  <AccountUserID>043c0e40-a412-46fc-ade8-3e4de0bf7e16</AccountUserID>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetLogin

Получение логина пользователя

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя
Email stirng электронный адрес

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует
409 пользователь с указанным адресом уже существует
412 значение эл.почты не соответствует необходимому формату/маске

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <Login>testlogin</Login>
</Result>


GetEmail

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

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
Email string электронный адрес пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <Email>test@email</Email>
</Result>


GetPhoneCountry

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

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
PhoneCountry string код страны пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <PhoneCountry>RU</PhoneCountry>
</Result>


SetPhoneNumber

Установка нового номера телефона пользователя

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя
PhoneNumber stirng номер телефона

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует
409 пользователь с указанным номером уже существует
412 значение номера телефона не соответствует необходимому формату

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <PhoneNumber>0970979797</PhoneNumber>
  <PhoneCountry>RU</PhoneCountry>
  <AccountUserID>427651fb-5e97-4d94-908b-e9cacb6bfae1</AccountUserID>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetPhoneNumber

Получение номера телефона пользователя

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
PhoneNumber stirng номер телефона

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <PhoneNumber>0970979797</PhoneNumber>
</Result>


SetFirstName

Установка нового имени пользователя

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя
FirstName string имя пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <FirstName>Иван</FirstName>
  <AccountUserID>b048e7de-e0a6-490b-845f-9cb5e245fb2f</AccountUserID>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetFirstName

Получение имени пользователя

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
FirstName string имя пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <FirstName>Иван</FirstName>
</Result>


SetLastName

Установка новой фамилии пользователя

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя
LastName stirng фамилия пользователя

Возможные ошибки метода:

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <LastName>Федоров</LastName>
  <AccountUserID>384554aa-9f88-48c5-8783-bb239099eabc</AccountUserID>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetLastName

Получение фамилии пользователя

GET

Параметры метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует
Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
LastName string фамилия пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <LastName>Федоров</LastName>
</Result>


SetMiddleName

Установка нового отчества пользователя

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя
MiddleName stirng отчество пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <MiddleName>Сергеевич</MiddleName>
  <AccountUserID>156efe1a-ab9d-441c-92f1-1c6bfd5d757d</AccountUserID>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


AccountUsers/GetMiddleName?accountUserID={accountUserID}

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

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
MiddleName stirng отчество пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <MiddleName>Сергеевич</MiddleName>
</Result>


SetRoleID

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

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя
RoleID integer код роли пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <RoleId>1</RoleId>
  <AccountUserID>ef350c96-68c9-4193-acf8-a18d18d1b4a4</AccountUserID>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetRoleID

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

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
RoleID integer код роли пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
412 значение эл.адреса не соответствует необходимому формату/маске

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <RoleID>64</RoleID>
</Result>


SetCorpUserID

Установка идентификатора пользователя в системе КОРП

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя
CorpUserID guid идентификатор пользователяв системе Корп

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <CorpUserID>a5be9bb1-dabe-428d-a4ce-fd9ffd854df7</CorpUserID>
  <AccountUserID>1d0c88f8-e6b3-4374-af40-f81ce9cfb5b4</AccountUserID>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetCorpUserID

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

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
CorpUserID guid идентификатор пользователяв системе Корп

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <CorpUserID>f10c44a9-ed83-449a-862a-e188ecd1e9a8</CorpUserID>
</Result>


SetComment

Установка нового комментария о пользователе

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя
Comment stirng комментарий о пользователе

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <Comment>Комментарий</Comment>
  <AccountUserID>17861fb0-37a5-4d09-ae87-9870b6460ba0</AccountUserID>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetComment

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

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя
Login stirng логин пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
Comment string комментарий о пользователе

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <Comment>Комментарий</Comment>
</Result>


SetUnsubscribed

Установка признака отказа от получения уведомлений

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя
Unsubscribed boolean признак отказа от получения уведомлений

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <Unsubscribed>true</Unsubscribed>
  <AccountUserID>a92e535d-9802-4574-81a3-f79c50a6097b</AccountUserID>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetUnsubscribed

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

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
Unsubscribed boolean признак отказа от получения уведомлений

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <Unsubscribed>true</Unsubscribed>
</Result>


GetActivated

Получение признака активации пользователя

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
Activated boolean признак активации пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <Activated>true</Activated>
</Result>


SetCreationDate

Установка даты создания пользователя

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя
CreationDate datetime дата создания пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <CreationDate>2015-01-28T17:05:02.9216185+03:00</CreationDate>
  <AccountUserID>153a55fc-9ddd-4269-8d83-26c2d05ef6ef</AccountUserID>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetCreationDate

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

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
CreationDate datetime дата создания пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <CreationDate>2015-01-28T17:08:11.671593+03:00</CreationDate>
</Result>


GetIDByCorpUserID

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

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
CorpUserID guid идентификатор пользователя в Корпе

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AccountUserID>260a6e52-2215-4982-9588-f4aef3190e28</AccountUserID>
</Result>


UpdatePropertiesByCorp

Установка свойств пользователя при изменении их в системе Корп

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя
CorpUserID guid идентификатор пользователя в Корпе
FirstName stirng имя
LastName stirng фамилия
MiddleName stirng отчество
Comment stirng комментарий о пользователе

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует
412 значение свойства пользователя не указано или не соответствует необходимому формату

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <AccountUserID>1d04d1af-edb6-4ddf-b85a-4d461e4a6dcf</AccountUserID>
  <CorpUserID>6e6de1f1-25fe-47a9-a829-db613df5c0ee</CorpUserID>
  <FirstName>Иван</FirstName>
  <LastName>Федоров</LastName>
  <MiddleName>Сергеевич</MiddleName>
  <Comment>Комментарий</Comment>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


AccountUserSessions

Сессии пользователей, содержащие токены авторизации


Login

Метод аутентификации пользователя, возвращающий токен авторизации. Создается пользовательская сессия.

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserLogin stirng логин пользователя при аутентификации
AccountUserPassword stirng пароль пользователя при аутентификации
ClientDescription stirng дескриптор клиентского приложения

Результат метода:

Имя параметра Тип параметра Описание параметра
Token guid токен авторизации пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
405 если идентифицированный пользователь имеет неподтвержденный статус

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <AccountUserLogin>testlogin</AccountUserLogin>
  <AccountUserPassword>testpassword</AccountUserPassword>
  <ClientDescription>ClientADL</ClientDescription>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AccounUserSessionID>670968ee-0eed-459b-8456-6efcc6fa326d</AccounUserSessionID>
</Result>


CheckTokenValidity

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

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
Token guid токен авторизации пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
TokenValidity boolean признак валидности токена пользователя

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <TokenValidity>true</TokenValidity>
</Result>


GetAccountUserIDByToken

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

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
Token guid токен авторизации пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AccountUserID>e606e9fc-132b-47ed-a3f3-2ec77192f72b</AccountUserID>
</Result>


GetIDs

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

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountUserSessionIDs list список идентификаторов сессий

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AccountUserSessionIDs>
    <Item>f8357f81-1a72-429d-8857-f21f0fa0bb80</Item>
    <Item>284e102c-6427-4c3d-a979-b201a1cbc7d4</Item>
    <Item>512a8673-e32c-484f-b5c6-d053508d487e</Item>
  </AccountUserSessionIDs>
</Result>


GetProperties

Возвращает свойства пользовательской сессии

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserSessionIDs list список идентификаторов сессий

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя
Token guid пользовательский токен
StaticToken boolean признак статического токена
TokenСreationTime datetime время создания/обновления токена
ClientDescription string дескриптор клиентского приложения
ClientDeviceInfo string информация о клиентском устройстве
ClientIPAddress string IP-адрес клиента

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AccountUserID>6941bdf6-0a50-4989-9ee5-e0a273970e7e</AccountUserID>
  <Token>f1a79b81-f835-4307-a3fd-3f6fe98e09da</Token>
  <StaticToken>true</StaticToken>
  <TokenСreationTime>2015-01-28T17:15:09.0676778+03:00</TokenСreationTime>
  <ClientDescription>ClientADL</ClientDescription>
  <ClientDeviceInfo></ClientDeviceInfo>
  <ClientIPAddress>10.20.10.255</ClientIPAddress>
</Result>


Delete

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

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserSessionIDs list список идентификаторов сессий

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


Count

Возвращает количество пользовательских сессий по указанному пользователю

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Результат метода:

Имя параметра Тип параметра Описание параметра
Count int количество элементов списка

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <Count>1</Count>
</Result>


GetAccountUserID

Возвращает идентификатор пользователя пользовательской сессии

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserSessionID guid список идентификаторов сессий

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountUserID guid идентификатор пользователя

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AccountUserID>40bf3520-07a0-4272-9cef-e5c31c87370c</AccountUserID>
</Result>


GetToken

Возвращает токен пользовательской сессии

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserSessionID guid идентификатор сессии

Результат метода:

Имя параметра Тип параметра Описание параметра
Token guid токен автоизации

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <Token>3e483c72-71c2-467d-9908-6bb15eae0930</Token>
</Result>


GetTokenСreationTime

Возвращает время создания токена пользовательской сессии

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserSessionID guid идентификатор сессии

Результат метода:

Имя параметра Тип параметра Описание параметра
TokenСreationTime datetime время создания токена

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <TokenСreationTime>2015-01-28T17:18:10.5216773+03:00</TokenСreationTime>
</Result>


GetClientDescription

Возвращает дескриптор клиентского приложения пользовательской сессии

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserSessionID guid идентификатор сессии

Результат метода:

Имя параметра Тип параметра Описание параметра
ClientDescription string дескриптор клиентского приложения

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <ClientDescription>ClientADL</ClientDescription>
</Result>


GetClientDeviceInfo

Возвращает информацию о клиентском устройстве

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserSessionID guid идентификатор пользовательской сессии

Результат метода:

Имя параметра Тип параметра Описание параметра
ClientDeviceInfo string информацию о клиентском устройстве

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <ClientDeviceInfo></ClientDeviceInfo>
</Result>


GetClientIPAddress

Возвращает IP-адрес клиента пользовательской сессии

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserSessionID guid идентификатор пользовательской сессии

Результат метода:

Имя параметра Тип параметра Описание параметра
ClientIPAddress string IP-адрес клиента

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <ClientIPAddress>10.20.10.255</ClientIPAddress>
</Result>


GetStaticToken

Возвращает признак статического токена

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountUserSessionID guid идентификатор пользовательской сессии

Результат метода:

Имя параметра Тип параметра Описание параметра
StaticToken boolean признак статического токена

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <StaticToken>true</StaticToken>
</Result>


AccountDatabases

Информация о базах данных аккаунтов


GetAccountID

Получение идентификатора аккаунта для указанной базы данных

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountDatabaseID guid идентификатор базы данных

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор аккаунта

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<AccountDatabaseAccountIDDTO>
  <AccountID>3e483c72-71c2-467d-9908-6bb15eae0930</AccountID>
</AccountDatabaseAccountIDDTO>


Add

Добавление новой базы данных в указанный аккаунт

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountDatabaseID guid идентификатор базы данных

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountDatabaseID guid идентификатор базы данных

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <AccountID>12d257d1-de8a-4fec-8044-72948e088a4b</AccountID>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Request>
  <AccountDatabaseID>b83a56bf-1b8a-4ec1-ac8a-8245973bb0d9</AccountDatabaseID>
</Request>


GetProperties

Возвращает основные свойства базы данных

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountDatabaseID guid идентификатор базы данных

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор аккаунта
CreationDate datetime дата создания базы
LastActivityDate datetime дата последней активности с базой
Caption string наименование базы данных
ConfigurationName string наименование конфигурации базы
ConfigurationVersion string версия конфигурации базы
ApplicationName string наименование платформы

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AccountID>a4f64154-a600-40e5-ab0a-abf8af2ea5d7</AccountID>
  <CreationDate>2015-01-28T17:34:42.1416749+03:00</CreationDate>
  <LastActivityDate>2015-01-28T17:34:42.1416749+03:00</LastActivityDate>
  <Caption>БП 3.0</Caption>
  <ConfigurationName>Бухгалтерия предприятия</ConfigurationName>
  <ConfigurationVersion>3.0.1.55</ConfigurationVersion>
  <ApplicationName>1С82</ApplicationName>
</Result>


SetLastActivityDate

Установка времени последней активности базы данных

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountDatabaseID guid идентификатор базы данных
LastActivityDate datetime дата последней активности с базой

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <AccountDatabaseID>d622f925-186d-43f5-951e-1ea5bc27f63c</AccountDatabaseID>
  <LastActivityDate>2015-01-28T17:35:22.4909712+03:00</LastActivityDate>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetLastActivityDate

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

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountDatabaseID guid идентификатор базы данных

Результат метода:

Имя параметра Тип параметра Описание параметра
LastActivityDate datetime дата последней активности с базой

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<AccountDatabaseLastActivityDateDTO>
  <LastActivityDate>2015-01-28T17:40:18.3683956+03:00</LastActivityDate>
</AccountDatabaseLastActivityDateDTO>


SetCreationDate

Установка времени создания базы данных

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountDatabaseID guid идентификатор базы данных
CreationDate datetime дата и время создания базы данных

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <AccountDatabaseID>4ec24eb4-5320-4ce6-b743-ab678e879454</AccountDatabaseID>
  <CreationDate>2015-01-28T17:41:51.8594219+03:00</CreationDate>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetCreationDate

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

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountDatabaseID guid идентификатор базы данных

Результат метода:

Имя параметра Тип параметра Описание параметра
CreationDate datetime дата и время создания базы данных

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<AccountDatabaseCreationDateDTO>
  <CreationDate>2015-01-28T17:44:36.4561291+03:00</CreationDate>
</AccountDatabaseCreationDateDTO>


SetCaption

Установка наименования базы данных

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountDatabaseID guid идентификатор базы данных
Caption string наименование базы данных

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <AccountDatabaseID>dd4aabe5-09fd-40e7-b1e2-36ea17aec1bf</AccountDatabaseID>
  <Caption>БП 3.0</Caption>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetCaption

Получение наименования базы данных

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountDatabaseID guid идентификатор базы данных

Результат метода:

Имя параметра Тип параметра Описание параметра
Caption string наименование базы данных

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AccountDatabaseCaption>БП 3.0</AccountDatabaseCaption>
</Result>


GetDbNumber

Получение номера базы данных

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountDatabaseID guid идентификатор базы данных

Результат метода:

Имя параметра Тип параметра Описание параметра
DbNumber integer номер базы данных

Возможные ошибки метода:

Код ошибки Описание ошибки
404 пользователя с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Request>
  <AccountDatabaseNumber>1</AccountDatabaseNumber>
</Request>


CloudServices

Перечень служб облака и токенов


Add

Создание и добавление информации о новой службе

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
CloudServiceID string строковый идентификатор службы
ServiceICaption string наименование службы

Результат метода:

Имя параметра Тип параметра Описание параметра
CloudServiceID string идентификатор новой службы

Возможные ошибки метода:

Код ошибки Описание ошибки
409 служба с таким идентификатором уже существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <CloudServiceID>CORE42</CloudServiceID>
  <ServiceCaption>Ядро</ServiceCaption>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <CloudServiceID>CORE42</CloudServiceID>
</Result>


GetIDs

Получение идентификаторов служб

GET

Результат метода:

Имя параметра Тип параметра Описание параметра
CloudServiceIDs list список идентификаторов служб

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <CloudServiceIDs >
    <Item>56898366-dadf-4194-9302-2e0d20fa19e1</Item>
    <Item>56898366-dadf-4194-9302-2e0d20fa19e2</Item>
    <Item>56898366-dadf-4194-9302-2e0d20fa19e3</Item>
  </CloudServiceIDs>
</Result>


Delete

Удаление службы

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
CloudServiceID string идентификатор службы

Возможные ошибки метода:

Код ошибки Описание ошибки
404 служба с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <CloudServiceID>CORE42</CloudServiceID>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


Count

Возвращает общее количество служб

GET

Результат метода:

Имя параметра Тип параметра Описание параметра
Count int количество элементов списка

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <Count>1</Count>
</Result>


SetServiceCaption

Устанавливает наименование службы

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
CloudServiceID string идентификатор службы
ServiceICaption string наименование службы

Возможные ошибки метода:

Код ошибки Описание ошибки
404 служба с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <CloudServiceID>CORE42</CloudServiceID>
  <ServiceCaption>Ядро</ServiceCaption>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetServiceCaption

Возвращает наименование службы

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
CloudServiceID string идентификатор службы

Результат метода:

Имя параметра Тип параметра Описание параметра
ServiceCaption string наименование службы

Возможные ошибки метода:

Код ошибки Описание ошибки
404 служба с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <Caption>Ядро</Caption>
</Result>


SetServiceToken

Устанавливает значение токена авторизации службы

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
CloudServiceID string идентификатор службы
ServiceToken guid токен авторизации службы

Возможные ошибки метода:

Код ошибки Описание ошибки
404 служба с указанным идентификатором не существует
409 служба с таким токеном уже существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <CloudServiceID>56898366-dadf-4194-9302-2e0d20fa19e1</CloudServiceID>
  <ServiceToken>8399b89c-25d6-43e5-9a1b-bc0b2495fc09</ServiceToken>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetServiceToken

Возвращает значение токена авторизации службы

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
CloudServiceID string идентификатор службы

Результат метода:

Имя параметра Тип параметра Описание параметра
ServiceToken guid токен авторизации службы

Возможные ошибки метода:

Код ошибки Описание ошибки
404 службы с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <Token>56898366-dadf-4194-9302-2e0d20fa19e1</Token>
</Result>


CheckServiceTokenValidity

Проверяется валидность токена авторизации службы

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
ServiceToken guid токен авторизации службы

Результат метода:

Имя параметра Тип параметра Описание параметра
ServiceTokenValidity boolean признак валидности токена

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <Token>56898366-dadf-4194-9302-2e0d20fa19e1</Token>
</Result>


CSResources

Ресурсы служб облака


Add

Создание и добавление информации о новом ресурсе службы

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
CloudServiceID string идентификатор службы
ResourceName string наименование ресурса

Результат метода:

Имя параметра Тип параметра Описание параметра
CSResourceID guid идентификатор нового ресурса

Возможные ошибки метода:

Код ошибки Описание ошибки
409 ресурс с указанным именем уже существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <CloudServiceID>56898366-dadf-4194-9302-2e0d20fa19e1</CloudServiceID>
  <ResourcesName>CountOfDay</ResourcesName>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <CSResourceID>941668e8-b313-47f8-b6e9-58058c981e3d</CSResourceID>
</Result>


GetIDs

Возвращает список идентификаторов ресурсов указанной службы

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
CloudServiceID string идентификатор службы

Результат метода:

Имя параметра Тип параметра Описание параметра
CSResourceID guid идентификатор ресурса

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <CSResourcesIDs >
    <Item>37a3c0bf-cf31-413e-a4a7-fea42411f753</Item>
    <Item>faaa7e38-2621-4c5b-9f06-01baeb76b5ed</Item>
    <Item>c0382c33-a759-452b-9e8c-5ab46cb71d72</Item>
  </CSResourcesIDs>
</Result>


Delete

Удаление ресурса

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
CSResourceID guid идентификатор ресурса

Возможные ошибки метода:

Код ошибки Описание ошибки
404 ресурса с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <CSResourceID>f0ae091e-b9b0-43e6-befa-60f974076911</CSResourceID>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetCloudServiceIDd

Возвращает идентификатор службы указанного ресурса

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
CSResourceID guid идентификатор ресурса

Результат метода:

Имя параметра Тип параметра Описание параметра
CloudServiceID string идентификатор службы

Возможные ошибки метода:

Код ошибки Описание ошибки
404 ресурса с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <CloudServiceID>CORE42</CloudServiceID>
</Result>


SetResourceName

Установка наименования ресурса

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
CSResourceID guid идентификатор ресурса
ResourceName string наименование ресурса

Возможные ошибки метода:

Код ошибки Описание ошибки
404 ресурса с указанным идентификатором не существует
409 ресурса с указанным именем уже существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <CSResourceID>b4fdc7f1-9d34-4968-b6d8-a3b3eb8fc46e</CSResourceID>
  <ResourcesName>CountOfDay</ResourcesName>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
{
  "CSResourceID": "b4fdc7f1-9d34-4968-b6d8-a3b3eb8fc46e",
  "ResourcesName": "CountOfDay"
}


GetResourceName

Возвращает наименование ресурса

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
CSResourceID guid идентификатор ресурса

Результат метода:

Имя параметра Тип параметра Описание параметра
ResourceName string наименование ресурса

Возможные ошибки метода:

Код ошибки Описание ошибки
404 ресурса с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <ResourceName>CountOfDay</ResourceName>
</Result>


SetDaysAutoDecrease

Установка признака ежедневного автодекремента значения ресурса

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
CSResourceID guid идентификатор ресурса
DaysAutoDecrease boolean признак ежедневного автодекремента значения ресурса

Возможные ошибки метода:

Код ошибки Описание ошибки
404 ресурса с указанным идентификатором не существует

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <CSResourceID>73512d9d-ed5a-4e74-87b5-e1c294580992</CSResourceID>
  <DaysAutoDecrease>true</DaysAutoDecrease>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetDaysAutoDecrease

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

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
CSResourceID guid идентификатор ресурса

Результат метода:

Имя параметра Тип параметра Описание параметра
DaysAutoDecrease boolean признак ежедневного автодекремента значения ресурса

Возможные ошибки метода:

Код ошибки Описание ошибки
404 ресурса с указанным идентификатором не существует

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <ResourceName>CountOfDay</ResourceName>
</Result>


AccountCSResourceValues

Показатели ресурсов служб. Объект Функционирует как регистр накопления.


IncreaseValue

Увеличивает значение указанного ресурса службы

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор аккаунта
CSResourceID guid идентификатор ресурса
ModifyResourceValue integer величина изменения ресурса

Возможные ошибки метода:

Код ошибки Описание ошибки
412 один из обязательных параметров не задан или имеет неверное значение

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <AccountID>3ce1e4d4-ff7e-4f6f-ada4-485d88bff1c4</AccountID>
  <CSResourceID>3a93dead-bf6e-4eba-b3f9-d8b5ad677224</CSResourceID>
  <ModifyResourceValue>1</ModifyResourceValue>
  <ModifyResourceComment>за распознавание</ModifyResourceComment>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


DecreaseValue

Уменьшает значение указанного ресурса службы

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор аккаунта
CSResourceID guid идентификатор ресурса
ModifyResourceValue integer величина изменения ресурса
ModifyResourceComment string комментарий изменения значения ресурса

Возможные ошибки метода:

Код ошибки Описание ошибки
412 один из обязательных параметров не задан или имеет неверное значение

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <AccountID>1992613f-559f-4e67-9f1f-6dacccf89803</AccountID>
  <CSResourceID>c6500116-a9d5-47f4-b52c-88ea23a71645</CSResourceID>
  <ModifyResourceValue>1</ModifyResourceValue>
  <ModifyResourceComment>за распознавание</ModifyResourceComment>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetValue

Возвращает значение указанного ресурса

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор аккаунта
CSResourceID guid идентификатор ресурса

Результат метода:

Имя параметра Тип параметра Описание параметра
ServiceResourceValue integer значение ресурса

Возможные ошибки метода:

Код ошибки Описание ошибки
404 не обнаружен показатель ресурса

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <ServiceResourceValue>1</ServiceResourceValue>
</Result>


FindIDs

Возвращает список идентификаторов записей с изменениями значений ресурсов

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор аккаунта
CSResourceID guid идентификатор ресурса

Результат метода:

Имя параметра Тип параметра Описание параметра
AcountCSResourceValueIDs guid список идентификаторов записей с изменениями значений ресурсов

Возможные ошибки метода:

Код ошибки Описание ошибки
404 не обнаружен показатель ресурса

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AcountCSResourceValueIDs >
    <Item>426a3df0-1ad0-4980-b9f9-4c245ca4c696</Item>
    <Item>6b95bf45-5654-424a-9caf-7219de6c7e63</Item>
    <Item>fbab5a5a-7a7d-4ddb-95c7-77a3d7e779c0</Item>
  </AcountCSResourceValueIDs>
</Result>


GetProperties

Возвращает свойства записи изменения значения ресурса

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AcountCSResourceValueID guid идентификатор записи с изменением значение ресурса

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор аккаунта
CSResourceID guid идентификатор ресурса
InitiatorCloudServiceID guid идентификатор инициатора изменеия ресурса
ModifyResourceDateTime datetime дата/время изменения ресурса
ModifyResourceValue integer величина изменения ресурса
ModifyResourceComment string комментарий изменения значения ресурса

Возможные ошибки метода:

Код ошибки Описание ошибки
404 не обнаружен показатель ресурса

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AccountId>e6710e69-1d8e-4f84-870d-5b6c41b56822</AccountId>
  <CSResourceID>15dcf46b-0b1c-4579-89cf-ed9625d3ae49</CSResourceID>
  <InitiatorCloudServiceID>92218cd5-70ea-4606-b374-0798e4ceb807</InitiatorCloudServiceID>
  <ModifyResourceDateTime>2015-01-28T18:14:37.9562907+03:00</ModifyResourceDateTime>
  <ModifyResourceValue>5</ModifyResourceValue>
  <ModifyResourceComment>за распознавание</ModifyResourceComment>
</Result>


GetAccountID

Возвращает идентификатор аккаунта

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AcountCSResourceValueID guid идентификатор записи с изменением значение ресурса

Результат метода:

Имя параметра Тип параметра Описание параметра
AccountID guid идентификатор аккаунта

Возможные ошибки метода:

Код ошибки Описание ошибки
404 не обнаружен показатель ресурса

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <AccountId>ea9ccae0-9c44-4db4-a3d5-7a9a3b56f682</AccountId>
</Result>


GetCSResourceID

Возвращает идентификатор ресурса

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AcountCSResourceValueID guid идентификатор записи с изменением значение ресурса

Результат метода:

Имя параметра Тип параметра Описание параметра
CSResourceID guid идентификатор нового аккаунта

Возможные ошибки метода:

Код ошибки Описание ошибки
404 не обнаружен показатель ресурса

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <CSResourceId>f4d6187b-1fc0-49cb-bb4d-2d80079c0f46</CSResourceId>
</Result>


GetInitiatorCloudServiceID

Возвращает идентификатор инициатора изменения ресурса

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AcountCSResourceValueID guid идентификатор записи с изменением значение ресурса

Результат метода:

Имя параметра Тип параметра Описание параметра
InitiatorCloudServiceID guid идентификатор инициатора изменения ресурса

Возможные ошибки метода:

Код ошибки Описание ошибки
404 не обнаружен показатель ресурса

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <InitiatorCloudServiceId>8e828474-5ffb-4baf-9859-2d3a298832c9</InitiatorCloudServiceId>
</Result>


GetModifyResourceDateTime

Возвращает дату/время изменения ресурса

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AcountCSResourceValueID guid идентификатор записи с изменением значение ресурса

Результат метода:

Имя параметра Тип параметра Описание параметра
ModifyResourceDateTime datetime дата/время изменения ресурса

Возможные ошибки метода:

Код ошибки Описание ошибки
404 не обнаружен показатель ресурса

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <InitiatorCloudServiceId>2015-01-28T18:26:50.289911+03:00</InitiatorCloudServiceId>
</Result>


GetModifyResourceValue

Возвращает значение изменения ресурса

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AcountCSResourceValueID guid идентификатор записи с изменением значение ресурса

Результат метода:

Имя параметра Тип параметра Описание параметра
ModifyResourceValue integer величина изменения ресурса

Возможные ошибки метода:

Код ошибки Описание ошибки
404 не обнаружен показатель ресурса

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <ModifyResourceValue>1</ModifyResourceValue>
</Result>


GetModifyResourceComment

Возвращает комментарий изменения значения ресурса

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
AcountCSResourceValueID guid идентификатор записи с изменением значение ресурса

Результат метода:

Имя параметра Тип параметра Описание параметра
ModifyResourceComment string комментарий изменения значения ресурса

Возможные ошибки метода:

Код ошибки Описание ошибки
404 не обнаружен показатель ресурса

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result>
  <ModifyResourceComment>за распознавание</ModifyResourceComment>
</Result>


CSPerformanceCounters

Счетчики производительности служб облака


SetPerformanceValue

Установка значения счетчика производительности

POST

Параметры метода:

Имя параметра Тип параметра Описание параметра
CloudServiceID string идентификатор службы
AccountUserID guid идентификатор пользователя аккаунта
PerformanceCounterID string идентификатор счетчика
PerformanceCounterValue integer значение счетчика

Возможные ошибки метода:

Код ошибки Описание ошибки
412 один из обязательных параметров не задан или имеет неверное значение

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <CloudServiceID>c6c77817-fce1-4305-9dbc-3a56a0976ba9</CloudServiceID>
  <AccountUserID>c6c77817-fce1-4305-9dbc-3a56a0976ba9</AccountUserID>
  <PerformanceCounterID>c6c77817-fce1-4305-9dbc-3a56a0976ba9</PerformanceCounterID>
  <PerformanceCounterValue>5.1</PerformanceCounterValue>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />


GetPerformanceValue

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

GET

Параметры метода:

Имя параметра Тип параметра Описание параметра
CloudServiceID string идентификатор службы
AccountUserID guid идентификатор пользователя аккаунта
PerformanceCounterID string идентификатор счетчика
DateTimeFrom datetime дата и время начала поискового диапазона
DateTimeTo datetime дата и время конца поискового диапазона

Результат метода:

Имя параметра Тип параметра Описание параметра
CSResourceID guid идентификатор нового аккаунта

Возможные ошибки метода:

Код ошибки Описание ошибки
412 один из обязательных параметров не задан или имеет неверное значение

XML-формат тела запроса:

application/xml, text/xml

Sample:
<Request>
  <CloudServiceID>CORE42</CloudServiceID>
  <AccountUserID>902d4900-0af2-4313-b7e6-9f9b4727f4e0</AccountUserID>
  <PerformanceCounterID>internal.core42.accountuser.add</PerformanceCounterID>
  <PerformanceCounterValue>1.1</PerformanceCounterValue>
</Request>

XML-формат тела ответа:

application/xml, text/xml

  Sample:
<Result />