Web Service: MessagingService
Port MessagingService
Port type IMessagingService
1. CreateExternalComm
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IMessagingService_CreateExternalComm_InputMessage (soap:body, use = literal)
parameters type CreateExternalComm
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | ExternalCommDto | 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 |
| Actioned | Optional | boolean | Actioned parameter (nillable) |
| ActionedDateUtc | Optional | dateTime | ActionedDateUtc parameter (nillable) |
| CommsType | Optional | CommsType | TaskEvent, NewTask |
| ContractId | Optional | int | ContractId parameter (nillable) |
| EntityId | Optional | long | EntityId parameter (nillable) |
| ExternalCommId | Optional | long | ExternalCommId parameter (nillable) |
| Message | Optional | string | Message parameter (nillable) |
| MessageTypeId | Optional | int | MessageTypeId parameter (nillable) |
| ReceivedFrom | Optional | string | ReceivedFrom parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
Output: IMessagingService_CreateExternalComm_OutputMessage (soap:body, use = literal)
parameters type CreateExternalCommResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateExternalCommResult | Optional | ExternalCommDto | CreateExternalCommResult 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 |
| Actioned | Optional | boolean | Actioned parameter (nillable) |
| ActionedDateUtc | Optional | dateTime | ActionedDateUtc parameter (nillable) |
| CommsType | Optional | CommsType | TaskEvent, NewTask |
| ContractId | Optional | int | ContractId parameter (nillable) |
| EntityId | Optional | long | EntityId parameter (nillable) |
| ExternalCommId | Optional | long | ExternalCommId parameter (nillable) |
| Message | Optional | string | Message parameter (nillable) |
| MessageTypeId | Optional | int | MessageTypeId parameter (nillable) |
| ReceivedFrom | Optional | string | ReceivedFrom parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new MessagingServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new ExternalCommDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateExternalComm(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:CreateExternalComm>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- ExternalCommDto properties here -->
</bas:dto>
</bas:CreateExternalComm>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/MessagingService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object ExternalCommDto
# Call the service method
$result = $proxy.CreateExternalComm($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
2. CreateMessage
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IMessagingService_CreateMessage_InputMessage (soap:body, use = literal)
parameters type CreateMessage
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | MessagesDto | 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) |
| CompletedDate | Optional | dateTime | CompletedDate parameter (nillable) |
| DueDate | Optional | dateTime | DueDate parameter (nillable) |
| ExpiresUtc | Optional | dateTime | ExpiresUtc parameter (nillable) |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| LinkURL | Optional | string | LinkURL parameter (nillable) |
| LoggedDate | Optional | dateTime | LoggedDate parameter (nillable) |
| MessageId | Optional | int | MessageId parameter (nillable) |
| MessageText | Optional | string | MessageText parameter (nillable) |
| MessageType | Optional | string | MessageType parameter (nillable) |
| MessageTypeId | Optional | long | MessageTypeId parameter (nillable) |
| ObjectId | Optional | long | ObjectId parameter (nillable) |
| Priority | Optional | MessagePriority | Low, Medium, High |
| Status | Optional | MessageState | Unread, Read, Actioned, Unactioned, Deleted |
| Subject | Optional | string | Subject parameter (nillable) |
Output: IMessagingService_CreateMessage_OutputMessage (soap:body, use = literal)
parameters type CreateMessageResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateMessageResult | Optional | MessagesDto | CreateMessageResult 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) |
| CompletedDate | Optional | dateTime | CompletedDate parameter (nillable) |
| DueDate | Optional | dateTime | DueDate parameter (nillable) |
| ExpiresUtc | Optional | dateTime | ExpiresUtc parameter (nillable) |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| LinkURL | Optional | string | LinkURL parameter (nillable) |
| LoggedDate | Optional | dateTime | LoggedDate parameter (nillable) |
| MessageId | Optional | int | MessageId parameter (nillable) |
| MessageText | Optional | string | MessageText parameter (nillable) |
| MessageType | Optional | string | MessageType parameter (nillable) |
| MessageTypeId | Optional | long | MessageTypeId parameter (nillable) |
| ObjectId | Optional | long | ObjectId parameter (nillable) |
| Priority | Optional | MessagePriority | Low, Medium, High |
| Status | Optional | MessageState | Unread, Read, Actioned, Unactioned, Deleted |
| Subject | Optional | string | Subject parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new MessagingServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new MessagesDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateMessage(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:CreateMessage>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- MessagesDto properties here -->
</bas:dto>
</bas:CreateMessage>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/MessagingService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object MessagesDto
# Call the service method
$result = $proxy.CreateMessage($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
3. GetExternalCommById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IMessagingService_GetExternalCommById_InputMessage (soap:body, use = literal)
parameters type GetExternalCommById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: IMessagingService_GetExternalCommById_OutputMessage (soap:body, use = literal)
parameters type GetExternalCommByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetExternalCommByIdResult | Optional | ExternalCommDto | GetExternalCommByIdResult 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 |
| Actioned | Optional | boolean | Actioned parameter (nillable) |
| ActionedDateUtc | Optional | dateTime | ActionedDateUtc parameter (nillable) |
| CommsType | Optional | CommsType | TaskEvent, NewTask |
| ContractId | Optional | int | ContractId parameter (nillable) |
| EntityId | Optional | long | EntityId parameter (nillable) |
| ExternalCommId | Optional | long | ExternalCommId parameter (nillable) |
| Message | Optional | string | Message parameter (nillable) |
| MessageTypeId | Optional | int | MessageTypeId parameter (nillable) |
| ReceivedFrom | Optional | string | ReceivedFrom parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new MessagingServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetExternalCommById(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:GetExternalCommById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetExternalCommById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/MessagingService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetExternalCommById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
4. GetExternalCommsByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IMessagingService_GetExternalCommsByDto_InputMessage (soap:body, use = literal)
parameters type GetExternalCommsByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | ExternalCommDto | 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 |
| Actioned | Optional | boolean | Actioned parameter (nillable) |
| ActionedDateUtc | Optional | dateTime | ActionedDateUtc parameter (nillable) |
| CommsType | Optional | CommsType | TaskEvent, NewTask |
| ContractId | Optional | int | ContractId parameter (nillable) |
| EntityId | Optional | long | EntityId parameter (nillable) |
| ExternalCommId | Optional | long | ExternalCommId parameter (nillable) |
| Message | Optional | string | Message parameter (nillable) |
| MessageTypeId | Optional | int | MessageTypeId parameter (nillable) |
| ReceivedFrom | Optional | string | ReceivedFrom parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: IMessagingService_GetExternalCommsByDto_OutputMessage (soap:body, use = literal)
parameters type GetExternalCommsByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetExternalCommsByDtoResult | Optional | ArrayOfExternalCommDto | GetExternalCommsByDtoResult parameter (nillable) |
| ExternalCommDto | Optional | ExternalCommDto | ExternalCommDto 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 |
| Actioned | Optional | boolean | Actioned parameter (nillable) |
| ActionedDateUtc | Optional | dateTime | ActionedDateUtc parameter (nillable) |
| CommsType | Optional | CommsType | TaskEvent, NewTask |
| ContractId | Optional | int | ContractId parameter (nillable) |
| EntityId | Optional | long | EntityId parameter (nillable) |
| ExternalCommId | Optional | long | ExternalCommId parameter (nillable) |
| Message | Optional | string | Message parameter (nillable) |
| MessageTypeId | Optional | int | MessageTypeId parameter (nillable) |
| ReceivedFrom | Optional | string | ReceivedFrom parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new MessagingServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new ExternalCommDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetExternalCommsByDto(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:GetExternalCommsByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- ExternalCommDto properties here -->
</bas:dto>
</bas:GetExternalCommsByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/MessagingService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object ExternalCommDto
# Call the service method
$result = $proxy.GetExternalCommsByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
5. GetMessaegeDetails
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IMessagingService_GetMessaegeDetails_InputMessage (soap:body, use = literal)
parameters type GetMessaegeDetails
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| machineName | Optional | string | machineName parameter (nillable) |
| messageIndex | Optional | int | messageIndex parameter |
Output: IMessagingService_GetMessaegeDetails_OutputMessage (soap:body, use = literal)
parameters type GetMessaegeDetailsResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetMessaegeDetailsResult | Optional | string | GetMessaegeDetailsResult parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new MessagingServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
string machineName = "your_value_here";
// Call the service method
var response = client.GetMessaegeDetails(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:GetMessaegeDetails>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:machineName>sample_value</bas:machineName>
</bas:GetMessaegeDetails>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/MessagingService.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.GetMessaegeDetails($sessionId, $impersonateAccountId, $machineName)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
6. GetMessageById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IMessagingService_GetMessageById_InputMessage (soap:body, use = literal)
parameters type GetMessageById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: IMessagingService_GetMessageById_OutputMessage (soap:body, use = literal)
parameters type GetMessageByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetMessageByIdResult | Optional | MessagesDto | GetMessageByIdResult 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) |
| CompletedDate | Optional | dateTime | CompletedDate parameter (nillable) |
| DueDate | Optional | dateTime | DueDate parameter (nillable) |
| ExpiresUtc | Optional | dateTime | ExpiresUtc parameter (nillable) |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| LinkURL | Optional | string | LinkURL parameter (nillable) |
| LoggedDate | Optional | dateTime | LoggedDate parameter (nillable) |
| MessageId | Optional | int | MessageId parameter (nillable) |
| MessageText | Optional | string | MessageText parameter (nillable) |
| MessageType | Optional | string | MessageType parameter (nillable) |
| MessageTypeId | Optional | long | MessageTypeId parameter (nillable) |
| ObjectId | Optional | long | ObjectId parameter (nillable) |
| Priority | Optional | MessagePriority | Low, Medium, High |
| Status | Optional | MessageState | Unread, Read, Actioned, Unactioned, Deleted |
| Subject | Optional | string | Subject parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new MessagingServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetMessageById(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:GetMessageById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetMessageById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/MessagingService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetMessageById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
7. GetMessagesByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IMessagingService_GetMessagesByDto_InputMessage (soap:body, use = literal)
parameters type GetMessagesByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | MessagesDto | 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) |
| CompletedDate | Optional | dateTime | CompletedDate parameter (nillable) |
| DueDate | Optional | dateTime | DueDate parameter (nillable) |
| ExpiresUtc | Optional | dateTime | ExpiresUtc parameter (nillable) |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| LinkURL | Optional | string | LinkURL parameter (nillable) |
| LoggedDate | Optional | dateTime | LoggedDate parameter (nillable) |
| MessageId | Optional | int | MessageId parameter (nillable) |
| MessageText | Optional | string | MessageText parameter (nillable) |
| MessageType | Optional | string | MessageType parameter (nillable) |
| MessageTypeId | Optional | long | MessageTypeId parameter (nillable) |
| ObjectId | Optional | long | ObjectId parameter (nillable) |
| Priority | Optional | MessagePriority | Low, Medium, High |
| Status | Optional | MessageState | Unread, Read, Actioned, Unactioned, Deleted |
| Subject | Optional | string | Subject parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: IMessagingService_GetMessagesByDto_OutputMessage (soap:body, use = literal)
parameters type GetMessagesByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetMessagesByDtoResult | Optional | ArrayOfMessagesDto | GetMessagesByDtoResult parameter (nillable) |
| MessagesDto | Optional | MessagesDto | MessagesDto 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) |
| CompletedDate | Optional | dateTime | CompletedDate parameter (nillable) |
| DueDate | Optional | dateTime | DueDate parameter (nillable) |
| ExpiresUtc | Optional | dateTime | ExpiresUtc parameter (nillable) |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| LinkURL | Optional | string | LinkURL parameter (nillable) |
| LoggedDate | Optional | dateTime | LoggedDate parameter (nillable) |
| MessageId | Optional | int | MessageId parameter (nillable) |
| MessageText | Optional | string | MessageText parameter (nillable) |
| MessageType | Optional | string | MessageType parameter (nillable) |
| MessageTypeId | Optional | long | MessageTypeId parameter (nillable) |
| ObjectId | Optional | long | ObjectId parameter (nillable) |
| Priority | Optional | MessagePriority | Low, Medium, High |
| Status | Optional | MessageState | Unread, Read, Actioned, Unactioned, Deleted |
| Subject | Optional | string | Subject parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new MessagingServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new MessagesDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetMessagesByDto(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:GetMessagesByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- MessagesDto properties here -->
</bas:dto>
</bas:GetMessagesByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/MessagingService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object MessagesDto
# Call the service method
$result = $proxy.GetMessagesByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
8. GetMessagesCount
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IMessagingService_GetMessagesCount_InputMessage (soap:body, use = literal)
parameters type GetMessagesCount
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| machineName | Optional | string | machineName parameter (nillable) |
Output: IMessagingService_GetMessagesCount_OutputMessage (soap:body, use = literal)
parameters type GetMessagesCountResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetMessagesCountResult | Optional | int | GetMessagesCountResult parameter |
Code Examples
C# Example
// Create the service client
using (var client = new MessagingServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
string machineName = "your_value_here";
// Call the service method
var response = client.GetMessagesCount(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:GetMessagesCount>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:machineName>sample_value</bas:machineName>
</bas:GetMessagesCount>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/MessagingService.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.GetMessagesCount($sessionId, $impersonateAccountId, $machineName)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
9. UpdateExternalComm
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IMessagingService_UpdateExternalComm_InputMessage (soap:body, use = literal)
parameters type UpdateExternalComm
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | ExternalCommDto | 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 |
| Actioned | Optional | boolean | Actioned parameter (nillable) |
| ActionedDateUtc | Optional | dateTime | ActionedDateUtc parameter (nillable) |
| CommsType | Optional | CommsType | TaskEvent, NewTask |
| ContractId | Optional | int | ContractId parameter (nillable) |
| EntityId | Optional | long | EntityId parameter (nillable) |
| ExternalCommId | Optional | long | ExternalCommId parameter (nillable) |
| Message | Optional | string | Message parameter (nillable) |
| MessageTypeId | Optional | int | MessageTypeId parameter (nillable) |
| ReceivedFrom | Optional | string | ReceivedFrom parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
Output: IMessagingService_UpdateExternalComm_OutputMessage (soap:body, use = literal)
parameters type UpdateExternalCommResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateExternalCommResult | Optional | ExternalCommDto | UpdateExternalCommResult 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 |
| Actioned | Optional | boolean | Actioned parameter (nillable) |
| ActionedDateUtc | Optional | dateTime | ActionedDateUtc parameter (nillable) |
| CommsType | Optional | CommsType | TaskEvent, NewTask |
| ContractId | Optional | int | ContractId parameter (nillable) |
| EntityId | Optional | long | EntityId parameter (nillable) |
| ExternalCommId | Optional | long | ExternalCommId parameter (nillable) |
| Message | Optional | string | Message parameter (nillable) |
| MessageTypeId | Optional | int | MessageTypeId parameter (nillable) |
| ReceivedFrom | Optional | string | ReceivedFrom parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new MessagingServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new ExternalCommDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateExternalComm(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:UpdateExternalComm>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- ExternalCommDto properties here -->
</bas:dto>
</bas:UpdateExternalComm>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/MessagingService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object ExternalCommDto
# Call the service method
$result = $proxy.UpdateExternalComm($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
10. UpdateMessage
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IMessagingService_UpdateMessage_InputMessage (soap:body, use = literal)
parameters type UpdateMessage
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | MessagesDto | 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) |
| CompletedDate | Optional | dateTime | CompletedDate parameter (nillable) |
| DueDate | Optional | dateTime | DueDate parameter (nillable) |
| ExpiresUtc | Optional | dateTime | ExpiresUtc parameter (nillable) |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| LinkURL | Optional | string | LinkURL parameter (nillable) |
| LoggedDate | Optional | dateTime | LoggedDate parameter (nillable) |
| MessageId | Optional | int | MessageId parameter (nillable) |
| MessageText | Optional | string | MessageText parameter (nillable) |
| MessageType | Optional | string | MessageType parameter (nillable) |
| MessageTypeId | Optional | long | MessageTypeId parameter (nillable) |
| ObjectId | Optional | long | ObjectId parameter (nillable) |
| Priority | Optional | MessagePriority | Low, Medium, High |
| Status | Optional | MessageState | Unread, Read, Actioned, Unactioned, Deleted |
| Subject | Optional | string | Subject parameter (nillable) |
Output: IMessagingService_UpdateMessage_OutputMessage (soap:body, use = literal)
parameters type UpdateMessageResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateMessageResult | Optional | MessagesDto | UpdateMessageResult 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) |
| CompletedDate | Optional | dateTime | CompletedDate parameter (nillable) |
| DueDate | Optional | dateTime | DueDate parameter (nillable) |
| ExpiresUtc | Optional | dateTime | ExpiresUtc parameter (nillable) |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| LinkURL | Optional | string | LinkURL parameter (nillable) |
| LoggedDate | Optional | dateTime | LoggedDate parameter (nillable) |
| MessageId | Optional | int | MessageId parameter (nillable) |
| MessageText | Optional | string | MessageText parameter (nillable) |
| MessageType | Optional | string | MessageType parameter (nillable) |
| MessageTypeId | Optional | long | MessageTypeId parameter (nillable) |
| ObjectId | Optional | long | ObjectId parameter (nillable) |
| Priority | Optional | MessagePriority | Low, Medium, High |
| Status | Optional | MessageState | Unread, Read, Actioned, Unactioned, Deleted |
| Subject | Optional | string | Subject parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new MessagingServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new MessagesDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateMessage(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:UpdateMessage>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- MessagesDto properties here -->
</bas:dto>
</bas:UpdateMessage>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/MessagingService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object MessagesDto
# Call the service method
$result = $proxy.UpdateMessage($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}