Core42 – центральная служба 42Облака, обеспечивающая аутентификацию и авторизацию пользователей, формирующая структуру аккаунтов, пользователей, баз данных и различных ресурсов. Обеспечивает их взаимодействие и доступ к этим данным для других служб.
Архитектурным стандартом построения API ядра является REST.Содержит аккаунты облака, представляющие собой группировки пользователей, баз данных и других объектов и данных
GetProperties
Получить данные аккаунта по идентификатору аккаунта.
Имя параметра | Тип | Описание параметра |
accountID | Guid | Идентификатор аккаунта. |
Имя параметра | Тип | Описание параметра |
AccountPropertiesDTO | AccountPropertiesDTO | Данные аккаунта |
<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>a171d575-75b0-4061-9e71-adf37a201ddf</LocaleId> <ManagerId>6f2034de-a3fe-4eda-8431-ce58e4c4abe5</ManagerId> </Result>
{ "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": "a171d575-75b0-4061-9e71-adf37a201ddf", "ManagerId": "6f2034de-a3fe-4eda-8431-ce58e4c4abe5" }
GetAccountCaption
Получить название аккаунта по идентификатору.
Имя параметра | Тип | Описание параметра |
accountID | Guid | Идентификатор акканта. |
Имя параметра | Тип | Описание параметра |
AccountCaptionDTO | AccountCaptionDTO | Название аккаунта |
<Result> <AccountCaption>sample string 1</AccountCaption> </Result>
{ "AccountCaption": "sample string 1" }
GetReferralAccountID
Получить идентификатор рефферала по идентификатору аккаунта.
Имя параметра | Тип | Описание параметра |
accountID | Guid | Идентификатор аккаунта. |
Имя параметра | Тип | Описание параметра |
AccountReferalAccountIdDTO | AccountReferalAccountIdDTO | Идентификатор рефферала |
<Result> <ReferralAccountID>sample string 1</ReferralAccountID> </Result>
{ "ReferralAccountID": "sample string 1" }
GetIndexNumber
Получить номер аккаунта по идентификатору.
Имя параметра | Тип | Описание параметра |
accountID | Guid | Идентификатор аккаунта. |
Имя параметра | Тип | Описание параметра |
AccountIndexNumberDTO | AccountIndexNumberDTO | Номер аккаунта |
<Result> <IndexNumber>1</IndexNumber> </Result>
{ "IndexNumber": 1 }
GetRegistrationDate
Получить дату регистрации аккаунта по идентификатору аккаунта.
Имя параметра | Тип | Описание параметра |
accountID | Guid | Идентификатор аккаунта. |
Имя параметра | Тип | Описание параметра |
AccountRegistrationDateDTO | AccountRegistrationDateDTO | Дата регистрации аккаунта |
<Result> <RegistrationDate>sample string 1</RegistrationDate> </Result>
{ "RegistrationDate": "sample string 1" }
GetFileStorageServerID
Получить идентификатор файлового хранилища по идентификатору аккаунта
Имя параметра | Тип | Описание параметра |
accountId | Guid | Идентификатор аккаунта |
Имя параметра | Тип | Описание параметра |
CloudFileStorageServerIdDTO | CloudFileStorageServerIdDTO | Идентификатор файлового хранилища |
<Result> <FileStorageServerID>c5ca0eb5-55fa-462f-82fd-c5386f8912b6</FileStorageServerID> </Result>
{ "FileStorageServerID": "c5ca0eb5-55fa-462f-82fd-c5386f8912b6" }
GetStatus
Получить статус аккаунта по идентификатору аккаунта
Имя параметра | Тип | Описание параметра |
accountId | Guid | Идентификатор аккаунта |
Имя параметра | Тип | Описание параметра |
AccountStatusDTO | AccountStatusDTO | Статус аккаунта |
<Result> <Status>sample string 1</Status> </Result>
{ "Status": "sample string 1" }
FindByEmail
Поиск аккаунта по электронной почте
Имя параметра | Тип | Описание параметра |
searchString | String | Строка поиска |
Имя параметра | Тип | Описание параметра |
AccountIDDTO | AccountIDDTO | Идентификатор аккаунта |
<Result> <AccountID>8bdd5450-23d9-4d11-8040-cb54ca08387b</AccountID> </Result>
{ "AccountID": "8bdd5450-23d9-4d11-8040-cb54ca08387b" }
GetAccountIdByIndexNumber
Получить идентификатор аккаунта по номеру аккаунта
Имя параметра | Тип | Описание параметра |
indexNumber | Int32 | Номер аккаунта |
Имя параметра | Тип | Описание параметра |
AccountIDDTO | AccountIDDTO | Идентификатор аккаунта |
<Result> <AccountID>0fd60815-06b3-4f5f-9384-fe218d5d66d9</AccountID> </Result>
{ "AccountID": "0fd60815-06b3-4f5f-9384-fe218d5d66d9" }
GetAccoutUsersProperties
Получить свойства(данные) пользователей аккаунта по идентификатору аккаунта
Имя параметра | Тип | Описание параметра |
accountId | Guid | Идентификатор аккаунта |
Имя параметра | Тип | Описание параметра |
AccountUsersTableDTO | AccountUsersTableDTO | Свойства пользователей аккаунта |
<Result> <AccountSearchResultTable Type="sample string 1"> <Row> <ID>8ee1a4ef-e4ea-4c1c-8a9c-b1695eaf10d8</ID> <AccountID>810241e9-32b4-4f7e-a980-5e1f60a3644e</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>200fd14e-9cf7-4791-b85a-e752c2e54d8d</CorpUserID> <CorpUserSyncStatus>sample string 9</CorpUserSyncStatus> <Removed>true</Removed> <CreationDate>sample string 11</CreationDate> <IsManager>true</IsManager> <Activated>true</Activated> </Row> <Row> <ID>8ee1a4ef-e4ea-4c1c-8a9c-b1695eaf10d8</ID> <AccountID>810241e9-32b4-4f7e-a980-5e1f60a3644e</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>200fd14e-9cf7-4791-b85a-e752c2e54d8d</CorpUserID> <CorpUserSyncStatus>sample string 9</CorpUserSyncStatus> <Removed>true</Removed> <CreationDate>sample string 11</CreationDate> <IsManager>true</IsManager> <Activated>true</Activated> </Row> <Row> <ID>8ee1a4ef-e4ea-4c1c-8a9c-b1695eaf10d8</ID> <AccountID>810241e9-32b4-4f7e-a980-5e1f60a3644e</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>200fd14e-9cf7-4791-b85a-e752c2e54d8d</CorpUserID> <CorpUserSyncStatus>sample string 9</CorpUserSyncStatus> <Removed>true</Removed> <CreationDate>sample string 11</CreationDate> <IsManager>true</IsManager> <Activated>true</Activated> </Row> </AccountSearchResultTable> </Result>
{ "AccountSearchResultTable": { "Rows": [ { "ID": "8ee1a4ef-e4ea-4c1c-8a9c-b1695eaf10d8", "AccountID": "810241e9-32b4-4f7e-a980-5e1f60a3644e", "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": "200fd14e-9cf7-4791-b85a-e752c2e54d8d", "CorpUserSyncStatus": "sample string 9", "Removed": true, "CreationDate": "sample string 11", "IsManager": true, "Activated": true }, { "ID": "8ee1a4ef-e4ea-4c1c-8a9c-b1695eaf10d8", "AccountID": "810241e9-32b4-4f7e-a980-5e1f60a3644e", "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": "200fd14e-9cf7-4791-b85a-e752c2e54d8d", "CorpUserSyncStatus": "sample string 9", "Removed": true, "CreationDate": "sample string 11", "IsManager": true, "Activated": true }, { "ID": "8ee1a4ef-e4ea-4c1c-8a9c-b1695eaf10d8", "AccountID": "810241e9-32b4-4f7e-a980-5e1f60a3644e", "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": "200fd14e-9cf7-4791-b85a-e752c2e54d8d", "CorpUserSyncStatus": "sample string 9", "Removed": true, "CreationDate": "sample string 11", "IsManager": true, "Activated": true } ] } }
GetCompanyNameById
Получить название компании по идентификатору компании Нужен для промо сайта, при приглашении пользователя
Имя параметра | Тип | Описание параметра |
companyId | String | Идентификатор компании |
<string>sample string 1</string>
"sample string 1"
GetCurrentPhone
Получить текущий номер телефона Нужен для промо сайта, при активации отображении на какой номер был отправлен код активации
<string>sample string 1</string>
"sample string 1"
GetPayment
Получить счет для аккаунта по фильтру
Имя параметра | Тип | Описание параметра |
accountId | Guid | Идентификатор аккаунта |
startPeriod | Nullable`1 | Начальный период поиска счета |
endPeriod | Nullable`1 | Конечный период поиска счета |
type | String | Тип счета |
Имя параметра | Тип | Описание параметра |
InvoiceDTO | InvoiceDTO | Счет аккаунта |
<Result> <Id>43b823da-3f93-41fc-a66f-ce5810c1b46f</Id> <Date>2022-06-26T02:29:13.9595972+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>656e333a-787c-41b1-93aa-bbbad2a8112a</AccountId> <Uniq>sample string 10</Uniq> <Currency>sample string 11</Currency> </Result>
{ "Id": "43b823da-3f93-41fc-a66f-ce5810c1b46f", "Date": "2022-06-26T02:29:13.9595972+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": "656e333a-787c-41b1-93aa-bbbad2a8112a", "Uniq": "sample string 10", "Currency": "sample string 11" }
GetAccountBalance
Получить баланс аккаунта
Имя параметра | Тип | Описание параметра |
accountId | Guid | Id аккаунта |
Имя параметра | Тип | Описание параметра |
AccountBalanceDto | AccountBalanceDto | Баланс аккаунта |
<Result> <AccountBalance>1</AccountBalance> </Result>
{ "AccountBalance": 1.0 }
GetAccountIdByUserLogin
Получить Id аккаунта по логину пользователя
Имя параметра | Тип | Описание параметра |
login | String | Логин пользователя |
Имя параметра | Тип | Описание параметра |
AccountIDDTO | AccountIDDTO | ИД аккаунта |
<Result> <AccountID>dd9133cf-876c-4de2-9d1f-5f5dc4cda08b</AccountID> </Result>
{ "AccountID": "dd9133cf-876c-4de2-9d1f-5f5dc4cda08b" }
Содержит информацию о пользователях аккаунтов 42 Облака
GetProperties
Получить свойства пользователя облака.
Имя параметра | Тип | Описание параметра |
accountUserId | Guid | Идентификатор пользователя облака. |
Имя параметра | Тип | Описание параметра |
AccountUserPropertiesDTO | AccountUserPropertiesDTO | Свойства пользователя облака. |
<Result> <ID>bc7f9c35-5c89-48a0-990d-8b8ab969504d</ID> <AccountID>781ab2ef-a00d-4e27-818f-95eb6796f99c</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>1d67ef65-61fa-44c5-867a-6191ff65b479</CorpUserID> <CorpUserSyncStatus>sample string 9</CorpUserSyncStatus> <Removed>true</Removed> <CreationDate>sample string 11</CreationDate> <IsManager>true</IsManager> <Activated>true</Activated> </Result>
{ "ID": "bc7f9c35-5c89-48a0-990d-8b8ab969504d", "AccountID": "781ab2ef-a00d-4e27-818f-95eb6796f99c", "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": "1d67ef65-61fa-44c5-867a-6191ff65b479", "CorpUserSyncStatus": "sample string 9", "Removed": true, "CreationDate": "sample string 11", "IsManager": true, "Activated": true }
GetAccountId
Получить номер аккаунта по идентификатору пользователя облака
Имя параметра | Тип | Описание параметра |
accountUserId | Guid | Идентификатор пользователя облака |
Имя параметра | Тип | Описание параметра |
AccountUserAccountIDDTO | AccountUserAccountIDDTO | Номер аккаунта пользователя облака |
<Result> <AccountID>737707bf-746f-4eee-8854-f5787cdc24c5</AccountID> </Result>
{ "AccountID": "737707bf-746f-4eee-8854-f5787cdc24c5" }
GetIdByEmail
Получить идентификатор пользователя облака по электронной почте
Имя параметра | Тип | Описание параметра |
String | Электронная почта |
Имя параметра | Тип | Описание параметра |
AccountUserIDDTO | AccountUserIDDTO | Идентификатор пользователя |
<Result> <AccountUserID>c0fc356c-67ea-4280-b958-782cc613fdb7</AccountUserID> </Result>
{ "AccountUserID": "c0fc356c-67ea-4280-b958-782cc613fdb7" }
GetIdByLogin
Получить идентификатор пользователя облака по логину пользователя
Имя параметра | Тип | Описание параметра |
login | String | Логин пользователя |
Имя параметра | Тип | Описание параметра |
AccountUserIDDTO | AccountUserIDDTO | Идентификатор пользователя |
<Result> <AccountUserID>b1e9e832-050a-4ce5-96b3-07651cb92fa9</AccountUserID> </Result>
{ "AccountUserID": "b1e9e832-050a-4ce5-96b3-07651cb92fa9" }
GetIdByPhoneNumber
Получить идентификатор пользователя облака по номеру телефона
Имя параметра | Тип | Описание параметра |
phoneCountry | String | Телефонный код страны |
phoneNumber | String | Номер телефона |
Имя параметра | Тип | Описание параметра |
AccountUserIDDTO | AccountUserIDDTO | Идентификатор пользователя |
<Result> <AccountUserID>801a3b9b-5909-422f-96c1-7ef5b7e1e994</AccountUserID> </Result>
{ "AccountUserID": "801a3b9b-5909-422f-96c1-7ef5b7e1e994" }
GetIDs
Получить список идентификаторов пользователей по идентификатору аккаунта
Имя параметра | Тип | Описание параметра |
accountID | Guid | Идентификатор аккаунта |
Имя параметра | Тип | Описание параметра |
AccountUsersIDsListDTO | AccountUsersIDsListDTO | Список идентификаторов пользователей |
<Result> <AccountUserIDs Type="sample string 1"> <Item>e0631add-76f5-4448-aa3b-eba4c6103e8a</Item> <Item>eabd0a49-4f40-4d62-a8c8-f0ed4880adfe</Item> <Item>567ffd06-5c6e-4713-85f1-7ca731761abb</Item> </AccountUserIDs> </Result>
{ "AccountUserIDs": { "List": [ "e0631add-76f5-4448-aa3b-eba4c6103e8a", "eabd0a49-4f40-4d62-a8c8-f0ed4880adfe", "567ffd06-5c6e-4713-85f1-7ca731761abb" ] } }
GetLogin
Получить логин пользователя облака по идентификатору пользователя облака
Имя параметра | Тип | Описание параметра |
accountUserID | Guid | Идентификатор пользователя облака |
Имя параметра | Тип | Описание параметра |
AccountUserLoginDTO | AccountUserLoginDTO | Логин пользователя облака |
<Result> <Login>sample string 1</Login> </Result>
{ "Login": "sample string 1" }
GetEmail
Получить электронную почту пользователя облака по идентификатору пользователя
Имя параметра | Тип | Описание параметра |
accountUserID | Guid | Идентификатор пользователя облака |
Имя параметра | Тип | Описание параметра |
AccountUserEmailDTO | AccountUserEmailDTO | Электронная почта пользователя |
<Result> <Email>sample string 1</Email> </Result>
{ "Email": "sample string 1" }
GetPhoneNumber
Получить номер телефона пользователя облака по идентификатору пользователя
Имя параметра | Тип | Описание параметра |
accountUserID | Guid | Идентификатор пользователя облака |
Имя параметра | Тип | Описание параметра |
AccountUserPhoneNumberDTO | AccountUserPhoneNumberDTO | Номер телефона пользователя облака |
<Result> <PhoneNumber>sample string 1</PhoneNumber> </Result>
{ "PhoneNumber": "sample string 1" }
GetFirstName
Получить Фамилию пользователя облака по идентификатору пользователя
Имя параметра | Тип | Описание параметра |
accountUserID | Guid | Идентификатор пользователя облака |
Имя параметра | Тип | Описание параметра |
AccountUserFirstNameDTO | AccountUserFirstNameDTO | Фамилия пользователя облака |
<Result> <FirstName>sample string 1</FirstName> </Result>
{ "FirstName": "sample string 1" }
GetLastName
Получить Имя пользователя облака по идентификатору пользователя
Имя параметра | Тип | Описание параметра |
accountUserID | Guid | Идентификатор пользователя облака |
Имя параметра | Тип | Описание параметра |
AccountUserLastNameDTO | AccountUserLastNameDTO | Имя пользователя облака |
<Result> <LastName>sample string 1</LastName> </Result>
{ "LastName": "sample string 1" }
GetMiddleName
Получить отчество пользователя облака по идентификатору пользователя
Имя параметра | Тип | Описание параметра |
accountUserID | Guid | Идентификатор пользователя облака |
Имя параметра | Тип | Описание параметра |
AccountUserMiddleNameDTO | AccountUserMiddleNameDTO | Отчество пользователя облака |
<Result> <MiddleName>sample string 1</MiddleName> </Result>
{ "MiddleName": "sample string 1" }
GetActivated
Получить признак активности пользователя облака по идентификатору пользователя
Имя параметра | Тип | Описание параметра |
accountUserID | Guid | Идентификатор пользователя облака |
Имя параметра | Тип | Описание параметра |
AccountUserActivatedDTO | AccountUserActivatedDTO | Признак активности пользователя облака |
<Result> <Activated>true</Activated> </Result>
{ "Activated": true }
GetCreationDate
Получить дату регистрации пользователя облака по идентификатору пользователя
Имя параметра | Тип | Описание параметра |
accountUserID | Guid | Идентификатор пользователя облака |
Имя параметра | Тип | Описание параметра |
AccountUserCreationDateDTO | AccountUserCreationDateDTO | Дата регистрации пользователя облака |
<Result> <CreationDate>2022-06-26T02:29:13.9752165+03:00</CreationDate> </Result>
{ "CreationDate": "2022-06-26T02:29:13.9752165+03:00" }
Find
Поиск пользователей облака по фильтру
Имя параметра | Тип | Описание параметра |
searchString | String | Строка поиска |
accountId | Nullable`1 | Идентификатор аккаунта |
maxRecordsCount | Int32 | Максимальное количество записей |
Имя параметра | Тип | Описание параметра |
AccountUserInfoTableDTO | AccountUserInfoTableDTO | Пользователи облака |
<Result> <AccountSearchResultTable Type="sample string 1"> <Row> <AccountUserId>c5e64bbd-f359-4dcf-8b03-5da27f578c5d</AccountUserId> <AccountUserName>sample string 2</AccountUserName> <Email>sample string 3</Email> </Row> <Row> <AccountUserId>c5e64bbd-f359-4dcf-8b03-5da27f578c5d</AccountUserId> <AccountUserName>sample string 2</AccountUserName> <Email>sample string 3</Email> </Row> <Row> <AccountUserId>c5e64bbd-f359-4dcf-8b03-5da27f578c5d</AccountUserId> <AccountUserName>sample string 2</AccountUserName> <Email>sample string 3</Email> </Row> </AccountSearchResultTable> </Result>
{ "AccountSearchResultTable": { "Rows": [ { "Id": "c5e64bbd-f359-4dcf-8b03-5da27f578c5d", "AccountUserName": "sample string 2", "Email": "sample string 3" }, { "Id": "c5e64bbd-f359-4dcf-8b03-5da27f578c5d", "AccountUserName": "sample string 2", "Email": "sample string 3" }, { "Id": "c5e64bbd-f359-4dcf-8b03-5da27f578c5d", "AccountUserName": "sample string 2", "Email": "sample string 3" } ] } }
GetAccountUsers
Получить список пользователей аккаунта по идентификатору
Имя параметра | Тип | Описание параметра |
accountId | Guid | Идентификатор аккаунта |
Имя параметра | Тип | Описание параметра |
AccountUserListDTO | AccountUserListDTO | Cписок пользователей аккаунта |
<Result> <AccountUserList> <ID>d0c2f481-de35-44d7-9be5-33ab21166b11</ID> <AccountID>cde32d6c-46e1-4174-a7af-3b5cb72d3ffe</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>581445e2-40e4-4711-b5c2-823fd2e0de78</CorpUserID> <CorpUserSyncStatus>sample string 9</CorpUserSyncStatus> <Removed>true</Removed> <CreationDate>sample string 11</CreationDate> <IsManager>true</IsManager> <Activated>true</Activated> </AccountUserList> <AccountUserList> <ID>d0c2f481-de35-44d7-9be5-33ab21166b11</ID> <AccountID>cde32d6c-46e1-4174-a7af-3b5cb72d3ffe</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>581445e2-40e4-4711-b5c2-823fd2e0de78</CorpUserID> <CorpUserSyncStatus>sample string 9</CorpUserSyncStatus> <Removed>true</Removed> <CreationDate>sample string 11</CreationDate> <IsManager>true</IsManager> <Activated>true</Activated> </AccountUserList> <AccountUserList> <ID>d0c2f481-de35-44d7-9be5-33ab21166b11</ID> <AccountID>cde32d6c-46e1-4174-a7af-3b5cb72d3ffe</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>581445e2-40e4-4711-b5c2-823fd2e0de78</CorpUserID> <CorpUserSyncStatus>sample string 9</CorpUserSyncStatus> <Removed>true</Removed> <CreationDate>sample string 11</CreationDate> <IsManager>true</IsManager> <Activated>true</Activated> </AccountUserList> </Result>
{ "AccountDatabaseList": [ { "ID": "d0c2f481-de35-44d7-9be5-33ab21166b11", "AccountID": "cde32d6c-46e1-4174-a7af-3b5cb72d3ffe", "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": "581445e2-40e4-4711-b5c2-823fd2e0de78", "CorpUserSyncStatus": "sample string 9", "Removed": true, "CreationDate": "sample string 11", "IsManager": true, "Activated": true }, { "ID": "d0c2f481-de35-44d7-9be5-33ab21166b11", "AccountID": "cde32d6c-46e1-4174-a7af-3b5cb72d3ffe", "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": "581445e2-40e4-4711-b5c2-823fd2e0de78", "CorpUserSyncStatus": "sample string 9", "Removed": true, "CreationDate": "sample string 11", "IsManager": true, "Activated": true }, { "ID": "d0c2f481-de35-44d7-9be5-33ab21166b11", "AccountID": "cde32d6c-46e1-4174-a7af-3b5cb72d3ffe", "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": "581445e2-40e4-4711-b5c2-823fd2e0de78", "CorpUserSyncStatus": "sample string 9", "Removed": true, "CreationDate": "sample string 11", "IsManager": true, "Activated": true } ] }
Контроллер для работы с сервисами партнера
GetAccountServicesList
Получить список сервисов у аккаунта. Сервисы принадлежащие партнеру.
Имя параметра | Тип | Описание параметра |
accountId | Guid | Номер аккаунта партнера. |
Имя параметра | Тип | Описание параметра |
GuidListItem | GuidListItem | Список номеров сервисов. |
<GuidListItem Type="sample string 1"> <Item>bf9f72b5-25a3-4c74-9aad-3d23d3ec9bd5</Item> <Item>8048dbca-33d6-4eb3-bd47-41110c4b7e01</Item> <Item>d74b6ff3-3419-43cf-a604-4741bdce8ea4</Item> </GuidListItem>
{ "List": [ "bf9f72b5-25a3-4c74-9aad-3d23d3ec9bd5", "8048dbca-33d6-4eb3-bd47-41110c4b7e01", "d74b6ff3-3419-43cf-a604-4741bdce8ea4" ] }
GetServiceInfo
Получить детальную информацию по партнерскому сервису.
Имя параметра | Тип | Описание параметра |
serviceId | Guid | Номер сервиса. |
Имя параметра | Тип | Описание параметра |
ServiceInfoDto | ServiceInfoDto | Информация по сервису. |
<Result> <Name>sample string 1</Name> <Description>sample string 2</Description> <BillingServiceStatus>Draft</BillingServiceStatus> <ServiceActivationDate>2022-06-26T02:29:13.9908424+03:00</ServiceActivationDate> <IsServiceDisabled>true</IsServiceDisabled> </Result>
{ "Name": "sample string 1", "Description": "sample string 2", "BillingServiceStatus": 1, "ServiceActivationDate": "2022-06-26T02:29:13.9908424+03:00", "IsServiceDisabled": true }
GetServiceTypesList
Получить список услуг партнерского сервиса.
Имя параметра | Тип | Описание параметра |
serviceId | Guid | Номер сервиса. |
Имя параметра | Тип | Описание параметра |
GuidListItem | GuidListItem | Список услуг сервиса. |
<GuidListItem Type="sample string 1"> <Item>97f43227-c7dd-4a62-8846-726f963ae1c4</Item> <Item>9bfcebba-334b-4cda-8b63-2f0e0c00e6fb</Item> <Item>2d509e5e-9652-4d8a-b017-a64f12ff0a4b</Item> </GuidListItem>
{ "List": [ "97f43227-c7dd-4a62-8846-726f963ae1c4", "9bfcebba-334b-4cda-8b63-2f0e0c00e6fb", "2d509e5e-9652-4d8a-b017-a64f12ff0a4b" ] }
GetServiceTypeInfo
Получить детальную информацию о услуге сервиса.
Имя параметра | Тип | Описание параметра |
serviceTypeId | Guid | Номер услуги сервиса. |
Имя параметра | Тип | Описание параметра |
ServiceTypeInfoDto | ServiceTypeInfoDto | Информация по услуге сервиса. |
<Result> <Name>sample string 1</Name> <Description>sample string 2</Description> <BillingType>ForAccountUser</BillingType> <DependServiceTypeId>d66339ea-9e28-4508-b68e-601b55914269</DependServiceTypeId> <Cost>3</Cost> </Result>
{ "Name": "sample string 1", "Description": "sample string 2", "BillingType": 0, "DependServiceTypeId": "d66339ea-9e28-4508-b68e-601b55914269", "Cost": 3.0 }
GetServiceTypesStateForUser
Получить информацию по состоянию сервиса и подключенным услугам у клиента.
Имя параметра | Тип | Описание параметра |
serviceId | Guid | Номер сервиса. |
accountUserId | Guid | Номер пользователя облака 42. |
Имя параметра | Тип | Описание параметра |
ServiceTypeStateForUserDto | ServiceTypeStateForUserDto | Список подключенных услуг сервиса у клиента. |
<Result> <ServiceIsActive>true</ServiceIsActive> <IsDemoPeriod>true</IsDemoPeriod> <ServiceDemoExpiredDate>2022-06-26T02:29:14.0064662+03:00</ServiceDemoExpiredDate> <ServiceExpiredDate>2022-06-26T02:29:14.0064662+03:00</ServiceExpiredDate> <EnabledServiceTypesList Type="sample string 1"> <Item>c6498c89-9ec2-4b4b-a4e0-cbaf67f64868</Item> <Item>483a7c9e-19bf-4be1-b20a-277ae0c0b0f1</Item> <Item>6e6faec1-6c08-4b44-a837-b1c7623b893a</Item> </EnabledServiceTypesList> <IsServiceDisabled>true</IsServiceDisabled> </Result>
{ "ServiceIsActive": true, "IsDemoPeriod": true, "ServiceDemoExpiredDate": "2022-06-26T02:29:14.0064662+03:00", "ServiceExpiredDate": "2022-06-26T02:29:14.0064662+03:00", "EnabledServiceTypesList": { "List": [ "c6498c89-9ec2-4b4b-a4e0-cbaf67f64868", "483a7c9e-19bf-4be1-b20a-277ae0c0b0f1", "6e6faec1-6c08-4b44-a837-b1c7623b893a" ] }, "IsServiceDisabled": true }
GetServiceTypeStateForUserByLogin
Получить информацию по состоянию сервиса и подключенным услугам у клиента.
Имя параметра | Тип | Описание параметра |
serviceId | Guid | Номер сервиса. |
accountUserLogin | String | Логин пользователя облака 42. |
Имя параметра | Тип | Описание параметра |
ServiceTypeStateForUserDto | ServiceTypeStateForUserDto | Список подключенных услуг сервиса у клиента. |
<Result> <ServiceIsActive>true</ServiceIsActive> <IsDemoPeriod>true</IsDemoPeriod> <ServiceDemoExpiredDate>2022-06-26T02:29:14.0064662+03:00</ServiceDemoExpiredDate> <ServiceExpiredDate>2022-06-26T02:29:14.0064662+03:00</ServiceExpiredDate> <EnabledServiceTypesList Type="sample string 1"> <Item>c0ecf5ba-57bb-4139-a284-ac4d9ed183d7</Item> <Item>ca917335-9d6a-4132-b811-0387589f7d16</Item> <Item>aeaff920-ee3c-4d2f-a844-9f30e67e3411</Item> </EnabledServiceTypesList> <IsServiceDisabled>true</IsServiceDisabled> </Result>
{ "ServiceIsActive": true, "IsDemoPeriod": true, "ServiceDemoExpiredDate": "2022-06-26T02:29:14.0064662+03:00", "ServiceExpiredDate": "2022-06-26T02:29:14.0064662+03:00", "EnabledServiceTypesList": { "List": [ "c0ecf5ba-57bb-4139-a284-ac4d9ed183d7", "ca917335-9d6a-4132-b811-0387589f7d16", "aeaff920-ee3c-4d2f-a844-9f30e67e3411" ] }, "IsServiceDisabled": true }
CheckServiceTypeStatusForUserByLogin
Проверить статус указанной услуги сервиса у клиента.
Имя параметра | Тип | Описание параметра |
serviceTypeId | Guid | Номер услуги сервиса. |
accountUserLogin | String | Логин пользователя облака 42. |
Имя параметра | Тип | Описание параметра |
ServiceTypeStatusForUserDto | ServiceTypeStatusForUserDto | Признак активности указанной услуги сервиса у клиента. |
<Result> <Result>true</Result> <IsDemoPeriod>true</IsDemoPeriod> <IsServiceDisabled>true</IsServiceDisabled> </Result>
{ "IsDemoPeriod": true, "IsServiceDisabled": true, "Result": true }
ActivateService
Активировать сервис для пользователя.
Имя параметра | Тип | Описание параметра |
serviceId | Guid | Номер сервиса. |
accountUserId | Guid | Номер пользователя облака 42. |
DownloadServiceFile
Скачать файл сервиса биллинга
Имя параметра | Тип | Описание параметра |
fileId | Guid | Id файла сервиса |
GetServiceStatusForAccount
Получить статус сервиса для аккаунта
Имя параметра | Тип | Описание параметра |
accountId | Guid | Id аккаунта |
serviceId | Guid | Id сервиса |
Имя параметра | Тип | Описание параметра |
ServiceStateForAccountDto | ServiceStateForAccountDto | Модель статуса сервиса для аккаунта |
<Result> <ExpireDate>2022-06-26T02:29:14.0064662+03:00</ExpireDate> <DatabasesIds type="sample string 1"> <DatabaseId>774955bd-bd5c-442f-a071-7bf9ea3fc003</DatabaseId> <DatabaseId>0013bce9-b2fd-462d-85ca-9660c89ad67b</DatabaseId> <DatabaseId>1a211616-d3ca-43f0-957e-9377c9afb587</DatabaseId> </DatabasesIds> <ConnectedServiceTypesToUsers type="sample string 1"> <ConnectedServiceTypeToUser> <UserId>b42945a8-f582-4ff8-8f4a-62ca9620a4ac</UserId> <ServiceTypeId>be634aef-c807-4a31-bc80-56882ad4b56b</ServiceTypeId> </ConnectedServiceTypeToUser> <ConnectedServiceTypeToUser> <UserId>b42945a8-f582-4ff8-8f4a-62ca9620a4ac</UserId> <ServiceTypeId>be634aef-c807-4a31-bc80-56882ad4b56b</ServiceTypeId> </ConnectedServiceTypeToUser> <ConnectedServiceTypeToUser> <UserId>b42945a8-f582-4ff8-8f4a-62ca9620a4ac</UserId> <ServiceTypeId>be634aef-c807-4a31-bc80-56882ad4b56b</ServiceTypeId> </ConnectedServiceTypeToUser> </ConnectedServiceTypesToUsers> <BillingServiceStatusForAccount>NotActivated</BillingServiceStatusForAccount> <IsDemo>true</IsDemo> </Result>
{ "ExpireDate": "2022-06-26T02:29:14.0064662+03:00", "DatabasesIds": { "DatabaseId": [ "774955bd-bd5c-442f-a071-7bf9ea3fc003", "0013bce9-b2fd-462d-85ca-9660c89ad67b", "1a211616-d3ca-43f0-957e-9377c9afb587" ] }, "ConnectedServiceTypesToUsers": { "ConnectedServiceTypeToUser": [ { "UserId": "b42945a8-f582-4ff8-8f4a-62ca9620a4ac", "ServiceTypeId": "be634aef-c807-4a31-bc80-56882ad4b56b" }, { "UserId": "b42945a8-f582-4ff8-8f4a-62ca9620a4ac", "ServiceTypeId": "be634aef-c807-4a31-bc80-56882ad4b56b" }, { "UserId": "b42945a8-f582-4ff8-8f4a-62ca9620a4ac", "ServiceTypeId": "be634aef-c807-4a31-bc80-56882ad4b56b" } ] }, "BillingServiceStatusForAccount": 0, "IsDemo": true }
Контроллер для работы с заявками на вывод средств
GetAgentCashOutRequestsInStatusNew
Получить заявки на вывод средств в статусе "Новая"
Имя параметра | Тип | Описание параметра |
AgentCashOutRequestsInStatusNewDto | AgentCashOutRequestsInStatusNewDto | Заявки на вывод средств в статусе "Новая" |
<Result> <ActualAgencyAgreementDate>2022-06-26T02:29:14.0220892+03:00</ActualAgencyAgreementDate> <ActualAgencyAgreementLink>sample string 2</ActualAgencyAgreementLink> <AgentCashOutRequests Type="sample string 1"> <Row> <RequestNumber>sample string 1</RequestNumber> <AccountNumber>2</AccountNumber> <CreationDateTime>2022-06-26T02:29:14.0220892+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>2022-06-26T02:29:14.0220892+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>2022-06-26T02:29:14.0220892+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>
{ "ActualAgencyAgreementDate": "2022-06-26T02:29:14.0220892+03:00", "ActualAgencyAgreementLink": "sample string 2", "AgentCashOutRequests": { "Row": [ { "RequestNumber": "sample string 1", "AccountNumber": 2, "CreationDateTime": "2022-06-26T02:29:14.0220892+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": "2022-06-26T02:29:14.0220892+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": "2022-06-26T02:29:14.0220892+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
Сменить статус заявки на вывод средств
Имя параметра | Тип | Описание параметра |
changeAgentCashOutRequestStatus | ChangeAgentCashOutRequestStatusDto | Модель смены статуса заявки на вывод средств |
<Request> <RequestNumber>sample string 1</RequestNumber> <Sum>2</Sum> <Status>New</Status> </Request>
{ "RequestNumber": "sample string 1", "Sum": 2.0, "Status": 1 }
Сессии пользователей, содержащие токены авторизации
CheckTokenValidity
Выполнить валидацию токена для пользователя облака
Имя параметра | Тип | Описание параметра |
token | Guid | Токен пользователя |
Имя параметра | Тип | Описание параметра |
AccounUserTokenValidityDTO | AccounUserTokenValidityDTO | Валидность токена |
<Result> <TokenValidity>true</TokenValidity> </Result>
{ "TokenValidity": true }
GetAccountUserIDByToken
Получение идентификатора пользователя по токену авторизации
Имя параметра | Тип | Описание параметра |
token | Guid | Токен пользователя |
Имя параметра | Тип | Описание параметра |
AccountUserIDDTO | AccountUserIDDTO | Идентификатора пользователя |
<Result> <AccountUserID>ee9f99bc-6520-401d-aef5-94c1b0eee133</AccountUserID> </Result>
{ "AccountUserID": "ee9f99bc-6520-401d-aef5-94c1b0eee133" }
Login
Выполнить вход в облако по средствам логин/пароля. Создается запись с новой сессией пользователя.
Имя параметра | Тип | Описание параметра |
model | LoginModel | Параметры входа |
<Request> <AccountUserLogin>sample string 1</AccountUserLogin> <AccountUserPassword>sample string 2</AccountUserPassword> <ClientDescription>sample string 3</ClientDescription> <ClientDeviceInfo>sample string 4</ClientDeviceInfo> </Request>
{ "AccountUserLogin": "sample string 1", "AccountUserPassword": "sample string 2", "ClientDescription": "sample string 3", "ClientDeviceInfo": "sample string 4" }
Имя параметра | Тип | Описание параметра |
AccountUserTokenDTO | AccountUserTokenDTO | Идентификатор созданной сессии. SessionToken |
<Result> <Token>78e68287-4314-4e4f-ba87-a86e24e7eeb0</Token> </Result>
{ "Token": "78e68287-4314-4e4f-ba87-a86e24e7eeb0" }
LoginByEmail
Выполнить вход в облако по средствам электронной почты/пароля Создается запись с новой сессией пользователя.
Имя параметра | Тип | Описание параметра |
model | LoginEmailModelDTO | Параметры входа |
<Request> <Email>sample string 1</Email> <Password>sample string 2</Password> </Request>
{ "Email": "sample string 1", "Password": "sample string 2" }
Имя параметра | Тип | Описание параметра |
AccountTokenAuthorization | AccountTokenAuthorization | Идентификатор созданной сессии. SessionToken |
<Result> <AccountToken>c5516fcc-5660-49f9-b829-76b57108f432</AccountToken> </Result>
{ "AccountToken": "c5516fcc-5660-49f9-b829-76b57108f432" }