Web Service: EventsService
Port EventsService
Port type IEventsService
1. CreateEvent
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IEventsService_CreateEvent_InputMessage (soap:body, use = literal)
parameters type CreateEvent
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | EventDto | 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) |
| Comments | Optional | string | Comments parameter (nillable) |
| DueDateUtc | Optional | dateTime | DueDateUtc parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| EventCreatedUtc | Optional | dateTime | EventCreatedUtc parameter (nillable) |
| EventId | Optional | long | EventId parameter (nillable) |
| ExternalController | Optional | boolean | ExternalController parameter (nillable) |
| GenericEventType | Optional | long | GenericEventType parameter (nillable) |
| IntegrationDate | Optional | dateTime | IntegrationDate parameter (nillable) |
| IntegrationIdentifier | Optional | string | IntegrationIdentifier parameter (nillable) |
| IntegrationObject | Optional | string | IntegrationObject parameter (nillable) |
| IntegrationSystem | Optional | string | IntegrationSystem parameter (nillable) |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| Latitude | Optional | double | Latitude parameter (nillable) |
| Longitude | Optional | double | Longitude parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TimeZoneId | Optional | long | TimeZoneId parameter (nillable) |
| Type | Optional | EventTypes | PLANNED, ACTUAL |
Output: IEventsService_CreateEvent_OutputMessage (soap:body, use = literal)
parameters type CreateEventResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateEventResult | Optional | EventDto | CreateEventResult 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) |
| Comments | Optional | string | Comments parameter (nillable) |
| DueDateUtc | Optional | dateTime | DueDateUtc parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| EventCreatedUtc | Optional | dateTime | EventCreatedUtc parameter (nillable) |
| EventId | Optional | long | EventId parameter (nillable) |
| ExternalController | Optional | boolean | ExternalController parameter (nillable) |
| GenericEventType | Optional | long | GenericEventType parameter (nillable) |
| IntegrationDate | Optional | dateTime | IntegrationDate parameter (nillable) |
| IntegrationIdentifier | Optional | string | IntegrationIdentifier parameter (nillable) |
| IntegrationObject | Optional | string | IntegrationObject parameter (nillable) |
| IntegrationSystem | Optional | string | IntegrationSystem parameter (nillable) |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| Latitude | Optional | double | Latitude parameter (nillable) |
| Longitude | Optional | double | Longitude parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TimeZoneId | Optional | long | TimeZoneId parameter (nillable) |
| Type | Optional | EventTypes | PLANNED, ACTUAL |
Code Examples
C# Example
// Create the service client
using (var client = new EventsServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new EventDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateEvent(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:CreateEvent>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- EventDto properties here -->
</bas:dto>
</bas:CreateEvent>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/EventsService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object EventDto
# Call the service method
$result = $proxy.CreateEvent($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
2. CreateGenericEventType
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IEventsService_CreateGenericEventType_InputMessage (soap:body, use = literal)
parameters type CreateGenericEventType
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | GenericEventTypeDto | 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 |
| Comments | Optional | string | Comments parameter (nillable) |
| DefaultEventType | Optional | EventTypes | PLANNED, ACTUAL |
| Description | Optional | string | Description parameter (nillable) |
| GenericEventTypeId | Optional | long | GenericEventTypeId parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
Output: IEventsService_CreateGenericEventType_OutputMessage (soap:body, use = literal)
parameters type CreateGenericEventTypeResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateGenericEventTypeResult | Optional | GenericEventTypeDto | CreateGenericEventTypeResult 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 |
| Comments | Optional | string | Comments parameter (nillable) |
| DefaultEventType | Optional | EventTypes | PLANNED, ACTUAL |
| Description | Optional | string | Description parameter (nillable) |
| GenericEventTypeId | Optional | long | GenericEventTypeId parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new EventsServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new GenericEventTypeDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateGenericEventType(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:CreateGenericEventType>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- GenericEventTypeDto properties here -->
</bas:dto>
</bas:CreateGenericEventType>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/EventsService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object GenericEventTypeDto
# Call the service method
$result = $proxy.CreateGenericEventType($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
3. GetEventById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IEventsService_GetEventById_InputMessage (soap:body, use = literal)
parameters type GetEventById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: IEventsService_GetEventById_OutputMessage (soap:body, use = literal)
parameters type GetEventByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetEventByIdResult | Optional | EventDto | GetEventByIdResult 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) |
| Comments | Optional | string | Comments parameter (nillable) |
| DueDateUtc | Optional | dateTime | DueDateUtc parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| EventCreatedUtc | Optional | dateTime | EventCreatedUtc parameter (nillable) |
| EventId | Optional | long | EventId parameter (nillable) |
| ExternalController | Optional | boolean | ExternalController parameter (nillable) |
| GenericEventType | Optional | long | GenericEventType parameter (nillable) |
| IntegrationDate | Optional | dateTime | IntegrationDate parameter (nillable) |
| IntegrationIdentifier | Optional | string | IntegrationIdentifier parameter (nillable) |
| IntegrationObject | Optional | string | IntegrationObject parameter (nillable) |
| IntegrationSystem | Optional | string | IntegrationSystem parameter (nillable) |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| Latitude | Optional | double | Latitude parameter (nillable) |
| Longitude | Optional | double | Longitude parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TimeZoneId | Optional | long | TimeZoneId parameter (nillable) |
| Type | Optional | EventTypes | PLANNED, ACTUAL |
Code Examples
C# Example
// Create the service client
using (var client = new EventsServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetEventById(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:GetEventById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetEventById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/EventsService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetEventById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
4. GetEventsByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IEventsService_GetEventsByDto_InputMessage (soap:body, use = literal)
parameters type GetEventsByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | EventDto | 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) |
| Comments | Optional | string | Comments parameter (nillable) |
| DueDateUtc | Optional | dateTime | DueDateUtc parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| EventCreatedUtc | Optional | dateTime | EventCreatedUtc parameter (nillable) |
| EventId | Optional | long | EventId parameter (nillable) |
| ExternalController | Optional | boolean | ExternalController parameter (nillable) |
| GenericEventType | Optional | long | GenericEventType parameter (nillable) |
| IntegrationDate | Optional | dateTime | IntegrationDate parameter (nillable) |
| IntegrationIdentifier | Optional | string | IntegrationIdentifier parameter (nillable) |
| IntegrationObject | Optional | string | IntegrationObject parameter (nillable) |
| IntegrationSystem | Optional | string | IntegrationSystem parameter (nillable) |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| Latitude | Optional | double | Latitude parameter (nillable) |
| Longitude | Optional | double | Longitude parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TimeZoneId | Optional | long | TimeZoneId parameter (nillable) |
| Type | Optional | EventTypes | PLANNED, ACTUAL |
| page | Optional | long | page parameter (nillable) |
Output: IEventsService_GetEventsByDto_OutputMessage (soap:body, use = literal)
parameters type GetEventsByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetEventsByDtoResult | Optional | ArrayOfEventDto | GetEventsByDtoResult parameter (nillable) |
| EventDto | Optional | EventDto | EventDto 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) |
| Comments | Optional | string | Comments parameter (nillable) |
| DueDateUtc | Optional | dateTime | DueDateUtc parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| EventCreatedUtc | Optional | dateTime | EventCreatedUtc parameter (nillable) |
| EventId | Optional | long | EventId parameter (nillable) |
| ExternalController | Optional | boolean | ExternalController parameter (nillable) |
| GenericEventType | Optional | long | GenericEventType parameter (nillable) |
| IntegrationDate | Optional | dateTime | IntegrationDate parameter (nillable) |
| IntegrationIdentifier | Optional | string | IntegrationIdentifier parameter (nillable) |
| IntegrationObject | Optional | string | IntegrationObject parameter (nillable) |
| IntegrationSystem | Optional | string | IntegrationSystem parameter (nillable) |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| Latitude | Optional | double | Latitude parameter (nillable) |
| Longitude | Optional | double | Longitude parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TimeZoneId | Optional | long | TimeZoneId parameter (nillable) |
| Type | Optional | EventTypes | PLANNED, ACTUAL |
Code Examples
C# Example
// Create the service client
using (var client = new EventsServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new EventDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetEventsByDto(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:GetEventsByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- EventDto properties here -->
</bas:dto>
</bas:GetEventsByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/EventsService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object EventDto
# Call the service method
$result = $proxy.GetEventsByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
5. GetGenericEventTypeById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IEventsService_GetGenericEventTypeById_InputMessage (soap:body, use = literal)
parameters type GetGenericEventTypeById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: IEventsService_GetGenericEventTypeById_OutputMessage (soap:body, use = literal)
parameters type GetGenericEventTypeByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetGenericEventTypeByIdResult | Optional | GenericEventTypeDto | GetGenericEventTypeByIdResult 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 |
| Comments | Optional | string | Comments parameter (nillable) |
| DefaultEventType | Optional | EventTypes | PLANNED, ACTUAL |
| Description | Optional | string | Description parameter (nillable) |
| GenericEventTypeId | Optional | long | GenericEventTypeId parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new EventsServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetGenericEventTypeById(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:GetGenericEventTypeById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetGenericEventTypeById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/EventsService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetGenericEventTypeById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
6. GetGenericEventTypesByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IEventsService_GetGenericEventTypesByDto_InputMessage (soap:body, use = literal)
parameters type GetGenericEventTypesByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | GenericEventTypeDto | 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 |
| Comments | Optional | string | Comments parameter (nillable) |
| DefaultEventType | Optional | EventTypes | PLANNED, ACTUAL |
| Description | Optional | string | Description parameter (nillable) |
| GenericEventTypeId | Optional | long | GenericEventTypeId parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: IEventsService_GetGenericEventTypesByDto_OutputMessage (soap:body, use = literal)
parameters type GetGenericEventTypesByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetGenericEventTypesByDtoResult | Optional | ArrayOfGenericEventTypeDto | GetGenericEventTypesByDtoResult parameter (nillable) |
| GenericEventTypeDto | Optional | GenericEventTypeDto | GenericEventTypeDto 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 |
| Comments | Optional | string | Comments parameter (nillable) |
| DefaultEventType | Optional | EventTypes | PLANNED, ACTUAL |
| Description | Optional | string | Description parameter (nillable) |
| GenericEventTypeId | Optional | long | GenericEventTypeId parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new EventsServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new GenericEventTypeDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetGenericEventTypesByDto(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:GetGenericEventTypesByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- GenericEventTypeDto properties here -->
</bas:dto>
</bas:GetGenericEventTypesByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/EventsService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object GenericEventTypeDto
# Call the service method
$result = $proxy.GetGenericEventTypesByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
7. UpdateEvent
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IEventsService_UpdateEvent_InputMessage (soap:body, use = literal)
parameters type UpdateEvent
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | EventDto | 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) |
| Comments | Optional | string | Comments parameter (nillable) |
| DueDateUtc | Optional | dateTime | DueDateUtc parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| EventCreatedUtc | Optional | dateTime | EventCreatedUtc parameter (nillable) |
| EventId | Optional | long | EventId parameter (nillable) |
| ExternalController | Optional | boolean | ExternalController parameter (nillable) |
| GenericEventType | Optional | long | GenericEventType parameter (nillable) |
| IntegrationDate | Optional | dateTime | IntegrationDate parameter (nillable) |
| IntegrationIdentifier | Optional | string | IntegrationIdentifier parameter (nillable) |
| IntegrationObject | Optional | string | IntegrationObject parameter (nillable) |
| IntegrationSystem | Optional | string | IntegrationSystem parameter (nillable) |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| Latitude | Optional | double | Latitude parameter (nillable) |
| Longitude | Optional | double | Longitude parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TimeZoneId | Optional | long | TimeZoneId parameter (nillable) |
| Type | Optional | EventTypes | PLANNED, ACTUAL |
Output: IEventsService_UpdateEvent_OutputMessage (soap:body, use = literal)
parameters type UpdateEventResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateEventResult | Optional | EventDto | UpdateEventResult 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) |
| Comments | Optional | string | Comments parameter (nillable) |
| DueDateUtc | Optional | dateTime | DueDateUtc parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| EventCreatedUtc | Optional | dateTime | EventCreatedUtc parameter (nillable) |
| EventId | Optional | long | EventId parameter (nillable) |
| ExternalController | Optional | boolean | ExternalController parameter (nillable) |
| GenericEventType | Optional | long | GenericEventType parameter (nillable) |
| IntegrationDate | Optional | dateTime | IntegrationDate parameter (nillable) |
| IntegrationIdentifier | Optional | string | IntegrationIdentifier parameter (nillable) |
| IntegrationObject | Optional | string | IntegrationObject parameter (nillable) |
| IntegrationSystem | Optional | string | IntegrationSystem parameter (nillable) |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| Latitude | Optional | double | Latitude parameter (nillable) |
| Longitude | Optional | double | Longitude parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TimeZoneId | Optional | long | TimeZoneId parameter (nillable) |
| Type | Optional | EventTypes | PLANNED, ACTUAL |
Code Examples
C# Example
// Create the service client
using (var client = new EventsServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new EventDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateEvent(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:UpdateEvent>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- EventDto properties here -->
</bas:dto>
</bas:UpdateEvent>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/EventsService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object EventDto
# Call the service method
$result = $proxy.UpdateEvent($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
8. UpdateGenericEventType
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IEventsService_UpdateGenericEventType_InputMessage (soap:body, use = literal)
parameters type UpdateGenericEventType
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | GenericEventTypeDto | 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 |
| Comments | Optional | string | Comments parameter (nillable) |
| DefaultEventType | Optional | EventTypes | PLANNED, ACTUAL |
| Description | Optional | string | Description parameter (nillable) |
| GenericEventTypeId | Optional | long | GenericEventTypeId parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
Output: IEventsService_UpdateGenericEventType_OutputMessage (soap:body, use = literal)
parameters type UpdateGenericEventTypeResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateGenericEventTypeResult | Optional | GenericEventTypeDto | UpdateGenericEventTypeResult 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 |
| Comments | Optional | string | Comments parameter (nillable) |
| DefaultEventType | Optional | EventTypes | PLANNED, ACTUAL |
| Description | Optional | string | Description parameter (nillable) |
| GenericEventTypeId | Optional | long | GenericEventTypeId parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new EventsServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new GenericEventTypeDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateGenericEventType(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:UpdateGenericEventType>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- GenericEventTypeDto properties here -->
</bas:dto>
</bas:UpdateGenericEventType>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/EventsService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object GenericEventTypeDto
# Call the service method
$result = $proxy.UpdateGenericEventType($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}