Application name

Core42

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

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

Accounts

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

GetProperties

Получить данные аккаунта по идентификатору аккаунта.

GET
api_v2/Accounts/GetProperties?accountID={accountID}
Имя параметра Тип Описание параметра
accountID Guid Идентификатор аккаунта.
Имя параметра Тип Описание параметра
AccountPropertiesDTO AccountPropertiesDTO Данные аккаунта
application/xml, text/xml 
<Result>
  <AccountCaption>sample string 1</AccountCaption>
  <ReferralAccountID>sample string 2</ReferralAccountID>
  <RegistrationDate>sample string 3</RegistrationDate>
  <IndexNumber>sample string 4</IndexNumber>
  <Removed>true</Removed>
  <Description>sample string 6</Description>
  <Currency>sample string 7</Currency>
  <INN>sample string 8</INN>
  <LocaleId>a9d8bd9d-bca5-4df4-ac7f-afef22c2f7eb</LocaleId>
  <ManagerId>bb8deb1a-a36e-41a0-b354-6631f4d120b2</ManagerId>
</Result>
application/json, text/json 
{
  "AccountCaption": "sample string 1",
  "ReferralAccountID": "sample string 2",
  "RegistrationDate": "sample string 3",
  "IndexNumber": "sample string 4",
  "Removed": true,
  "Description": "sample string 6",
  "Currency": "sample string 7",
  "INN": "sample string 8",
  "LocaleId": "a9d8bd9d-bca5-4df4-ac7f-afef22c2f7eb",
  "ManagerId": "bb8deb1a-a36e-41a0-b354-6631f4d120b2"
}

GetAccountCaption

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

GET
api_v2/Accounts/GetAccountCaption?accountID={accountID}
Имя параметра Тип Описание параметра
accountID Guid Идентификатор акканта.
Имя параметра Тип Описание параметра
AccountCaptionDTO AccountCaptionDTO Название аккаунта
application/xml, text/xml 
<Result>
  <AccountCaption>sample string 1</AccountCaption>
</Result>
application/json, text/json 
{
  "AccountCaption": "sample string 1"
}

GetReferralAccountID

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

GET
api_v2/Accounts/GetReferralAccountID?accountID={accountID}
Имя параметра Тип Описание параметра
accountID Guid Идентификатор аккаунта.
Имя параметра Тип Описание параметра
AccountReferalAccountIdDTO AccountReferalAccountIdDTO Идентификатор рефферала
application/xml, text/xml 
<Result>
  <ReferralAccountID>sample string 1</ReferralAccountID>
</Result>
application/json, text/json 
{
  "ReferralAccountID": "sample string 1"
}

GetIndexNumber

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

GET
api_v2/Accounts/GetIndexNumber?accountID={accountID}
Имя параметра Тип Описание параметра
accountID Guid Идентификатор аккаунта.
Имя параметра Тип Описание параметра
AccountIndexNumberDTO AccountIndexNumberDTO Номер аккаунта
application/xml, text/xml 
<Result>
  <IndexNumber>1</IndexNumber>
</Result>
application/json, text/json 
{
  "IndexNumber": 1
}

GetRegistrationDate

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

GET
api_v2/Accounts/GetRegistrationDate?accountID={accountID}
Имя параметра Тип Описание параметра
accountID Guid Идентификатор аккаунта.
Имя параметра Тип Описание параметра
AccountRegistrationDateDTO AccountRegistrationDateDTO Дата регистрации аккаунта
application/xml, text/xml 
<Result>
  <RegistrationDate>sample string 1</RegistrationDate>
</Result>
application/json, text/json 
{
  "RegistrationDate": "sample string 1"
}

GetFileStorageServerID

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

GET
api_v2/Accounts/GetFileStorageServerID?accountId={accountId}
Имя параметра Тип Описание параметра
accountId Guid Идентификатор аккаунта
Имя параметра Тип Описание параметра
CloudFileStorageServerIdDTO CloudFileStorageServerIdDTO Идентификатор файлового хранилища
application/xml, text/xml 
<Result>
  <FileStorageServerID>7ac7159e-377a-44d8-bb79-37fc476cf3fc</FileStorageServerID>
</Result>
application/json, text/json 
{
  "FileStorageServerID": "7ac7159e-377a-44d8-bb79-37fc476cf3fc"
}

GetProvidedServiceType

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

GET
api_v2/Accounts/GetProvidedServiceType?accountId={accountId}
Имя параметра Тип Описание параметра
accountId Guid Идентификатор аккаунта
Имя параметра Тип Описание параметра
ProvidedServiceTypeDTO ProvidedServiceTypeDTO Тип оказанной услуги
application/xml, text/xml 
<Result>
  <ProvidedServiceType>sample string 1</ProvidedServiceType>
</Result>
application/json, text/json 
{
  "ProvidedServiceType": "sample string 1"
}

GetStatus

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

GET
api_v2/Accounts/GetStatus?accountId={accountId}
Имя параметра Тип Описание параметра
accountId Guid Идентификатор аккаунта
Имя параметра Тип Описание параметра
AccountStatusDTO AccountStatusDTO Статус аккаунта
application/xml, text/xml 
<Result>
  <Status>sample string 1</Status>
</Result>
application/json, text/json 
{
  "Status": "sample string 1"
}

FindByEmail

Поиск аккаунта по электронной почте

GET
api_v2/Accounts/FindByEmail?searchString={searchString}
Имя параметра Тип Описание параметра
searchString String Строка поиска
Имя параметра Тип Описание параметра
AccountIDDTO AccountIDDTO Идентификатор аккаунта
application/xml, text/xml 
<Result>
  <AccountID>b3520fc9-5a6b-45ed-a7a1-b8a849d16ea1</AccountID>
</Result>
application/json, text/json 
{
  "AccountID": "b3520fc9-5a6b-45ed-a7a1-b8a849d16ea1"
}

GetAccountIdByIndexNumber

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

GET
api_v2/Accounts/GetAccountIdByIndexNumber?indexNumber={indexNumber}
Имя параметра Тип Описание параметра
indexNumber Int32 Номер аккаунта
Имя параметра Тип Описание параметра
AccountIDDTO AccountIDDTO Идентификатор аккаунта
application/xml, text/xml 
<Result>
  <AccountID>ac5d3b20-06be-4bc0-9e25-b54a8246f4d2</AccountID>
</Result>
application/json, text/json 
{
  "AccountID": "ac5d3b20-06be-4bc0-9e25-b54a8246f4d2"
}

GetAccoutUsersProperties

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

GET
api_v2/Accounts/GetAccoutUsersProperties?accountId={accountId}
Имя параметра Тип Описание параметра
accountId Guid Идентификатор аккаунта
Имя параметра Тип Описание параметра
AccountUsersTableDTO AccountUsersTableDTO Свойства пользователей аккаунта
application/xml, text/xml 
<Result>
  <AccountSearchResultTable Type="sample string 1">
    <Row>
      <ID>3b2adc36-859e-4600-bcc3-dff4e7d725cf</ID>
      <AccountID>67fdedcc-c9a8-47c2-aa56-4132f0eb556e</AccountID>
      <Login>sample string 3</Login>
      <Email>sample string 4</Email>
      <FullPhoneNumber>sample string 5</FullPhoneNumber>
      <FirstName>sample string 6</FirstName>
      <LastName>sample string 7</LastName>
      <MiddleName>sample string 8</MiddleName>
      <CorpUserID>dc429866-d590-448c-b115-f4ca6f67ec2d</CorpUserID>
      <CorpUserSyncStatus>sample string 9</CorpUserSyncStatus>
      <Removed>true</Removed>
      <CreationDate>sample string 11</CreationDate>
      <IsManager>true</IsManager>
      <Activated>true</Activated>
    </Row>
    <Row>
      <ID>3b2adc36-859e-4600-bcc3-dff4e7d725cf</ID>
      <AccountID>67fdedcc-c9a8-47c2-aa56-4132f0eb556e</AccountID>
      <Login>sample string 3</Login>
      <Email>sample string 4</Email>
      <FullPhoneNumber>sample string 5</FullPhoneNumber>
      <FirstName>sample string 6</FirstName>
      <LastName>sample string 7</LastName>
      <MiddleName>sample string 8</MiddleName>
      <CorpUserID>dc429866-d590-448c-b115-f4ca6f67ec2d</CorpUserID>
      <CorpUserSyncStatus>sample string 9</CorpUserSyncStatus>
      <Removed>true</Removed>
      <CreationDate>sample string 11</CreationDate>
      <IsManager>true</IsManager>
      <Activated>true</Activated>
    </Row>
    <Row>
      <ID>3b2adc36-859e-4600-bcc3-dff4e7d725cf</ID>
      <AccountID>67fdedcc-c9a8-47c2-aa56-4132f0eb556e</AccountID>
      <Login>sample string 3</Login>
      <Email>sample string 4</Email>
      <FullPhoneNumber>sample string 5</FullPhoneNumber>
      <FirstName>sample string 6</FirstName>
      <LastName>sample string 7</LastName>
      <MiddleName>sample string 8</MiddleName>
      <CorpUserID>dc429866-d590-448c-b115-f4ca6f67ec2d</CorpUserID>
      <CorpUserSyncStatus>sample string 9</CorpUserSyncStatus>
      <Removed>true</Removed>
      <CreationDate>sample string 11</CreationDate>
      <IsManager>true</IsManager>
      <Activated>true</Activated>
    </Row>
  </AccountSearchResultTable>
</Result>
application/json, text/json 
{
  "AccountSearchResultTable": {
    "Rows": [
      {
        "ID": "3b2adc36-859e-4600-bcc3-dff4e7d725cf",
        "AccountID": "67fdedcc-c9a8-47c2-aa56-4132f0eb556e",
        "Login": "sample string 3",
        "Email": "sample string 4",
        "FullPhoneNumber": "sample string 5",
        "FirstName": "sample string 6",
        "LastName": "sample string 7",
        "MiddleName": "sample string 8",
        "CorpUserID": "dc429866-d590-448c-b115-f4ca6f67ec2d",
        "CorpUserSyncStatus": "sample string 9",
        "Removed": true,
        "CreationDate": "sample string 11",
        "IsManager": true,
        "Activated": true
      },
      {
        "ID": "3b2adc36-859e-4600-bcc3-dff4e7d725cf",
        "AccountID": "67fdedcc-c9a8-47c2-aa56-4132f0eb556e",
        "Login": "sample string 3",
        "Email": "sample string 4",
        "FullPhoneNumber": "sample string 5",
        "FirstName": "sample string 6",
        "LastName": "sample string 7",
        "MiddleName": "sample string 8",
        "CorpUserID": "dc429866-d590-448c-b115-f4ca6f67ec2d",
        "CorpUserSyncStatus": "sample string 9",
        "Removed": true,
        "CreationDate": "sample string 11",
        "IsManager": true,
        "Activated": true
      },
      {
        "ID": "3b2adc36-859e-4600-bcc3-dff4e7d725cf",
        "AccountID": "67fdedcc-c9a8-47c2-aa56-4132f0eb556e",
        "Login": "sample string 3",
        "Email": "sample string 4",
        "FullPhoneNumber": "sample string 5",
        "FirstName": "sample string 6",
        "LastName": "sample string 7",
        "MiddleName": "sample string 8",
        "CorpUserID": "dc429866-d590-448c-b115-f4ca6f67ec2d",
        "CorpUserSyncStatus": "sample string 9",
        "Removed": true,
        "CreationDate": "sample string 11",
        "IsManager": true,
        "Activated": true
      }
    ]
  }
}

GetCompanyNameById

Получить название компании по идентификатору компании Нужен для промо сайта, при приглашении пользователя

GET
api_v2/Accounts/GetCompanyNameById?companyId={companyId}
Имя параметра Тип Описание параметра
companyId String Идентификатор компании
application/xml, text/xml 
<string>sample string 1</string>
application/json, text/json 
"sample string 1"

GetCurrentPhone

Получить текущий номер телефона Нужен для промо сайта, при активации отображении на какой номер был отправлен код активации

GET
api_v2/Accounts/GetCurrentPhone
application/xml, text/xml 
<string>sample string 1</string>
application/json, text/json 
"sample string 1"

GetPayment

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

GET
api_v2/Accounts/GetPayment?accountId={accountId}&startPeriod={startPeriod}&endPeriod={endPeriod}&type={type}
Имя параметра Тип Описание параметра
accountId Guid Идентификатор аккаунта
startPeriod Nullable`1 Начальный период поиска счета
endPeriod Nullable`1 Конечный период поиска счета
type String Тип счета
Имя параметра Тип Описание параметра
InvoiceDTO InvoiceDTO Счет аккаунта
application/xml, text/xml 
<Result>
  <Id>c64d869b-0eaa-42ba-a6ad-12276781ac26</Id>
  <Date>2020-04-03T03:56:10.0049657+03:00</Date>
  <Sum>3</Sum>
  <InvoiceNumber>sample string 4</InvoiceNumber>
  <Requisite>sample string 5</Requisite>
  <Description>sample string 6</Description>
  <Comment>sample string 7</Comment>
  <State>sample string 8</State>
  <AccountId>d825c8bb-b483-43ab-895c-5cdbfe745a7a</AccountId>
  <Uniq>sample string 10</Uniq>
  <Currency>sample string 11</Currency>
</Result>
application/json, text/json 
{
  "Id": "c64d869b-0eaa-42ba-a6ad-12276781ac26",
  "Date": "2020-04-03T03:56:10.0049657+03:00",
  "Sum": 3.0,
  "InvoiceNumber": "sample string 4",
  "Requisite": "sample string 5",
  "Description": "sample string 6",
  "Comment": "sample string 7",
  "State": "sample string 8",
  "AccountId": "d825c8bb-b483-43ab-895c-5cdbfe745a7a",
  "Uniq": "sample string 10",
  "Currency": "sample string 11"
}
AccountUsers

AccountUsers

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

GetProperties

Получить свойства пользователя облака.

GET
api_v2/AccountUsers/GetProperties?accountUserId={accountUserId}
Имя параметра Тип Описание параметра
accountUserId Guid Идентификатор пользователя облака.
Имя параметра Тип Описание параметра
AccountUserPropertiesDTO AccountUserPropertiesDTO Свойства пользователя облака.
application/xml, text/xml 
<Result>
  <ID>3bac225f-65b5-4853-8893-b534a3462a91</ID>
  <AccountID>0f0627b3-9cf4-4ee2-9d38-4b46d170893b</AccountID>
  <Login>sample string 3</Login>
  <Email>sample string 4</Email>
  <FullPhoneNumber>sample string 5</FullPhoneNumber>
  <FirstName>sample string 6</FirstName>
  <LastName>sample string 7</LastName>
  <MiddleName>sample string 8</MiddleName>
  <CorpUserID>9e42ff2b-b6e6-4b06-a9e3-20c3b2c87b89</CorpUserID>
  <CorpUserSyncStatus>sample string 9</CorpUserSyncStatus>
  <Removed>true</Removed>
  <CreationDate>sample string 11</CreationDate>
  <IsManager>true</IsManager>
  <Activated>true</Activated>
</Result>
application/json, text/json 
{
  "ID": "3bac225f-65b5-4853-8893-b534a3462a91",
  "AccountID": "0f0627b3-9cf4-4ee2-9d38-4b46d170893b",
  "Login": "sample string 3",
  "Email": "sample string 4",
  "FullPhoneNumber": "sample string 5",
  "FirstName": "sample string 6",
  "LastName": "sample string 7",
  "MiddleName": "sample string 8",
  "CorpUserID": "9e42ff2b-b6e6-4b06-a9e3-20c3b2c87b89",
  "CorpUserSyncStatus": "sample string 9",
  "Removed": true,
  "CreationDate": "sample string 11",
  "IsManager": true,
  "Activated": true
}

GetAccountId

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

GET
api_v2/AccountUsers/GetAccountId?accountUserId={accountUserId}
Имя параметра Тип Описание параметра
accountUserId Guid Идентификатор пользователя облака
Имя параметра Тип Описание параметра
AccountUserAccountIDDTO AccountUserAccountIDDTO Номер аккаунта пользователя облака
application/xml, text/xml 
<Result>
  <AccountID>1d4cfda4-b923-47de-8766-41d0f76b2122</AccountID>
</Result>
application/json, text/json 
{
  "AccountID": "1d4cfda4-b923-47de-8766-41d0f76b2122"
}

GetIdByEmail

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

GET
api_v2/AccountUsers/GetIdByEmail?email={email}
Имя параметра Тип Описание параметра
email String Электронная почта
Имя параметра Тип Описание параметра
AccountUserIDDTO AccountUserIDDTO Идентификатор пользователя
application/xml, text/xml 
<Result>
  <AccountUserID>c05e9ea3-f0d2-487c-8593-e585c1999339</AccountUserID>
</Result>
application/json, text/json 
{
  "AccountUserID": "c05e9ea3-f0d2-487c-8593-e585c1999339"
}

GetIdByLogin

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

GET
api_v2/AccountUsers/GetIdByLogin?login={login}
Имя параметра Тип Описание параметра
login String Логин пользователя
Имя параметра Тип Описание параметра
AccountUserIDDTO AccountUserIDDTO Идентификатор пользователя
application/xml, text/xml 
<Result>
  <AccountUserID>0c7fe3eb-454b-4fc0-ad6d-2357e73bdc3b</AccountUserID>
</Result>
application/json, text/json 
{
  "AccountUserID": "0c7fe3eb-454b-4fc0-ad6d-2357e73bdc3b"
}

GetIdByPhoneNumber

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

GET
api_v2/AccountUsers/GetIdByPhoneNumber?phoneCountry={phoneCountry}&phoneNumber={phoneNumber}
Имя параметра Тип Описание параметра
phoneCountry String Телефонный код страны
phoneNumber String Номер телефона
Имя параметра Тип Описание параметра
AccountUserIDDTO AccountUserIDDTO Идентификатор пользователя
application/xml, text/xml 
<Result>
  <AccountUserID>00d5780c-aa45-49ec-912b-460fda5d02c0</AccountUserID>
</Result>
application/json, text/json 
{
  "AccountUserID": "00d5780c-aa45-49ec-912b-460fda5d02c0"
}

GetIDs

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

GET
api_v2/AccountUsers/GetIDs?accountID={accountID}
Имя параметра Тип Описание параметра
accountID Guid Идентификатор аккаунта
Имя параметра Тип Описание параметра
AccountUsersIDsListDTO AccountUsersIDsListDTO Список идентификаторов пользователей
application/xml, text/xml 
<Result>
  <AccountUserIDs Type="sample string 1">
    <Item>21279167-e2e6-48a6-995b-0aed899cb68b</Item>
    <Item>2c694c4a-de54-4e0e-b983-4f895f4fb45b</Item>
    <Item>813d5e28-2698-49ef-87a0-acec763464c8</Item>
  </AccountUserIDs>
</Result>
application/json, text/json 
{
  "AccountUserIDs": {
    "List": [
      "21279167-e2e6-48a6-995b-0aed899cb68b",
      "2c694c4a-de54-4e0e-b983-4f895f4fb45b",
      "813d5e28-2698-49ef-87a0-acec763464c8"
    ]
  }
}

GetLogin

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

GET
api_v2/AccountUsers/GetLogin?accountUserID={accountUserID}
Имя параметра Тип Описание параметра
accountUserID Guid Идентификатор пользователя облака
Имя параметра Тип Описание параметра
AccountUserLoginDTO AccountUserLoginDTO Логин пользователя облака
application/xml, text/xml 
<Result>
  <Login>sample string 1</Login>
</Result>
application/json, text/json 
{
  "Login": "sample string 1"
}

GetEmail

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

GET
api_v2/AccountUsers/GetEmail?accountUserID={accountUserID}
Имя параметра Тип Описание параметра
accountUserID Guid Идентификатор пользователя облака
Имя параметра Тип Описание параметра
AccountUserEmailDTO AccountUserEmailDTO Электронная почта пользователя
application/xml, text/xml 
<Result>
  <Email>sample string 1</Email>
</Result>
application/json, text/json 
{
  "Email": "sample string 1"
}

GetPhoneNumber

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

GET
api_v2/AccountUsers/GetPhoneNumber?accountUserID={accountUserID}
Имя параметра Тип Описание параметра
accountUserID Guid Идентификатор пользователя облака
Имя параметра Тип Описание параметра
AccountUserPhoneNumberDTO AccountUserPhoneNumberDTO Номер телефона пользователя облака
application/xml, text/xml 
<Result>
  <PhoneNumber>sample string 1</PhoneNumber>
</Result>
application/json, text/json 
{
  "PhoneNumber": "sample string 1"
}

GetFirstName

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

GET
api_v2/AccountUsers/GetFirstName?accountUserID={accountUserID}
Имя параметра Тип Описание параметра
accountUserID Guid Идентификатор пользователя облака
Имя параметра Тип Описание параметра
AccountUserFirstNameDTO AccountUserFirstNameDTO Фамилия пользователя облака
application/xml, text/xml 
<Result>
  <FirstName>sample string 1</FirstName>
</Result>
application/json, text/json 
{
  "FirstName": "sample string 1"
}

GetLastName

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

GET
api_v2/AccountUsers/GetLastName?accountUserID={accountUserID}
Имя параметра Тип Описание параметра
accountUserID Guid Идентификатор пользователя облака
Имя параметра Тип Описание параметра
AccountUserLastNameDTO AccountUserLastNameDTO Имя пользователя облака
application/xml, text/xml 
<Result>
  <LastName>sample string 1</LastName>
</Result>
application/json, text/json 
{
  "LastName": "sample string 1"
}

GetMiddleName

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

GET
api_v2/AccountUsers/GetMiddleName?accountUserID={accountUserID}
Имя параметра Тип Описание параметра
accountUserID Guid Идентификатор пользователя облака
Имя параметра Тип Описание параметра
AccountUserMiddleNameDTO AccountUserMiddleNameDTO Отчество пользователя облака
application/xml, text/xml 
<Result>
  <MiddleName>sample string 1</MiddleName>
</Result>
application/json, text/json 
{
  "MiddleName": "sample string 1"
}

GetActivated

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

GET
api_v2/AccountUsers/GetActivated?accountUserID={accountUserID}
Имя параметра Тип Описание параметра
accountUserID Guid Идентификатор пользователя облака
Имя параметра Тип Описание параметра
AccountUserActivatedDTO AccountUserActivatedDTO Признак активности пользователя облака
application/xml, text/xml 
<Result>
  <Activated>true</Activated>
</Result>
application/json, text/json 
{
  "Activated": true
}

GetCreationDate

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

GET
api_v2/AccountUsers/GetCreationDate?accountUserID={accountUserID}
Имя параметра Тип Описание параметра
accountUserID Guid Идентификатор пользователя облака
Имя параметра Тип Описание параметра
AccountUserCreationDateDTO AccountUserCreationDateDTO Дата регистрации пользователя облака
application/xml, text/xml 
<Result>
  <CreationDate>2020-04-03T03:56:10.0049657+03:00</CreationDate>
</Result>
application/json, text/json 
{
  "CreationDate": "2020-04-03T03:56:10.0049657+03:00"
}

Find

Поиск пользователей облака по фильтру

GET
api_v2/AccountUsers/Find?searchString={searchString}&accountId={accountId}&maxRecordsCount={maxRecordsCount}
Имя параметра Тип Описание параметра
searchString String Строка поиска
accountId Nullable`1 Идентификатор аккаунта
maxRecordsCount Int32 Максимальное количество записей
Имя параметра Тип Описание параметра
AccountUserInfoTableDTO AccountUserInfoTableDTO Пользователи облака
application/xml, text/xml 
<Result>
  <AccountSearchResultTable Type="sample string 1">
    <Row>
      <AccountUserId>4071767d-1a0e-4ffe-ad8c-2afc6a1906d1</AccountUserId>
      <AccountUserName>sample string 2</AccountUserName>
      <Email>sample string 3</Email>
    </Row>
    <Row>
      <AccountUserId>4071767d-1a0e-4ffe-ad8c-2afc6a1906d1</AccountUserId>
      <AccountUserName>sample string 2</AccountUserName>
      <Email>sample string 3</Email>
    </Row>
    <Row>
      <AccountUserId>4071767d-1a0e-4ffe-ad8c-2afc6a1906d1</AccountUserId>
      <AccountUserName>sample string 2</AccountUserName>
      <Email>sample string 3</Email>
    </Row>
  </AccountSearchResultTable>
</Result>
application/json, text/json 
{
  "AccountSearchResultTable": {
    "Rows": [
      {
        "Id": "4071767d-1a0e-4ffe-ad8c-2afc6a1906d1",
        "AccountUserName": "sample string 2",
        "Email": "sample string 3"
      },
      {
        "Id": "4071767d-1a0e-4ffe-ad8c-2afc6a1906d1",
        "AccountUserName": "sample string 2",
        "Email": "sample string 3"
      },
      {
        "Id": "4071767d-1a0e-4ffe-ad8c-2afc6a1906d1",
        "AccountUserName": "sample string 2",
        "Email": "sample string 3"
      }
    ]
  }
}

GetAccountUsers

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

GET
api_v2/AccountUsers/GetAccountUsers?accountId={accountId}
Имя параметра Тип Описание параметра
accountId Guid Идентификатор аккаунта
Имя параметра Тип Описание параметра
AccountUserListDTO AccountUserListDTO Cписок пользователей аккаунта
application/xml, text/xml 
<Result>
  <AccountUserList>
    <ID>13193dcb-65e9-4b10-b2ea-197b027b1e53</ID>
    <AccountID>eecbd70d-8811-45d5-a74d-3444644cd0e9</AccountID>
    <Login>sample string 3</Login>
    <Email>sample string 4</Email>
    <FullPhoneNumber>sample string 5</FullPhoneNumber>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <MiddleName>sample string 8</MiddleName>
    <CorpUserID>48e54c62-6217-413a-8dff-3c054ebc8f08</CorpUserID>
    <CorpUserSyncStatus>sample string 9</CorpUserSyncStatus>
    <Removed>true</Removed>
    <CreationDate>sample string 11</CreationDate>
    <IsManager>true</IsManager>
    <Activated>true</Activated>
  </AccountUserList>
  <AccountUserList>
    <ID>13193dcb-65e9-4b10-b2ea-197b027b1e53</ID>
    <AccountID>eecbd70d-8811-45d5-a74d-3444644cd0e9</AccountID>
    <Login>sample string 3</Login>
    <Email>sample string 4</Email>
    <FullPhoneNumber>sample string 5</FullPhoneNumber>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <MiddleName>sample string 8</MiddleName>
    <CorpUserID>48e54c62-6217-413a-8dff-3c054ebc8f08</CorpUserID>
    <CorpUserSyncStatus>sample string 9</CorpUserSyncStatus>
    <Removed>true</Removed>
    <CreationDate>sample string 11</CreationDate>
    <IsManager>true</IsManager>
    <Activated>true</Activated>
  </AccountUserList>
  <AccountUserList>
    <ID>13193dcb-65e9-4b10-b2ea-197b027b1e53</ID>
    <AccountID>eecbd70d-8811-45d5-a74d-3444644cd0e9</AccountID>
    <Login>sample string 3</Login>
    <Email>sample string 4</Email>
    <FullPhoneNumber>sample string 5</FullPhoneNumber>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <MiddleName>sample string 8</MiddleName>
    <CorpUserID>48e54c62-6217-413a-8dff-3c054ebc8f08</CorpUserID>
    <CorpUserSyncStatus>sample string 9</CorpUserSyncStatus>
    <Removed>true</Removed>
    <CreationDate>sample string 11</CreationDate>
    <IsManager>true</IsManager>
    <Activated>true</Activated>
  </AccountUserList>
</Result>
application/json, text/json 
{
  "AccountDatabaseList": [
    {
      "ID": "13193dcb-65e9-4b10-b2ea-197b027b1e53",
      "AccountID": "eecbd70d-8811-45d5-a74d-3444644cd0e9",
      "Login": "sample string 3",
      "Email": "sample string 4",
      "FullPhoneNumber": "sample string 5",
      "FirstName": "sample string 6",
      "LastName": "sample string 7",
      "MiddleName": "sample string 8",
      "CorpUserID": "48e54c62-6217-413a-8dff-3c054ebc8f08",
      "CorpUserSyncStatus": "sample string 9",
      "Removed": true,
      "CreationDate": "sample string 11",
      "IsManager": true,
      "Activated": true
    },
    {
      "ID": "13193dcb-65e9-4b10-b2ea-197b027b1e53",
      "AccountID": "eecbd70d-8811-45d5-a74d-3444644cd0e9",
      "Login": "sample string 3",
      "Email": "sample string 4",
      "FullPhoneNumber": "sample string 5",
      "FirstName": "sample string 6",
      "LastName": "sample string 7",
      "MiddleName": "sample string 8",
      "CorpUserID": "48e54c62-6217-413a-8dff-3c054ebc8f08",
      "CorpUserSyncStatus": "sample string 9",
      "Removed": true,
      "CreationDate": "sample string 11",
      "IsManager": true,
      "Activated": true
    },
    {
      "ID": "13193dcb-65e9-4b10-b2ea-197b027b1e53",
      "AccountID": "eecbd70d-8811-45d5-a74d-3444644cd0e9",
      "Login": "sample string 3",
      "Email": "sample string 4",
      "FullPhoneNumber": "sample string 5",
      "FirstName": "sample string 6",
      "LastName": "sample string 7",
      "MiddleName": "sample string 8",
      "CorpUserID": "48e54c62-6217-413a-8dff-3c054ebc8f08",
      "CorpUserSyncStatus": "sample string 9",
      "Removed": true,
      "CreationDate": "sample string 11",
      "IsManager": true,
      "Activated": true
    }
  ]
}
PartnerServicesData

PartnerServicesData

Контроллер для работы с сервисами партнера

GetAccountServicesList

Получить список сервисов у аккаунта. Сервисы принадлежащие партнеру.

GET
api_v2/PartnerServicesData/GetAccountServicesList?accountId={accountId}
Имя параметра Тип Описание параметра
accountId Guid Номер аккаунта партнера.
Имя параметра Тип Описание параметра
GuidListItem GuidListItem Список номеров сервисов.
application/xml, text/xml 
<GuidListItem Type="sample string 1">
  <Item>aa723578-bcee-49de-a77c-8312d7590df2</Item>
  <Item>788c8048-207d-42bc-a3c1-0e3f8a862eef</Item>
  <Item>c0d8110e-8ff2-4260-8574-38130d7a7936</Item>
</GuidListItem>
application/json, text/json 
{
  "List": [
    "aa723578-bcee-49de-a77c-8312d7590df2",
    "788c8048-207d-42bc-a3c1-0e3f8a862eef",
    "c0d8110e-8ff2-4260-8574-38130d7a7936"
  ]
}

GetServiceInfo

Получить детальную информацию по партнерскому сервису.

GET
api_v2/PartnerServicesData/GetServiceInfo?serviceId={serviceId}
Имя параметра Тип Описание параметра
serviceId Guid Номер сервиса.
Имя параметра Тип Описание параметра
ServiceInfoDto ServiceInfoDto Информация по сервису.
application/xml, text/xml 
<Result>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
  <BillingServiceStatus>Draft</BillingServiceStatus>
  <ServiceActivationDate>2020-04-03T03:56:10.0049657+03:00</ServiceActivationDate>
</Result>
application/json, text/json 
{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "BillingServiceStatus": 1,
  "ServiceActivationDate": "2020-04-03T03:56:10.0049657+03:00"
}

GetServiceTypesList

Получить список услуг партнерского сервиса.

GET
api_v2/PartnerServicesData/GetServiceTypesList?serviceId={serviceId}
Имя параметра Тип Описание параметра
serviceId Guid Номер сервиса.
Имя параметра Тип Описание параметра
GuidListItem GuidListItem Список услуг сервиса.
application/xml, text/xml 
<GuidListItem Type="sample string 1">
  <Item>3cbcb219-8a2f-4471-af5e-140e64aeaa56</Item>
  <Item>49db1cfd-25fe-45f0-87e1-19e666be336c</Item>
  <Item>537473ee-1b91-40f9-b2ea-fc90bc2666fe</Item>
</GuidListItem>
application/json, text/json 
{
  "List": [
    "3cbcb219-8a2f-4471-af5e-140e64aeaa56",
    "49db1cfd-25fe-45f0-87e1-19e666be336c",
    "537473ee-1b91-40f9-b2ea-fc90bc2666fe"
  ]
}

GetServiceTypeInfo

Получить детальную информацию о услуге сервиса.

GET
api_v2/PartnerServicesData/GetServiceTypeInfo?serviceTypeId={serviceTypeId}
Имя параметра Тип Описание параметра
serviceTypeId Guid Номер услуги сервиса.
Имя параметра Тип Описание параметра
ServiceTypeInfoDto ServiceTypeInfoDto Информация по услуге сервиса.
application/xml, text/xml 
<Result>
  <Name>sample string 1</Name>
  <Description>sample string 2</Description>
  <BillingType>ForAccountUser</BillingType>
  <DependServiceTypeId>a9f4f13e-4a9a-4262-84df-4a173e26b90c</DependServiceTypeId>
  <Cost>3</Cost>
</Result>
application/json, text/json 
{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "BillingType": 0,
  "DependServiceTypeId": "a9f4f13e-4a9a-4262-84df-4a173e26b90c",
  "Cost": 3.0
}

GetServiceTypesStateForUser

Получить информацию по состоянию сервиса и подключенным услугам у клиента.

GET
api_v2/PartnerServicesData/GetServiceTypesStateForUser?serviceId={serviceId}&accountUserId={accountUserId}
Имя параметра Тип Описание параметра
serviceId Guid Номер сервиса.
accountUserId Guid Номер пользователя облака 42.
Имя параметра Тип Описание параметра
ServiceTypeStateForUserDto ServiceTypeStateForUserDto Список подключенных услуг сервиса у клиента.
application/xml, text/xml 
<Result>
  <ServiceIsActive>true</ServiceIsActive>
  <ServiceExpiredDate>2020-04-03T03:56:10.0049657+03:00</ServiceExpiredDate>
  <EnabledServiceTypesList Type="sample string 1">
    <Item>944e3361-3e0c-4282-8721-01f57f346903</Item>
    <Item>cb985fba-0143-4dd2-a2ac-248758443e92</Item>
    <Item>50d84ad4-2139-4eb2-94bc-b2bee947117f</Item>
  </EnabledServiceTypesList>
</Result>
application/json, text/json 
{
  "ServiceIsActive": true,
  "ServiceExpiredDate": "2020-04-03T03:56:10.0049657+03:00",
  "EnabledServiceTypesList": {
    "List": [
      "944e3361-3e0c-4282-8721-01f57f346903",
      "cb985fba-0143-4dd2-a2ac-248758443e92",
      "50d84ad4-2139-4eb2-94bc-b2bee947117f"
    ]
  }
}

GetServiceTypeStateForUserByLogin

Получить информацию по состоянию сервиса и подключенным услугам у клиента.

GET
api_v2/PartnerServicesData/GetServiceTypeStateForUserByLogin?serviceId={serviceId}&accountUserLogin={accountUserLogin}
Имя параметра Тип Описание параметра
serviceId Guid Номер сервиса.
accountUserLogin String Логин пользователя облака 42.
Имя параметра Тип Описание параметра
ServiceTypeStateForUserDto ServiceTypeStateForUserDto Список подключенных услуг сервиса у клиента.
application/xml, text/xml 
<Result>
  <ServiceIsActive>true</ServiceIsActive>
  <ServiceExpiredDate>2020-04-03T03:56:10.0049657+03:00</ServiceExpiredDate>
  <EnabledServiceTypesList Type="sample string 1">
    <Item>e2ba0817-e4bc-4c0d-ab5b-f3fe8bb47044</Item>
    <Item>2725514c-69a0-4cbc-875f-a8d45bb57af5</Item>
    <Item>951a4c82-8913-4422-88d4-665f5b9fd7d7</Item>
  </EnabledServiceTypesList>
</Result>
application/json, text/json 
{
  "ServiceIsActive": true,
  "ServiceExpiredDate": "2020-04-03T03:56:10.0049657+03:00",
  "EnabledServiceTypesList": {
    "List": [
      "e2ba0817-e4bc-4c0d-ab5b-f3fe8bb47044",
      "2725514c-69a0-4cbc-875f-a8d45bb57af5",
      "951a4c82-8913-4422-88d4-665f5b9fd7d7"
    ]
  }
}

CheckServiceTypeStatusForUserByLogin

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

GET
api_v2/PartnerServicesData/CheckServiceTypeStatusForUserByLogin?serviceTypeId={serviceTypeId}&accountUserLogin={accountUserLogin}
Имя параметра Тип Описание параметра
serviceTypeId Guid Номер услуги сервиса.
accountUserLogin String Логин пользователя облака 42.
Имя параметра Тип Описание параметра
BoolDTO BoolDTO Признак активности указанной услуги сервиса у клиента.
application/xml, text/xml 
<Result>
  <Result>true</Result>
</Result>
application/json, text/json 
{
  "Result": true
}

ActivateService

Активировать сервис для пользователя.

GET
api_v2/PartnerServicesData/ActivateService?serviceId={serviceId}&accountUserId={accountUserId}
Имя параметра Тип Описание параметра
serviceId Guid Номер сервиса.
accountUserId Guid Номер пользователя облака 42.
AgentCashOutRequest

AgentCashOutRequest

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

GetAgentCashOutRequestsInStatusNew

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

GET
api_v2/AgentCashOutRequest/GetAgentCashOutRequestsInStatusNew
Имя параметра Тип Описание параметра
AgentCashOutRequestsInStatusNewDto AgentCashOutRequestsInStatusNewDto Заявки на вывод средств в статусе "Новая"
application/xml, text/xml 
<Result>
  <ActualAgencyAgreementDate>2020-04-03T03:56:10.0049657+03:00</ActualAgencyAgreementDate>
  <ActualAgencyAgreementLink>sample string 2</ActualAgencyAgreementLink>
  <AgentCashOutRequests Type="sample string 1">
    <Row>
      <RequestNumber>sample string 1</RequestNumber>
      <AccountNumber>2</AccountNumber>
      <CreationDateTime>2020-04-03T03:56:10.0049657+03:00</CreationDateTime>
      <Sum>4</Sum>
      <AgentReportLinks Type="sample string 1">
        <Item>sample string 1</Item>
        <Item>sample string 2</Item>
        <Item>sample string 3</Item>
      </AgentReportLinks>
      <AgentRequisitesForPayment>
        <Recipient>sample string 1</Recipient>
        <Inn>sample string 2</Inn>
        <BankName>sample string 3</BankName>
        <SettlementAccount>sample string 4</SettlementAccount>
      </AgentRequisitesForPayment>
      <SupplierCode>sample string 5</SupplierCode>
    </Row>
    <Row>
      <RequestNumber>sample string 1</RequestNumber>
      <AccountNumber>2</AccountNumber>
      <CreationDateTime>2020-04-03T03:56:10.0049657+03:00</CreationDateTime>
      <Sum>4</Sum>
      <AgentReportLinks Type="sample string 1">
        <Item>sample string 1</Item>
        <Item>sample string 2</Item>
        <Item>sample string 3</Item>
      </AgentReportLinks>
      <AgentRequisitesForPayment>
        <Recipient>sample string 1</Recipient>
        <Inn>sample string 2</Inn>
        <BankName>sample string 3</BankName>
        <SettlementAccount>sample string 4</SettlementAccount>
      </AgentRequisitesForPayment>
      <SupplierCode>sample string 5</SupplierCode>
    </Row>
    <Row>
      <RequestNumber>sample string 1</RequestNumber>
      <AccountNumber>2</AccountNumber>
      <CreationDateTime>2020-04-03T03:56:10.0049657+03:00</CreationDateTime>
      <Sum>4</Sum>
      <AgentReportLinks Type="sample string 1">
        <Item>sample string 1</Item>
        <Item>sample string 2</Item>
        <Item>sample string 3</Item>
      </AgentReportLinks>
      <AgentRequisitesForPayment>
        <Recipient>sample string 1</Recipient>
        <Inn>sample string 2</Inn>
        <BankName>sample string 3</BankName>
        <SettlementAccount>sample string 4</SettlementAccount>
      </AgentRequisitesForPayment>
      <SupplierCode>sample string 5</SupplierCode>
    </Row>
  </AgentCashOutRequests>
</Result>
application/json, text/json 
{
  "ActualAgencyAgreementDate": "2020-04-03T03:56:10.0049657+03:00",
  "ActualAgencyAgreementLink": "sample string 2",
  "AgentCashOutRequests": {
    "Row": [
      {
        "RequestNumber": "sample string 1",
        "AccountNumber": 2,
        "CreationDateTime": "2020-04-03T03:56:10.0049657+03:00",
        "Sum": 4.0,
        "AgentReportLinks": {
          "Item": [
            "sample string 1",
            "sample string 2",
            "sample string 3"
          ]
        },
        "AgentRequisitesForPayment": {
          "Recipient": "sample string 1",
          "Inn": "sample string 2",
          "BankName": "sample string 3",
          "SettlementAccount": "sample string 4"
        },
        "SupplierCode": "sample string 5"
      },
      {
        "RequestNumber": "sample string 1",
        "AccountNumber": 2,
        "CreationDateTime": "2020-04-03T03:56:10.0049657+03:00",
        "Sum": 4.0,
        "AgentReportLinks": {
          "Item": [
            "sample string 1",
            "sample string 2",
            "sample string 3"
          ]
        },
        "AgentRequisitesForPayment": {
          "Recipient": "sample string 1",
          "Inn": "sample string 2",
          "BankName": "sample string 3",
          "SettlementAccount": "sample string 4"
        },
        "SupplierCode": "sample string 5"
      },
      {
        "RequestNumber": "sample string 1",
        "AccountNumber": 2,
        "CreationDateTime": "2020-04-03T03:56:10.0049657+03:00",
        "Sum": 4.0,
        "AgentReportLinks": {
          "Item": [
            "sample string 1",
            "sample string 2",
            "sample string 3"
          ]
        },
        "AgentRequisitesForPayment": {
          "Recipient": "sample string 1",
          "Inn": "sample string 2",
          "BankName": "sample string 3",
          "SettlementAccount": "sample string 4"
        },
        "SupplierCode": "sample string 5"
      }
    ]
  }
}

ChangeAgentCashOutRequestStatus

Сменить статус заявки на вывод средств

POST
api_v2/AgentCashOutRequest/ChangeAgentCashOutRequestStatus
Имя параметра Тип Описание параметра
changeAgentCashOutRequestStatus ChangeAgentCashOutRequestStatusDto Модель смены статуса заявки на вывод средств
application/xml, text/xml 
<Request>
  <RequestNumber>sample string 1</RequestNumber>
  <Sum>2</Sum>
  <Status>New</Status>
</Request>
application/json, text/json 
{
  "RequestNumber": "sample string 1",
  "Sum": 2.0,
  "Status": 1
}
AccountUserSessions

AccountUserSessions

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

CheckTokenValidity

Выполнить валидацию токена для пользователя облака

GET
api_v2/AccountUserSessions/CheckTokenValidity?token={token}
Имя параметра Тип Описание параметра
token Guid Токен пользователя
Имя параметра Тип Описание параметра
AccounUserTokenValidityDTO AccounUserTokenValidityDTO Валидность токена
application/xml, text/xml 
<Result>
  <TokenValidity>true</TokenValidity>
</Result>
application/json, text/json 
{
  "TokenValidity": true
}

GetAccountUserIDByToken

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

GET
api_v2/AccountUserSessions/GetAccountUserIDByToken?token={token}
Имя параметра Тип Описание параметра
token Guid Токен пользователя
Имя параметра Тип Описание параметра
AccountUserIDDTO AccountUserIDDTO Идентификатора пользователя
application/xml, text/xml 
<Result>
  <AccountUserID>9cc52eaf-7bf8-4f1c-9daf-ae620c89e004</AccountUserID>
</Result>
application/json, text/json 
{
  "AccountUserID": "9cc52eaf-7bf8-4f1c-9daf-ae620c89e004"
}

Login

Выполнить вход в облако по средствам логин/пароля. Создается запись с новой сессией пользователя.

POST
api_v2/AccountUserSessions/Login
Имя параметра Тип Описание параметра
model LoginModel Параметры входа
application/xml, text/xml 
<Request>
  <AccountUserLogin>sample string 1</AccountUserLogin>
  <AccountUserPassword>sample string 2</AccountUserPassword>
  <ClientDescription>sample string 3</ClientDescription>
  <ClientDeviceInfo>sample string 4</ClientDeviceInfo>
</Request>
application/json, text/json 
{
  "AccountUserLogin": "sample string 1",
  "AccountUserPassword": "sample string 2",
  "ClientDescription": "sample string 3",
  "ClientDeviceInfo": "sample string 4"
}
Имя параметра Тип Описание параметра
AccountUserTokenDTO AccountUserTokenDTO Идентификатор созданной сессии. SessionToken
application/xml, text/xml 
<Result>
  <Token>9d4407b1-4d68-4c6b-95a1-4cf0a163e4db</Token>
</Result>
application/json, text/json 
{
  "Token": "9d4407b1-4d68-4c6b-95a1-4cf0a163e4db"
}

LoginByEmail

Выполнить вход в облако по средствам электронной почты/пароля Создается запись с новой сессией пользователя.

POST
api_v2/AccountUserSessions/LoginByEmail
Имя параметра Тип Описание параметра
model LoginEmailModelDTO Параметры входа
application/xml, text/xml 
<Request>
  <Email>sample string 1</Email>
  <Password>sample string 2</Password>
</Request>
application/json, text/json 
{
  "Email": "sample string 1",
  "Password": "sample string 2"
}
Имя параметра Тип Описание параметра
AccountTokenAuthorization AccountTokenAuthorization Идентификатор созданной сессии. SessionToken
application/xml, text/xml 
<Result>
  <AccountToken>c4e1e98c-e793-4e9d-93ad-fa9eb5067ff4</AccountToken>
</Result>
application/json, text/json 
{
  "AccountToken": "c4e1e98c-e793-4e9d-93ad-fa9eb5067ff4"
}