Web Service: AccountService
Port AccountService
- CreateAccountDetail
- CreateAccountRoleDetail
- CreateAccountUserLicenceTypeDetail
- CreateRoleDetail
- DeleteAccountRoleDetail
- DeleteAccountUserLicenceTypeDetail
- GetAccountByIdDetail
- GetAccountProfilesByDtoDetail
- GetAccountRoleByIdDetail
- GetAccountRolesByDtoDetail
- GetAccountUserLicenceTypeByIdDetail
- GetAccountsByDtoDetail
- GetAccountsUserLicenceTypesByDtoDetail
- GetReachMenuItemsByDtoDetail
- GetRolesByDtoDetail
- GetRolesByIdDetail
- GetUserLicenceTypesByDtoDetail
- UpdateAccountDetail
- UpdateAccountRoleDetail
- UpdateAccountUserLicenceTypeDetail
- UpdateRoleDetail
Port type IAccountService
1. CreateAccount
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_CreateAccount_InputMessage (soap:body, use = literal)
parameters type CreateAccount
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| AccountDto | Optional | AccountDto | AccountDto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountDisabled | Optional | boolean | AccountDisabled parameter (nillable) |
| AccountDisabledDate | Optional | dateTime | AccountDisabledDate parameter (nillable) |
| AccountEmail | Optional | string | AccountEmail parameter (nillable) |
| AccountId | Optional | long | AccountId parameter (nillable) |
| AccountProfileId | Optional | long | AccountProfileId parameter (nillable) |
| AccountType | Optional | AccountUserType | Unknown, Operational, Mobile, Service, SysAdmin, Reach, Connect, ConnectPlus, OutlookService, Import, IntuitiveDesigner, IntuitiveViewer, AccountToBeImpersonated, AccountToImpersonate, GuestSurveyResponseAccount, AtYourServiceWorkOrder, EvolutionSupportAccount |
| AllowModeElevation | Optional | boolean | AllowModeElevation parameter (nillable) |
| AutoLogon | Optional | boolean | AutoLogon parameter (nillable) |
| BvViewId | Optional | long | BvViewId parameter (nillable) |
| ChangePassword | Optional | boolean | ChangePassword parameter (nillable) |
| ClonedFromAccountId | Optional | long | ClonedFromAccountId parameter (nillable) |
| DatabaseId | Optional | long | DatabaseId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| FailedAuthCount | Optional | short | FailedAuthCount parameter (nillable) |
| ForgottenPassword | Optional | boolean | ForgottenPassword parameter (nillable) |
| FullName | Optional | string | FullName parameter (nillable) |
| GoObjectRefId | Optional | long | GoObjectRefId parameter (nillable) |
| HostedInstallationId | Optional | long | HostedInstallationId parameter (nillable) |
| IsGuestAccount | Optional | boolean | IsGuestAccount parameter (nillable) |
| LDAPAccount | Optional | string | LDAPAccount parameter (nillable) |
| LicenceType | Optional | AccountLicenceType | Unknown, Concurrent, Named |
| LocaleId | Optional | long | LocaleId parameter (nillable) |
| Locked | Optional | boolean | Locked parameter (nillable) |
| LoginName | Optional | string | LoginName parameter (nillable) |
| Notes | Optional | string | Notes parameter (nillable) |
| Password | Optional | string | Password parameter (nillable) |
| PasswordChangeDateUtc | Optional | dateTime | PasswordChangeDateUtc parameter (nillable) |
| PasswordNeverExpires | Optional | boolean | PasswordNeverExpires parameter (nillable) |
| SelfRegisteredDate | Optional | dateTime | SelfRegisteredDate parameter (nillable) |
| SupportAccountMode | Optional | SupportAccountMode | None, User, Admin |
| TermsAndConditionsAcceptance | Optional | string | TermsAndConditionsAcceptance parameter (nillable) |
| TimeZoneId | Optional | long | TimeZoneId parameter (nillable) |
| TranslationSetId | Optional | long | TranslationSetId parameter (nillable) |
Output: IAccountService_CreateAccount_OutputMessage (soap:body, use = literal)
parameters type CreateAccountResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateAccountResult | Optional | AccountDto | CreateAccountResult parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountDisabled | Optional | boolean | AccountDisabled parameter (nillable) |
| AccountDisabledDate | Optional | dateTime | AccountDisabledDate parameter (nillable) |
| AccountEmail | Optional | string | AccountEmail parameter (nillable) |
| AccountId | Optional | long | AccountId parameter (nillable) |
| AccountProfileId | Optional | long | AccountProfileId parameter (nillable) |
| AccountType | Optional | AccountUserType | Unknown, Operational, Mobile, Service, SysAdmin, Reach, Connect, ConnectPlus, OutlookService, Import, IntuitiveDesigner, IntuitiveViewer, AccountToBeImpersonated, AccountToImpersonate, GuestSurveyResponseAccount, AtYourServiceWorkOrder, EvolutionSupportAccount |
| AllowModeElevation | Optional | boolean | AllowModeElevation parameter (nillable) |
| AutoLogon | Optional | boolean | AutoLogon parameter (nillable) |
| BvViewId | Optional | long | BvViewId parameter (nillable) |
| ChangePassword | Optional | boolean | ChangePassword parameter (nillable) |
| ClonedFromAccountId | Optional | long | ClonedFromAccountId parameter (nillable) |
| DatabaseId | Optional | long | DatabaseId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| FailedAuthCount | Optional | short | FailedAuthCount parameter (nillable) |
| ForgottenPassword | Optional | boolean | ForgottenPassword parameter (nillable) |
| FullName | Optional | string | FullName parameter (nillable) |
| GoObjectRefId | Optional | long | GoObjectRefId parameter (nillable) |
| HostedInstallationId | Optional | long | HostedInstallationId parameter (nillable) |
| IsGuestAccount | Optional | boolean | IsGuestAccount parameter (nillable) |
| LDAPAccount | Optional | string | LDAPAccount parameter (nillable) |
| LicenceType | Optional | AccountLicenceType | Unknown, Concurrent, Named |
| LocaleId | Optional | long | LocaleId parameter (nillable) |
| Locked | Optional | boolean | Locked parameter (nillable) |
| LoginName | Optional | string | LoginName parameter (nillable) |
| Notes | Optional | string | Notes parameter (nillable) |
| Password | Optional | string | Password parameter (nillable) |
| PasswordChangeDateUtc | Optional | dateTime | PasswordChangeDateUtc parameter (nillable) |
| PasswordNeverExpires | Optional | boolean | PasswordNeverExpires parameter (nillable) |
| SelfRegisteredDate | Optional | dateTime | SelfRegisteredDate parameter (nillable) |
| SupportAccountMode | Optional | SupportAccountMode | None, User, Admin |
| TermsAndConditionsAcceptance | Optional | string | TermsAndConditionsAcceptance parameter (nillable) |
| TimeZoneId | Optional | long | TimeZoneId parameter (nillable) |
| TranslationSetId | Optional | long | TranslationSetId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var AccountDto = new AccountDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateAccount(sessionId, impersonateAccountId, AccountDto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:CreateAccount>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:AccountDto>
<!-- AccountDto properties here -->
</bas:AccountDto>
</bas:CreateAccount>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$AccountDto = New-Object AccountDto
# Call the service method
$result = $proxy.CreateAccount($sessionId, $impersonateAccountId, $AccountDto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
2. CreateAccountRole
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_CreateAccountRole_InputMessage (soap:body, use = literal)
parameters type CreateAccountRole
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | AccountRoleDto | dto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountId | Optional | long | AccountId parameter (nillable) |
| AccountRoleId | Optional | long | AccountRoleId parameter (nillable) |
| DatabaseId | Optional | long | DatabaseId parameter (nillable) |
| RoleId | Optional | long | RoleId parameter (nillable) |
Output: IAccountService_CreateAccountRole_OutputMessage (soap:body, use = literal)
parameters type CreateAccountRoleResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateAccountRoleResult | Optional | AccountRoleDto | CreateAccountRoleResult parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountId | Optional | long | AccountId parameter (nillable) |
| AccountRoleId | Optional | long | AccountRoleId parameter (nillable) |
| DatabaseId | Optional | long | DatabaseId parameter (nillable) |
| RoleId | Optional | long | RoleId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new AccountRoleDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateAccountRole(sessionId, impersonateAccountId, dto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:CreateAccountRole>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- AccountRoleDto properties here -->
</bas:dto>
</bas:CreateAccountRole>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object AccountRoleDto
# Call the service method
$result = $proxy.CreateAccountRole($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
3. CreateAccountUserLicenceType
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_CreateAccountUserLicenceType_InputMessage (soap:body, use = literal)
parameters type CreateAccountUserLicenceType
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | AccountUserLicenceTypeDto | dto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountId | Optional | long | AccountId parameter (nillable) |
| UserLicenceTypeName | Optional | string | UserLicenceTypeName parameter (nillable) |
Output: IAccountService_CreateAccountUserLicenceType_OutputMessage (soap:body, use = literal)
parameters type CreateAccountUserLicenceTypeResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateAccountUserLicenceTypeResult | Optional | AccountUserLicenceTypeDto | CreateAccountUserLicenceTypeResult parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountId | Optional | long | AccountId parameter (nillable) |
| UserLicenceTypeName | Optional | string | UserLicenceTypeName parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new AccountUserLicenceTypeDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateAccountUserLicenceType(sessionId, impersonateAccountId, dto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:CreateAccountUserLicenceType>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- AccountUserLicenceTypeDto properties here -->
</bas:dto>
</bas:CreateAccountUserLicenceType>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object AccountUserLicenceTypeDto
# Call the service method
$result = $proxy.CreateAccountUserLicenceType($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
4. CreateRole
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_CreateRole_InputMessage (soap:body, use = literal)
parameters type CreateRole
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | RoleDto | dto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| Description | Optional | string | Description parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| RoleId | Optional | long | RoleId parameter (nillable) |
Output: IAccountService_CreateRole_OutputMessage (soap:body, use = literal)
parameters type CreateRoleResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateRoleResult | Optional | RoleDto | CreateRoleResult parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| Description | Optional | string | Description parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| RoleId | Optional | long | RoleId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new RoleDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateRole(sessionId, impersonateAccountId, dto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:CreateRole>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- RoleDto properties here -->
</bas:dto>
</bas:CreateRole>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object RoleDto
# Call the service method
$result = $proxy.CreateRole($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
5. DeleteAccountRole
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_DeleteAccountRole_InputMessage (soap:body, use = literal)
parameters type DeleteAccountRole
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.DeleteAccountRole(sessionId, impersonateAccountId, entityId);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:DeleteAccountRole>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:DeleteAccountRole>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.DeleteAccountRole($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
6. DeleteAccountUserLicenceType
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_DeleteAccountUserLicenceType_InputMessage (soap:body, use = literal)
parameters type DeleteAccountUserLicenceType
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | AccountUserLicenceTypeDto | dto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountId | Optional | long | AccountId parameter (nillable) |
| UserLicenceTypeName | Optional | string | UserLicenceTypeName parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new AccountUserLicenceTypeDto
{
// Set DTO properties here
};
// Call the service method
var response = client.DeleteAccountUserLicenceType(sessionId, impersonateAccountId, dto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:DeleteAccountUserLicenceType>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- AccountUserLicenceTypeDto properties here -->
</bas:dto>
</bas:DeleteAccountUserLicenceType>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object AccountUserLicenceTypeDto
# Call the service method
$result = $proxy.DeleteAccountUserLicenceType($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
7. GetAccountById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_GetAccountById_InputMessage (soap:body, use = literal)
parameters type GetAccountById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| accountId | Optional | long | accountId parameter |
Output: IAccountService_GetAccountById_OutputMessage (soap:body, use = literal)
parameters type GetAccountByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetAccountByIdResult | Optional | AccountDto | GetAccountByIdResult parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountDisabled | Optional | boolean | AccountDisabled parameter (nillable) |
| AccountDisabledDate | Optional | dateTime | AccountDisabledDate parameter (nillable) |
| AccountEmail | Optional | string | AccountEmail parameter (nillable) |
| AccountId | Optional | long | AccountId parameter (nillable) |
| AccountProfileId | Optional | long | AccountProfileId parameter (nillable) |
| AccountType | Optional | AccountUserType | Unknown, Operational, Mobile, Service, SysAdmin, Reach, Connect, ConnectPlus, OutlookService, Import, IntuitiveDesigner, IntuitiveViewer, AccountToBeImpersonated, AccountToImpersonate, GuestSurveyResponseAccount, AtYourServiceWorkOrder, EvolutionSupportAccount |
| AllowModeElevation | Optional | boolean | AllowModeElevation parameter (nillable) |
| AutoLogon | Optional | boolean | AutoLogon parameter (nillable) |
| BvViewId | Optional | long | BvViewId parameter (nillable) |
| ChangePassword | Optional | boolean | ChangePassword parameter (nillable) |
| ClonedFromAccountId | Optional | long | ClonedFromAccountId parameter (nillable) |
| DatabaseId | Optional | long | DatabaseId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| FailedAuthCount | Optional | short | FailedAuthCount parameter (nillable) |
| ForgottenPassword | Optional | boolean | ForgottenPassword parameter (nillable) |
| FullName | Optional | string | FullName parameter (nillable) |
| GoObjectRefId | Optional | long | GoObjectRefId parameter (nillable) |
| HostedInstallationId | Optional | long | HostedInstallationId parameter (nillable) |
| IsGuestAccount | Optional | boolean | IsGuestAccount parameter (nillable) |
| LDAPAccount | Optional | string | LDAPAccount parameter (nillable) |
| LicenceType | Optional | AccountLicenceType | Unknown, Concurrent, Named |
| LocaleId | Optional | long | LocaleId parameter (nillable) |
| Locked | Optional | boolean | Locked parameter (nillable) |
| LoginName | Optional | string | LoginName parameter (nillable) |
| Notes | Optional | string | Notes parameter (nillable) |
| Password | Optional | string | Password parameter (nillable) |
| PasswordChangeDateUtc | Optional | dateTime | PasswordChangeDateUtc parameter (nillable) |
| PasswordNeverExpires | Optional | boolean | PasswordNeverExpires parameter (nillable) |
| SelfRegisteredDate | Optional | dateTime | SelfRegisteredDate parameter (nillable) |
| SupportAccountMode | Optional | SupportAccountMode | None, User, Admin |
| TermsAndConditionsAcceptance | Optional | string | TermsAndConditionsAcceptance parameter (nillable) |
| TimeZoneId | Optional | long | TimeZoneId parameter (nillable) |
| TranslationSetId | Optional | long | TranslationSetId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long accountId = 123;
// Call the service method
var response = client.GetAccountById(sessionId, impersonateAccountId, accountId);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:GetAccountById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:accountId>123</bas:accountId>
</bas:GetAccountById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$accountId = 123
# Call the service method
$result = $proxy.GetAccountById($sessionId, $impersonateAccountId, $accountId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
8. GetAccountProfilesByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_GetAccountProfilesByDto_InputMessage (soap:body, use = literal)
parameters type GetAccountProfilesByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | AccountProfileDto | dto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountProfileId | Optional | long | AccountProfileId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: IAccountService_GetAccountProfilesByDto_OutputMessage (soap:body, use = literal)
parameters type GetAccountProfilesByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetAccountProfilesByDtoResult | Optional | ArrayOfAccountProfileDto | GetAccountProfilesByDtoResult parameter (nillable) |
| AccountProfileDto | Optional | AccountProfileDto | AccountProfileDto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountProfileId | Optional | long | AccountProfileId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new AccountProfileDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetAccountProfilesByDto(sessionId, impersonateAccountId, dto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:GetAccountProfilesByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- AccountProfileDto properties here -->
</bas:dto>
</bas:GetAccountProfilesByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object AccountProfileDto
# Call the service method
$result = $proxy.GetAccountProfilesByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
9. GetAccountRoleById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_GetAccountRoleById_InputMessage (soap:body, use = literal)
parameters type GetAccountRoleById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: IAccountService_GetAccountRoleById_OutputMessage (soap:body, use = literal)
parameters type GetAccountRoleByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetAccountRoleByIdResult | Optional | AccountRoleDto | GetAccountRoleByIdResult parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountId | Optional | long | AccountId parameter (nillable) |
| AccountRoleId | Optional | long | AccountRoleId parameter (nillable) |
| DatabaseId | Optional | long | DatabaseId parameter (nillable) |
| RoleId | Optional | long | RoleId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetAccountRoleById(sessionId, impersonateAccountId, entityId);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:GetAccountRoleById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetAccountRoleById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetAccountRoleById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
10. GetAccountRolesByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_GetAccountRolesByDto_InputMessage (soap:body, use = literal)
parameters type GetAccountRolesByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | AccountRoleDto | dto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountId | Optional | long | AccountId parameter (nillable) |
| AccountRoleId | Optional | long | AccountRoleId parameter (nillable) |
| DatabaseId | Optional | long | DatabaseId parameter (nillable) |
| RoleId | Optional | long | RoleId parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: IAccountService_GetAccountRolesByDto_OutputMessage (soap:body, use = literal)
parameters type GetAccountRolesByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetAccountRolesByDtoResult | Optional | ArrayOfAccountRoleDto | GetAccountRolesByDtoResult parameter (nillable) |
| AccountRoleDto | Optional | AccountRoleDto | AccountRoleDto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountId | Optional | long | AccountId parameter (nillable) |
| AccountRoleId | Optional | long | AccountRoleId parameter (nillable) |
| DatabaseId | Optional | long | DatabaseId parameter (nillable) |
| RoleId | Optional | long | RoleId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new AccountRoleDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetAccountRolesByDto(sessionId, impersonateAccountId, dto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:GetAccountRolesByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- AccountRoleDto properties here -->
</bas:dto>
</bas:GetAccountRolesByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object AccountRoleDto
# Call the service method
$result = $proxy.GetAccountRolesByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
11. GetAccountUserLicenceTypeById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_GetAccountUserLicenceTypeById_InputMessage (soap:body, use = literal)
parameters type GetAccountUserLicenceTypeById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: IAccountService_GetAccountUserLicenceTypeById_OutputMessage (soap:body, use = literal)
parameters type GetAccountUserLicenceTypeByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetAccountUserLicenceTypeByIdResult | Optional | AccountUserLicenceTypeDto | GetAccountUserLicenceTypeByIdResult parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountId | Optional | long | AccountId parameter (nillable) |
| UserLicenceTypeName | Optional | string | UserLicenceTypeName parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetAccountUserLicenceTypeById(sessionId, impersonateAccountId, entityId);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:GetAccountUserLicenceTypeById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetAccountUserLicenceTypeById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetAccountUserLicenceTypeById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
12. GetAccountsByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_GetAccountsByDto_InputMessage (soap:body, use = literal)
parameters type GetAccountsByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| accountDto | Optional | AccountDto | accountDto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountDisabled | Optional | boolean | AccountDisabled parameter (nillable) |
| AccountDisabledDate | Optional | dateTime | AccountDisabledDate parameter (nillable) |
| AccountEmail | Optional | string | AccountEmail parameter (nillable) |
| AccountId | Optional | long | AccountId parameter (nillable) |
| AccountProfileId | Optional | long | AccountProfileId parameter (nillable) |
| AccountType | Optional | AccountUserType | Unknown, Operational, Mobile, Service, SysAdmin, Reach, Connect, ConnectPlus, OutlookService, Import, IntuitiveDesigner, IntuitiveViewer, AccountToBeImpersonated, AccountToImpersonate, GuestSurveyResponseAccount, AtYourServiceWorkOrder, EvolutionSupportAccount |
| AllowModeElevation | Optional | boolean | AllowModeElevation parameter (nillable) |
| AutoLogon | Optional | boolean | AutoLogon parameter (nillable) |
| BvViewId | Optional | long | BvViewId parameter (nillable) |
| ChangePassword | Optional | boolean | ChangePassword parameter (nillable) |
| ClonedFromAccountId | Optional | long | ClonedFromAccountId parameter (nillable) |
| DatabaseId | Optional | long | DatabaseId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| FailedAuthCount | Optional | short | FailedAuthCount parameter (nillable) |
| ForgottenPassword | Optional | boolean | ForgottenPassword parameter (nillable) |
| FullName | Optional | string | FullName parameter (nillable) |
| GoObjectRefId | Optional | long | GoObjectRefId parameter (nillable) |
| HostedInstallationId | Optional | long | HostedInstallationId parameter (nillable) |
| IsGuestAccount | Optional | boolean | IsGuestAccount parameter (nillable) |
| LDAPAccount | Optional | string | LDAPAccount parameter (nillable) |
| LicenceType | Optional | AccountLicenceType | Unknown, Concurrent, Named |
| LocaleId | Optional | long | LocaleId parameter (nillable) |
| Locked | Optional | boolean | Locked parameter (nillable) |
| LoginName | Optional | string | LoginName parameter (nillable) |
| Notes | Optional | string | Notes parameter (nillable) |
| Password | Optional | string | Password parameter (nillable) |
| PasswordChangeDateUtc | Optional | dateTime | PasswordChangeDateUtc parameter (nillable) |
| PasswordNeverExpires | Optional | boolean | PasswordNeverExpires parameter (nillable) |
| SelfRegisteredDate | Optional | dateTime | SelfRegisteredDate parameter (nillable) |
| SupportAccountMode | Optional | SupportAccountMode | None, User, Admin |
| TermsAndConditionsAcceptance | Optional | string | TermsAndConditionsAcceptance parameter (nillable) |
| TimeZoneId | Optional | long | TimeZoneId parameter (nillable) |
| TranslationSetId | Optional | long | TranslationSetId parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: IAccountService_GetAccountsByDto_OutputMessage (soap:body, use = literal)
parameters type GetAccountsByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetAccountsByDtoResult | Optional | ArrayOfAccountDto | GetAccountsByDtoResult parameter (nillable) |
| AccountDto | Optional | AccountDto | AccountDto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountDisabled | Optional | boolean | AccountDisabled parameter (nillable) |
| AccountDisabledDate | Optional | dateTime | AccountDisabledDate parameter (nillable) |
| AccountEmail | Optional | string | AccountEmail parameter (nillable) |
| AccountId | Optional | long | AccountId parameter (nillable) |
| AccountProfileId | Optional | long | AccountProfileId parameter (nillable) |
| AccountType | Optional | AccountUserType | Unknown, Operational, Mobile, Service, SysAdmin, Reach, Connect, ConnectPlus, OutlookService, Import, IntuitiveDesigner, IntuitiveViewer, AccountToBeImpersonated, AccountToImpersonate, GuestSurveyResponseAccount, AtYourServiceWorkOrder, EvolutionSupportAccount |
| AllowModeElevation | Optional | boolean | AllowModeElevation parameter (nillable) |
| AutoLogon | Optional | boolean | AutoLogon parameter (nillable) |
| BvViewId | Optional | long | BvViewId parameter (nillable) |
| ChangePassword | Optional | boolean | ChangePassword parameter (nillable) |
| ClonedFromAccountId | Optional | long | ClonedFromAccountId parameter (nillable) |
| DatabaseId | Optional | long | DatabaseId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| FailedAuthCount | Optional | short | FailedAuthCount parameter (nillable) |
| ForgottenPassword | Optional | boolean | ForgottenPassword parameter (nillable) |
| FullName | Optional | string | FullName parameter (nillable) |
| GoObjectRefId | Optional | long | GoObjectRefId parameter (nillable) |
| HostedInstallationId | Optional | long | HostedInstallationId parameter (nillable) |
| IsGuestAccount | Optional | boolean | IsGuestAccount parameter (nillable) |
| LDAPAccount | Optional | string | LDAPAccount parameter (nillable) |
| LicenceType | Optional | AccountLicenceType | Unknown, Concurrent, Named |
| LocaleId | Optional | long | LocaleId parameter (nillable) |
| Locked | Optional | boolean | Locked parameter (nillable) |
| LoginName | Optional | string | LoginName parameter (nillable) |
| Notes | Optional | string | Notes parameter (nillable) |
| Password | Optional | string | Password parameter (nillable) |
| PasswordChangeDateUtc | Optional | dateTime | PasswordChangeDateUtc parameter (nillable) |
| PasswordNeverExpires | Optional | boolean | PasswordNeverExpires parameter (nillable) |
| SelfRegisteredDate | Optional | dateTime | SelfRegisteredDate parameter (nillable) |
| SupportAccountMode | Optional | SupportAccountMode | None, User, Admin |
| TermsAndConditionsAcceptance | Optional | string | TermsAndConditionsAcceptance parameter (nillable) |
| TimeZoneId | Optional | long | TimeZoneId parameter (nillable) |
| TranslationSetId | Optional | long | TranslationSetId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var accountDto = new AccountDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetAccountsByDto(sessionId, impersonateAccountId, accountDto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:GetAccountsByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:accountDto>
<!-- AccountDto properties here -->
</bas:accountDto>
</bas:GetAccountsByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$accountDto = New-Object AccountDto
# Call the service method
$result = $proxy.GetAccountsByDto($sessionId, $impersonateAccountId, $accountDto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
13. GetAccountsUserLicenceTypesByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_GetAccountsUserLicenceTypesByDto_InputMessage (soap:body, use = literal)
parameters type GetAccountsUserLicenceTypesByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | AccountUserLicenceTypeDto | dto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountId | Optional | long | AccountId parameter (nillable) |
| UserLicenceTypeName | Optional | string | UserLicenceTypeName parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: IAccountService_GetAccountsUserLicenceTypesByDto_OutputMessage (soap:body, use = literal)
parameters type GetAccountsUserLicenceTypesByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetAccountsUserLicenceTypesByDtoResult | Optional | ArrayOfAccountUserLicenceTypeDto | GetAccountsUserLicenceTypesByDtoResult parameter (nillable) |
| AccountUserLicenceTypeDto | Optional | AccountUserLicenceTypeDto | AccountUserLicenceTypeDto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountId | Optional | long | AccountId parameter (nillable) |
| UserLicenceTypeName | Optional | string | UserLicenceTypeName parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new AccountUserLicenceTypeDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetAccountsUserLicenceTypesByDto(sessionId, impersonateAccountId, dto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:GetAccountsUserLicenceTypesByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- AccountUserLicenceTypeDto properties here -->
</bas:dto>
</bas:GetAccountsUserLicenceTypesByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object AccountUserLicenceTypeDto
# Call the service method
$result = $proxy.GetAccountsUserLicenceTypesByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
14. GetReachMenuItemsByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_GetReachMenuItemsByDto_InputMessage (soap:body, use = literal)
parameters type GetReachMenuItemsByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | ReachMenuItemDto | dto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| OpenURLInNewWindow | Optional | boolean | OpenURLInNewWindow parameter (nillable) |
| Ordinal | Optional | long | Ordinal parameter (nillable) |
| PublishedFromUtc | Optional | dateTime | PublishedFromUtc parameter (nillable) |
| PublishedToUtc | Optional | dateTime | PublishedToUtc parameter (nillable) |
| ReachMenuItemId | Optional | long | ReachMenuItemId parameter (nillable) |
| ReachPageId | Optional | long | ReachPageId parameter (nillable) |
| ReachParentMenuItemId | Optional | long | ReachParentMenuItemId parameter (nillable) |
| Text | Optional | string | Text parameter (nillable) |
| TimeZoneId | Optional | long | TimeZoneId parameter (nillable) |
| URL | Optional | string | URL parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: IAccountService_GetReachMenuItemsByDto_OutputMessage (soap:body, use = literal)
parameters type GetReachMenuItemsByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetReachMenuItemsByDtoResult | Optional | ArrayOfReachMenuItemDto | GetReachMenuItemsByDtoResult parameter (nillable) |
| ReachMenuItemDto | Optional | ReachMenuItemDto | ReachMenuItemDto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| OpenURLInNewWindow | Optional | boolean | OpenURLInNewWindow parameter (nillable) |
| Ordinal | Optional | long | Ordinal parameter (nillable) |
| PublishedFromUtc | Optional | dateTime | PublishedFromUtc parameter (nillable) |
| PublishedToUtc | Optional | dateTime | PublishedToUtc parameter (nillable) |
| ReachMenuItemId | Optional | long | ReachMenuItemId parameter (nillable) |
| ReachPageId | Optional | long | ReachPageId parameter (nillable) |
| ReachParentMenuItemId | Optional | long | ReachParentMenuItemId parameter (nillable) |
| Text | Optional | string | Text parameter (nillable) |
| TimeZoneId | Optional | long | TimeZoneId parameter (nillable) |
| URL | Optional | string | URL parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new ReachMenuItemDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetReachMenuItemsByDto(sessionId, impersonateAccountId, dto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:GetReachMenuItemsByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- ReachMenuItemDto properties here -->
</bas:dto>
</bas:GetReachMenuItemsByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object ReachMenuItemDto
# Call the service method
$result = $proxy.GetReachMenuItemsByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
15. GetRolesByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_GetRolesByDto_InputMessage (soap:body, use = literal)
parameters type GetRolesByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | RoleDto | dto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| Description | Optional | string | Description parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| RoleId | Optional | long | RoleId parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: IAccountService_GetRolesByDto_OutputMessage (soap:body, use = literal)
parameters type GetRolesByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetRolesByDtoResult | Optional | ArrayOfRoleDto | GetRolesByDtoResult parameter (nillable) |
| RoleDto | Optional | RoleDto | RoleDto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| Description | Optional | string | Description parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| RoleId | Optional | long | RoleId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new RoleDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetRolesByDto(sessionId, impersonateAccountId, dto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:GetRolesByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- RoleDto properties here -->
</bas:dto>
</bas:GetRolesByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object RoleDto
# Call the service method
$result = $proxy.GetRolesByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
16. GetRolesById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_GetRolesById_InputMessage (soap:body, use = literal)
parameters type GetRolesById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: IAccountService_GetRolesById_OutputMessage (soap:body, use = literal)
parameters type GetRolesByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetRolesByIdResult | Optional | RoleDto | GetRolesByIdResult parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| Description | Optional | string | Description parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| RoleId | Optional | long | RoleId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetRolesById(sessionId, impersonateAccountId, entityId);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:GetRolesById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetRolesById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetRolesById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
17. GetUserLicenceTypesByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_GetUserLicenceTypesByDto_InputMessage (soap:body, use = literal)
parameters type GetUserLicenceTypesByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | UserLicenceTypeDto | dto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountType | Optional | AccountUserType | Unknown, Operational, Mobile, Service, SysAdmin, Reach, Connect, ConnectPlus, OutlookService, Import, IntuitiveDesigner, IntuitiveViewer, AccountToBeImpersonated, AccountToImpersonate, GuestSurveyResponseAccount, AtYourServiceWorkOrder, EvolutionSupportAccount |
| LicenceType | Optional | AccountLicenceType | Unknown, Concurrent, Named |
| Name | Optional | string | Name parameter (nillable) |
| UserLicenceTypeId | Optional | long | UserLicenceTypeId parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: IAccountService_GetUserLicenceTypesByDto_OutputMessage (soap:body, use = literal)
parameters type GetUserLicenceTypesByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetUserLicenceTypesByDtoResult | Optional | ArrayOfUserLicenceTypeDto | GetUserLicenceTypesByDtoResult parameter (nillable) |
| UserLicenceTypeDto | Optional | UserLicenceTypeDto | UserLicenceTypeDto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountType | Optional | AccountUserType | Unknown, Operational, Mobile, Service, SysAdmin, Reach, Connect, ConnectPlus, OutlookService, Import, IntuitiveDesigner, IntuitiveViewer, AccountToBeImpersonated, AccountToImpersonate, GuestSurveyResponseAccount, AtYourServiceWorkOrder, EvolutionSupportAccount |
| LicenceType | Optional | AccountLicenceType | Unknown, Concurrent, Named |
| Name | Optional | string | Name parameter (nillable) |
| UserLicenceTypeId | Optional | long | UserLicenceTypeId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new UserLicenceTypeDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetUserLicenceTypesByDto(sessionId, impersonateAccountId, dto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:GetUserLicenceTypesByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- UserLicenceTypeDto properties here -->
</bas:dto>
</bas:GetUserLicenceTypesByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object UserLicenceTypeDto
# Call the service method
$result = $proxy.GetUserLicenceTypesByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
18. UpdateAccount
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_UpdateAccount_InputMessage (soap:body, use = literal)
parameters type UpdateAccount
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| AccountDto | Optional | AccountDto | AccountDto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountDisabled | Optional | boolean | AccountDisabled parameter (nillable) |
| AccountDisabledDate | Optional | dateTime | AccountDisabledDate parameter (nillable) |
| AccountEmail | Optional | string | AccountEmail parameter (nillable) |
| AccountId | Optional | long | AccountId parameter (nillable) |
| AccountProfileId | Optional | long | AccountProfileId parameter (nillable) |
| AccountType | Optional | AccountUserType | Unknown, Operational, Mobile, Service, SysAdmin, Reach, Connect, ConnectPlus, OutlookService, Import, IntuitiveDesigner, IntuitiveViewer, AccountToBeImpersonated, AccountToImpersonate, GuestSurveyResponseAccount, AtYourServiceWorkOrder, EvolutionSupportAccount |
| AllowModeElevation | Optional | boolean | AllowModeElevation parameter (nillable) |
| AutoLogon | Optional | boolean | AutoLogon parameter (nillable) |
| BvViewId | Optional | long | BvViewId parameter (nillable) |
| ChangePassword | Optional | boolean | ChangePassword parameter (nillable) |
| ClonedFromAccountId | Optional | long | ClonedFromAccountId parameter (nillable) |
| DatabaseId | Optional | long | DatabaseId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| FailedAuthCount | Optional | short | FailedAuthCount parameter (nillable) |
| ForgottenPassword | Optional | boolean | ForgottenPassword parameter (nillable) |
| FullName | Optional | string | FullName parameter (nillable) |
| GoObjectRefId | Optional | long | GoObjectRefId parameter (nillable) |
| HostedInstallationId | Optional | long | HostedInstallationId parameter (nillable) |
| IsGuestAccount | Optional | boolean | IsGuestAccount parameter (nillable) |
| LDAPAccount | Optional | string | LDAPAccount parameter (nillable) |
| LicenceType | Optional | AccountLicenceType | Unknown, Concurrent, Named |
| LocaleId | Optional | long | LocaleId parameter (nillable) |
| Locked | Optional | boolean | Locked parameter (nillable) |
| LoginName | Optional | string | LoginName parameter (nillable) |
| Notes | Optional | string | Notes parameter (nillable) |
| Password | Optional | string | Password parameter (nillable) |
| PasswordChangeDateUtc | Optional | dateTime | PasswordChangeDateUtc parameter (nillable) |
| PasswordNeverExpires | Optional | boolean | PasswordNeverExpires parameter (nillable) |
| SelfRegisteredDate | Optional | dateTime | SelfRegisteredDate parameter (nillable) |
| SupportAccountMode | Optional | SupportAccountMode | None, User, Admin |
| TermsAndConditionsAcceptance | Optional | string | TermsAndConditionsAcceptance parameter (nillable) |
| TimeZoneId | Optional | long | TimeZoneId parameter (nillable) |
| TranslationSetId | Optional | long | TranslationSetId parameter (nillable) |
Output: IAccountService_UpdateAccount_OutputMessage (soap:body, use = literal)
parameters type UpdateAccountResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateAccountResult | Optional | AccountDto | UpdateAccountResult parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountDisabled | Optional | boolean | AccountDisabled parameter (nillable) |
| AccountDisabledDate | Optional | dateTime | AccountDisabledDate parameter (nillable) |
| AccountEmail | Optional | string | AccountEmail parameter (nillable) |
| AccountId | Optional | long | AccountId parameter (nillable) |
| AccountProfileId | Optional | long | AccountProfileId parameter (nillable) |
| AccountType | Optional | AccountUserType | Unknown, Operational, Mobile, Service, SysAdmin, Reach, Connect, ConnectPlus, OutlookService, Import, IntuitiveDesigner, IntuitiveViewer, AccountToBeImpersonated, AccountToImpersonate, GuestSurveyResponseAccount, AtYourServiceWorkOrder, EvolutionSupportAccount |
| AllowModeElevation | Optional | boolean | AllowModeElevation parameter (nillable) |
| AutoLogon | Optional | boolean | AutoLogon parameter (nillable) |
| BvViewId | Optional | long | BvViewId parameter (nillable) |
| ChangePassword | Optional | boolean | ChangePassword parameter (nillable) |
| ClonedFromAccountId | Optional | long | ClonedFromAccountId parameter (nillable) |
| DatabaseId | Optional | long | DatabaseId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| FailedAuthCount | Optional | short | FailedAuthCount parameter (nillable) |
| ForgottenPassword | Optional | boolean | ForgottenPassword parameter (nillable) |
| FullName | Optional | string | FullName parameter (nillable) |
| GoObjectRefId | Optional | long | GoObjectRefId parameter (nillable) |
| HostedInstallationId | Optional | long | HostedInstallationId parameter (nillable) |
| IsGuestAccount | Optional | boolean | IsGuestAccount parameter (nillable) |
| LDAPAccount | Optional | string | LDAPAccount parameter (nillable) |
| LicenceType | Optional | AccountLicenceType | Unknown, Concurrent, Named |
| LocaleId | Optional | long | LocaleId parameter (nillable) |
| Locked | Optional | boolean | Locked parameter (nillable) |
| LoginName | Optional | string | LoginName parameter (nillable) |
| Notes | Optional | string | Notes parameter (nillable) |
| Password | Optional | string | Password parameter (nillable) |
| PasswordChangeDateUtc | Optional | dateTime | PasswordChangeDateUtc parameter (nillable) |
| PasswordNeverExpires | Optional | boolean | PasswordNeverExpires parameter (nillable) |
| SelfRegisteredDate | Optional | dateTime | SelfRegisteredDate parameter (nillable) |
| SupportAccountMode | Optional | SupportAccountMode | None, User, Admin |
| TermsAndConditionsAcceptance | Optional | string | TermsAndConditionsAcceptance parameter (nillable) |
| TimeZoneId | Optional | long | TimeZoneId parameter (nillable) |
| TranslationSetId | Optional | long | TranslationSetId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var AccountDto = new AccountDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateAccount(sessionId, impersonateAccountId, AccountDto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:UpdateAccount>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:AccountDto>
<!-- AccountDto properties here -->
</bas:AccountDto>
</bas:UpdateAccount>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$AccountDto = New-Object AccountDto
# Call the service method
$result = $proxy.UpdateAccount($sessionId, $impersonateAccountId, $AccountDto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
19. UpdateAccountRole
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_UpdateAccountRole_InputMessage (soap:body, use = literal)
parameters type UpdateAccountRole
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | AccountRoleDto | dto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountId | Optional | long | AccountId parameter (nillable) |
| AccountRoleId | Optional | long | AccountRoleId parameter (nillable) |
| DatabaseId | Optional | long | DatabaseId parameter (nillable) |
| RoleId | Optional | long | RoleId parameter (nillable) |
Output: IAccountService_UpdateAccountRole_OutputMessage (soap:body, use = literal)
parameters type UpdateAccountRoleResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateAccountRoleResult | Optional | AccountRoleDto | UpdateAccountRoleResult parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountId | Optional | long | AccountId parameter (nillable) |
| AccountRoleId | Optional | long | AccountRoleId parameter (nillable) |
| DatabaseId | Optional | long | DatabaseId parameter (nillable) |
| RoleId | Optional | long | RoleId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new AccountRoleDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateAccountRole(sessionId, impersonateAccountId, dto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:UpdateAccountRole>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- AccountRoleDto properties here -->
</bas:dto>
</bas:UpdateAccountRole>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object AccountRoleDto
# Call the service method
$result = $proxy.UpdateAccountRole($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
20. UpdateAccountUserLicenceType
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_UpdateAccountUserLicenceType_InputMessage (soap:body, use = literal)
parameters type UpdateAccountUserLicenceType
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | AccountUserLicenceTypeDto | dto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountId | Optional | long | AccountId parameter (nillable) |
| UserLicenceTypeName | Optional | string | UserLicenceTypeName parameter (nillable) |
Output: IAccountService_UpdateAccountUserLicenceType_OutputMessage (soap:body, use = literal)
parameters type UpdateAccountUserLicenceTypeResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateAccountUserLicenceTypeResult | Optional | AccountUserLicenceTypeDto | UpdateAccountUserLicenceTypeResult parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AccountId | Optional | long | AccountId parameter (nillable) |
| UserLicenceTypeName | Optional | string | UserLicenceTypeName parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new AccountUserLicenceTypeDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateAccountUserLicenceType(sessionId, impersonateAccountId, dto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:UpdateAccountUserLicenceType>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- AccountUserLicenceTypeDto properties here -->
</bas:dto>
</bas:UpdateAccountUserLicenceType>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object AccountUserLicenceTypeDto
# Call the service method
$result = $proxy.UpdateAccountUserLicenceType($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
21. UpdateRole
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAccountService_UpdateRole_InputMessage (soap:body, use = literal)
parameters type UpdateRole
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | RoleDto | dto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| Description | Optional | string | Description parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| RoleId | Optional | long | RoleId parameter (nillable) |
Output: IAccountService_UpdateRole_OutputMessage (soap:body, use = literal)
parameters type UpdateRoleResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateRoleResult | Optional | RoleDto | UpdateRoleResult parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| Description | Optional | string | Description parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| RoleId | Optional | long | RoleId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AccountServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new RoleDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateRole(sessionId, impersonateAccountId, dto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:UpdateRole>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- RoleDto properties here -->
</bas:dto>
</bas:UpdateRole>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AccountService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object RoleDto
# Call the service method
$result = $proxy.UpdateRole($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}