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.
AgentCashOutRequest

AgentCashOutRequest

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

GetAgentCashOutRequestsInStatusNew

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

GET
api_v2/AgentCashOutRequest/GetAgentCashOutRequestsInStatusNew
Имя параметра Тип Описание параметра
AgentCashOutRequestsInStatusNewDto AgentCashOutRequestsInStatusNewDto Заявки на вывод средств в статусе "Новая"
application/xml, text/xml 
<Result>
  <ActualAgencyAgreementDate>2020-04-08T22:10:21.8506477+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-08T22:10:21.8506477+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-08T22:10:21.8506477+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-08T22:10:21.8506477+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-08T22:10:21.8506477+03:00",
  "ActualAgencyAgreementLink": "sample string 2",
  "AgentCashOutRequests": {
    "Row": [
      {
        "RequestNumber": "sample string 1",
        "AccountNumber": 2,
        "CreationDateTime": "2020-04-08T22:10:21.8506477+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-08T22:10:21.8506477+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-08T22:10:21.8506477+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
}
PartnerServicesData

PartnerServicesData

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

GetAccountServicesList

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

GET
api_v2/PartnerServicesData/GetAccountServicesList?accountId={accountId}
Имя параметра Тип Описание параметра
accountId Guid Номер аккаунта партнера.
Имя параметра Тип Описание параметра
GuidListItem GuidListItem Список номеров сервисов.
application/xml, text/xml 
<GuidListItem Type="sample string 1">
  <Item>29529419-a83a-4c61-98ae-001730d5b9ef</Item>
  <Item>bf2bce20-d6d5-4a61-b538-59404211dd39</Item>
  <Item>c0ac2dc6-8e0b-4044-b23e-e4645a22cb8c</Item>
</GuidListItem>
application/json, text/json 
{
  "List": [
    "29529419-a83a-4c61-98ae-001730d5b9ef",
    "bf2bce20-d6d5-4a61-b538-59404211dd39",
    "c0ac2dc6-8e0b-4044-b23e-e4645a22cb8c"
  ]
}

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-08T22:10:21.9287699+03:00</ServiceActivationDate>
</Result>
application/json, text/json 
{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "BillingServiceStatus": 1,
  "ServiceActivationDate": "2020-04-08T22:10:21.9287699+03:00"
}

GetServiceTypesList

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

GET
api_v2/PartnerServicesData/GetServiceTypesList?serviceId={serviceId}
Имя параметра Тип Описание параметра
serviceId Guid Номер сервиса.
Имя параметра Тип Описание параметра
GuidListItem GuidListItem Список услуг сервиса.
application/xml, text/xml 
<GuidListItem Type="sample string 1">
  <Item>52b3c74e-3306-49e0-9461-b107f249bc18</Item>
  <Item>0be75ae0-780f-4b8d-ba17-17e8eb19c883</Item>
  <Item>81ddd1e9-4a85-4ae6-be1c-237d07a18144</Item>
</GuidListItem>
application/json, text/json 
{
  "List": [
    "52b3c74e-3306-49e0-9461-b107f249bc18",
    "0be75ae0-780f-4b8d-ba17-17e8eb19c883",
    "81ddd1e9-4a85-4ae6-be1c-237d07a18144"
  ]
}

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>810a06f4-639c-41fb-9bc3-11393ee5c471</DependServiceTypeId>
  <Cost>3</Cost>
</Result>
application/json, text/json 
{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "BillingType": 0,
  "DependServiceTypeId": "810a06f4-639c-41fb-9bc3-11393ee5c471",
  "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-08T22:10:21.9443955+03:00</ServiceExpiredDate>
  <EnabledServiceTypesList Type="sample string 1">
    <Item>248785ca-c46b-4cee-a2ae-2120508b29ea</Item>
    <Item>8e61b4ef-8ace-415f-9628-57fbef930b42</Item>
    <Item>dc3bd143-2689-45f6-bf48-d25d33b21ba5</Item>
  </EnabledServiceTypesList>
</Result>
application/json, text/json 
{
  "ServiceIsActive": true,
  "ServiceExpiredDate": "2020-04-08T22:10:21.9443955+03:00",
  "EnabledServiceTypesList": {
    "List": [
      "248785ca-c46b-4cee-a2ae-2120508b29ea",
      "8e61b4ef-8ace-415f-9628-57fbef930b42",
      "dc3bd143-2689-45f6-bf48-d25d33b21ba5"
    ]
  }
}

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-08T22:10:21.9443955+03:00</ServiceExpiredDate>
  <EnabledServiceTypesList Type="sample string 1">
    <Item>7d61fdd7-f7f1-4d16-9ffa-7bc118ae97df</Item>
    <Item>1f51df93-4cf1-4541-9f3b-b8a3dd3ab037</Item>
    <Item>24c2c3fd-e797-4745-adb0-9c0be24c855e</Item>
  </EnabledServiceTypesList>
</Result>
application/json, text/json 
{
  "ServiceIsActive": true,
  "ServiceExpiredDate": "2020-04-08T22:10:21.9443955+03:00",
  "EnabledServiceTypesList": {
    "List": [
      "7d61fdd7-f7f1-4d16-9ffa-7bc118ae97df",
      "1f51df93-4cf1-4541-9f3b-b8a3dd3ab037",
      "24c2c3fd-e797-4745-adb0-9c0be24c855e"
    ]
  }
}

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.
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>119bc24e-3a96-4b1c-aa31-5a0a1da1f4c0</AccountUserID>
</Result>
application/json, text/json 
{
  "AccountUserID": "119bc24e-3a96-4b1c-aa31-5a0a1da1f4c0"
}

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>75af4519-e9c2-4c70-b3bd-f5b76fbc60fc</Token>
</Result>
application/json, text/json 
{
  "Token": "75af4519-e9c2-4c70-b3bd-f5b76fbc60fc"
}

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>1c233057-68e6-49fe-835a-6ee65466de62</AccountToken>
</Result>
application/json, text/json 
{
  "AccountToken": "1c233057-68e6-49fe-835a-6ee65466de62"
}
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>1f5b4996-c6c1-4243-b099-fa51e988570d</LocaleId>
  <ManagerId>19b0ea40-d4be-48f1-b516-9845922e4767</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": "1f5b4996-c6c1-4243-b099-fa51e988570d",
  "ManagerId": "19b0ea40-d4be-48f1-b516-9845922e4767"
}

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>4ba4f1b5-9e76-4afe-a11f-c859c938bc88</FileStorageServerID>
</Result>
application/json, text/json 
{
  "FileStorageServerID": "4ba4f1b5-9e76-4afe-a11f-c859c938bc88"
}

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>256ac394-eb2e-4d76-af13-50adf725fefa</AccountID>
</Result>
application/json, text/json 
{
  "AccountID": "256ac394-eb2e-4d76-af13-50adf725fefa"
}

GetAccountIdByIndexNumber

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

GET
api_v2/Accounts/GetAccountIdByIndexNumber?indexNumber={indexNumber}
Имя параметра Тип Описание параметра
indexNumber Int32 Номер аккаунта
Имя параметра Тип Описание параметра
AccountIDDTO AccountIDDTO Идентификатор аккаунта
application/xml, text/xml 
<Result>
  <AccountID>275b590b-2627-4e0f-9e33-f83348369f5e</AccountID>
</Result>
application/json, text/json 
{
  "AccountID": "275b590b-2627-4e0f-9e33-f83348369f5e"
}

GetAccoutUsersProperties

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

GET
api_v2/Accounts/GetAccoutUsersProperties?accountId={accountId}
Имя параметра Тип Описание параметра
accountId Guid Идентификатор аккаунта
Имя параметра Тип Описание параметра
AccountUsersTableDTO AccountUsersTableDTO Свойства пользователей аккаунта
application/xml, text/xml 
<Result>
  <AccountSearchResultTable Type="sample string 1">
    <Row>
      <ID>dd45855f-9e78-4cc2-a3d3-e5e3eac97cbb</ID>
      <AccountID>75b4c42d-86b9-495d-aace-564b570b35d4</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>8f738283-38bc-4c79-86bc-794c3da4b2a7</CorpUserID>
      <CorpUserSyncStatus>sample string 9</CorpUserSyncStatus>
      <Removed>true</Removed>
      <CreationDate>sample string 11</CreationDate>
      <IsManager>true</IsManager>
      <Activated>true</Activated>
    </Row>
    <Row>
      <ID>dd45855f-9e78-4cc2-a3d3-e5e3eac97cbb</ID>
      <AccountID>75b4c42d-86b9-495d-aace-564b570b35d4</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>8f738283-38bc-4c79-86bc-794c3da4b2a7</CorpUserID>
      <CorpUserSyncStatus>sample string 9</CorpUserSyncStatus>
      <Removed>true</Removed>
      <CreationDate>sample string 11</CreationDate>
      <IsManager>true</IsManager>
      <Activated>true</Activated>
    </Row>
    <Row>
      <ID>dd45855f-9e78-4cc2-a3d3-e5e3eac97cbb</ID>
      <AccountID>75b4c42d-86b9-495d-aace-564b570b35d4</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>8f738283-38bc-4c79-86bc-794c3da4b2a7</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": "dd45855f-9e78-4cc2-a3d3-e5e3eac97cbb",
        "AccountID": "75b4c42d-86b9-495d-aace-564b570b35d4",
        "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": "8f738283-38bc-4c79-86bc-794c3da4b2a7",
        "CorpUserSyncStatus": "sample string 9",
        "Removed": true,
        "CreationDate": "sample string 11",
        "IsManager": true,
        "Activated": true
      },
      {
        "ID": "dd45855f-9e78-4cc2-a3d3-e5e3eac97cbb",
        "AccountID": "75b4c42d-86b9-495d-aace-564b570b35d4",
        "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": "8f738283-38bc-4c79-86bc-794c3da4b2a7",
        "CorpUserSyncStatus": "sample string 9",
        "Removed": true,
        "CreationDate": "sample string 11",
        "IsManager": true,
        "Activated": true
      },
      {
        "ID": "dd45855f-9e78-4cc2-a3d3-e5e3eac97cbb",
        "AccountID": "75b4c42d-86b9-495d-aace-564b570b35d4",
        "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": "8f738283-38bc-4c79-86bc-794c3da4b2a7",
        "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>0de9d132-d9db-4c6e-98fc-52bc998a664b</Id>
  <Date>2020-04-08T22:10:22.0381317+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>b27e2e15-5655-4513-9824-abb7c7a6e0fe</AccountId>
  <Uniq>sample string 10</Uniq>
  <Currency>sample string 11</Currency>
</Result>
application/json, text/json 
{
  "Id": "0de9d132-d9db-4c6e-98fc-52bc998a664b",
  "Date": "2020-04-08T22:10:22.0381317+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": "b27e2e15-5655-4513-9824-abb7c7a6e0fe",
  "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>69308f95-b13b-49c2-9161-881f96f0795f</ID>
  <AccountID>b75fa7ff-479a-48c1-94a6-103e233c1a9d</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>cd95566d-8c44-4a6a-85cc-ced321da21f1</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": "69308f95-b13b-49c2-9161-881f96f0795f",
  "AccountID": "b75fa7ff-479a-48c1-94a6-103e233c1a9d",
  "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": "cd95566d-8c44-4a6a-85cc-ced321da21f1",
  "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>5d72e5ea-09bd-48e2-9c61-dd254128974f</AccountID>
</Result>
application/json, text/json 
{
  "AccountID": "5d72e5ea-09bd-48e2-9c61-dd254128974f"
}

GetIdByEmail

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

GET
api_v2/AccountUsers/GetIdByEmail?email={email}
Имя параметра Тип Описание параметра
email String Электронная почта
Имя параметра Тип Описание параметра
AccountUserIDDTO AccountUserIDDTO Идентификатор пользователя
application/xml, text/xml 
<Result>
  <AccountUserID>ebf132b1-b24c-4a67-96da-b8738a159f77</AccountUserID>
</Result>
application/json, text/json 
{
  "AccountUserID": "ebf132b1-b24c-4a67-96da-b8738a159f77"
}

GetIdByLogin

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

GET
api_v2/AccountUsers/GetIdByLogin?login={login}
Имя параметра Тип Описание параметра
login String Логин пользователя
Имя параметра Тип Описание параметра
AccountUserIDDTO AccountUserIDDTO Идентификатор пользователя
application/xml, text/xml 
<Result>
  <AccountUserID>5030cb59-5323-4dea-a9ac-8372beca4021</AccountUserID>
</Result>
application/json, text/json 
{
  "AccountUserID": "5030cb59-5323-4dea-a9ac-8372beca4021"
}

GetIdByPhoneNumber

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

GET
api_v2/AccountUsers/GetIdByPhoneNumber?phoneCountry={phoneCountry}&phoneNumber={phoneNumber}
Имя параметра Тип Описание параметра
phoneCountry String Телефонный код страны
phoneNumber String Номер телефона
Имя параметра Тип Описание параметра
AccountUserIDDTO AccountUserIDDTO Идентификатор пользователя
application/xml, text/xml 
<Result>
  <AccountUserID>82541ad7-726a-4267-ac24-6b2ef94e7574</AccountUserID>
</Result>
application/json, text/json 
{
  "AccountUserID": "82541ad7-726a-4267-ac24-6b2ef94e7574"
}

GetIDs

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

GET
api_v2/AccountUsers/GetIDs?accountID={accountID}
Имя параметра Тип Описание параметра
accountID Guid Идентификатор аккаунта
Имя параметра Тип Описание параметра
AccountUsersIDsListDTO AccountUsersIDsListDTO Список идентификаторов пользователей
application/xml, text/xml 
<Result>
  <AccountUserIDs Type="sample string 1">
    <Item>3e057b0e-1c32-45ec-b580-e7576f2ac491</Item>
    <Item>c5b42f45-800f-4c83-948b-2298192b3c05</Item>
    <Item>4b5bc3b6-328f-442f-8e5b-183092f09d8f</Item>
  </AccountUserIDs>
</Result>
application/json, text/json 
{
  "AccountUserIDs": {
    "List": [
      "3e057b0e-1c32-45ec-b580-e7576f2ac491",
      "c5b42f45-800f-4c83-948b-2298192b3c05",
      "4b5bc3b6-328f-442f-8e5b-183092f09d8f"
    ]
  }
}

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-08T22:10:22.1006413+03:00</CreationDate>
</Result>
application/json, text/json 
{
  "CreationDate": "2020-04-08T22:10:22.1006413+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>fbfffa10-3527-4d90-a798-0defc166d4ad</AccountUserId>
      <AccountUserName>sample string 2</AccountUserName>
      <Email>sample string 3</Email>
    </Row>
    <Row>
      <AccountUserId>fbfffa10-3527-4d90-a798-0defc166d4ad</AccountUserId>
      <AccountUserName>sample string 2</AccountUserName>
      <Email>sample string 3</Email>
    </Row>
    <Row>
      <AccountUserId>fbfffa10-3527-4d90-a798-0defc166d4ad</AccountUserId>
      <AccountUserName>sample string 2</AccountUserName>
      <Email>sample string 3</Email>
    </Row>
  </AccountSearchResultTable>
</Result>
application/json, text/json 
{
  "AccountSearchResultTable": {
    "Rows": [
      {
        "Id": "fbfffa10-3527-4d90-a798-0defc166d4ad",
        "AccountUserName": "sample string 2",
        "Email": "sample string 3"
      },
      {
        "Id": "fbfffa10-3527-4d90-a798-0defc166d4ad",
        "AccountUserName": "sample string 2",
        "Email": "sample string 3"
      },
      {
        "Id": "fbfffa10-3527-4d90-a798-0defc166d4ad",
        "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>8ca35524-9e83-4ba8-a5c3-cc8728996dba</ID>
    <AccountID>528f8aa9-2bb3-44aa-a962-b9692e118f14</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>a15db2c6-800f-4d81-9fda-8cbd87b8c6c9</CorpUserID>
    <CorpUserSyncStatus>sample string 9</CorpUserSyncStatus>
    <Removed>true</Removed>
    <CreationDate>sample string 11</CreationDate>
    <IsManager>true</IsManager>
    <Activated>true</Activated>
  </AccountUserList>
  <AccountUserList>
    <ID>8ca35524-9e83-4ba8-a5c3-cc8728996dba</ID>
    <AccountID>528f8aa9-2bb3-44aa-a962-b9692e118f14</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>a15db2c6-800f-4d81-9fda-8cbd87b8c6c9</CorpUserID>
    <CorpUserSyncStatus>sample string 9</CorpUserSyncStatus>
    <Removed>true</Removed>
    <CreationDate>sample string 11</CreationDate>
    <IsManager>true</IsManager>
    <Activated>true</Activated>
  </AccountUserList>
  <AccountUserList>
    <ID>8ca35524-9e83-4ba8-a5c3-cc8728996dba</ID>
    <AccountID>528f8aa9-2bb3-44aa-a962-b9692e118f14</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>a15db2c6-800f-4d81-9fda-8cbd87b8c6c9</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": "8ca35524-9e83-4ba8-a5c3-cc8728996dba",
      "AccountID": "528f8aa9-2bb3-44aa-a962-b9692e118f14",
      "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": "a15db2c6-800f-4d81-9fda-8cbd87b8c6c9",
      "CorpUserSyncStatus": "sample string 9",
      "Removed": true,
      "CreationDate": "sample string 11",
      "IsManager": true,
      "Activated": true
    },
    {
      "ID": "8ca35524-9e83-4ba8-a5c3-cc8728996dba",
      "AccountID": "528f8aa9-2bb3-44aa-a962-b9692e118f14",
      "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": "a15db2c6-800f-4d81-9fda-8cbd87b8c6c9",
      "CorpUserSyncStatus": "sample string 9",
      "Removed": true,
      "CreationDate": "sample string 11",
      "IsManager": true,
      "Activated": true
    },
    {
      "ID": "8ca35524-9e83-4ba8-a5c3-cc8728996dba",
      "AccountID": "528f8aa9-2bb3-44aa-a962-b9692e118f14",
      "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": "a15db2c6-800f-4d81-9fda-8cbd87b8c6c9",
      "CorpUserSyncStatus": "sample string 9",
      "Removed": true,
      "CreationDate": "sample string 11",
      "IsManager": true,
      "Activated": true
    }
  ]
}