Web Service: SecurityService

Port SecurityService

Location:
http://<MRI_Evolution_Site_Path>/Services/Basic/SecurityService.svc
Protocol:
SOAP
Transport protocol:
SOAP over HTTP
Operations:
  1. AuthenticateDetail
  2. AuthenticateByAccountUserTypeDetail
  3. AuthenticateDatabaseDetail
  4. AuthenticateDatabaseByAccountUserTypeDetail
  5. AuthenticateDatabaseOutlookDetail
  6. AuthenticateOutlookDetail
  7. LogOutDetail

Port type ISecurityService

1. Authenticate

Style: document

Operation type: Request-response. The endpoint receives a message, and sends a correlated message.

Input: SecurityService_Authenticate_InputMessage (soap:body, use = literal)

parameters type Authenticate

Parameter Name Required Type Description
loginName Optional string loginName parameter (nillable)
password Optional string password parameter (nillable)

Output: SecurityService_Authenticate_OutputMessage (soap:body, use = literal)

parameters type AuthenticateResponse

Parameter Name Required Type Description
AuthenticateResult Optional AuthenticationDto AuthenticateResult 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
EvolutionVersion Optional string EvolutionVersion parameter (nillable)
OperationResult Optional AuthenticationResultCode Unknown, Succeeded, NotAuthenticated, WrongUserNameOrPassword, GeneralFailure, LicensedAreaAccessDenied, ProductNotLicensed, BreachedLicenceEntities, DatabaseInvalidVersion, DatabaseNotAvailable, DatabaseAccessDenied, FailedMaximumNumberUsersLoggedIn, UserAlreadyLoggedIn, SessionExpired, AccountLockedOut, PasswordExpired, AccountDisabled
SessionId Optional string SessionId parameter (nillable)
Code Examples
C# Example
// Create the service client
using (var client = new SecurityServiceClient())
{
    // Create the request parameters
    string loginName = "your_value_here";
    string password = "your_value_here";
    
    // Call the service method
    var response = client.Authenticate(loginName, password);
    
    // 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:Authenticate>
         <bas:loginName>sample_value</bas:loginName>
         <bas:password>sample_value</bas:password>
      </bas:Authenticate>
   </soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SecurityService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl

# Set parameters
$loginName = "your_value_here"
$password = "your_value_here"

# Call the service method
$result = $proxy.Authenticate($loginName, $password)

# Process the result
if ($result) {
    Write-Host "Operation completed successfully"
    $result | Format-List
}

2. AuthenticateByAccountUserType

Style: document

Operation type: Request-response. The endpoint receives a message, and sends a correlated message.

Input: SecurityService_AuthenticateByAccountUserType_InputMessage (soap:body, use = literal)

parameters type AuthenticateByAccountUserType

Parameter Name Required Type Description
loginName Optional string loginName parameter (nillable)
password Optional string password parameter (nillable)
accountUserType Optional AccountUserTypeDto Service, Import

Output: SecurityService_AuthenticateByAccountUserType_OutputMessage (soap:body, use = literal)

parameters type AuthenticateByAccountUserTypeResponse

Parameter Name Required Type Description
AuthenticateByAccountUserTypeResult Optional AuthenticationDto AuthenticateByAccountUserTypeResult 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
EvolutionVersion Optional string EvolutionVersion parameter (nillable)
OperationResult Optional AuthenticationResultCode Unknown, Succeeded, NotAuthenticated, WrongUserNameOrPassword, GeneralFailure, LicensedAreaAccessDenied, ProductNotLicensed, BreachedLicenceEntities, DatabaseInvalidVersion, DatabaseNotAvailable, DatabaseAccessDenied, FailedMaximumNumberUsersLoggedIn, UserAlreadyLoggedIn, SessionExpired, AccountLockedOut, PasswordExpired, AccountDisabled
SessionId Optional string SessionId parameter (nillable)
Code Examples
C# Example
// Create the service client
using (var client = new SecurityServiceClient())
{
    // Create the request parameters
    string loginName = "your_value_here";
    string password = "your_value_here";
    var accountUserType = new AccountUserTypeDto
    {
        // Set DTO properties here
    };
    
    // Call the service method
    var response = client.AuthenticateByAccountUserType(loginName, password, accountUserType);
    
    // 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:AuthenticateByAccountUserType>
         <bas:loginName>sample_value</bas:loginName>
         <bas:password>sample_value</bas:password>
         <bas:accountUserType>
            <!-- AccountUserTypeDto properties here -->
         </bas:accountUserType>
      </bas:AuthenticateByAccountUserType>
   </soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SecurityService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl

# Set parameters
$loginName = "your_value_here"
$password = "your_value_here"
$accountUserType = New-Object AccountUserTypeDto

# Call the service method
$result = $proxy.AuthenticateByAccountUserType($loginName, $password, $accountUserType)

# Process the result
if ($result) {
    Write-Host "Operation completed successfully"
    $result | Format-List
}

3. AuthenticateDatabase

Style: document

Operation type: Request-response. The endpoint receives a message, and sends a correlated message.

Input: SecurityService_AuthenticateDatabase_InputMessage (soap:body, use = literal)

parameters type AuthenticateDatabase

Parameter Name Required Type Description
loginName Optional string loginName parameter (nillable)
password Optional string password parameter (nillable)
databaseName Optional string databaseName parameter (nillable)

Output: SecurityService_AuthenticateDatabase_OutputMessage (soap:body, use = literal)

parameters type AuthenticateDatabaseResponse

Parameter Name Required Type Description
AuthenticateDatabaseResult Optional AuthenticationDto AuthenticateDatabaseResult 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
EvolutionVersion Optional string EvolutionVersion parameter (nillable)
OperationResult Optional AuthenticationResultCode Unknown, Succeeded, NotAuthenticated, WrongUserNameOrPassword, GeneralFailure, LicensedAreaAccessDenied, ProductNotLicensed, BreachedLicenceEntities, DatabaseInvalidVersion, DatabaseNotAvailable, DatabaseAccessDenied, FailedMaximumNumberUsersLoggedIn, UserAlreadyLoggedIn, SessionExpired, AccountLockedOut, PasswordExpired, AccountDisabled
SessionId Optional string SessionId parameter (nillable)
Code Examples
C# Example
// Create the service client
using (var client = new SecurityServiceClient())
{
    // Create the request parameters
    string loginName = "your_value_here";
    string password = "your_value_here";
    string databaseName = "your_value_here";
    
    // Call the service method
    var response = client.AuthenticateDatabase(loginName, password, databaseName);
    
    // 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:AuthenticateDatabase>
         <bas:loginName>sample_value</bas:loginName>
         <bas:password>sample_value</bas:password>
         <bas:databaseName>sample_value</bas:databaseName>
      </bas:AuthenticateDatabase>
   </soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SecurityService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl

# Set parameters
$loginName = "your_value_here"
$password = "your_value_here"
$databaseName = "your_value_here"

# Call the service method
$result = $proxy.AuthenticateDatabase($loginName, $password, $databaseName)

# Process the result
if ($result) {
    Write-Host "Operation completed successfully"
    $result | Format-List
}

4. AuthenticateDatabaseByAccountUserType

Style: document

Operation type: Request-response. The endpoint receives a message, and sends a correlated message.

Input: SecurityService_AuthenticateDatabaseByAccountUserType_InputMessage (soap:body, use = literal)

parameters type AuthenticateDatabaseByAccountUserType

Parameter Name Required Type Description
loginName Optional string loginName parameter (nillable)
password Optional string password parameter (nillable)
databaseName Optional string databaseName parameter (nillable)
accountUserType Optional AccountUserTypeDto Service, Import

Output: SecurityService_AuthenticateDatabaseByAccountUserType_OutputMessage (soap:body, use = literal)

parameters type AuthenticateDatabaseByAccountUserTypeResponse

Parameter Name Required Type Description
AuthenticateDatabaseByAccountUserTypeResult Optional AuthenticationDto AuthenticateDatabaseByAccountUserTypeResult 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
EvolutionVersion Optional string EvolutionVersion parameter (nillable)
OperationResult Optional AuthenticationResultCode Unknown, Succeeded, NotAuthenticated, WrongUserNameOrPassword, GeneralFailure, LicensedAreaAccessDenied, ProductNotLicensed, BreachedLicenceEntities, DatabaseInvalidVersion, DatabaseNotAvailable, DatabaseAccessDenied, FailedMaximumNumberUsersLoggedIn, UserAlreadyLoggedIn, SessionExpired, AccountLockedOut, PasswordExpired, AccountDisabled
SessionId Optional string SessionId parameter (nillable)
Code Examples
C# Example
// Create the service client
using (var client = new SecurityServiceClient())
{
    // Create the request parameters
    string loginName = "your_value_here";
    string password = "your_value_here";
    string databaseName = "your_value_here";
    
    // Call the service method
    var response = client.AuthenticateDatabaseByAccountUserType(loginName, password, databaseName);
    
    // 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:AuthenticateDatabaseByAccountUserType>
         <bas:loginName>sample_value</bas:loginName>
         <bas:password>sample_value</bas:password>
         <bas:databaseName>sample_value</bas:databaseName>
      </bas:AuthenticateDatabaseByAccountUserType>
   </soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SecurityService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl

# Set parameters
$loginName = "your_value_here"
$password = "your_value_here"
$databaseName = "your_value_here"

# Call the service method
$result = $proxy.AuthenticateDatabaseByAccountUserType($loginName, $password, $databaseName)

# Process the result
if ($result) {
    Write-Host "Operation completed successfully"
    $result | Format-List
}

5. AuthenticateDatabaseOutlook

Style: document

Operation type: Request-response. The endpoint receives a message, and sends a correlated message.

Input: SecurityService_AuthenticateDatabaseOutlook_InputMessage (soap:body, use = literal)

parameters type AuthenticateDatabaseOutlook

Parameter Name Required Type Description
loginName Optional string loginName parameter (nillable)
password Optional string password parameter (nillable)
databaseName Optional string databaseName parameter (nillable)

Output: SecurityService_AuthenticateDatabaseOutlook_OutputMessage (soap:body, use = literal)

parameters type AuthenticateDatabaseOutlookResponse

Parameter Name Required Type Description
AuthenticateDatabaseOutlookResult Optional AuthenticationDto AuthenticateDatabaseOutlookResult 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
EvolutionVersion Optional string EvolutionVersion parameter (nillable)
OperationResult Optional AuthenticationResultCode Unknown, Succeeded, NotAuthenticated, WrongUserNameOrPassword, GeneralFailure, LicensedAreaAccessDenied, ProductNotLicensed, BreachedLicenceEntities, DatabaseInvalidVersion, DatabaseNotAvailable, DatabaseAccessDenied, FailedMaximumNumberUsersLoggedIn, UserAlreadyLoggedIn, SessionExpired, AccountLockedOut, PasswordExpired, AccountDisabled
SessionId Optional string SessionId parameter (nillable)
Code Examples
C# Example
// Create the service client
using (var client = new SecurityServiceClient())
{
    // Create the request parameters
    string loginName = "your_value_here";
    string password = "your_value_here";
    string databaseName = "your_value_here";
    
    // Call the service method
    var response = client.AuthenticateDatabaseOutlook(loginName, password, databaseName);
    
    // 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:AuthenticateDatabaseOutlook>
         <bas:loginName>sample_value</bas:loginName>
         <bas:password>sample_value</bas:password>
         <bas:databaseName>sample_value</bas:databaseName>
      </bas:AuthenticateDatabaseOutlook>
   </soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SecurityService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl

# Set parameters
$loginName = "your_value_here"
$password = "your_value_here"
$databaseName = "your_value_here"

# Call the service method
$result = $proxy.AuthenticateDatabaseOutlook($loginName, $password, $databaseName)

# Process the result
if ($result) {
    Write-Host "Operation completed successfully"
    $result | Format-List
}

6. AuthenticateOutlook

Style: document

Operation type: Request-response. The endpoint receives a message, and sends a correlated message.

Input: SecurityService_AuthenticateOutlook_InputMessage (soap:body, use = literal)

parameters type AuthenticateOutlook

Parameter Name Required Type Description
loginName Optional string loginName parameter (nillable)
password Optional string password parameter (nillable)

Output: SecurityService_AuthenticateOutlook_OutputMessage (soap:body, use = literal)

parameters type AuthenticateOutlookResponse

Parameter Name Required Type Description
AuthenticateOutlookResult Optional AuthenticationDto AuthenticateOutlookResult 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
EvolutionVersion Optional string EvolutionVersion parameter (nillable)
OperationResult Optional AuthenticationResultCode Unknown, Succeeded, NotAuthenticated, WrongUserNameOrPassword, GeneralFailure, LicensedAreaAccessDenied, ProductNotLicensed, BreachedLicenceEntities, DatabaseInvalidVersion, DatabaseNotAvailable, DatabaseAccessDenied, FailedMaximumNumberUsersLoggedIn, UserAlreadyLoggedIn, SessionExpired, AccountLockedOut, PasswordExpired, AccountDisabled
SessionId Optional string SessionId parameter (nillable)
Code Examples
C# Example
// Create the service client
using (var client = new SecurityServiceClient())
{
    // Create the request parameters
    string loginName = "your_value_here";
    string password = "your_value_here";
    
    // Call the service method
    var response = client.AuthenticateOutlook(loginName, password);
    
    // 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:AuthenticateOutlook>
         <bas:loginName>sample_value</bas:loginName>
         <bas:password>sample_value</bas:password>
      </bas:AuthenticateOutlook>
   </soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SecurityService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl

# Set parameters
$loginName = "your_value_here"
$password = "your_value_here"

# Call the service method
$result = $proxy.AuthenticateOutlook($loginName, $password)

# Process the result
if ($result) {
    Write-Host "Operation completed successfully"
    $result | Format-List
}

7. LogOut

Style: document

Operation type: Request-response. The endpoint receives a message, and sends a correlated message.

Input: SecurityService_LogOut_InputMessage (soap:body, use = literal)

parameters type LogOut

Parameter Name Required Type Description
sessionId Optional string sessionId parameter (nillable)
Code Examples
C# Example
// Create the service client
using (var client = new SecurityServiceClient())
{
    // Create the request parameters
    string sessionId = "your_value_here";
    
    // Call the service method
    var response = client.LogOut(sessionId);
    
    // 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:LogOut>
         <bas:sessionId>sample_value</bas:sessionId>
      </bas:LogOut>
   </soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SecurityService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl

# Set parameters
$sessionId = "your_value_here"

# Call the service method
$result = $proxy.LogOut($sessionId)

# Process the result
if ($result) {
    Write-Host "Operation completed successfully"
    $result | Format-List
}