Web Service: AppointmentService
Port AppointmentService
- CreateAppointmentTypeDetail
- CreateAppointmentVisitDetail
- CreateRequestDetail
- Create_x0020_Appointment_x0020_Visit_x0020_ResolutionDetail
- GetAppointmentTypeByIdDetail
- GetAppointmentTypesByDtoDetail
- GetAppointmentVisitByIdDetail
- GetAppointmentVisitsByDtoDetail
- GetRequestByIdDetail
- GetRequestsByDtoDetail
- Get_x0020_Appointment_x0020_Visit_x0020_Resolution_x0020_By_x0020_IdDetail
- Get_x0020_Appointment_x0020_Visit_x0020_Resolutions_x0020_By_x0020_DtoDetail
- UpdateAppointmentTypeDetail
- UpdateAppointmentVisitDetail
- UpdateRequestDetail
- Update_x0020_Appointment_x0020_Visit_x0020_ResolutionDetail
Port type IAppointmentService
1. CreateAppointmentType
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAppointmentService_CreateAppointmentType_InputMessage (soap:body, use = literal)
parameters type CreateAppointmentType
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | AppointmentTypeDto | 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 |
| AdjustWindowOnAction | Optional | AdjustWindowOnActionEnum | DoNotAdjust, OnResourceAcceptance, OnDespatch |
| AdjustWindowTo | Optional | double | AdjustWindowTo parameter (nillable) |
| AppointmentClass | Optional | AppointmentClassEnum | TaskAppointment, SiteVisit |
| AppointmentTypeId | Optional | long | AppointmentTypeId parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| DefaultWindowRounding | Optional | DefaultWindowRoundingEnum | ToNearestHour, ToNearest30mins, ToNearest15mins, NoRoundingUseSpecificTimes |
| DefaultWindowSize | Optional | double | DefaultWindowSize parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| DurationType | Optional | DurationTypeEnum | Expandable, Fixed |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| MaximumDuration | Optional | double | MaximumDuration parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| SignOffRequiredContractor | Optional | SignOffRequiredContractorEnum | NotRequired, OnDeparture, OnCompletion |
| SignOffRequiredFsiGo | Optional | SignOffRequiredFSIGoEnum | NotRequired, OnDeparture, OnCompletion |
Output: IAppointmentService_CreateAppointmentType_OutputMessage (soap:body, use = literal)
parameters type CreateAppointmentTypeResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateAppointmentTypeResult | Optional | AppointmentTypeDto | CreateAppointmentTypeResult 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 |
| AdjustWindowOnAction | Optional | AdjustWindowOnActionEnum | DoNotAdjust, OnResourceAcceptance, OnDespatch |
| AdjustWindowTo | Optional | double | AdjustWindowTo parameter (nillable) |
| AppointmentClass | Optional | AppointmentClassEnum | TaskAppointment, SiteVisit |
| AppointmentTypeId | Optional | long | AppointmentTypeId parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| DefaultWindowRounding | Optional | DefaultWindowRoundingEnum | ToNearestHour, ToNearest30mins, ToNearest15mins, NoRoundingUseSpecificTimes |
| DefaultWindowSize | Optional | double | DefaultWindowSize parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| DurationType | Optional | DurationTypeEnum | Expandable, Fixed |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| MaximumDuration | Optional | double | MaximumDuration parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| SignOffRequiredContractor | Optional | SignOffRequiredContractorEnum | NotRequired, OnDeparture, OnCompletion |
| SignOffRequiredFsiGo | Optional | SignOffRequiredFSIGoEnum | NotRequired, OnDeparture, OnCompletion |
Code Examples
C# Example
// Create the service client
using (var client = new AppointmentServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new AppointmentTypeDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateAppointmentType(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:CreateAppointmentType>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- AppointmentTypeDto properties here -->
</bas:dto>
</bas:CreateAppointmentType>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AppointmentService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object AppointmentTypeDto
# Call the service method
$result = $proxy.CreateAppointmentType($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
2. CreateAppointmentVisit
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAppointmentService_CreateAppointmentVisit_InputMessage (soap:body, use = literal)
parameters type CreateAppointmentVisit
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | AppointmentVisitDto | 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 |
| StateName | Optional | string | StateName parameter (nillable) |
| AppointmentTypeId | Optional | long | AppointmentTypeId parameter (nillable) |
| AppointmentValue | Optional | double | AppointmentValue parameter (nillable) |
| AppointmentVisitId | Optional | long | AppointmentVisitId parameter (nillable) |
| AppointmentVisitResolutionId | Optional | long | AppointmentVisitResolutionId parameter (nillable) |
| ArrivalDate | Optional | dateTime | ArrivalDate parameter (nillable) |
| BuildingId | Optional | int | BuildingId parameter (nillable) |
| CompletionDate | Optional | dateTime | CompletionDate parameter (nillable) |
| ConfirmedBy | Optional | long | ConfirmedBy parameter (nillable) |
| ContactId | Optional | int | ContactId parameter (nillable) |
| ContractId | Optional | int | ContractId parameter (nillable) |
| CustomerDescription | Optional | string | CustomerDescription parameter (nillable) |
| CustomerNotes | Optional | string | CustomerNotes parameter (nillable) |
| CustomerNotified | Optional | boolean | CustomerNotified parameter (nillable) |
| DateConfirmed | Optional | dateTime | DateConfirmed parameter (nillable) |
| DateDespatched | Optional | dateTime | DateDespatched parameter (nillable) |
| DespatchedBy | Optional | long | DespatchedBy parameter (nillable) |
| DisciplineId | Optional | int | DisciplineId parameter (nillable) |
| EstArrivalDate | Optional | dateTime | EstArrivalDate parameter (nillable) |
| EstBreaks | Optional | double | EstBreaks parameter (nillable) |
| EstCompletionDate | Optional | dateTime | EstCompletionDate parameter (nillable) |
| EstStartDate | Optional | dateTime | EstStartDate parameter (nillable) |
| EstTime | Optional | double | EstTime parameter (nillable) |
| EstTravelTime | Optional | double | EstTravelTime parameter (nillable) |
| Locked | Optional | boolean | Locked parameter (nillable) |
| Mitigated | Optional | boolean | Mitigated parameter (nillable) |
| MitigationEventId | Optional | long | MitigationEventId parameter (nillable) |
| MitigationNotes | Optional | string | MitigationNotes parameter (nillable) |
| OriginalAppointmentId | Optional | long | OriginalAppointmentId parameter (nillable) |
| RequestId | Optional | long | RequestId parameter (nillable) |
| RescheduleRequestDate | Optional | dateTime | RescheduleRequestDate parameter (nillable) |
| RescheduleRequestNotes | Optional | string | RescheduleRequestNotes parameter (nillable) |
| ResolutionNotes | Optional | string | ResolutionNotes parameter (nillable) |
| ResourceAllocated | Optional | boolean | ResourceAllocated parameter (nillable) |
| ResourceId | Optional | int | ResourceId parameter (nillable) |
| ResourceNotes | Optional | string | ResourceNotes parameter (nillable) |
| RevisitProposedDate | Optional | dateTime | RevisitProposedDate parameter (nillable) |
| RevisitRequired | Optional | RevisitRequiredEnum | NotRequired, AgreedRevisit, NewAppointmentRequiredSomeoneElse, NewAppointmentRequiredSameResource |
| SiteSignOffBy | Optional | string | SiteSignOffBy parameter (nillable) |
| SiteSignOffDate | Optional | dateTime | SiteSignOffDate parameter (nillable) |
| SiteSignOffNotes | Optional | string | SiteSignOffNotes parameter (nillable) |
| SiteSignedOff | Optional | boolean | SiteSignedOff parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| Summary | Optional | string | Summary parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TeamId | Optional | long | TeamId parameter (nillable) |
| TravelStartDate | Optional | dateTime | TravelStartDate parameter (nillable) |
| TravelTime | Optional | double | TravelTime parameter (nillable) |
| UniqueRef | Optional | string | UniqueRef parameter (nillable) |
| WindowEndDate | Optional | dateTime | WindowEndDate parameter (nillable) |
| WindowStartDate | Optional | dateTime | WindowStartDate parameter (nillable) |
Output: IAppointmentService_CreateAppointmentVisit_OutputMessage (soap:body, use = literal)
parameters type CreateAppointmentVisitResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateAppointmentVisitResult | Optional | AppointmentVisitDto | CreateAppointmentVisitResult 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 |
| StateName | Optional | string | StateName parameter (nillable) |
| AppointmentTypeId | Optional | long | AppointmentTypeId parameter (nillable) |
| AppointmentValue | Optional | double | AppointmentValue parameter (nillable) |
| AppointmentVisitId | Optional | long | AppointmentVisitId parameter (nillable) |
| AppointmentVisitResolutionId | Optional | long | AppointmentVisitResolutionId parameter (nillable) |
| ArrivalDate | Optional | dateTime | ArrivalDate parameter (nillable) |
| BuildingId | Optional | int | BuildingId parameter (nillable) |
| CompletionDate | Optional | dateTime | CompletionDate parameter (nillable) |
| ConfirmedBy | Optional | long | ConfirmedBy parameter (nillable) |
| ContactId | Optional | int | ContactId parameter (nillable) |
| ContractId | Optional | int | ContractId parameter (nillable) |
| CustomerDescription | Optional | string | CustomerDescription parameter (nillable) |
| CustomerNotes | Optional | string | CustomerNotes parameter (nillable) |
| CustomerNotified | Optional | boolean | CustomerNotified parameter (nillable) |
| DateConfirmed | Optional | dateTime | DateConfirmed parameter (nillable) |
| DateDespatched | Optional | dateTime | DateDespatched parameter (nillable) |
| DespatchedBy | Optional | long | DespatchedBy parameter (nillable) |
| DisciplineId | Optional | int | DisciplineId parameter (nillable) |
| EstArrivalDate | Optional | dateTime | EstArrivalDate parameter (nillable) |
| EstBreaks | Optional | double | EstBreaks parameter (nillable) |
| EstCompletionDate | Optional | dateTime | EstCompletionDate parameter (nillable) |
| EstStartDate | Optional | dateTime | EstStartDate parameter (nillable) |
| EstTime | Optional | double | EstTime parameter (nillable) |
| EstTravelTime | Optional | double | EstTravelTime parameter (nillable) |
| Locked | Optional | boolean | Locked parameter (nillable) |
| Mitigated | Optional | boolean | Mitigated parameter (nillable) |
| MitigationEventId | Optional | long | MitigationEventId parameter (nillable) |
| MitigationNotes | Optional | string | MitigationNotes parameter (nillable) |
| OriginalAppointmentId | Optional | long | OriginalAppointmentId parameter (nillable) |
| RequestId | Optional | long | RequestId parameter (nillable) |
| RescheduleRequestDate | Optional | dateTime | RescheduleRequestDate parameter (nillable) |
| RescheduleRequestNotes | Optional | string | RescheduleRequestNotes parameter (nillable) |
| ResolutionNotes | Optional | string | ResolutionNotes parameter (nillable) |
| ResourceAllocated | Optional | boolean | ResourceAllocated parameter (nillable) |
| ResourceId | Optional | int | ResourceId parameter (nillable) |
| ResourceNotes | Optional | string | ResourceNotes parameter (nillable) |
| RevisitProposedDate | Optional | dateTime | RevisitProposedDate parameter (nillable) |
| RevisitRequired | Optional | RevisitRequiredEnum | NotRequired, AgreedRevisit, NewAppointmentRequiredSomeoneElse, NewAppointmentRequiredSameResource |
| SiteSignOffBy | Optional | string | SiteSignOffBy parameter (nillable) |
| SiteSignOffDate | Optional | dateTime | SiteSignOffDate parameter (nillable) |
| SiteSignOffNotes | Optional | string | SiteSignOffNotes parameter (nillable) |
| SiteSignedOff | Optional | boolean | SiteSignedOff parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| Summary | Optional | string | Summary parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TeamId | Optional | long | TeamId parameter (nillable) |
| TravelStartDate | Optional | dateTime | TravelStartDate parameter (nillable) |
| TravelTime | Optional | double | TravelTime parameter (nillable) |
| UniqueRef | Optional | string | UniqueRef parameter (nillable) |
| WindowEndDate | Optional | dateTime | WindowEndDate parameter (nillable) |
| WindowStartDate | Optional | dateTime | WindowStartDate parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AppointmentServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new AppointmentVisitDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateAppointmentVisit(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:CreateAppointmentVisit>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- AppointmentVisitDto properties here -->
</bas:dto>
</bas:CreateAppointmentVisit>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AppointmentService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object AppointmentVisitDto
# Call the service method
$result = $proxy.CreateAppointmentVisit($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
3. CreateRequest
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAppointmentService_CreateRequest_InputMessage (soap:body, use = literal)
parameters type CreateRequest
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | RequestDto | 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 |
| StateName | Optional | string | StateName parameter (nillable) |
| ActionedBy | Optional | long | ActionedBy parameter (nillable) |
| AllItemsAllocated | Optional | boolean | AllItemsAllocated parameter (nillable) |
| ApplyPlanningConstraints | Optional | boolean | ApplyPlanningConstraints parameter (nillable) |
| AppointmentCommsMethod | Optional | int | AppointmentCommsMethod parameter (nillable) |
| AppointmentNotes | Optional | string | AppointmentNotes parameter (nillable) |
| AppointmentRequired | Optional | boolean | AppointmentRequired parameter (nillable) |
| ArrangeApptTargetDateUtc | Optional | dateTime | ArrangeApptTargetDateUtc parameter (nillable) |
| BuildingId | Optional | int | BuildingId parameter (nillable) |
| CalendarDayId | Optional | long | CalendarDayId parameter (nillable) |
| CalendarSessionId | Optional | long | CalendarSessionId parameter (nillable) |
| CallerSourceId | Optional | int | CallerSourceId parameter (nillable) |
| CategoryId | Optional | int | CategoryId parameter (nillable) |
| CompletedByAccountId | Optional | long | CompletedByAccountId parameter (nillable) |
| CompletionType | Optional | CompletionType | NoSelection, TaskResolution, SelfDiagnosis, ResolvedByOperator |
| ContactId | Optional | int | ContactId parameter (nillable) |
| ContractId | Optional | int | ContractId parameter (nillable) |
| CostCentreId | Optional | int | CostCentreId parameter (nillable) |
| CostCodeId | Optional | int | CostCodeId parameter (nillable) |
| CostLabour | Optional | double | CostLabour parameter (nillable) |
| CostMaterials | Optional | double | CostMaterials parameter (nillable) |
| CostPlant | Optional | double | CostPlant parameter (nillable) |
| DateActioned | Optional | dateTime | DateActioned parameter (nillable) |
| DateCompletedUtc | Optional | dateTime | DateCompletedUtc parameter (nillable) |
| DateRequested | Optional | dateTime | DateRequested parameter (nillable) |
| DepartmentId | Optional | int | DepartmentId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| DisableReminders | Optional | boolean | DisableReminders parameter (nillable) |
| DisciplineId | Optional | int | DisciplineId parameter (nillable) |
| ExternalIdentifier | Optional | string | ExternalIdentifier parameter (nillable) |
| ExternalReference | Optional | string | ExternalReference parameter (nillable) |
| LevelOfCompletionId | Optional | int | LevelOfCompletionId parameter (nillable) |
| Notes | Optional | string | Notes parameter (nillable) |
| OwnerAccountId | Optional | long | OwnerAccountId parameter (nillable) |
| PriorityId | Optional | int | PriorityId parameter (nillable) |
| RecoverabilityTypeId | Optional | long | RecoverabilityTypeId parameter (nillable) |
| Reference | Optional | string | Reference parameter (nillable) |
| RequestId | Optional | long | RequestId parameter (nillable) |
| RequestType | Optional | string | RequestType parameter (nillable) |
| RequesterAddress | Optional | string | RequesterAddress parameter (nillable) |
| RequesterAltContact | Optional | string | RequesterAltContact parameter (nillable) |
| RequesterAltEmail | Optional | string | RequesterAltEmail parameter (nillable) |
| RequesterAltPhone | Optional | string | RequesterAltPhone parameter (nillable) |
| RequesterEmail | Optional | string | RequesterEmail parameter (nillable) |
| RequesterName | Optional | string | RequesterName parameter (nillable) |
| RequesterPhone | Optional | string | RequesterPhone parameter (nillable) |
| RequesterPropRef | Optional | string | RequesterPropRef parameter (nillable) |
| ResolutionComments | Optional | string | ResolutionComments parameter (nillable) |
| SaleLabour | Optional | double | SaleLabour parameter (nillable) |
| SaleMaterials | Optional | double | SaleMaterials parameter (nillable) |
| SalePricePlant | Optional | double | SalePricePlant parameter (nillable) |
| SalesInvoiceInfo | Optional | string | SalesInvoiceInfo parameter (nillable) |
| Source | Optional | string | Source parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| Summary | Optional | string | Summary parameter (nillable) |
| TaskPerfAttendDate | Optional | dateTime | TaskPerfAttendDate parameter (nillable) |
| TaskPerfContainDate | Optional | dateTime | TaskPerfContainDate parameter (nillable) |
| TaskPerfFixDate | Optional | dateTime | TaskPerfFixDate parameter (nillable) |
| TaskPerfMeasurable | Optional | long | TaskPerfMeasurable parameter (nillable) |
| TaskPerfRespondDate | Optional | dateTime | TaskPerfRespondDate parameter (nillable) |
| TaskPerfSLAAttendDate | Optional | dateTime | TaskPerfSLAAttendDate parameter (nillable) |
| TaskPerfSLAContainDate | Optional | dateTime | TaskPerfSLAContainDate parameter (nillable) |
| TaskPerfSLAFixDate | Optional | dateTime | TaskPerfSLAFixDate parameter (nillable) |
| TaskPerfSLARespondDate | Optional | dateTime | TaskPerfSLARespondDate parameter (nillable) |
| TaskPerfSLAUserDefinedDate | Optional | dateTime | TaskPerfSLAUserDefinedDate parameter (nillable) |
| TaskPerfUserDefinedDate | Optional | dateTime | TaskPerfUserDefinedDate parameter (nillable) |
| UniqueRef | Optional | string | UniqueRef parameter (nillable) |
Output: IAppointmentService_CreateRequest_OutputMessage (soap:body, use = literal)
parameters type CreateRequestResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateRequestResult | Optional | RequestDto | CreateRequestResult 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 |
| StateName | Optional | string | StateName parameter (nillable) |
| ActionedBy | Optional | long | ActionedBy parameter (nillable) |
| AllItemsAllocated | Optional | boolean | AllItemsAllocated parameter (nillable) |
| ApplyPlanningConstraints | Optional | boolean | ApplyPlanningConstraints parameter (nillable) |
| AppointmentCommsMethod | Optional | int | AppointmentCommsMethod parameter (nillable) |
| AppointmentNotes | Optional | string | AppointmentNotes parameter (nillable) |
| AppointmentRequired | Optional | boolean | AppointmentRequired parameter (nillable) |
| ArrangeApptTargetDateUtc | Optional | dateTime | ArrangeApptTargetDateUtc parameter (nillable) |
| BuildingId | Optional | int | BuildingId parameter (nillable) |
| CalendarDayId | Optional | long | CalendarDayId parameter (nillable) |
| CalendarSessionId | Optional | long | CalendarSessionId parameter (nillable) |
| CallerSourceId | Optional | int | CallerSourceId parameter (nillable) |
| CategoryId | Optional | int | CategoryId parameter (nillable) |
| CompletedByAccountId | Optional | long | CompletedByAccountId parameter (nillable) |
| CompletionType | Optional | CompletionType | NoSelection, TaskResolution, SelfDiagnosis, ResolvedByOperator |
| ContactId | Optional | int | ContactId parameter (nillable) |
| ContractId | Optional | int | ContractId parameter (nillable) |
| CostCentreId | Optional | int | CostCentreId parameter (nillable) |
| CostCodeId | Optional | int | CostCodeId parameter (nillable) |
| CostLabour | Optional | double | CostLabour parameter (nillable) |
| CostMaterials | Optional | double | CostMaterials parameter (nillable) |
| CostPlant | Optional | double | CostPlant parameter (nillable) |
| DateActioned | Optional | dateTime | DateActioned parameter (nillable) |
| DateCompletedUtc | Optional | dateTime | DateCompletedUtc parameter (nillable) |
| DateRequested | Optional | dateTime | DateRequested parameter (nillable) |
| DepartmentId | Optional | int | DepartmentId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| DisableReminders | Optional | boolean | DisableReminders parameter (nillable) |
| DisciplineId | Optional | int | DisciplineId parameter (nillable) |
| ExternalIdentifier | Optional | string | ExternalIdentifier parameter (nillable) |
| ExternalReference | Optional | string | ExternalReference parameter (nillable) |
| LevelOfCompletionId | Optional | int | LevelOfCompletionId parameter (nillable) |
| Notes | Optional | string | Notes parameter (nillable) |
| OwnerAccountId | Optional | long | OwnerAccountId parameter (nillable) |
| PriorityId | Optional | int | PriorityId parameter (nillable) |
| RecoverabilityTypeId | Optional | long | RecoverabilityTypeId parameter (nillable) |
| Reference | Optional | string | Reference parameter (nillable) |
| RequestId | Optional | long | RequestId parameter (nillable) |
| RequestType | Optional | string | RequestType parameter (nillable) |
| RequesterAddress | Optional | string | RequesterAddress parameter (nillable) |
| RequesterAltContact | Optional | string | RequesterAltContact parameter (nillable) |
| RequesterAltEmail | Optional | string | RequesterAltEmail parameter (nillable) |
| RequesterAltPhone | Optional | string | RequesterAltPhone parameter (nillable) |
| RequesterEmail | Optional | string | RequesterEmail parameter (nillable) |
| RequesterName | Optional | string | RequesterName parameter (nillable) |
| RequesterPhone | Optional | string | RequesterPhone parameter (nillable) |
| RequesterPropRef | Optional | string | RequesterPropRef parameter (nillable) |
| ResolutionComments | Optional | string | ResolutionComments parameter (nillable) |
| SaleLabour | Optional | double | SaleLabour parameter (nillable) |
| SaleMaterials | Optional | double | SaleMaterials parameter (nillable) |
| SalePricePlant | Optional | double | SalePricePlant parameter (nillable) |
| SalesInvoiceInfo | Optional | string | SalesInvoiceInfo parameter (nillable) |
| Source | Optional | string | Source parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| Summary | Optional | string | Summary parameter (nillable) |
| TaskPerfAttendDate | Optional | dateTime | TaskPerfAttendDate parameter (nillable) |
| TaskPerfContainDate | Optional | dateTime | TaskPerfContainDate parameter (nillable) |
| TaskPerfFixDate | Optional | dateTime | TaskPerfFixDate parameter (nillable) |
| TaskPerfMeasurable | Optional | long | TaskPerfMeasurable parameter (nillable) |
| TaskPerfRespondDate | Optional | dateTime | TaskPerfRespondDate parameter (nillable) |
| TaskPerfSLAAttendDate | Optional | dateTime | TaskPerfSLAAttendDate parameter (nillable) |
| TaskPerfSLAContainDate | Optional | dateTime | TaskPerfSLAContainDate parameter (nillable) |
| TaskPerfSLAFixDate | Optional | dateTime | TaskPerfSLAFixDate parameter (nillable) |
| TaskPerfSLARespondDate | Optional | dateTime | TaskPerfSLARespondDate parameter (nillable) |
| TaskPerfSLAUserDefinedDate | Optional | dateTime | TaskPerfSLAUserDefinedDate parameter (nillable) |
| TaskPerfUserDefinedDate | Optional | dateTime | TaskPerfUserDefinedDate parameter (nillable) |
| UniqueRef | Optional | string | UniqueRef parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AppointmentServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new RequestDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateRequest(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:CreateRequest>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- RequestDto properties here -->
</bas:dto>
</bas:CreateRequest>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AppointmentService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object RequestDto
# Call the service method
$result = $proxy.CreateRequest($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
4. Create_x0020_Appointment_x0020_Visit_x0020_Resolution
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAppointmentService_Create_x0020_Appointment_x0020_Visit_x0020_Resolution_InputMessage (soap:body, use = literal)
parameters type Create_x0020_Appointment_x0020_Visit_x0020_Resolution
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | AppointmentVisitResolutionDto | 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 |
| AppointmentVisitResolutionId | Optional | long | AppointmentVisitResolutionId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
Output: IAppointmentService_Create_x0020_Appointment_x0020_Visit_x0020_Resolution_OutputMessage (soap:body, use = literal)
parameters type Create_x0020_Appointment_x0020_Visit_x0020_ResolutionResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Create_x0020_Appointment_x0020_Visit_x0020_ResolutionResult | Optional | AppointmentVisitResolutionDto | Create_x0020_Appointment_x0020_Visit_x0020_ResolutionResult 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 |
| AppointmentVisitResolutionId | Optional | long | AppointmentVisitResolutionId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AppointmentServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new AppointmentVisitResolutionDto
{
// Set DTO properties here
};
// Call the service method
var response = client.Create_x0020_Appointment_x0020_Visit_x0020_Resolution(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:Create_x0020_Appointment_x0020_Visit_x0020_Resolution>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- AppointmentVisitResolutionDto properties here -->
</bas:dto>
</bas:Create_x0020_Appointment_x0020_Visit_x0020_Resolution>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AppointmentService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object AppointmentVisitResolutionDto
# Call the service method
$result = $proxy.Create_x0020_Appointment_x0020_Visit_x0020_Resolution($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
5. GetAppointmentTypeById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAppointmentService_GetAppointmentTypeById_InputMessage (soap:body, use = literal)
parameters type GetAppointmentTypeById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: IAppointmentService_GetAppointmentTypeById_OutputMessage (soap:body, use = literal)
parameters type GetAppointmentTypeByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetAppointmentTypeByIdResult | Optional | AppointmentTypeDto | GetAppointmentTypeByIdResult 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 |
| AdjustWindowOnAction | Optional | AdjustWindowOnActionEnum | DoNotAdjust, OnResourceAcceptance, OnDespatch |
| AdjustWindowTo | Optional | double | AdjustWindowTo parameter (nillable) |
| AppointmentClass | Optional | AppointmentClassEnum | TaskAppointment, SiteVisit |
| AppointmentTypeId | Optional | long | AppointmentTypeId parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| DefaultWindowRounding | Optional | DefaultWindowRoundingEnum | ToNearestHour, ToNearest30mins, ToNearest15mins, NoRoundingUseSpecificTimes |
| DefaultWindowSize | Optional | double | DefaultWindowSize parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| DurationType | Optional | DurationTypeEnum | Expandable, Fixed |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| MaximumDuration | Optional | double | MaximumDuration parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| SignOffRequiredContractor | Optional | SignOffRequiredContractorEnum | NotRequired, OnDeparture, OnCompletion |
| SignOffRequiredFsiGo | Optional | SignOffRequiredFSIGoEnum | NotRequired, OnDeparture, OnCompletion |
Code Examples
C# Example
// Create the service client
using (var client = new AppointmentServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetAppointmentTypeById(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:GetAppointmentTypeById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetAppointmentTypeById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AppointmentService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetAppointmentTypeById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
6. GetAppointmentTypesByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAppointmentService_GetAppointmentTypesByDto_InputMessage (soap:body, use = literal)
parameters type GetAppointmentTypesByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | AppointmentTypeDto | 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 |
| AdjustWindowOnAction | Optional | AdjustWindowOnActionEnum | DoNotAdjust, OnResourceAcceptance, OnDespatch |
| AdjustWindowTo | Optional | double | AdjustWindowTo parameter (nillable) |
| AppointmentClass | Optional | AppointmentClassEnum | TaskAppointment, SiteVisit |
| AppointmentTypeId | Optional | long | AppointmentTypeId parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| DefaultWindowRounding | Optional | DefaultWindowRoundingEnum | ToNearestHour, ToNearest30mins, ToNearest15mins, NoRoundingUseSpecificTimes |
| DefaultWindowSize | Optional | double | DefaultWindowSize parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| DurationType | Optional | DurationTypeEnum | Expandable, Fixed |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| MaximumDuration | Optional | double | MaximumDuration parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| SignOffRequiredContractor | Optional | SignOffRequiredContractorEnum | NotRequired, OnDeparture, OnCompletion |
| SignOffRequiredFsiGo | Optional | SignOffRequiredFSIGoEnum | NotRequired, OnDeparture, OnCompletion |
| page | Optional | long | page parameter (nillable) |
Output: IAppointmentService_GetAppointmentTypesByDto_OutputMessage (soap:body, use = literal)
parameters type GetAppointmentTypesByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetAppointmentTypesByDtoResult | Optional | ArrayOfAppointmentTypeDto | GetAppointmentTypesByDtoResult parameter (nillable) |
| AppointmentTypeDto | Optional | AppointmentTypeDto | AppointmentTypeDto 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 |
| AdjustWindowOnAction | Optional | AdjustWindowOnActionEnum | DoNotAdjust, OnResourceAcceptance, OnDespatch |
| AdjustWindowTo | Optional | double | AdjustWindowTo parameter (nillable) |
| AppointmentClass | Optional | AppointmentClassEnum | TaskAppointment, SiteVisit |
| AppointmentTypeId | Optional | long | AppointmentTypeId parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| DefaultWindowRounding | Optional | DefaultWindowRoundingEnum | ToNearestHour, ToNearest30mins, ToNearest15mins, NoRoundingUseSpecificTimes |
| DefaultWindowSize | Optional | double | DefaultWindowSize parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| DurationType | Optional | DurationTypeEnum | Expandable, Fixed |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| MaximumDuration | Optional | double | MaximumDuration parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| SignOffRequiredContractor | Optional | SignOffRequiredContractorEnum | NotRequired, OnDeparture, OnCompletion |
| SignOffRequiredFsiGo | Optional | SignOffRequiredFSIGoEnum | NotRequired, OnDeparture, OnCompletion |
Code Examples
C# Example
// Create the service client
using (var client = new AppointmentServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new AppointmentTypeDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetAppointmentTypesByDto(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:GetAppointmentTypesByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- AppointmentTypeDto properties here -->
</bas:dto>
</bas:GetAppointmentTypesByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AppointmentService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object AppointmentTypeDto
# Call the service method
$result = $proxy.GetAppointmentTypesByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
7. GetAppointmentVisitById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAppointmentService_GetAppointmentVisitById_InputMessage (soap:body, use = literal)
parameters type GetAppointmentVisitById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: IAppointmentService_GetAppointmentVisitById_OutputMessage (soap:body, use = literal)
parameters type GetAppointmentVisitByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetAppointmentVisitByIdResult | Optional | AppointmentVisitDto | GetAppointmentVisitByIdResult 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 |
| StateName | Optional | string | StateName parameter (nillable) |
| AppointmentTypeId | Optional | long | AppointmentTypeId parameter (nillable) |
| AppointmentValue | Optional | double | AppointmentValue parameter (nillable) |
| AppointmentVisitId | Optional | long | AppointmentVisitId parameter (nillable) |
| AppointmentVisitResolutionId | Optional | long | AppointmentVisitResolutionId parameter (nillable) |
| ArrivalDate | Optional | dateTime | ArrivalDate parameter (nillable) |
| BuildingId | Optional | int | BuildingId parameter (nillable) |
| CompletionDate | Optional | dateTime | CompletionDate parameter (nillable) |
| ConfirmedBy | Optional | long | ConfirmedBy parameter (nillable) |
| ContactId | Optional | int | ContactId parameter (nillable) |
| ContractId | Optional | int | ContractId parameter (nillable) |
| CustomerDescription | Optional | string | CustomerDescription parameter (nillable) |
| CustomerNotes | Optional | string | CustomerNotes parameter (nillable) |
| CustomerNotified | Optional | boolean | CustomerNotified parameter (nillable) |
| DateConfirmed | Optional | dateTime | DateConfirmed parameter (nillable) |
| DateDespatched | Optional | dateTime | DateDespatched parameter (nillable) |
| DespatchedBy | Optional | long | DespatchedBy parameter (nillable) |
| DisciplineId | Optional | int | DisciplineId parameter (nillable) |
| EstArrivalDate | Optional | dateTime | EstArrivalDate parameter (nillable) |
| EstBreaks | Optional | double | EstBreaks parameter (nillable) |
| EstCompletionDate | Optional | dateTime | EstCompletionDate parameter (nillable) |
| EstStartDate | Optional | dateTime | EstStartDate parameter (nillable) |
| EstTime | Optional | double | EstTime parameter (nillable) |
| EstTravelTime | Optional | double | EstTravelTime parameter (nillable) |
| Locked | Optional | boolean | Locked parameter (nillable) |
| Mitigated | Optional | boolean | Mitigated parameter (nillable) |
| MitigationEventId | Optional | long | MitigationEventId parameter (nillable) |
| MitigationNotes | Optional | string | MitigationNotes parameter (nillable) |
| OriginalAppointmentId | Optional | long | OriginalAppointmentId parameter (nillable) |
| RequestId | Optional | long | RequestId parameter (nillable) |
| RescheduleRequestDate | Optional | dateTime | RescheduleRequestDate parameter (nillable) |
| RescheduleRequestNotes | Optional | string | RescheduleRequestNotes parameter (nillable) |
| ResolutionNotes | Optional | string | ResolutionNotes parameter (nillable) |
| ResourceAllocated | Optional | boolean | ResourceAllocated parameter (nillable) |
| ResourceId | Optional | int | ResourceId parameter (nillable) |
| ResourceNotes | Optional | string | ResourceNotes parameter (nillable) |
| RevisitProposedDate | Optional | dateTime | RevisitProposedDate parameter (nillable) |
| RevisitRequired | Optional | RevisitRequiredEnum | NotRequired, AgreedRevisit, NewAppointmentRequiredSomeoneElse, NewAppointmentRequiredSameResource |
| SiteSignOffBy | Optional | string | SiteSignOffBy parameter (nillable) |
| SiteSignOffDate | Optional | dateTime | SiteSignOffDate parameter (nillable) |
| SiteSignOffNotes | Optional | string | SiteSignOffNotes parameter (nillable) |
| SiteSignedOff | Optional | boolean | SiteSignedOff parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| Summary | Optional | string | Summary parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TeamId | Optional | long | TeamId parameter (nillable) |
| TravelStartDate | Optional | dateTime | TravelStartDate parameter (nillable) |
| TravelTime | Optional | double | TravelTime parameter (nillable) |
| UniqueRef | Optional | string | UniqueRef parameter (nillable) |
| WindowEndDate | Optional | dateTime | WindowEndDate parameter (nillable) |
| WindowStartDate | Optional | dateTime | WindowStartDate parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AppointmentServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetAppointmentVisitById(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:GetAppointmentVisitById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetAppointmentVisitById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AppointmentService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetAppointmentVisitById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
8. GetAppointmentVisitsByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAppointmentService_GetAppointmentVisitsByDto_InputMessage (soap:body, use = literal)
parameters type GetAppointmentVisitsByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | AppointmentVisitDto | 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 |
| StateName | Optional | string | StateName parameter (nillable) |
| AppointmentTypeId | Optional | long | AppointmentTypeId parameter (nillable) |
| AppointmentValue | Optional | double | AppointmentValue parameter (nillable) |
| AppointmentVisitId | Optional | long | AppointmentVisitId parameter (nillable) |
| AppointmentVisitResolutionId | Optional | long | AppointmentVisitResolutionId parameter (nillable) |
| ArrivalDate | Optional | dateTime | ArrivalDate parameter (nillable) |
| BuildingId | Optional | int | BuildingId parameter (nillable) |
| CompletionDate | Optional | dateTime | CompletionDate parameter (nillable) |
| ConfirmedBy | Optional | long | ConfirmedBy parameter (nillable) |
| ContactId | Optional | int | ContactId parameter (nillable) |
| ContractId | Optional | int | ContractId parameter (nillable) |
| CustomerDescription | Optional | string | CustomerDescription parameter (nillable) |
| CustomerNotes | Optional | string | CustomerNotes parameter (nillable) |
| CustomerNotified | Optional | boolean | CustomerNotified parameter (nillable) |
| DateConfirmed | Optional | dateTime | DateConfirmed parameter (nillable) |
| DateDespatched | Optional | dateTime | DateDespatched parameter (nillable) |
| DespatchedBy | Optional | long | DespatchedBy parameter (nillable) |
| DisciplineId | Optional | int | DisciplineId parameter (nillable) |
| EstArrivalDate | Optional | dateTime | EstArrivalDate parameter (nillable) |
| EstBreaks | Optional | double | EstBreaks parameter (nillable) |
| EstCompletionDate | Optional | dateTime | EstCompletionDate parameter (nillable) |
| EstStartDate | Optional | dateTime | EstStartDate parameter (nillable) |
| EstTime | Optional | double | EstTime parameter (nillable) |
| EstTravelTime | Optional | double | EstTravelTime parameter (nillable) |
| Locked | Optional | boolean | Locked parameter (nillable) |
| Mitigated | Optional | boolean | Mitigated parameter (nillable) |
| MitigationEventId | Optional | long | MitigationEventId parameter (nillable) |
| MitigationNotes | Optional | string | MitigationNotes parameter (nillable) |
| OriginalAppointmentId | Optional | long | OriginalAppointmentId parameter (nillable) |
| RequestId | Optional | long | RequestId parameter (nillable) |
| RescheduleRequestDate | Optional | dateTime | RescheduleRequestDate parameter (nillable) |
| RescheduleRequestNotes | Optional | string | RescheduleRequestNotes parameter (nillable) |
| ResolutionNotes | Optional | string | ResolutionNotes parameter (nillable) |
| ResourceAllocated | Optional | boolean | ResourceAllocated parameter (nillable) |
| ResourceId | Optional | int | ResourceId parameter (nillable) |
| ResourceNotes | Optional | string | ResourceNotes parameter (nillable) |
| RevisitProposedDate | Optional | dateTime | RevisitProposedDate parameter (nillable) |
| RevisitRequired | Optional | RevisitRequiredEnum | NotRequired, AgreedRevisit, NewAppointmentRequiredSomeoneElse, NewAppointmentRequiredSameResource |
| SiteSignOffBy | Optional | string | SiteSignOffBy parameter (nillable) |
| SiteSignOffDate | Optional | dateTime | SiteSignOffDate parameter (nillable) |
| SiteSignOffNotes | Optional | string | SiteSignOffNotes parameter (nillable) |
| SiteSignedOff | Optional | boolean | SiteSignedOff parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| Summary | Optional | string | Summary parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TeamId | Optional | long | TeamId parameter (nillable) |
| TravelStartDate | Optional | dateTime | TravelStartDate parameter (nillable) |
| TravelTime | Optional | double | TravelTime parameter (nillable) |
| UniqueRef | Optional | string | UniqueRef parameter (nillable) |
| WindowEndDate | Optional | dateTime | WindowEndDate parameter (nillable) |
| WindowStartDate | Optional | dateTime | WindowStartDate parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: IAppointmentService_GetAppointmentVisitsByDto_OutputMessage (soap:body, use = literal)
parameters type GetAppointmentVisitsByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetAppointmentVisitsByDtoResult | Optional | ArrayOfAppointmentVisitDto | GetAppointmentVisitsByDtoResult parameter (nillable) |
| AppointmentVisitDto | Optional | AppointmentVisitDto | AppointmentVisitDto 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 |
| StateName | Optional | string | StateName parameter (nillable) |
| AppointmentTypeId | Optional | long | AppointmentTypeId parameter (nillable) |
| AppointmentValue | Optional | double | AppointmentValue parameter (nillable) |
| AppointmentVisitId | Optional | long | AppointmentVisitId parameter (nillable) |
| AppointmentVisitResolutionId | Optional | long | AppointmentVisitResolutionId parameter (nillable) |
| ArrivalDate | Optional | dateTime | ArrivalDate parameter (nillable) |
| BuildingId | Optional | int | BuildingId parameter (nillable) |
| CompletionDate | Optional | dateTime | CompletionDate parameter (nillable) |
| ConfirmedBy | Optional | long | ConfirmedBy parameter (nillable) |
| ContactId | Optional | int | ContactId parameter (nillable) |
| ContractId | Optional | int | ContractId parameter (nillable) |
| CustomerDescription | Optional | string | CustomerDescription parameter (nillable) |
| CustomerNotes | Optional | string | CustomerNotes parameter (nillable) |
| CustomerNotified | Optional | boolean | CustomerNotified parameter (nillable) |
| DateConfirmed | Optional | dateTime | DateConfirmed parameter (nillable) |
| DateDespatched | Optional | dateTime | DateDespatched parameter (nillable) |
| DespatchedBy | Optional | long | DespatchedBy parameter (nillable) |
| DisciplineId | Optional | int | DisciplineId parameter (nillable) |
| EstArrivalDate | Optional | dateTime | EstArrivalDate parameter (nillable) |
| EstBreaks | Optional | double | EstBreaks parameter (nillable) |
| EstCompletionDate | Optional | dateTime | EstCompletionDate parameter (nillable) |
| EstStartDate | Optional | dateTime | EstStartDate parameter (nillable) |
| EstTime | Optional | double | EstTime parameter (nillable) |
| EstTravelTime | Optional | double | EstTravelTime parameter (nillable) |
| Locked | Optional | boolean | Locked parameter (nillable) |
| Mitigated | Optional | boolean | Mitigated parameter (nillable) |
| MitigationEventId | Optional | long | MitigationEventId parameter (nillable) |
| MitigationNotes | Optional | string | MitigationNotes parameter (nillable) |
| OriginalAppointmentId | Optional | long | OriginalAppointmentId parameter (nillable) |
| RequestId | Optional | long | RequestId parameter (nillable) |
| RescheduleRequestDate | Optional | dateTime | RescheduleRequestDate parameter (nillable) |
| RescheduleRequestNotes | Optional | string | RescheduleRequestNotes parameter (nillable) |
| ResolutionNotes | Optional | string | ResolutionNotes parameter (nillable) |
| ResourceAllocated | Optional | boolean | ResourceAllocated parameter (nillable) |
| ResourceId | Optional | int | ResourceId parameter (nillable) |
| ResourceNotes | Optional | string | ResourceNotes parameter (nillable) |
| RevisitProposedDate | Optional | dateTime | RevisitProposedDate parameter (nillable) |
| RevisitRequired | Optional | RevisitRequiredEnum | NotRequired, AgreedRevisit, NewAppointmentRequiredSomeoneElse, NewAppointmentRequiredSameResource |
| SiteSignOffBy | Optional | string | SiteSignOffBy parameter (nillable) |
| SiteSignOffDate | Optional | dateTime | SiteSignOffDate parameter (nillable) |
| SiteSignOffNotes | Optional | string | SiteSignOffNotes parameter (nillable) |
| SiteSignedOff | Optional | boolean | SiteSignedOff parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| Summary | Optional | string | Summary parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TeamId | Optional | long | TeamId parameter (nillable) |
| TravelStartDate | Optional | dateTime | TravelStartDate parameter (nillable) |
| TravelTime | Optional | double | TravelTime parameter (nillable) |
| UniqueRef | Optional | string | UniqueRef parameter (nillable) |
| WindowEndDate | Optional | dateTime | WindowEndDate parameter (nillable) |
| WindowStartDate | Optional | dateTime | WindowStartDate parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AppointmentServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new AppointmentVisitDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetAppointmentVisitsByDto(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:GetAppointmentVisitsByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- AppointmentVisitDto properties here -->
</bas:dto>
</bas:GetAppointmentVisitsByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AppointmentService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object AppointmentVisitDto
# Call the service method
$result = $proxy.GetAppointmentVisitsByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
9. GetRequestById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAppointmentService_GetRequestById_InputMessage (soap:body, use = literal)
parameters type GetRequestById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: IAppointmentService_GetRequestById_OutputMessage (soap:body, use = literal)
parameters type GetRequestByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetRequestByIdResult | Optional | RequestDto | GetRequestByIdResult 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 |
| StateName | Optional | string | StateName parameter (nillable) |
| ActionedBy | Optional | long | ActionedBy parameter (nillable) |
| AllItemsAllocated | Optional | boolean | AllItemsAllocated parameter (nillable) |
| ApplyPlanningConstraints | Optional | boolean | ApplyPlanningConstraints parameter (nillable) |
| AppointmentCommsMethod | Optional | int | AppointmentCommsMethod parameter (nillable) |
| AppointmentNotes | Optional | string | AppointmentNotes parameter (nillable) |
| AppointmentRequired | Optional | boolean | AppointmentRequired parameter (nillable) |
| ArrangeApptTargetDateUtc | Optional | dateTime | ArrangeApptTargetDateUtc parameter (nillable) |
| BuildingId | Optional | int | BuildingId parameter (nillable) |
| CalendarDayId | Optional | long | CalendarDayId parameter (nillable) |
| CalendarSessionId | Optional | long | CalendarSessionId parameter (nillable) |
| CallerSourceId | Optional | int | CallerSourceId parameter (nillable) |
| CategoryId | Optional | int | CategoryId parameter (nillable) |
| CompletedByAccountId | Optional | long | CompletedByAccountId parameter (nillable) |
| CompletionType | Optional | CompletionType | NoSelection, TaskResolution, SelfDiagnosis, ResolvedByOperator |
| ContactId | Optional | int | ContactId parameter (nillable) |
| ContractId | Optional | int | ContractId parameter (nillable) |
| CostCentreId | Optional | int | CostCentreId parameter (nillable) |
| CostCodeId | Optional | int | CostCodeId parameter (nillable) |
| CostLabour | Optional | double | CostLabour parameter (nillable) |
| CostMaterials | Optional | double | CostMaterials parameter (nillable) |
| CostPlant | Optional | double | CostPlant parameter (nillable) |
| DateActioned | Optional | dateTime | DateActioned parameter (nillable) |
| DateCompletedUtc | Optional | dateTime | DateCompletedUtc parameter (nillable) |
| DateRequested | Optional | dateTime | DateRequested parameter (nillable) |
| DepartmentId | Optional | int | DepartmentId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| DisableReminders | Optional | boolean | DisableReminders parameter (nillable) |
| DisciplineId | Optional | int | DisciplineId parameter (nillable) |
| ExternalIdentifier | Optional | string | ExternalIdentifier parameter (nillable) |
| ExternalReference | Optional | string | ExternalReference parameter (nillable) |
| LevelOfCompletionId | Optional | int | LevelOfCompletionId parameter (nillable) |
| Notes | Optional | string | Notes parameter (nillable) |
| OwnerAccountId | Optional | long | OwnerAccountId parameter (nillable) |
| PriorityId | Optional | int | PriorityId parameter (nillable) |
| RecoverabilityTypeId | Optional | long | RecoverabilityTypeId parameter (nillable) |
| Reference | Optional | string | Reference parameter (nillable) |
| RequestId | Optional | long | RequestId parameter (nillable) |
| RequestType | Optional | string | RequestType parameter (nillable) |
| RequesterAddress | Optional | string | RequesterAddress parameter (nillable) |
| RequesterAltContact | Optional | string | RequesterAltContact parameter (nillable) |
| RequesterAltEmail | Optional | string | RequesterAltEmail parameter (nillable) |
| RequesterAltPhone | Optional | string | RequesterAltPhone parameter (nillable) |
| RequesterEmail | Optional | string | RequesterEmail parameter (nillable) |
| RequesterName | Optional | string | RequesterName parameter (nillable) |
| RequesterPhone | Optional | string | RequesterPhone parameter (nillable) |
| RequesterPropRef | Optional | string | RequesterPropRef parameter (nillable) |
| ResolutionComments | Optional | string | ResolutionComments parameter (nillable) |
| SaleLabour | Optional | double | SaleLabour parameter (nillable) |
| SaleMaterials | Optional | double | SaleMaterials parameter (nillable) |
| SalePricePlant | Optional | double | SalePricePlant parameter (nillable) |
| SalesInvoiceInfo | Optional | string | SalesInvoiceInfo parameter (nillable) |
| Source | Optional | string | Source parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| Summary | Optional | string | Summary parameter (nillable) |
| TaskPerfAttendDate | Optional | dateTime | TaskPerfAttendDate parameter (nillable) |
| TaskPerfContainDate | Optional | dateTime | TaskPerfContainDate parameter (nillable) |
| TaskPerfFixDate | Optional | dateTime | TaskPerfFixDate parameter (nillable) |
| TaskPerfMeasurable | Optional | long | TaskPerfMeasurable parameter (nillable) |
| TaskPerfRespondDate | Optional | dateTime | TaskPerfRespondDate parameter (nillable) |
| TaskPerfSLAAttendDate | Optional | dateTime | TaskPerfSLAAttendDate parameter (nillable) |
| TaskPerfSLAContainDate | Optional | dateTime | TaskPerfSLAContainDate parameter (nillable) |
| TaskPerfSLAFixDate | Optional | dateTime | TaskPerfSLAFixDate parameter (nillable) |
| TaskPerfSLARespondDate | Optional | dateTime | TaskPerfSLARespondDate parameter (nillable) |
| TaskPerfSLAUserDefinedDate | Optional | dateTime | TaskPerfSLAUserDefinedDate parameter (nillable) |
| TaskPerfUserDefinedDate | Optional | dateTime | TaskPerfUserDefinedDate parameter (nillable) |
| UniqueRef | Optional | string | UniqueRef parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AppointmentServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetRequestById(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:GetRequestById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetRequestById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AppointmentService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetRequestById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
10. GetRequestsByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAppointmentService_GetRequestsByDto_InputMessage (soap:body, use = literal)
parameters type GetRequestsByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | RequestDto | 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 |
| StateName | Optional | string | StateName parameter (nillable) |
| ActionedBy | Optional | long | ActionedBy parameter (nillable) |
| AllItemsAllocated | Optional | boolean | AllItemsAllocated parameter (nillable) |
| ApplyPlanningConstraints | Optional | boolean | ApplyPlanningConstraints parameter (nillable) |
| AppointmentCommsMethod | Optional | int | AppointmentCommsMethod parameter (nillable) |
| AppointmentNotes | Optional | string | AppointmentNotes parameter (nillable) |
| AppointmentRequired | Optional | boolean | AppointmentRequired parameter (nillable) |
| ArrangeApptTargetDateUtc | Optional | dateTime | ArrangeApptTargetDateUtc parameter (nillable) |
| BuildingId | Optional | int | BuildingId parameter (nillable) |
| CalendarDayId | Optional | long | CalendarDayId parameter (nillable) |
| CalendarSessionId | Optional | long | CalendarSessionId parameter (nillable) |
| CallerSourceId | Optional | int | CallerSourceId parameter (nillable) |
| CategoryId | Optional | int | CategoryId parameter (nillable) |
| CompletedByAccountId | Optional | long | CompletedByAccountId parameter (nillable) |
| CompletionType | Optional | CompletionType | NoSelection, TaskResolution, SelfDiagnosis, ResolvedByOperator |
| ContactId | Optional | int | ContactId parameter (nillable) |
| ContractId | Optional | int | ContractId parameter (nillable) |
| CostCentreId | Optional | int | CostCentreId parameter (nillable) |
| CostCodeId | Optional | int | CostCodeId parameter (nillable) |
| CostLabour | Optional | double | CostLabour parameter (nillable) |
| CostMaterials | Optional | double | CostMaterials parameter (nillable) |
| CostPlant | Optional | double | CostPlant parameter (nillable) |
| DateActioned | Optional | dateTime | DateActioned parameter (nillable) |
| DateCompletedUtc | Optional | dateTime | DateCompletedUtc parameter (nillable) |
| DateRequested | Optional | dateTime | DateRequested parameter (nillable) |
| DepartmentId | Optional | int | DepartmentId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| DisableReminders | Optional | boolean | DisableReminders parameter (nillable) |
| DisciplineId | Optional | int | DisciplineId parameter (nillable) |
| ExternalIdentifier | Optional | string | ExternalIdentifier parameter (nillable) |
| ExternalReference | Optional | string | ExternalReference parameter (nillable) |
| LevelOfCompletionId | Optional | int | LevelOfCompletionId parameter (nillable) |
| Notes | Optional | string | Notes parameter (nillable) |
| OwnerAccountId | Optional | long | OwnerAccountId parameter (nillable) |
| PriorityId | Optional | int | PriorityId parameter (nillable) |
| RecoverabilityTypeId | Optional | long | RecoverabilityTypeId parameter (nillable) |
| Reference | Optional | string | Reference parameter (nillable) |
| RequestId | Optional | long | RequestId parameter (nillable) |
| RequestType | Optional | string | RequestType parameter (nillable) |
| RequesterAddress | Optional | string | RequesterAddress parameter (nillable) |
| RequesterAltContact | Optional | string | RequesterAltContact parameter (nillable) |
| RequesterAltEmail | Optional | string | RequesterAltEmail parameter (nillable) |
| RequesterAltPhone | Optional | string | RequesterAltPhone parameter (nillable) |
| RequesterEmail | Optional | string | RequesterEmail parameter (nillable) |
| RequesterName | Optional | string | RequesterName parameter (nillable) |
| RequesterPhone | Optional | string | RequesterPhone parameter (nillable) |
| RequesterPropRef | Optional | string | RequesterPropRef parameter (nillable) |
| ResolutionComments | Optional | string | ResolutionComments parameter (nillable) |
| SaleLabour | Optional | double | SaleLabour parameter (nillable) |
| SaleMaterials | Optional | double | SaleMaterials parameter (nillable) |
| SalePricePlant | Optional | double | SalePricePlant parameter (nillable) |
| SalesInvoiceInfo | Optional | string | SalesInvoiceInfo parameter (nillable) |
| Source | Optional | string | Source parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| Summary | Optional | string | Summary parameter (nillable) |
| TaskPerfAttendDate | Optional | dateTime | TaskPerfAttendDate parameter (nillable) |
| TaskPerfContainDate | Optional | dateTime | TaskPerfContainDate parameter (nillable) |
| TaskPerfFixDate | Optional | dateTime | TaskPerfFixDate parameter (nillable) |
| TaskPerfMeasurable | Optional | long | TaskPerfMeasurable parameter (nillable) |
| TaskPerfRespondDate | Optional | dateTime | TaskPerfRespondDate parameter (nillable) |
| TaskPerfSLAAttendDate | Optional | dateTime | TaskPerfSLAAttendDate parameter (nillable) |
| TaskPerfSLAContainDate | Optional | dateTime | TaskPerfSLAContainDate parameter (nillable) |
| TaskPerfSLAFixDate | Optional | dateTime | TaskPerfSLAFixDate parameter (nillable) |
| TaskPerfSLARespondDate | Optional | dateTime | TaskPerfSLARespondDate parameter (nillable) |
| TaskPerfSLAUserDefinedDate | Optional | dateTime | TaskPerfSLAUserDefinedDate parameter (nillable) |
| TaskPerfUserDefinedDate | Optional | dateTime | TaskPerfUserDefinedDate parameter (nillable) |
| UniqueRef | Optional | string | UniqueRef parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: IAppointmentService_GetRequestsByDto_OutputMessage (soap:body, use = literal)
parameters type GetRequestsByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetRequestsByDtoResult | Optional | ArrayOfRequestDto | GetRequestsByDtoResult parameter (nillable) |
| RequestDto | Optional | RequestDto | RequestDto 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 |
| StateName | Optional | string | StateName parameter (nillable) |
| ActionedBy | Optional | long | ActionedBy parameter (nillable) |
| AllItemsAllocated | Optional | boolean | AllItemsAllocated parameter (nillable) |
| ApplyPlanningConstraints | Optional | boolean | ApplyPlanningConstraints parameter (nillable) |
| AppointmentCommsMethod | Optional | int | AppointmentCommsMethod parameter (nillable) |
| AppointmentNotes | Optional | string | AppointmentNotes parameter (nillable) |
| AppointmentRequired | Optional | boolean | AppointmentRequired parameter (nillable) |
| ArrangeApptTargetDateUtc | Optional | dateTime | ArrangeApptTargetDateUtc parameter (nillable) |
| BuildingId | Optional | int | BuildingId parameter (nillable) |
| CalendarDayId | Optional | long | CalendarDayId parameter (nillable) |
| CalendarSessionId | Optional | long | CalendarSessionId parameter (nillable) |
| CallerSourceId | Optional | int | CallerSourceId parameter (nillable) |
| CategoryId | Optional | int | CategoryId parameter (nillable) |
| CompletedByAccountId | Optional | long | CompletedByAccountId parameter (nillable) |
| CompletionType | Optional | CompletionType | NoSelection, TaskResolution, SelfDiagnosis, ResolvedByOperator |
| ContactId | Optional | int | ContactId parameter (nillable) |
| ContractId | Optional | int | ContractId parameter (nillable) |
| CostCentreId | Optional | int | CostCentreId parameter (nillable) |
| CostCodeId | Optional | int | CostCodeId parameter (nillable) |
| CostLabour | Optional | double | CostLabour parameter (nillable) |
| CostMaterials | Optional | double | CostMaterials parameter (nillable) |
| CostPlant | Optional | double | CostPlant parameter (nillable) |
| DateActioned | Optional | dateTime | DateActioned parameter (nillable) |
| DateCompletedUtc | Optional | dateTime | DateCompletedUtc parameter (nillable) |
| DateRequested | Optional | dateTime | DateRequested parameter (nillable) |
| DepartmentId | Optional | int | DepartmentId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| DisableReminders | Optional | boolean | DisableReminders parameter (nillable) |
| DisciplineId | Optional | int | DisciplineId parameter (nillable) |
| ExternalIdentifier | Optional | string | ExternalIdentifier parameter (nillable) |
| ExternalReference | Optional | string | ExternalReference parameter (nillable) |
| LevelOfCompletionId | Optional | int | LevelOfCompletionId parameter (nillable) |
| Notes | Optional | string | Notes parameter (nillable) |
| OwnerAccountId | Optional | long | OwnerAccountId parameter (nillable) |
| PriorityId | Optional | int | PriorityId parameter (nillable) |
| RecoverabilityTypeId | Optional | long | RecoverabilityTypeId parameter (nillable) |
| Reference | Optional | string | Reference parameter (nillable) |
| RequestId | Optional | long | RequestId parameter (nillable) |
| RequestType | Optional | string | RequestType parameter (nillable) |
| RequesterAddress | Optional | string | RequesterAddress parameter (nillable) |
| RequesterAltContact | Optional | string | RequesterAltContact parameter (nillable) |
| RequesterAltEmail | Optional | string | RequesterAltEmail parameter (nillable) |
| RequesterAltPhone | Optional | string | RequesterAltPhone parameter (nillable) |
| RequesterEmail | Optional | string | RequesterEmail parameter (nillable) |
| RequesterName | Optional | string | RequesterName parameter (nillable) |
| RequesterPhone | Optional | string | RequesterPhone parameter (nillable) |
| RequesterPropRef | Optional | string | RequesterPropRef parameter (nillable) |
| ResolutionComments | Optional | string | ResolutionComments parameter (nillable) |
| SaleLabour | Optional | double | SaleLabour parameter (nillable) |
| SaleMaterials | Optional | double | SaleMaterials parameter (nillable) |
| SalePricePlant | Optional | double | SalePricePlant parameter (nillable) |
| SalesInvoiceInfo | Optional | string | SalesInvoiceInfo parameter (nillable) |
| Source | Optional | string | Source parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| Summary | Optional | string | Summary parameter (nillable) |
| TaskPerfAttendDate | Optional | dateTime | TaskPerfAttendDate parameter (nillable) |
| TaskPerfContainDate | Optional | dateTime | TaskPerfContainDate parameter (nillable) |
| TaskPerfFixDate | Optional | dateTime | TaskPerfFixDate parameter (nillable) |
| TaskPerfMeasurable | Optional | long | TaskPerfMeasurable parameter (nillable) |
| TaskPerfRespondDate | Optional | dateTime | TaskPerfRespondDate parameter (nillable) |
| TaskPerfSLAAttendDate | Optional | dateTime | TaskPerfSLAAttendDate parameter (nillable) |
| TaskPerfSLAContainDate | Optional | dateTime | TaskPerfSLAContainDate parameter (nillable) |
| TaskPerfSLAFixDate | Optional | dateTime | TaskPerfSLAFixDate parameter (nillable) |
| TaskPerfSLARespondDate | Optional | dateTime | TaskPerfSLARespondDate parameter (nillable) |
| TaskPerfSLAUserDefinedDate | Optional | dateTime | TaskPerfSLAUserDefinedDate parameter (nillable) |
| TaskPerfUserDefinedDate | Optional | dateTime | TaskPerfUserDefinedDate parameter (nillable) |
| UniqueRef | Optional | string | UniqueRef parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AppointmentServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new RequestDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetRequestsByDto(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:GetRequestsByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- RequestDto properties here -->
</bas:dto>
</bas:GetRequestsByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AppointmentService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object RequestDto
# Call the service method
$result = $proxy.GetRequestsByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
11. Get_x0020_Appointment_x0020_Visit_x0020_Resolution_x0020_By_x0020_Id
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAppointmentService_Get_x0020_Appointment_x0020_Visit_x0020_Resolution_x0020_By_x0020_Id_InputMessage (soap:body, use = literal)
parameters type Get_x0020_Appointment_x0020_Visit_x0020_Resolution_x0020_By_x0020_Id
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: IAppointmentService_Get_x0020_Appointment_x0020_Visit_x0020_Resolution_x0020_By_x0020_Id_OutputMessage (soap:body, use = literal)
parameters type Get_x0020_Appointment_x0020_Visit_x0020_Resolution_x0020_By_x0020_IdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Get_x0020_Appointment_x0020_Visit_x0020_Resolution_x0020_By_x0020_IdResult | Optional | AppointmentVisitResolutionDto | Get_x0020_Appointment_x0020_Visit_x0020_Resolution_x0020_By_x0020_IdResult 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 |
| AppointmentVisitResolutionId | Optional | long | AppointmentVisitResolutionId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AppointmentServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.Get_x0020_Appointment_x0020_Visit_x0020_Resolution_x0020_By_x0020_Id(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:Get_x0020_Appointment_x0020_Visit_x0020_Resolution_x0020_By_x0020_Id>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:Get_x0020_Appointment_x0020_Visit_x0020_Resolution_x0020_By_x0020_Id>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AppointmentService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.Get_x0020_Appointment_x0020_Visit_x0020_Resolution_x0020_By_x0020_Id($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
12. Get_x0020_Appointment_x0020_Visit_x0020_Resolutions_x0020_By_x0020_Dto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAppointmentService_Get_x0020_Appointment_x0020_Visit_x0020_Resolutions_x0020_By_x0020_Dto_InputMessage (soap:body, use = literal)
parameters type Get_x0020_Appointment_x0020_Visit_x0020_Resolutions_x0020_By_x0020_Dto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | AppointmentVisitResolutionDto | 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 |
| AppointmentVisitResolutionId | Optional | long | AppointmentVisitResolutionId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: IAppointmentService_Get_x0020_Appointment_x0020_Visit_x0020_Resolutions_x0020_By_x0020_Dto_OutputMessage (soap:body, use = literal)
parameters type Get_x0020_Appointment_x0020_Visit_x0020_Resolutions_x0020_By_x0020_DtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Get_x0020_Appointment_x0020_Visit_x0020_Resolutions_x0020_By_x0020_DtoResult | Optional | ArrayOfAppointmentVisitResolutionDto | Get_x0020_Appointment_x0020_Visit_x0020_Resolutions_x0020_By_x0020_DtoResult parameter (nillable) |
| AppointmentVisitResolutionDto | Optional | AppointmentVisitResolutionDto | AppointmentVisitResolutionDto 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 |
| AppointmentVisitResolutionId | Optional | long | AppointmentVisitResolutionId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AppointmentServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new AppointmentVisitResolutionDto
{
// Set DTO properties here
};
// Call the service method
var response = client.Get_x0020_Appointment_x0020_Visit_x0020_Resolutions_x0020_By_x0020_Dto(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:Get_x0020_Appointment_x0020_Visit_x0020_Resolutions_x0020_By_x0020_Dto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- AppointmentVisitResolutionDto properties here -->
</bas:dto>
</bas:Get_x0020_Appointment_x0020_Visit_x0020_Resolutions_x0020_By_x0020_Dto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AppointmentService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object AppointmentVisitResolutionDto
# Call the service method
$result = $proxy.Get_x0020_Appointment_x0020_Visit_x0020_Resolutions_x0020_By_x0020_Dto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
13. UpdateAppointmentType
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAppointmentService_UpdateAppointmentType_InputMessage (soap:body, use = literal)
parameters type UpdateAppointmentType
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | AppointmentTypeDto | 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 |
| AdjustWindowOnAction | Optional | AdjustWindowOnActionEnum | DoNotAdjust, OnResourceAcceptance, OnDespatch |
| AdjustWindowTo | Optional | double | AdjustWindowTo parameter (nillable) |
| AppointmentClass | Optional | AppointmentClassEnum | TaskAppointment, SiteVisit |
| AppointmentTypeId | Optional | long | AppointmentTypeId parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| DefaultWindowRounding | Optional | DefaultWindowRoundingEnum | ToNearestHour, ToNearest30mins, ToNearest15mins, NoRoundingUseSpecificTimes |
| DefaultWindowSize | Optional | double | DefaultWindowSize parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| DurationType | Optional | DurationTypeEnum | Expandable, Fixed |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| MaximumDuration | Optional | double | MaximumDuration parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| SignOffRequiredContractor | Optional | SignOffRequiredContractorEnum | NotRequired, OnDeparture, OnCompletion |
| SignOffRequiredFsiGo | Optional | SignOffRequiredFSIGoEnum | NotRequired, OnDeparture, OnCompletion |
Output: IAppointmentService_UpdateAppointmentType_OutputMessage (soap:body, use = literal)
parameters type UpdateAppointmentTypeResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateAppointmentTypeResult | Optional | AppointmentTypeDto | UpdateAppointmentTypeResult 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 |
| AdjustWindowOnAction | Optional | AdjustWindowOnActionEnum | DoNotAdjust, OnResourceAcceptance, OnDespatch |
| AdjustWindowTo | Optional | double | AdjustWindowTo parameter (nillable) |
| AppointmentClass | Optional | AppointmentClassEnum | TaskAppointment, SiteVisit |
| AppointmentTypeId | Optional | long | AppointmentTypeId parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| DefaultWindowRounding | Optional | DefaultWindowRoundingEnum | ToNearestHour, ToNearest30mins, ToNearest15mins, NoRoundingUseSpecificTimes |
| DefaultWindowSize | Optional | double | DefaultWindowSize parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| DurationType | Optional | DurationTypeEnum | Expandable, Fixed |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| MaximumDuration | Optional | double | MaximumDuration parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| SignOffRequiredContractor | Optional | SignOffRequiredContractorEnum | NotRequired, OnDeparture, OnCompletion |
| SignOffRequiredFsiGo | Optional | SignOffRequiredFSIGoEnum | NotRequired, OnDeparture, OnCompletion |
Code Examples
C# Example
// Create the service client
using (var client = new AppointmentServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new AppointmentTypeDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateAppointmentType(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:UpdateAppointmentType>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- AppointmentTypeDto properties here -->
</bas:dto>
</bas:UpdateAppointmentType>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AppointmentService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object AppointmentTypeDto
# Call the service method
$result = $proxy.UpdateAppointmentType($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
14. UpdateAppointmentVisit
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAppointmentService_UpdateAppointmentVisit_InputMessage (soap:body, use = literal)
parameters type UpdateAppointmentVisit
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | AppointmentVisitDto | 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 |
| StateName | Optional | string | StateName parameter (nillable) |
| AppointmentTypeId | Optional | long | AppointmentTypeId parameter (nillable) |
| AppointmentValue | Optional | double | AppointmentValue parameter (nillable) |
| AppointmentVisitId | Optional | long | AppointmentVisitId parameter (nillable) |
| AppointmentVisitResolutionId | Optional | long | AppointmentVisitResolutionId parameter (nillable) |
| ArrivalDate | Optional | dateTime | ArrivalDate parameter (nillable) |
| BuildingId | Optional | int | BuildingId parameter (nillable) |
| CompletionDate | Optional | dateTime | CompletionDate parameter (nillable) |
| ConfirmedBy | Optional | long | ConfirmedBy parameter (nillable) |
| ContactId | Optional | int | ContactId parameter (nillable) |
| ContractId | Optional | int | ContractId parameter (nillable) |
| CustomerDescription | Optional | string | CustomerDescription parameter (nillable) |
| CustomerNotes | Optional | string | CustomerNotes parameter (nillable) |
| CustomerNotified | Optional | boolean | CustomerNotified parameter (nillable) |
| DateConfirmed | Optional | dateTime | DateConfirmed parameter (nillable) |
| DateDespatched | Optional | dateTime | DateDespatched parameter (nillable) |
| DespatchedBy | Optional | long | DespatchedBy parameter (nillable) |
| DisciplineId | Optional | int | DisciplineId parameter (nillable) |
| EstArrivalDate | Optional | dateTime | EstArrivalDate parameter (nillable) |
| EstBreaks | Optional | double | EstBreaks parameter (nillable) |
| EstCompletionDate | Optional | dateTime | EstCompletionDate parameter (nillable) |
| EstStartDate | Optional | dateTime | EstStartDate parameter (nillable) |
| EstTime | Optional | double | EstTime parameter (nillable) |
| EstTravelTime | Optional | double | EstTravelTime parameter (nillable) |
| Locked | Optional | boolean | Locked parameter (nillable) |
| Mitigated | Optional | boolean | Mitigated parameter (nillable) |
| MitigationEventId | Optional | long | MitigationEventId parameter (nillable) |
| MitigationNotes | Optional | string | MitigationNotes parameter (nillable) |
| OriginalAppointmentId | Optional | long | OriginalAppointmentId parameter (nillable) |
| RequestId | Optional | long | RequestId parameter (nillable) |
| RescheduleRequestDate | Optional | dateTime | RescheduleRequestDate parameter (nillable) |
| RescheduleRequestNotes | Optional | string | RescheduleRequestNotes parameter (nillable) |
| ResolutionNotes | Optional | string | ResolutionNotes parameter (nillable) |
| ResourceAllocated | Optional | boolean | ResourceAllocated parameter (nillable) |
| ResourceId | Optional | int | ResourceId parameter (nillable) |
| ResourceNotes | Optional | string | ResourceNotes parameter (nillable) |
| RevisitProposedDate | Optional | dateTime | RevisitProposedDate parameter (nillable) |
| RevisitRequired | Optional | RevisitRequiredEnum | NotRequired, AgreedRevisit, NewAppointmentRequiredSomeoneElse, NewAppointmentRequiredSameResource |
| SiteSignOffBy | Optional | string | SiteSignOffBy parameter (nillable) |
| SiteSignOffDate | Optional | dateTime | SiteSignOffDate parameter (nillable) |
| SiteSignOffNotes | Optional | string | SiteSignOffNotes parameter (nillable) |
| SiteSignedOff | Optional | boolean | SiteSignedOff parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| Summary | Optional | string | Summary parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TeamId | Optional | long | TeamId parameter (nillable) |
| TravelStartDate | Optional | dateTime | TravelStartDate parameter (nillable) |
| TravelTime | Optional | double | TravelTime parameter (nillable) |
| UniqueRef | Optional | string | UniqueRef parameter (nillable) |
| WindowEndDate | Optional | dateTime | WindowEndDate parameter (nillable) |
| WindowStartDate | Optional | dateTime | WindowStartDate parameter (nillable) |
Output: IAppointmentService_UpdateAppointmentVisit_OutputMessage (soap:body, use = literal)
parameters type UpdateAppointmentVisitResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateAppointmentVisitResult | Optional | AppointmentVisitDto | UpdateAppointmentVisitResult 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 |
| StateName | Optional | string | StateName parameter (nillable) |
| AppointmentTypeId | Optional | long | AppointmentTypeId parameter (nillable) |
| AppointmentValue | Optional | double | AppointmentValue parameter (nillable) |
| AppointmentVisitId | Optional | long | AppointmentVisitId parameter (nillable) |
| AppointmentVisitResolutionId | Optional | long | AppointmentVisitResolutionId parameter (nillable) |
| ArrivalDate | Optional | dateTime | ArrivalDate parameter (nillable) |
| BuildingId | Optional | int | BuildingId parameter (nillable) |
| CompletionDate | Optional | dateTime | CompletionDate parameter (nillable) |
| ConfirmedBy | Optional | long | ConfirmedBy parameter (nillable) |
| ContactId | Optional | int | ContactId parameter (nillable) |
| ContractId | Optional | int | ContractId parameter (nillable) |
| CustomerDescription | Optional | string | CustomerDescription parameter (nillable) |
| CustomerNotes | Optional | string | CustomerNotes parameter (nillable) |
| CustomerNotified | Optional | boolean | CustomerNotified parameter (nillable) |
| DateConfirmed | Optional | dateTime | DateConfirmed parameter (nillable) |
| DateDespatched | Optional | dateTime | DateDespatched parameter (nillable) |
| DespatchedBy | Optional | long | DespatchedBy parameter (nillable) |
| DisciplineId | Optional | int | DisciplineId parameter (nillable) |
| EstArrivalDate | Optional | dateTime | EstArrivalDate parameter (nillable) |
| EstBreaks | Optional | double | EstBreaks parameter (nillable) |
| EstCompletionDate | Optional | dateTime | EstCompletionDate parameter (nillable) |
| EstStartDate | Optional | dateTime | EstStartDate parameter (nillable) |
| EstTime | Optional | double | EstTime parameter (nillable) |
| EstTravelTime | Optional | double | EstTravelTime parameter (nillable) |
| Locked | Optional | boolean | Locked parameter (nillable) |
| Mitigated | Optional | boolean | Mitigated parameter (nillable) |
| MitigationEventId | Optional | long | MitigationEventId parameter (nillable) |
| MitigationNotes | Optional | string | MitigationNotes parameter (nillable) |
| OriginalAppointmentId | Optional | long | OriginalAppointmentId parameter (nillable) |
| RequestId | Optional | long | RequestId parameter (nillable) |
| RescheduleRequestDate | Optional | dateTime | RescheduleRequestDate parameter (nillable) |
| RescheduleRequestNotes | Optional | string | RescheduleRequestNotes parameter (nillable) |
| ResolutionNotes | Optional | string | ResolutionNotes parameter (nillable) |
| ResourceAllocated | Optional | boolean | ResourceAllocated parameter (nillable) |
| ResourceId | Optional | int | ResourceId parameter (nillable) |
| ResourceNotes | Optional | string | ResourceNotes parameter (nillable) |
| RevisitProposedDate | Optional | dateTime | RevisitProposedDate parameter (nillable) |
| RevisitRequired | Optional | RevisitRequiredEnum | NotRequired, AgreedRevisit, NewAppointmentRequiredSomeoneElse, NewAppointmentRequiredSameResource |
| SiteSignOffBy | Optional | string | SiteSignOffBy parameter (nillable) |
| SiteSignOffDate | Optional | dateTime | SiteSignOffDate parameter (nillable) |
| SiteSignOffNotes | Optional | string | SiteSignOffNotes parameter (nillable) |
| SiteSignedOff | Optional | boolean | SiteSignedOff parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| Summary | Optional | string | Summary parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TeamId | Optional | long | TeamId parameter (nillable) |
| TravelStartDate | Optional | dateTime | TravelStartDate parameter (nillable) |
| TravelTime | Optional | double | TravelTime parameter (nillable) |
| UniqueRef | Optional | string | UniqueRef parameter (nillable) |
| WindowEndDate | Optional | dateTime | WindowEndDate parameter (nillable) |
| WindowStartDate | Optional | dateTime | WindowStartDate parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AppointmentServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new AppointmentVisitDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateAppointmentVisit(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:UpdateAppointmentVisit>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- AppointmentVisitDto properties here -->
</bas:dto>
</bas:UpdateAppointmentVisit>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AppointmentService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object AppointmentVisitDto
# Call the service method
$result = $proxy.UpdateAppointmentVisit($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
15. UpdateRequest
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAppointmentService_UpdateRequest_InputMessage (soap:body, use = literal)
parameters type UpdateRequest
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | RequestDto | 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 |
| StateName | Optional | string | StateName parameter (nillable) |
| ActionedBy | Optional | long | ActionedBy parameter (nillable) |
| AllItemsAllocated | Optional | boolean | AllItemsAllocated parameter (nillable) |
| ApplyPlanningConstraints | Optional | boolean | ApplyPlanningConstraints parameter (nillable) |
| AppointmentCommsMethod | Optional | int | AppointmentCommsMethod parameter (nillable) |
| AppointmentNotes | Optional | string | AppointmentNotes parameter (nillable) |
| AppointmentRequired | Optional | boolean | AppointmentRequired parameter (nillable) |
| ArrangeApptTargetDateUtc | Optional | dateTime | ArrangeApptTargetDateUtc parameter (nillable) |
| BuildingId | Optional | int | BuildingId parameter (nillable) |
| CalendarDayId | Optional | long | CalendarDayId parameter (nillable) |
| CalendarSessionId | Optional | long | CalendarSessionId parameter (nillable) |
| CallerSourceId | Optional | int | CallerSourceId parameter (nillable) |
| CategoryId | Optional | int | CategoryId parameter (nillable) |
| CompletedByAccountId | Optional | long | CompletedByAccountId parameter (nillable) |
| CompletionType | Optional | CompletionType | NoSelection, TaskResolution, SelfDiagnosis, ResolvedByOperator |
| ContactId | Optional | int | ContactId parameter (nillable) |
| ContractId | Optional | int | ContractId parameter (nillable) |
| CostCentreId | Optional | int | CostCentreId parameter (nillable) |
| CostCodeId | Optional | int | CostCodeId parameter (nillable) |
| CostLabour | Optional | double | CostLabour parameter (nillable) |
| CostMaterials | Optional | double | CostMaterials parameter (nillable) |
| CostPlant | Optional | double | CostPlant parameter (nillable) |
| DateActioned | Optional | dateTime | DateActioned parameter (nillable) |
| DateCompletedUtc | Optional | dateTime | DateCompletedUtc parameter (nillable) |
| DateRequested | Optional | dateTime | DateRequested parameter (nillable) |
| DepartmentId | Optional | int | DepartmentId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| DisableReminders | Optional | boolean | DisableReminders parameter (nillable) |
| DisciplineId | Optional | int | DisciplineId parameter (nillable) |
| ExternalIdentifier | Optional | string | ExternalIdentifier parameter (nillable) |
| ExternalReference | Optional | string | ExternalReference parameter (nillable) |
| LevelOfCompletionId | Optional | int | LevelOfCompletionId parameter (nillable) |
| Notes | Optional | string | Notes parameter (nillable) |
| OwnerAccountId | Optional | long | OwnerAccountId parameter (nillable) |
| PriorityId | Optional | int | PriorityId parameter (nillable) |
| RecoverabilityTypeId | Optional | long | RecoverabilityTypeId parameter (nillable) |
| Reference | Optional | string | Reference parameter (nillable) |
| RequestId | Optional | long | RequestId parameter (nillable) |
| RequestType | Optional | string | RequestType parameter (nillable) |
| RequesterAddress | Optional | string | RequesterAddress parameter (nillable) |
| RequesterAltContact | Optional | string | RequesterAltContact parameter (nillable) |
| RequesterAltEmail | Optional | string | RequesterAltEmail parameter (nillable) |
| RequesterAltPhone | Optional | string | RequesterAltPhone parameter (nillable) |
| RequesterEmail | Optional | string | RequesterEmail parameter (nillable) |
| RequesterName | Optional | string | RequesterName parameter (nillable) |
| RequesterPhone | Optional | string | RequesterPhone parameter (nillable) |
| RequesterPropRef | Optional | string | RequesterPropRef parameter (nillable) |
| ResolutionComments | Optional | string | ResolutionComments parameter (nillable) |
| SaleLabour | Optional | double | SaleLabour parameter (nillable) |
| SaleMaterials | Optional | double | SaleMaterials parameter (nillable) |
| SalePricePlant | Optional | double | SalePricePlant parameter (nillable) |
| SalesInvoiceInfo | Optional | string | SalesInvoiceInfo parameter (nillable) |
| Source | Optional | string | Source parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| Summary | Optional | string | Summary parameter (nillable) |
| TaskPerfAttendDate | Optional | dateTime | TaskPerfAttendDate parameter (nillable) |
| TaskPerfContainDate | Optional | dateTime | TaskPerfContainDate parameter (nillable) |
| TaskPerfFixDate | Optional | dateTime | TaskPerfFixDate parameter (nillable) |
| TaskPerfMeasurable | Optional | long | TaskPerfMeasurable parameter (nillable) |
| TaskPerfRespondDate | Optional | dateTime | TaskPerfRespondDate parameter (nillable) |
| TaskPerfSLAAttendDate | Optional | dateTime | TaskPerfSLAAttendDate parameter (nillable) |
| TaskPerfSLAContainDate | Optional | dateTime | TaskPerfSLAContainDate parameter (nillable) |
| TaskPerfSLAFixDate | Optional | dateTime | TaskPerfSLAFixDate parameter (nillable) |
| TaskPerfSLARespondDate | Optional | dateTime | TaskPerfSLARespondDate parameter (nillable) |
| TaskPerfSLAUserDefinedDate | Optional | dateTime | TaskPerfSLAUserDefinedDate parameter (nillable) |
| TaskPerfUserDefinedDate | Optional | dateTime | TaskPerfUserDefinedDate parameter (nillable) |
| UniqueRef | Optional | string | UniqueRef parameter (nillable) |
Output: IAppointmentService_UpdateRequest_OutputMessage (soap:body, use = literal)
parameters type UpdateRequestResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateRequestResult | Optional | RequestDto | UpdateRequestResult 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 |
| StateName | Optional | string | StateName parameter (nillable) |
| ActionedBy | Optional | long | ActionedBy parameter (nillable) |
| AllItemsAllocated | Optional | boolean | AllItemsAllocated parameter (nillable) |
| ApplyPlanningConstraints | Optional | boolean | ApplyPlanningConstraints parameter (nillable) |
| AppointmentCommsMethod | Optional | int | AppointmentCommsMethod parameter (nillable) |
| AppointmentNotes | Optional | string | AppointmentNotes parameter (nillable) |
| AppointmentRequired | Optional | boolean | AppointmentRequired parameter (nillable) |
| ArrangeApptTargetDateUtc | Optional | dateTime | ArrangeApptTargetDateUtc parameter (nillable) |
| BuildingId | Optional | int | BuildingId parameter (nillable) |
| CalendarDayId | Optional | long | CalendarDayId parameter (nillable) |
| CalendarSessionId | Optional | long | CalendarSessionId parameter (nillable) |
| CallerSourceId | Optional | int | CallerSourceId parameter (nillable) |
| CategoryId | Optional | int | CategoryId parameter (nillable) |
| CompletedByAccountId | Optional | long | CompletedByAccountId parameter (nillable) |
| CompletionType | Optional | CompletionType | NoSelection, TaskResolution, SelfDiagnosis, ResolvedByOperator |
| ContactId | Optional | int | ContactId parameter (nillable) |
| ContractId | Optional | int | ContractId parameter (nillable) |
| CostCentreId | Optional | int | CostCentreId parameter (nillable) |
| CostCodeId | Optional | int | CostCodeId parameter (nillable) |
| CostLabour | Optional | double | CostLabour parameter (nillable) |
| CostMaterials | Optional | double | CostMaterials parameter (nillable) |
| CostPlant | Optional | double | CostPlant parameter (nillable) |
| DateActioned | Optional | dateTime | DateActioned parameter (nillable) |
| DateCompletedUtc | Optional | dateTime | DateCompletedUtc parameter (nillable) |
| DateRequested | Optional | dateTime | DateRequested parameter (nillable) |
| DepartmentId | Optional | int | DepartmentId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| DisableReminders | Optional | boolean | DisableReminders parameter (nillable) |
| DisciplineId | Optional | int | DisciplineId parameter (nillable) |
| ExternalIdentifier | Optional | string | ExternalIdentifier parameter (nillable) |
| ExternalReference | Optional | string | ExternalReference parameter (nillable) |
| LevelOfCompletionId | Optional | int | LevelOfCompletionId parameter (nillable) |
| Notes | Optional | string | Notes parameter (nillable) |
| OwnerAccountId | Optional | long | OwnerAccountId parameter (nillable) |
| PriorityId | Optional | int | PriorityId parameter (nillable) |
| RecoverabilityTypeId | Optional | long | RecoverabilityTypeId parameter (nillable) |
| Reference | Optional | string | Reference parameter (nillable) |
| RequestId | Optional | long | RequestId parameter (nillable) |
| RequestType | Optional | string | RequestType parameter (nillable) |
| RequesterAddress | Optional | string | RequesterAddress parameter (nillable) |
| RequesterAltContact | Optional | string | RequesterAltContact parameter (nillable) |
| RequesterAltEmail | Optional | string | RequesterAltEmail parameter (nillable) |
| RequesterAltPhone | Optional | string | RequesterAltPhone parameter (nillable) |
| RequesterEmail | Optional | string | RequesterEmail parameter (nillable) |
| RequesterName | Optional | string | RequesterName parameter (nillable) |
| RequesterPhone | Optional | string | RequesterPhone parameter (nillable) |
| RequesterPropRef | Optional | string | RequesterPropRef parameter (nillable) |
| ResolutionComments | Optional | string | ResolutionComments parameter (nillable) |
| SaleLabour | Optional | double | SaleLabour parameter (nillable) |
| SaleMaterials | Optional | double | SaleMaterials parameter (nillable) |
| SalePricePlant | Optional | double | SalePricePlant parameter (nillable) |
| SalesInvoiceInfo | Optional | string | SalesInvoiceInfo parameter (nillable) |
| Source | Optional | string | Source parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| Summary | Optional | string | Summary parameter (nillable) |
| TaskPerfAttendDate | Optional | dateTime | TaskPerfAttendDate parameter (nillable) |
| TaskPerfContainDate | Optional | dateTime | TaskPerfContainDate parameter (nillable) |
| TaskPerfFixDate | Optional | dateTime | TaskPerfFixDate parameter (nillable) |
| TaskPerfMeasurable | Optional | long | TaskPerfMeasurable parameter (nillable) |
| TaskPerfRespondDate | Optional | dateTime | TaskPerfRespondDate parameter (nillable) |
| TaskPerfSLAAttendDate | Optional | dateTime | TaskPerfSLAAttendDate parameter (nillable) |
| TaskPerfSLAContainDate | Optional | dateTime | TaskPerfSLAContainDate parameter (nillable) |
| TaskPerfSLAFixDate | Optional | dateTime | TaskPerfSLAFixDate parameter (nillable) |
| TaskPerfSLARespondDate | Optional | dateTime | TaskPerfSLARespondDate parameter (nillable) |
| TaskPerfSLAUserDefinedDate | Optional | dateTime | TaskPerfSLAUserDefinedDate parameter (nillable) |
| TaskPerfUserDefinedDate | Optional | dateTime | TaskPerfUserDefinedDate parameter (nillable) |
| UniqueRef | Optional | string | UniqueRef parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AppointmentServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new RequestDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateRequest(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:UpdateRequest>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- RequestDto properties here -->
</bas:dto>
</bas:UpdateRequest>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AppointmentService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object RequestDto
# Call the service method
$result = $proxy.UpdateRequest($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
16. Update_x0020_Appointment_x0020_Visit_x0020_Resolution
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IAppointmentService_Update_x0020_Appointment_x0020_Visit_x0020_Resolution_InputMessage (soap:body, use = literal)
parameters type Update_x0020_Appointment_x0020_Visit_x0020_Resolution
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | AppointmentVisitResolutionDto | 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 |
| AppointmentVisitResolutionId | Optional | long | AppointmentVisitResolutionId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
Output: IAppointmentService_Update_x0020_Appointment_x0020_Visit_x0020_Resolution_OutputMessage (soap:body, use = literal)
parameters type Update_x0020_Appointment_x0020_Visit_x0020_ResolutionResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Update_x0020_Appointment_x0020_Visit_x0020_ResolutionResult | Optional | AppointmentVisitResolutionDto | Update_x0020_Appointment_x0020_Visit_x0020_ResolutionResult 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 |
| AppointmentVisitResolutionId | Optional | long | AppointmentVisitResolutionId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new AppointmentServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new AppointmentVisitResolutionDto
{
// Set DTO properties here
};
// Call the service method
var response = client.Update_x0020_Appointment_x0020_Visit_x0020_Resolution(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:Update_x0020_Appointment_x0020_Visit_x0020_Resolution>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- AppointmentVisitResolutionDto properties here -->
</bas:dto>
</bas:Update_x0020_Appointment_x0020_Visit_x0020_Resolution>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/AppointmentService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object AppointmentVisitResolutionDto
# Call the service method
$result = $proxy.Update_x0020_Appointment_x0020_Visit_x0020_Resolution($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}