Web Service: InstructionService

Port InstructionService

Location:
http://<MRI_Evolution_Site_Path>/Services/Basic/InstructionService.svc
Protocol:
SOAP
Transport protocol:
SOAP over HTTP
Operations:
  1. GetInstructionByIdDetail

Port type IInstructionService

1. GetInstructionById

Style: document

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

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

parameters type GetInstructionById

Parameter Name Required Type Description
sessionId Optional string sessionId parameter (nillable)
impersonateAccountId Optional long impersonateAccountId parameter (nillable)
instructionId Optional long instructionId parameter

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

parameters type GetInstructionByIdResponse

Parameter Name Required Type Description
GetInstructionByIdResult Optional InstructionDto GetInstructionByIdResult 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
AllowRecurringRequests Optional boolean AllowRecurringRequests parameter (nillable)
AssetId Optional long AssetId parameter (nillable)
BroadcastStatus Optional BroadcastStatusEnum NeverBroadcast, BroadcastAvailable, BroadcastByDefault
CISApplicable Optional CISApplicable No, Yes, Referral
Category Optional string Category parameter (nillable)
CategoryId Optional long CategoryId parameter (nillable)
Code Optional string Code parameter (nillable)
DailyPPMDays Optional int DailyPPMDays parameter (nillable)
DailyPPMExcludeHolidays Optional boolean DailyPPMExcludeHolidays parameter (nillable)
Description Optional string Description parameter (nillable)
Discipline Optional string Discipline parameter (nillable)
DisciplineId Optional long DisciplineId parameter (nillable)
EstimatedLabour Optional double EstimatedLabour parameter (nillable)
EstimatedPlant Optional double EstimatedPlant parameter (nillable)
EstimatedStock Optional double EstimatedStock parameter (nillable)
EstimatedTime Optional double EstimatedTime parameter (nillable)
FaultCodeId Optional int FaultCodeId parameter (nillable)
InstructionId Optional long InstructionId parameter (nillable)
InstructionSetScheduleId Optional long InstructionSetScheduleId parameter (nillable)
InstructionSetStatusId Optional long InstructionSetStatusId parameter (nillable)
IsForCallLogging Optional boolean IsForCallLogging parameter (nillable)
IsMasterInstruction Optional boolean IsMasterInstruction parameter (nillable)
Priority Optional string Priority parameter (nillable)
PriorityId Optional long PriorityId parameter (nillable)
RiskAssessmentId Optional long RiskAssessmentId parameter (nillable)
SFG20IsCustom Optional boolean SFG20IsCustom parameter (nillable)
ScheduledTask Optional boolean ScheduledTask parameter (nillable)
ServiceCatalogueTask Optional boolean ServiceCatalogueTask parameter (nillable)
Staff Optional double Staff parameter (nillable)
StateId Optional long StateId parameter (nillable)
StepPublishingStatus Optional StepPublishingStatusEnum NoSteps, Draft, Published, InDesign
Text Optional string Text parameter (nillable)
Code Examples
C# Example
// Create the service client
using (var client = new InstructionServiceClient())
{
    // Create the request parameters
    string sessionId = "your_value_here";
    long impersonateAccountId = 123;
    long instructionId = 123;
    
    // Call the service method
    var response = client.GetInstructionById(sessionId, impersonateAccountId, instructionId);
    
    // 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:GetInstructionById>
         <bas:sessionId>sample_value</bas:sessionId>
         <bas:impersonateAccountId>123</bas:impersonateAccountId>
         <bas:instructionId>123</bas:instructionId>
      </bas:GetInstructionById>
   </soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/InstructionService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl

# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$instructionId = 123

# Call the service method
$result = $proxy.GetInstructionById($sessionId, $impersonateAccountId, $instructionId)

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