Web Service: ClientAgentService
Port ClientAgentService
Location:
http://<MRI_Evolution_Site_Path>/Services/Basic/ClientAgentService.svc
Protocol:
SOAP
Transport protocol:
SOAP over HTTP
Operations:
Port type IClientAgentService
1. KeepAlive
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IClientAgentService_KeepAlive_InputMessage (soap:body, use = literal)
parameters type KeepAlive
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| machineName | Optional | string | machineName parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ClientAgentServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
string machineName = "your_value_here";
// Call the service method
var response = client.KeepAlive(sessionId, impersonateAccountId, machineName);
// 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:KeepAlive>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:machineName>sample_value</bas:machineName>
</bas:KeepAlive>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ClientAgentService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$machineName = "your_value_here"
# Call the service method
$result = $proxy.KeepAlive($sessionId, $impersonateAccountId, $machineName)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
2. RegisterAgent
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IClientAgentService_RegisterAgent_InputMessage (soap:body, use = literal)
parameters type RegisterAgent
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| machineName | Optional | string | machineName parameter (nillable) |
Output: IClientAgentService_RegisterAgent_OutputMessage (soap:body, use = literal)
parameters type RegisterAgentResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| RegisterAgentResult | Optional | boolean | RegisterAgentResult parameter |
Code Examples
C# Example
// Create the service client
using (var client = new ClientAgentServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
string machineName = "your_value_here";
// Call the service method
var response = client.RegisterAgent(sessionId, impersonateAccountId, machineName);
// 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:RegisterAgent>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:machineName>sample_value</bas:machineName>
</bas:RegisterAgent>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ClientAgentService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$machineName = "your_value_here"
# Call the service method
$result = $proxy.RegisterAgent($sessionId, $impersonateAccountId, $machineName)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}