Web Service: SurveyService
Port SurveyService
- CreateSupplySurveyDetail
- CreateSupplySurveyTemplateDetail
- CreateSurveyDetail
- CreateSurveyCategoryDetail
- CreateSurveyTemplateDetail
- CreateSurveyTokenDetail
- CreateWorkSurveyDetail
- CreateWorkSurveyTemplateDetail
- GetSupplySurveyByIdDetail
- GetSupplySurveyTemplateByIdDetail
- GetSupplySurveyTemplatesByDtoDetail
- GetSupplySurveysByDtoDetail
- GetSurveyAnswersByDtoDetail
- GetSurveyByIdDetail
- GetSurveyCategoryByDTODetail
- GetSurveyCategoryByIdDetail
- GetSurveyQuestionsByDtoDetail
- GetSurveyTemplateAssignmentsByDtoDetail
- GetSurveyTemplateByIdDetail
- GetSurveyTemplateQuestionsByDtoDetail
- GetSurveyTemplatesByDtoDetail
- GetSurveysByDtoDetail
- GetWorkSurveyByIdDetail
- GetWorkSurveyTemplateByIdDetail
- GetWorkSurveyTemplatesByDtoDetail
- GetWorkSurveysByDtoDetail
- UpdateSupplySurveyDetail
- UpdateSupplySurveyTemplateDetail
- UpdateSurveyDetail
- UpdateSurveyCategoryDetail
- UpdateSurveyTemplateDetail
- UpdateWorkSurveyDetail
- UpdateWorkSurveyTemplateDetail
Port type ISurveyService
1. CreateSupplySurvey
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_CreateSupplySurvey_InputMessage (soap:body, use = literal)
parameters type CreateSupplySurvey
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SupplySurveyDto | 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
Output: ISurveyService_CreateSupplySurvey_OutputMessage (soap:body, use = literal)
parameters type CreateSupplySurveyResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateSupplySurveyResult | Optional | SupplySurveyDto | CreateSupplySurveyResult 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SupplySurveyDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateSupplySurvey(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:CreateSupplySurvey>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SupplySurveyDto properties here -->
</bas:dto>
</bas:CreateSupplySurvey>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SupplySurveyDto
# Call the service method
$result = $proxy.CreateSupplySurvey($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
2. CreateSupplySurveyTemplate
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_CreateSupplySurveyTemplate_InputMessage (soap:body, use = literal)
parameters type CreateSupplySurveyTemplate
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SupplySurveyTemplateDto | 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | SupplySurveyTemplateContractorApplication | NotApplicable, RequiredForEachSupplier |
| Description | Optional | string | Description parameter (nillable) |
| EvoApplication | Optional | SupplySurveyTemplateEvoApplication | NotApplicable, RequiredForEachSupplier, RequiredForEachResource |
| EvoResponseCompulsory | Optional | SupplySurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, SuspendIfExpiredOrMissing |
| EvoResponseExpected | Optional | SupplySurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, WarnIfExpiredOrMissing |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | SupplySurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachResource |
| FsiGoResponseExpected | Optional | SupplySurveyTemplateFSIGoResponseExpected | NotApplicable, OnDuty, OffDuty |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | SupplySurveyTemplateResponseExpected | NotApplicable, GatewayCompliance |
| ResponseExpiry | Optional | SupplySurveyTemplateResponseExpiry | ValidUntilExpiryDate, NoAutomaticExpiry, SingleUseOnly, ValidUntilMidnightSameDay |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
Output: ISurveyService_CreateSupplySurveyTemplate_OutputMessage (soap:body, use = literal)
parameters type CreateSupplySurveyTemplateResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateSupplySurveyTemplateResult | Optional | SupplySurveyTemplateDto | CreateSupplySurveyTemplateResult 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | SupplySurveyTemplateContractorApplication | NotApplicable, RequiredForEachSupplier |
| Description | Optional | string | Description parameter (nillable) |
| EvoApplication | Optional | SupplySurveyTemplateEvoApplication | NotApplicable, RequiredForEachSupplier, RequiredForEachResource |
| EvoResponseCompulsory | Optional | SupplySurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, SuspendIfExpiredOrMissing |
| EvoResponseExpected | Optional | SupplySurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, WarnIfExpiredOrMissing |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | SupplySurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachResource |
| FsiGoResponseExpected | Optional | SupplySurveyTemplateFSIGoResponseExpected | NotApplicable, OnDuty, OffDuty |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | SupplySurveyTemplateResponseExpected | NotApplicable, GatewayCompliance |
| ResponseExpiry | Optional | SupplySurveyTemplateResponseExpiry | ValidUntilExpiryDate, NoAutomaticExpiry, SingleUseOnly, ValidUntilMidnightSameDay |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SupplySurveyTemplateDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateSupplySurveyTemplate(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:CreateSupplySurveyTemplate>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SupplySurveyTemplateDto properties here -->
</bas:dto>
</bas:CreateSupplySurveyTemplate>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SupplySurveyTemplateDto
# Call the service method
$result = $proxy.CreateSupplySurveyTemplate($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
3. CreateSurvey
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_CreateSurvey_InputMessage (soap:body, use = literal)
parameters type CreateSurvey
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SurveyDto | 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyClass | Optional | SurveyTemplateSurveyClass | WorkAndAccessRequirement, SupplyChain |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
Output: ISurveyService_CreateSurvey_OutputMessage (soap:body, use = literal)
parameters type CreateSurveyResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateSurveyResult | Optional | SurveyDto | CreateSurveyResult 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyClass | Optional | SurveyTemplateSurveyClass | WorkAndAccessRequirement, SupplyChain |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SurveyDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateSurvey(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:CreateSurvey>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SurveyDto properties here -->
</bas:dto>
</bas:CreateSurvey>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SurveyDto
# Call the service method
$result = $proxy.CreateSurvey($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
4. CreateSurveyCategory
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_CreateSurveyCategory_InputMessage (soap:body, use = literal)
parameters type CreateSurveyCategory
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SurveyCategoryDto | 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 |
| Name | Optional | string | Name parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
Output: ISurveyService_CreateSurveyCategory_OutputMessage (soap:body, use = literal)
parameters type CreateSurveyCategoryResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateSurveyCategoryResult | Optional | SurveyCategoryDto | CreateSurveyCategoryResult 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 |
| Name | Optional | string | Name parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SurveyCategoryDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateSurveyCategory(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:CreateSurveyCategory>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SurveyCategoryDto properties here -->
</bas:dto>
</bas:CreateSurveyCategory>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SurveyCategoryDto
# Call the service method
$result = $proxy.CreateSurveyCategory($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
5. CreateSurveyTemplate
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_CreateSurveyTemplate_InputMessage (soap:body, use = literal)
parameters type CreateSurveyTemplate
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SurveyTemplateDto | 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | SurveyTemplateContractorApplication | NotApplicable, RequiredForEachTask, RequiredForEachWorkPermit, RequiredForEachSupplier, RequiredForEachResource |
| Description | Optional | string | Description parameter (nillable) |
| EvoApplication | Optional | SurveyTemplateEvoApplication | NotApplicable, RequiredForEachAssignedResource, RequiredOncePerTask, RequiredForEachSupplier, RequiredForEachResource |
| EvoResponseCompulsory | Optional | SurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff, SuspendIfExpiredOrMissing |
| EvoResponseExpected | Optional | SurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff, WarnIfExpiredOrMissing |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | SurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachTask, RequiredForEachSiteVisit, RequiredForEachSupplier, RequiredForEachResource |
| FsiGoResponseExpected | Optional | SurveyTemplateFSIGoResponseExpected | NotApplicable, OnAcceptance, OnArrival, BeforeStartingWork, RiskAssessment, BeforeFinishingWork, OnVisitCompletion, OnDuty, OffDuty, DuringWork, OnPausingATask, OnResumingAPausedTask |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | SurveyTemplateResponseExpected | NotApplicable, GatewayTaskDetails, BeforeStartingWork, DuringWork, BeforeFinishingWork, AfterTaskCompletion, GatewayWorkPermitDetails, GatewayCompliance, GatewayResourceDetails |
| ResponseExpiry | Optional | SurveyTemplateResponseExpiry | ValidUntilExpiryDate, MustBeCompletedForEverySiteVisit, MustBeCompletedForEveryTask, MustBeCompletedForEveryWorkPermit, MustBeCompletedForEveryTimeRecord, NoAutomaticExpiry, SingleUseOnly, ValidUntilMidnightSameDay |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyClass | Optional | SurveyTemplateSurveyClass | WorkAndAccessRequirement, SupplyChain |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
Output: ISurveyService_CreateSurveyTemplate_OutputMessage (soap:body, use = literal)
parameters type CreateSurveyTemplateResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateSurveyTemplateResult | Optional | SurveyTemplateDto | CreateSurveyTemplateResult 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | SurveyTemplateContractorApplication | NotApplicable, RequiredForEachTask, RequiredForEachWorkPermit, RequiredForEachSupplier, RequiredForEachResource |
| Description | Optional | string | Description parameter (nillable) |
| EvoApplication | Optional | SurveyTemplateEvoApplication | NotApplicable, RequiredForEachAssignedResource, RequiredOncePerTask, RequiredForEachSupplier, RequiredForEachResource |
| EvoResponseCompulsory | Optional | SurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff, SuspendIfExpiredOrMissing |
| EvoResponseExpected | Optional | SurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff, WarnIfExpiredOrMissing |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | SurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachTask, RequiredForEachSiteVisit, RequiredForEachSupplier, RequiredForEachResource |
| FsiGoResponseExpected | Optional | SurveyTemplateFSIGoResponseExpected | NotApplicable, OnAcceptance, OnArrival, BeforeStartingWork, RiskAssessment, BeforeFinishingWork, OnVisitCompletion, OnDuty, OffDuty, DuringWork, OnPausingATask, OnResumingAPausedTask |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | SurveyTemplateResponseExpected | NotApplicable, GatewayTaskDetails, BeforeStartingWork, DuringWork, BeforeFinishingWork, AfterTaskCompletion, GatewayWorkPermitDetails, GatewayCompliance, GatewayResourceDetails |
| ResponseExpiry | Optional | SurveyTemplateResponseExpiry | ValidUntilExpiryDate, MustBeCompletedForEverySiteVisit, MustBeCompletedForEveryTask, MustBeCompletedForEveryWorkPermit, MustBeCompletedForEveryTimeRecord, NoAutomaticExpiry, SingleUseOnly, ValidUntilMidnightSameDay |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyClass | Optional | SurveyTemplateSurveyClass | WorkAndAccessRequirement, SupplyChain |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SurveyTemplateDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateSurveyTemplate(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:CreateSurveyTemplate>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SurveyTemplateDto properties here -->
</bas:dto>
</bas:CreateSurveyTemplate>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SurveyTemplateDto
# Call the service method
$result = $proxy.CreateSurveyTemplate($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
6. CreateSurveyToken
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_CreateSurveyToken_InputMessage (soap:body, use = literal)
parameters type CreateSurveyToken
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SurveyTokenDto | 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 |
| ExpiresUtc | Optional | dateTime | ExpiresUtc parameter (nillable) |
| GUID | Optional | string | GUID parameter (nillable) |
| IssuedToName | Optional | string | IssuedToName parameter (nillable) |
| SurveyTokenId | Optional | long | SurveyTokenId parameter (nillable) |
| Type | Optional | SurveyTokenSurveyType | SupplySurvey, WorkSurvey, TaskCSF, PurchaseOrderCSF |
| URLParameters | Optional | string | URLParameters parameter (nillable) |
Output: ISurveyService_CreateSurveyToken_OutputMessage (soap:body, use = literal)
parameters type CreateSurveyTokenResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateSurveyTokenResult | Optional | SurveyTokenDto | CreateSurveyTokenResult 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 |
| ExpiresUtc | Optional | dateTime | ExpiresUtc parameter (nillable) |
| GUID | Optional | string | GUID parameter (nillable) |
| IssuedToName | Optional | string | IssuedToName parameter (nillable) |
| SurveyTokenId | Optional | long | SurveyTokenId parameter (nillable) |
| Type | Optional | SurveyTokenSurveyType | SupplySurvey, WorkSurvey, TaskCSF, PurchaseOrderCSF |
| URLParameters | Optional | string | URLParameters parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SurveyTokenDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateSurveyToken(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:CreateSurveyToken>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SurveyTokenDto properties here -->
</bas:dto>
</bas:CreateSurveyToken>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SurveyTokenDto
# Call the service method
$result = $proxy.CreateSurveyToken($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
7. CreateWorkSurvey
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_CreateWorkSurvey_InputMessage (soap:body, use = literal)
parameters type CreateWorkSurvey
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | WorkSurveyDto | 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
Output: ISurveyService_CreateWorkSurvey_OutputMessage (soap:body, use = literal)
parameters type CreateWorkSurveyResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateWorkSurveyResult | Optional | WorkSurveyDto | CreateWorkSurveyResult 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new WorkSurveyDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateWorkSurvey(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:CreateWorkSurvey>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- WorkSurveyDto properties here -->
</bas:dto>
</bas:CreateWorkSurvey>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object WorkSurveyDto
# Call the service method
$result = $proxy.CreateWorkSurvey($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
8. CreateWorkSurveyTemplate
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_CreateWorkSurveyTemplate_InputMessage (soap:body, use = literal)
parameters type CreateWorkSurveyTemplate
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | WorkSurveyTemplateDto | 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | WorkSurveyTemplateContractorApplication | NotApplicable, RequiredForEachTask, RequiredForEachWorkPermit |
| Description | Optional | string | Description parameter (nillable) |
| EstimatedTime | Optional | double | EstimatedTime parameter (nillable) |
| EvoApplication | Optional | WorkSurveyTemplateEvoApplication | NotApplicable, RequiredForEachAssignedResource, RequiredOncePerTask |
| EvoResponseCompulsory | Optional | WorkSurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff |
| EvoResponseExpected | Optional | WorkSurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | WorkSurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachTask, RequiredForEachSiteVisit |
| FsiGoResponseExpected | Optional | WorkSurveyTemplateFSIGoResponseExpected | NotApplicable, OnAcceptance, OnArrival, BeforeStartingWork, RiskAssessment, BeforeFinishingWork, OnVisitCompletion, DuringWork, OnPausingATask, OnResumingAPausedTask |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | WorkSurveyTemplateResponseExpected | NotApplicable, GatewayTaskDetails, BeforeStartingWork, DuringWork, BeforeFinishingWork, AfterTaskCompletion, GatewayWorkPermitDetails |
| ResponseExpiry | Optional | WorkSurveyTemplateResponseExpiry | ValidUntilExpiryDate, NoAutomaticExpiry, SingleUseOnly |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
Output: ISurveyService_CreateWorkSurveyTemplate_OutputMessage (soap:body, use = literal)
parameters type CreateWorkSurveyTemplateResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateWorkSurveyTemplateResult | Optional | WorkSurveyTemplateDto | CreateWorkSurveyTemplateResult 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | WorkSurveyTemplateContractorApplication | NotApplicable, RequiredForEachTask, RequiredForEachWorkPermit |
| Description | Optional | string | Description parameter (nillable) |
| EstimatedTime | Optional | double | EstimatedTime parameter (nillable) |
| EvoApplication | Optional | WorkSurveyTemplateEvoApplication | NotApplicable, RequiredForEachAssignedResource, RequiredOncePerTask |
| EvoResponseCompulsory | Optional | WorkSurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff |
| EvoResponseExpected | Optional | WorkSurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | WorkSurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachTask, RequiredForEachSiteVisit |
| FsiGoResponseExpected | Optional | WorkSurveyTemplateFSIGoResponseExpected | NotApplicable, OnAcceptance, OnArrival, BeforeStartingWork, RiskAssessment, BeforeFinishingWork, OnVisitCompletion, DuringWork, OnPausingATask, OnResumingAPausedTask |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | WorkSurveyTemplateResponseExpected | NotApplicable, GatewayTaskDetails, BeforeStartingWork, DuringWork, BeforeFinishingWork, AfterTaskCompletion, GatewayWorkPermitDetails |
| ResponseExpiry | Optional | WorkSurveyTemplateResponseExpiry | ValidUntilExpiryDate, NoAutomaticExpiry, SingleUseOnly |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new WorkSurveyTemplateDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateWorkSurveyTemplate(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:CreateWorkSurveyTemplate>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- WorkSurveyTemplateDto properties here -->
</bas:dto>
</bas:CreateWorkSurveyTemplate>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object WorkSurveyTemplateDto
# Call the service method
$result = $proxy.CreateWorkSurveyTemplate($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
9. GetSupplySurveyById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_GetSupplySurveyById_InputMessage (soap:body, use = literal)
parameters type GetSupplySurveyById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: ISurveyService_GetSupplySurveyById_OutputMessage (soap:body, use = literal)
parameters type GetSupplySurveyByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetSupplySurveyByIdResult | Optional | SupplySurveyDto | GetSupplySurveyByIdResult 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetSupplySurveyById(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:GetSupplySurveyById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetSupplySurveyById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetSupplySurveyById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
10. GetSupplySurveyTemplateById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_GetSupplySurveyTemplateById_InputMessage (soap:body, use = literal)
parameters type GetSupplySurveyTemplateById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: ISurveyService_GetSupplySurveyTemplateById_OutputMessage (soap:body, use = literal)
parameters type GetSupplySurveyTemplateByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetSupplySurveyTemplateByIdResult | Optional | SupplySurveyTemplateDto | GetSupplySurveyTemplateByIdResult 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | SupplySurveyTemplateContractorApplication | NotApplicable, RequiredForEachSupplier |
| Description | Optional | string | Description parameter (nillable) |
| EvoApplication | Optional | SupplySurveyTemplateEvoApplication | NotApplicable, RequiredForEachSupplier, RequiredForEachResource |
| EvoResponseCompulsory | Optional | SupplySurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, SuspendIfExpiredOrMissing |
| EvoResponseExpected | Optional | SupplySurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, WarnIfExpiredOrMissing |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | SupplySurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachResource |
| FsiGoResponseExpected | Optional | SupplySurveyTemplateFSIGoResponseExpected | NotApplicable, OnDuty, OffDuty |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | SupplySurveyTemplateResponseExpected | NotApplicable, GatewayCompliance |
| ResponseExpiry | Optional | SupplySurveyTemplateResponseExpiry | ValidUntilExpiryDate, NoAutomaticExpiry, SingleUseOnly, ValidUntilMidnightSameDay |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetSupplySurveyTemplateById(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:GetSupplySurveyTemplateById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetSupplySurveyTemplateById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetSupplySurveyTemplateById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
11. GetSupplySurveyTemplatesByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_GetSupplySurveyTemplatesByDto_InputMessage (soap:body, use = literal)
parameters type GetSupplySurveyTemplatesByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SupplySurveyTemplateDto | 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | SupplySurveyTemplateContractorApplication | NotApplicable, RequiredForEachSupplier |
| Description | Optional | string | Description parameter (nillable) |
| EvoApplication | Optional | SupplySurveyTemplateEvoApplication | NotApplicable, RequiredForEachSupplier, RequiredForEachResource |
| EvoResponseCompulsory | Optional | SupplySurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, SuspendIfExpiredOrMissing |
| EvoResponseExpected | Optional | SupplySurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, WarnIfExpiredOrMissing |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | SupplySurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachResource |
| FsiGoResponseExpected | Optional | SupplySurveyTemplateFSIGoResponseExpected | NotApplicable, OnDuty, OffDuty |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | SupplySurveyTemplateResponseExpected | NotApplicable, GatewayCompliance |
| ResponseExpiry | Optional | SupplySurveyTemplateResponseExpiry | ValidUntilExpiryDate, NoAutomaticExpiry, SingleUseOnly, ValidUntilMidnightSameDay |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: ISurveyService_GetSupplySurveyTemplatesByDto_OutputMessage (soap:body, use = literal)
parameters type GetSupplySurveyTemplatesByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetSupplySurveyTemplatesByDtoResult | Optional | ArrayOfSupplySurveyTemplateDto | GetSupplySurveyTemplatesByDtoResult parameter (nillable) |
| SupplySurveyTemplateDto | Optional | SupplySurveyTemplateDto | SupplySurveyTemplateDto 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | SupplySurveyTemplateContractorApplication | NotApplicable, RequiredForEachSupplier |
| Description | Optional | string | Description parameter (nillable) |
| EvoApplication | Optional | SupplySurveyTemplateEvoApplication | NotApplicable, RequiredForEachSupplier, RequiredForEachResource |
| EvoResponseCompulsory | Optional | SupplySurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, SuspendIfExpiredOrMissing |
| EvoResponseExpected | Optional | SupplySurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, WarnIfExpiredOrMissing |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | SupplySurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachResource |
| FsiGoResponseExpected | Optional | SupplySurveyTemplateFSIGoResponseExpected | NotApplicable, OnDuty, OffDuty |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | SupplySurveyTemplateResponseExpected | NotApplicable, GatewayCompliance |
| ResponseExpiry | Optional | SupplySurveyTemplateResponseExpiry | ValidUntilExpiryDate, NoAutomaticExpiry, SingleUseOnly, ValidUntilMidnightSameDay |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SupplySurveyTemplateDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetSupplySurveyTemplatesByDto(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:GetSupplySurveyTemplatesByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SupplySurveyTemplateDto properties here -->
</bas:dto>
</bas:GetSupplySurveyTemplatesByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SupplySurveyTemplateDto
# Call the service method
$result = $proxy.GetSupplySurveyTemplatesByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
12. GetSupplySurveysByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_GetSupplySurveysByDto_InputMessage (soap:body, use = literal)
parameters type GetSupplySurveysByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SupplySurveyDto | 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: ISurveyService_GetSupplySurveysByDto_OutputMessage (soap:body, use = literal)
parameters type GetSupplySurveysByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetSupplySurveysByDtoResult | Optional | ArrayOfSupplySurveyDto | GetSupplySurveysByDtoResult parameter (nillable) |
| SupplySurveyDto | Optional | SupplySurveyDto | SupplySurveyDto 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SupplySurveyDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetSupplySurveysByDto(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:GetSupplySurveysByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SupplySurveyDto properties here -->
</bas:dto>
</bas:GetSupplySurveysByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SupplySurveyDto
# Call the service method
$result = $proxy.GetSupplySurveysByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
13. GetSurveyAnswersByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_GetSurveyAnswersByDto_InputMessage (soap:body, use = literal)
parameters type GetSurveyAnswersByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SurveyAnswerDto | 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 |
| AnswerGroup | Optional | int | AnswerGroup parameter (nillable) |
| Comments | Optional | string | Comments parameter (nillable) |
| DateTimeValueUtc | Optional | dateTime | DateTimeValueUtc parameter (nillable) |
| DecimalValue | Optional | double | DecimalValue parameter (nillable) |
| NumberValue | Optional | int | NumberValue parameter (nillable) |
| SurveyAnswerId | Optional | long | SurveyAnswerId parameter (nillable) |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyQuestionId | Optional | long | SurveyQuestionId parameter (nillable) |
| Value | Optional | string | Value parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: ISurveyService_GetSurveyAnswersByDto_OutputMessage (soap:body, use = literal)
parameters type GetSurveyAnswersByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetSurveyAnswersByDtoResult | Optional | ArrayOfSurveyAnswerDto | GetSurveyAnswersByDtoResult parameter (nillable) |
| SurveyAnswerDto | Optional | SurveyAnswerDto | SurveyAnswerDto 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 |
| AnswerGroup | Optional | int | AnswerGroup parameter (nillable) |
| Comments | Optional | string | Comments parameter (nillable) |
| DateTimeValueUtc | Optional | dateTime | DateTimeValueUtc parameter (nillable) |
| DecimalValue | Optional | double | DecimalValue parameter (nillable) |
| NumberValue | Optional | int | NumberValue parameter (nillable) |
| SurveyAnswerId | Optional | long | SurveyAnswerId parameter (nillable) |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyQuestionId | Optional | long | SurveyQuestionId parameter (nillable) |
| Value | Optional | string | Value parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SurveyAnswerDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetSurveyAnswersByDto(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:GetSurveyAnswersByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SurveyAnswerDto properties here -->
</bas:dto>
</bas:GetSurveyAnswersByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SurveyAnswerDto
# Call the service method
$result = $proxy.GetSurveyAnswersByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
14. GetSurveyById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_GetSurveyById_InputMessage (soap:body, use = literal)
parameters type GetSurveyById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: ISurveyService_GetSurveyById_OutputMessage (soap:body, use = literal)
parameters type GetSurveyByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetSurveyByIdResult | Optional | SurveyDto | GetSurveyByIdResult 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyClass | Optional | SurveyTemplateSurveyClass | WorkAndAccessRequirement, SupplyChain |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetSurveyById(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:GetSurveyById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetSurveyById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetSurveyById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
15. GetSurveyCategoryByDTO
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_GetSurveyCategoryByDTO_InputMessage (soap:body, use = literal)
parameters type GetSurveyCategoryByDTO
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SurveyCategoryDto | 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 |
| Name | Optional | string | Name parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: ISurveyService_GetSurveyCategoryByDTO_OutputMessage (soap:body, use = literal)
parameters type GetSurveyCategoryByDTOResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetSurveyCategoryByDTOResult | Optional | ArrayOfSurveyCategoryDto | GetSurveyCategoryByDTOResult parameter (nillable) |
| SurveyCategoryDto | Optional | SurveyCategoryDto | SurveyCategoryDto 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 |
| Name | Optional | string | Name parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SurveyCategoryDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetSurveyCategoryByDTO(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:GetSurveyCategoryByDTO>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SurveyCategoryDto properties here -->
</bas:dto>
</bas:GetSurveyCategoryByDTO>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SurveyCategoryDto
# Call the service method
$result = $proxy.GetSurveyCategoryByDTO($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
16. GetSurveyCategoryById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_GetSurveyCategoryById_InputMessage (soap:body, use = literal)
parameters type GetSurveyCategoryById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: ISurveyService_GetSurveyCategoryById_OutputMessage (soap:body, use = literal)
parameters type GetSurveyCategoryByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetSurveyCategoryByIdResult | Optional | SurveyCategoryDto | GetSurveyCategoryByIdResult 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 |
| Name | Optional | string | Name parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetSurveyCategoryById(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:GetSurveyCategoryById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetSurveyCategoryById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetSurveyCategoryById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
17. GetSurveyQuestionsByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_GetSurveyQuestionsByDto_InputMessage (soap:body, use = literal)
parameters type GetSurveyQuestionsByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SurveyQuestionDto | 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 |
| CommentText | Optional | string | CommentText parameter (nillable) |
| CorrectAnswer | Optional | string | CorrectAnswer parameter (nillable) |
| CorrectAnswerOperator | Optional | CorrectAnswerOperator | EqualTo, NotEqualTo, LessThan, LessThanOrEqualTo, MoreThan, MoreThanOrEqualTo, Between, In, NotIn |
| DefaultValue | Optional | string | DefaultValue parameter (nillable) |
| ExcludeIfNotAnswered | Optional | boolean | ExcludeIfNotAnswered parameter (nillable) |
| HasComment | Optional | boolean | HasComment parameter (nillable) |
| HierarchyClass | Optional | HierarchyClassEnum | Question, Item, Row, Column |
| IncludeInScoreCard | Optional | boolean | IncludeInScoreCard parameter (nillable) |
| InputType | Optional | string | InputType parameter (nillable) |
| IsRequired | Optional | boolean | IsRequired parameter (nillable) |
| MaxPossibleScore | Optional | double | MaxPossibleScore parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| OrderNumber | Optional | int | OrderNumber parameter (nillable) |
| ParentQuestionId | Optional | long | ParentQuestionId parameter (nillable) |
| QuestionType | Optional | string | QuestionType parameter (nillable) |
| ReadOnly | Optional | boolean | ReadOnly parameter (nillable) |
| ScoreCardCategory | Optional | string | ScoreCardCategory parameter (nillable) |
| ScoreForAnyAnswer | Optional | double | ScoreForAnyAnswer parameter (nillable) |
| ScoreForCorrectAnswer | Optional | double | ScoreForCorrectAnswer parameter (nillable) |
| ScoreForIncorrectAnswer | Optional | double | ScoreForIncorrectAnswer parameter (nillable) |
| ScoreType | Optional | ScoreType | None, AnswerValueIsTheScore, AnswerValueDeterminesaScore, AnyAnswerAchievesTheScore, SumMultipleAnswersForScore, Total |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyQuestionId | Optional | long | SurveyQuestionId parameter (nillable) |
| Title | Optional | string | Title parameter (nillable) |
| Visible | Optional | boolean | Visible parameter (nillable) |
| Weighting | Optional | double | Weighting parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: ISurveyService_GetSurveyQuestionsByDto_OutputMessage (soap:body, use = literal)
parameters type GetSurveyQuestionsByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetSurveyQuestionsByDtoResult | Optional | ArrayOfSurveyQuestionDto | GetSurveyQuestionsByDtoResult parameter (nillable) |
| SurveyQuestionDto | Optional | SurveyQuestionDto | SurveyQuestionDto 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 |
| CommentText | Optional | string | CommentText parameter (nillable) |
| CorrectAnswer | Optional | string | CorrectAnswer parameter (nillable) |
| CorrectAnswerOperator | Optional | CorrectAnswerOperator | EqualTo, NotEqualTo, LessThan, LessThanOrEqualTo, MoreThan, MoreThanOrEqualTo, Between, In, NotIn |
| DefaultValue | Optional | string | DefaultValue parameter (nillable) |
| ExcludeIfNotAnswered | Optional | boolean | ExcludeIfNotAnswered parameter (nillable) |
| HasComment | Optional | boolean | HasComment parameter (nillable) |
| HierarchyClass | Optional | HierarchyClassEnum | Question, Item, Row, Column |
| IncludeInScoreCard | Optional | boolean | IncludeInScoreCard parameter (nillable) |
| InputType | Optional | string | InputType parameter (nillable) |
| IsRequired | Optional | boolean | IsRequired parameter (nillable) |
| MaxPossibleScore | Optional | double | MaxPossibleScore parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| OrderNumber | Optional | int | OrderNumber parameter (nillable) |
| ParentQuestionId | Optional | long | ParentQuestionId parameter (nillable) |
| QuestionType | Optional | string | QuestionType parameter (nillable) |
| ReadOnly | Optional | boolean | ReadOnly parameter (nillable) |
| ScoreCardCategory | Optional | string | ScoreCardCategory parameter (nillable) |
| ScoreForAnyAnswer | Optional | double | ScoreForAnyAnswer parameter (nillable) |
| ScoreForCorrectAnswer | Optional | double | ScoreForCorrectAnswer parameter (nillable) |
| ScoreForIncorrectAnswer | Optional | double | ScoreForIncorrectAnswer parameter (nillable) |
| ScoreType | Optional | ScoreType | None, AnswerValueIsTheScore, AnswerValueDeterminesaScore, AnyAnswerAchievesTheScore, SumMultipleAnswersForScore, Total |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyQuestionId | Optional | long | SurveyQuestionId parameter (nillable) |
| Title | Optional | string | Title parameter (nillable) |
| Visible | Optional | boolean | Visible parameter (nillable) |
| Weighting | Optional | double | Weighting parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SurveyQuestionDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetSurveyQuestionsByDto(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:GetSurveyQuestionsByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SurveyQuestionDto properties here -->
</bas:dto>
</bas:GetSurveyQuestionsByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SurveyQuestionDto
# Call the service method
$result = $proxy.GetSurveyQuestionsByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
18. GetSurveyTemplateAssignmentsByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_GetSurveyTemplateAssignmentsByDto_InputMessage (soap:body, use = literal)
parameters type GetSurveyTemplateAssignmentsByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SurveyTemplateAssignmentDto | 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 |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| LinkedTo | Optional | string | LinkedTo parameter (nillable) |
| SurveyTemplateAssignmentId | Optional | long | SurveyTemplateAssignmentId parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: ISurveyService_GetSurveyTemplateAssignmentsByDto_OutputMessage (soap:body, use = literal)
parameters type GetSurveyTemplateAssignmentsByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetSurveyTemplateAssignmentsByDtoResult | Optional | ArrayOfSurveyTemplateAssignmentDto | GetSurveyTemplateAssignmentsByDtoResult parameter (nillable) |
| SurveyTemplateAssignmentDto | Optional | SurveyTemplateAssignmentDto | SurveyTemplateAssignmentDto 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 |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| LinkedTo | Optional | string | LinkedTo parameter (nillable) |
| SurveyTemplateAssignmentId | Optional | long | SurveyTemplateAssignmentId parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SurveyTemplateAssignmentDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetSurveyTemplateAssignmentsByDto(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:GetSurveyTemplateAssignmentsByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SurveyTemplateAssignmentDto properties here -->
</bas:dto>
</bas:GetSurveyTemplateAssignmentsByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SurveyTemplateAssignmentDto
# Call the service method
$result = $proxy.GetSurveyTemplateAssignmentsByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
19. GetSurveyTemplateById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_GetSurveyTemplateById_InputMessage (soap:body, use = literal)
parameters type GetSurveyTemplateById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: ISurveyService_GetSurveyTemplateById_OutputMessage (soap:body, use = literal)
parameters type GetSurveyTemplateByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetSurveyTemplateByIdResult | Optional | SurveyTemplateDto | GetSurveyTemplateByIdResult 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | SurveyTemplateContractorApplication | NotApplicable, RequiredForEachTask, RequiredForEachWorkPermit, RequiredForEachSupplier, RequiredForEachResource |
| Description | Optional | string | Description parameter (nillable) |
| EvoApplication | Optional | SurveyTemplateEvoApplication | NotApplicable, RequiredForEachAssignedResource, RequiredOncePerTask, RequiredForEachSupplier, RequiredForEachResource |
| EvoResponseCompulsory | Optional | SurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff, SuspendIfExpiredOrMissing |
| EvoResponseExpected | Optional | SurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff, WarnIfExpiredOrMissing |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | SurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachTask, RequiredForEachSiteVisit, RequiredForEachSupplier, RequiredForEachResource |
| FsiGoResponseExpected | Optional | SurveyTemplateFSIGoResponseExpected | NotApplicable, OnAcceptance, OnArrival, BeforeStartingWork, RiskAssessment, BeforeFinishingWork, OnVisitCompletion, OnDuty, OffDuty, DuringWork, OnPausingATask, OnResumingAPausedTask |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | SurveyTemplateResponseExpected | NotApplicable, GatewayTaskDetails, BeforeStartingWork, DuringWork, BeforeFinishingWork, AfterTaskCompletion, GatewayWorkPermitDetails, GatewayCompliance, GatewayResourceDetails |
| ResponseExpiry | Optional | SurveyTemplateResponseExpiry | ValidUntilExpiryDate, MustBeCompletedForEverySiteVisit, MustBeCompletedForEveryTask, MustBeCompletedForEveryWorkPermit, MustBeCompletedForEveryTimeRecord, NoAutomaticExpiry, SingleUseOnly, ValidUntilMidnightSameDay |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyClass | Optional | SurveyTemplateSurveyClass | WorkAndAccessRequirement, SupplyChain |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetSurveyTemplateById(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:GetSurveyTemplateById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetSurveyTemplateById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetSurveyTemplateById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
20. GetSurveyTemplateQuestionsByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_GetSurveyTemplateQuestionsByDto_InputMessage (soap:body, use = literal)
parameters type GetSurveyTemplateQuestionsByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SurveyTemplateQuestionDto | 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 |
| CommentText | Optional | string | CommentText parameter (nillable) |
| CorrectAnswer | Optional | string | CorrectAnswer parameter (nillable) |
| CorrectAnswerOperator | Optional | CorrectAnswerOperator | EqualTo, NotEqualTo, LessThan, LessThanOrEqualTo, MoreThan, MoreThanOrEqualTo, Between, In, NotIn |
| DefaultValue | Optional | string | DefaultValue parameter (nillable) |
| ExcludeIfNotAnswered | Optional | boolean | ExcludeIfNotAnswered parameter (nillable) |
| HasComment | Optional | boolean | HasComment parameter (nillable) |
| HierarchyClass | Optional | HierarchyClassEnum | Question, Item, Row, Column |
| IncludeInScoreCard | Optional | boolean | IncludeInScoreCard parameter (nillable) |
| InputType | Optional | string | InputType parameter (nillable) |
| IsRequired | Optional | boolean | IsRequired parameter (nillable) |
| MaxPossibleScore | Optional | double | MaxPossibleScore parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| OrderNumber | Optional | int | OrderNumber parameter (nillable) |
| ParentQuestionId | Optional | long | ParentQuestionId parameter (nillable) |
| QuestionType | Optional | string | QuestionType parameter (nillable) |
| ReadOnly | Optional | boolean | ReadOnly parameter (nillable) |
| ScoreCardCategory | Optional | string | ScoreCardCategory parameter (nillable) |
| ScoreForAnyAnswer | Optional | double | ScoreForAnyAnswer parameter (nillable) |
| ScoreForCorrectAnswer | Optional | double | ScoreForCorrectAnswer parameter (nillable) |
| ScoreForIncorrectAnswer | Optional | double | ScoreForIncorrectAnswer parameter (nillable) |
| ScoreType | Optional | ScoreType | None, AnswerValueIsTheScore, AnswerValueDeterminesaScore, AnyAnswerAchievesTheScore, SumMultipleAnswersForScore, Total |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyTemplateQuestionId | Optional | long | SurveyTemplateQuestionId parameter (nillable) |
| Title | Optional | string | Title parameter (nillable) |
| Visible | Optional | boolean | Visible parameter (nillable) |
| Weighting | Optional | double | Weighting parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: ISurveyService_GetSurveyTemplateQuestionsByDto_OutputMessage (soap:body, use = literal)
parameters type GetSurveyTemplateQuestionsByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetSurveyTemplateQuestionsByDtoResult | Optional | ArrayOfSurveyTemplateQuestionDto | GetSurveyTemplateQuestionsByDtoResult parameter (nillable) |
| SurveyTemplateQuestionDto | Optional | SurveyTemplateQuestionDto | SurveyTemplateQuestionDto 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 |
| CommentText | Optional | string | CommentText parameter (nillable) |
| CorrectAnswer | Optional | string | CorrectAnswer parameter (nillable) |
| CorrectAnswerOperator | Optional | CorrectAnswerOperator | EqualTo, NotEqualTo, LessThan, LessThanOrEqualTo, MoreThan, MoreThanOrEqualTo, Between, In, NotIn |
| DefaultValue | Optional | string | DefaultValue parameter (nillable) |
| ExcludeIfNotAnswered | Optional | boolean | ExcludeIfNotAnswered parameter (nillable) |
| HasComment | Optional | boolean | HasComment parameter (nillable) |
| HierarchyClass | Optional | HierarchyClassEnum | Question, Item, Row, Column |
| IncludeInScoreCard | Optional | boolean | IncludeInScoreCard parameter (nillable) |
| InputType | Optional | string | InputType parameter (nillable) |
| IsRequired | Optional | boolean | IsRequired parameter (nillable) |
| MaxPossibleScore | Optional | double | MaxPossibleScore parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| OrderNumber | Optional | int | OrderNumber parameter (nillable) |
| ParentQuestionId | Optional | long | ParentQuestionId parameter (nillable) |
| QuestionType | Optional | string | QuestionType parameter (nillable) |
| ReadOnly | Optional | boolean | ReadOnly parameter (nillable) |
| ScoreCardCategory | Optional | string | ScoreCardCategory parameter (nillable) |
| ScoreForAnyAnswer | Optional | double | ScoreForAnyAnswer parameter (nillable) |
| ScoreForCorrectAnswer | Optional | double | ScoreForCorrectAnswer parameter (nillable) |
| ScoreForIncorrectAnswer | Optional | double | ScoreForIncorrectAnswer parameter (nillable) |
| ScoreType | Optional | ScoreType | None, AnswerValueIsTheScore, AnswerValueDeterminesaScore, AnyAnswerAchievesTheScore, SumMultipleAnswersForScore, Total |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyTemplateQuestionId | Optional | long | SurveyTemplateQuestionId parameter (nillable) |
| Title | Optional | string | Title parameter (nillable) |
| Visible | Optional | boolean | Visible parameter (nillable) |
| Weighting | Optional | double | Weighting parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SurveyTemplateQuestionDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetSurveyTemplateQuestionsByDto(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:GetSurveyTemplateQuestionsByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SurveyTemplateQuestionDto properties here -->
</bas:dto>
</bas:GetSurveyTemplateQuestionsByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SurveyTemplateQuestionDto
# Call the service method
$result = $proxy.GetSurveyTemplateQuestionsByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
21. GetSurveyTemplatesByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_GetSurveyTemplatesByDto_InputMessage (soap:body, use = literal)
parameters type GetSurveyTemplatesByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SurveyTemplateDto | 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | SurveyTemplateContractorApplication | NotApplicable, RequiredForEachTask, RequiredForEachWorkPermit, RequiredForEachSupplier, RequiredForEachResource |
| Description | Optional | string | Description parameter (nillable) |
| EvoApplication | Optional | SurveyTemplateEvoApplication | NotApplicable, RequiredForEachAssignedResource, RequiredOncePerTask, RequiredForEachSupplier, RequiredForEachResource |
| EvoResponseCompulsory | Optional | SurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff, SuspendIfExpiredOrMissing |
| EvoResponseExpected | Optional | SurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff, WarnIfExpiredOrMissing |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | SurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachTask, RequiredForEachSiteVisit, RequiredForEachSupplier, RequiredForEachResource |
| FsiGoResponseExpected | Optional | SurveyTemplateFSIGoResponseExpected | NotApplicable, OnAcceptance, OnArrival, BeforeStartingWork, RiskAssessment, BeforeFinishingWork, OnVisitCompletion, OnDuty, OffDuty, DuringWork, OnPausingATask, OnResumingAPausedTask |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | SurveyTemplateResponseExpected | NotApplicable, GatewayTaskDetails, BeforeStartingWork, DuringWork, BeforeFinishingWork, AfterTaskCompletion, GatewayWorkPermitDetails, GatewayCompliance, GatewayResourceDetails |
| ResponseExpiry | Optional | SurveyTemplateResponseExpiry | ValidUntilExpiryDate, MustBeCompletedForEverySiteVisit, MustBeCompletedForEveryTask, MustBeCompletedForEveryWorkPermit, MustBeCompletedForEveryTimeRecord, NoAutomaticExpiry, SingleUseOnly, ValidUntilMidnightSameDay |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyClass | Optional | SurveyTemplateSurveyClass | WorkAndAccessRequirement, SupplyChain |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: ISurveyService_GetSurveyTemplatesByDto_OutputMessage (soap:body, use = literal)
parameters type GetSurveyTemplatesByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetSurveyTemplatesByDtoResult | Optional | ArrayOfSurveyTemplateDto | GetSurveyTemplatesByDtoResult parameter (nillable) |
| SurveyTemplateDto | Optional | SurveyTemplateDto | SurveyTemplateDto 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | SurveyTemplateContractorApplication | NotApplicable, RequiredForEachTask, RequiredForEachWorkPermit, RequiredForEachSupplier, RequiredForEachResource |
| Description | Optional | string | Description parameter (nillable) |
| EvoApplication | Optional | SurveyTemplateEvoApplication | NotApplicable, RequiredForEachAssignedResource, RequiredOncePerTask, RequiredForEachSupplier, RequiredForEachResource |
| EvoResponseCompulsory | Optional | SurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff, SuspendIfExpiredOrMissing |
| EvoResponseExpected | Optional | SurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff, WarnIfExpiredOrMissing |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | SurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachTask, RequiredForEachSiteVisit, RequiredForEachSupplier, RequiredForEachResource |
| FsiGoResponseExpected | Optional | SurveyTemplateFSIGoResponseExpected | NotApplicable, OnAcceptance, OnArrival, BeforeStartingWork, RiskAssessment, BeforeFinishingWork, OnVisitCompletion, OnDuty, OffDuty, DuringWork, OnPausingATask, OnResumingAPausedTask |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | SurveyTemplateResponseExpected | NotApplicable, GatewayTaskDetails, BeforeStartingWork, DuringWork, BeforeFinishingWork, AfterTaskCompletion, GatewayWorkPermitDetails, GatewayCompliance, GatewayResourceDetails |
| ResponseExpiry | Optional | SurveyTemplateResponseExpiry | ValidUntilExpiryDate, MustBeCompletedForEverySiteVisit, MustBeCompletedForEveryTask, MustBeCompletedForEveryWorkPermit, MustBeCompletedForEveryTimeRecord, NoAutomaticExpiry, SingleUseOnly, ValidUntilMidnightSameDay |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyClass | Optional | SurveyTemplateSurveyClass | WorkAndAccessRequirement, SupplyChain |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SurveyTemplateDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetSurveyTemplatesByDto(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:GetSurveyTemplatesByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SurveyTemplateDto properties here -->
</bas:dto>
</bas:GetSurveyTemplatesByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SurveyTemplateDto
# Call the service method
$result = $proxy.GetSurveyTemplatesByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
22. GetSurveysByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_GetSurveysByDto_InputMessage (soap:body, use = literal)
parameters type GetSurveysByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SurveyDto | 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyClass | Optional | SurveyTemplateSurveyClass | WorkAndAccessRequirement, SupplyChain |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: ISurveyService_GetSurveysByDto_OutputMessage (soap:body, use = literal)
parameters type GetSurveysByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetSurveysByDtoResult | Optional | ArrayOfSurveyDto | GetSurveysByDtoResult parameter (nillable) |
| SurveyDto | Optional | SurveyDto | SurveyDto 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyClass | Optional | SurveyTemplateSurveyClass | WorkAndAccessRequirement, SupplyChain |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SurveyDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetSurveysByDto(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:GetSurveysByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SurveyDto properties here -->
</bas:dto>
</bas:GetSurveysByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SurveyDto
# Call the service method
$result = $proxy.GetSurveysByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
23. GetWorkSurveyById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_GetWorkSurveyById_InputMessage (soap:body, use = literal)
parameters type GetWorkSurveyById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: ISurveyService_GetWorkSurveyById_OutputMessage (soap:body, use = literal)
parameters type GetWorkSurveyByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetWorkSurveyByIdResult | Optional | WorkSurveyDto | GetWorkSurveyByIdResult 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetWorkSurveyById(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:GetWorkSurveyById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetWorkSurveyById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetWorkSurveyById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
24. GetWorkSurveyTemplateById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_GetWorkSurveyTemplateById_InputMessage (soap:body, use = literal)
parameters type GetWorkSurveyTemplateById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: ISurveyService_GetWorkSurveyTemplateById_OutputMessage (soap:body, use = literal)
parameters type GetWorkSurveyTemplateByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetWorkSurveyTemplateByIdResult | Optional | WorkSurveyTemplateDto | GetWorkSurveyTemplateByIdResult 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | WorkSurveyTemplateContractorApplication | NotApplicable, RequiredForEachTask, RequiredForEachWorkPermit |
| Description | Optional | string | Description parameter (nillable) |
| EstimatedTime | Optional | double | EstimatedTime parameter (nillable) |
| EvoApplication | Optional | WorkSurveyTemplateEvoApplication | NotApplicable, RequiredForEachAssignedResource, RequiredOncePerTask |
| EvoResponseCompulsory | Optional | WorkSurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff |
| EvoResponseExpected | Optional | WorkSurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | WorkSurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachTask, RequiredForEachSiteVisit |
| FsiGoResponseExpected | Optional | WorkSurveyTemplateFSIGoResponseExpected | NotApplicable, OnAcceptance, OnArrival, BeforeStartingWork, RiskAssessment, BeforeFinishingWork, OnVisitCompletion, DuringWork, OnPausingATask, OnResumingAPausedTask |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | WorkSurveyTemplateResponseExpected | NotApplicable, GatewayTaskDetails, BeforeStartingWork, DuringWork, BeforeFinishingWork, AfterTaskCompletion, GatewayWorkPermitDetails |
| ResponseExpiry | Optional | WorkSurveyTemplateResponseExpiry | ValidUntilExpiryDate, NoAutomaticExpiry, SingleUseOnly |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetWorkSurveyTemplateById(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:GetWorkSurveyTemplateById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetWorkSurveyTemplateById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetWorkSurveyTemplateById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
25. GetWorkSurveyTemplatesByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_GetWorkSurveyTemplatesByDto_InputMessage (soap:body, use = literal)
parameters type GetWorkSurveyTemplatesByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | WorkSurveyTemplateDto | 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | WorkSurveyTemplateContractorApplication | NotApplicable, RequiredForEachTask, RequiredForEachWorkPermit |
| Description | Optional | string | Description parameter (nillable) |
| EstimatedTime | Optional | double | EstimatedTime parameter (nillable) |
| EvoApplication | Optional | WorkSurveyTemplateEvoApplication | NotApplicable, RequiredForEachAssignedResource, RequiredOncePerTask |
| EvoResponseCompulsory | Optional | WorkSurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff |
| EvoResponseExpected | Optional | WorkSurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | WorkSurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachTask, RequiredForEachSiteVisit |
| FsiGoResponseExpected | Optional | WorkSurveyTemplateFSIGoResponseExpected | NotApplicable, OnAcceptance, OnArrival, BeforeStartingWork, RiskAssessment, BeforeFinishingWork, OnVisitCompletion, DuringWork, OnPausingATask, OnResumingAPausedTask |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | WorkSurveyTemplateResponseExpected | NotApplicable, GatewayTaskDetails, BeforeStartingWork, DuringWork, BeforeFinishingWork, AfterTaskCompletion, GatewayWorkPermitDetails |
| ResponseExpiry | Optional | WorkSurveyTemplateResponseExpiry | ValidUntilExpiryDate, NoAutomaticExpiry, SingleUseOnly |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: ISurveyService_GetWorkSurveyTemplatesByDto_OutputMessage (soap:body, use = literal)
parameters type GetWorkSurveyTemplatesByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetWorkSurveyTemplatesByDtoResult | Optional | ArrayOfWorkSurveyTemplateDto | GetWorkSurveyTemplatesByDtoResult parameter (nillable) |
| WorkSurveyTemplateDto | Optional | WorkSurveyTemplateDto | WorkSurveyTemplateDto 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | WorkSurveyTemplateContractorApplication | NotApplicable, RequiredForEachTask, RequiredForEachWorkPermit |
| Description | Optional | string | Description parameter (nillable) |
| EstimatedTime | Optional | double | EstimatedTime parameter (nillable) |
| EvoApplication | Optional | WorkSurveyTemplateEvoApplication | NotApplicable, RequiredForEachAssignedResource, RequiredOncePerTask |
| EvoResponseCompulsory | Optional | WorkSurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff |
| EvoResponseExpected | Optional | WorkSurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | WorkSurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachTask, RequiredForEachSiteVisit |
| FsiGoResponseExpected | Optional | WorkSurveyTemplateFSIGoResponseExpected | NotApplicable, OnAcceptance, OnArrival, BeforeStartingWork, RiskAssessment, BeforeFinishingWork, OnVisitCompletion, DuringWork, OnPausingATask, OnResumingAPausedTask |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | WorkSurveyTemplateResponseExpected | NotApplicable, GatewayTaskDetails, BeforeStartingWork, DuringWork, BeforeFinishingWork, AfterTaskCompletion, GatewayWorkPermitDetails |
| ResponseExpiry | Optional | WorkSurveyTemplateResponseExpiry | ValidUntilExpiryDate, NoAutomaticExpiry, SingleUseOnly |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new WorkSurveyTemplateDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetWorkSurveyTemplatesByDto(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:GetWorkSurveyTemplatesByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- WorkSurveyTemplateDto properties here -->
</bas:dto>
</bas:GetWorkSurveyTemplatesByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object WorkSurveyTemplateDto
# Call the service method
$result = $proxy.GetWorkSurveyTemplatesByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
26. GetWorkSurveysByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_GetWorkSurveysByDto_InputMessage (soap:body, use = literal)
parameters type GetWorkSurveysByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | WorkSurveyDto | 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: ISurveyService_GetWorkSurveysByDto_OutputMessage (soap:body, use = literal)
parameters type GetWorkSurveysByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetWorkSurveysByDtoResult | Optional | ArrayOfWorkSurveyDto | GetWorkSurveysByDtoResult parameter (nillable) |
| WorkSurveyDto | Optional | WorkSurveyDto | WorkSurveyDto 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new WorkSurveyDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetWorkSurveysByDto(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:GetWorkSurveysByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- WorkSurveyDto properties here -->
</bas:dto>
</bas:GetWorkSurveysByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object WorkSurveyDto
# Call the service method
$result = $proxy.GetWorkSurveysByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
27. UpdateSupplySurvey
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_UpdateSupplySurvey_InputMessage (soap:body, use = literal)
parameters type UpdateSupplySurvey
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SupplySurveyDto | 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
Output: ISurveyService_UpdateSupplySurvey_OutputMessage (soap:body, use = literal)
parameters type UpdateSupplySurveyResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateSupplySurveyResult | Optional | SupplySurveyDto | UpdateSupplySurveyResult 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SupplySurveyDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateSupplySurvey(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:UpdateSupplySurvey>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SupplySurveyDto properties here -->
</bas:dto>
</bas:UpdateSupplySurvey>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SupplySurveyDto
# Call the service method
$result = $proxy.UpdateSupplySurvey($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
28. UpdateSupplySurveyTemplate
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_UpdateSupplySurveyTemplate_InputMessage (soap:body, use = literal)
parameters type UpdateSupplySurveyTemplate
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SupplySurveyTemplateDto | 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | SupplySurveyTemplateContractorApplication | NotApplicable, RequiredForEachSupplier |
| Description | Optional | string | Description parameter (nillable) |
| EvoApplication | Optional | SupplySurveyTemplateEvoApplication | NotApplicable, RequiredForEachSupplier, RequiredForEachResource |
| EvoResponseCompulsory | Optional | SupplySurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, SuspendIfExpiredOrMissing |
| EvoResponseExpected | Optional | SupplySurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, WarnIfExpiredOrMissing |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | SupplySurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachResource |
| FsiGoResponseExpected | Optional | SupplySurveyTemplateFSIGoResponseExpected | NotApplicable, OnDuty, OffDuty |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | SupplySurveyTemplateResponseExpected | NotApplicable, GatewayCompliance |
| ResponseExpiry | Optional | SupplySurveyTemplateResponseExpiry | ValidUntilExpiryDate, NoAutomaticExpiry, SingleUseOnly, ValidUntilMidnightSameDay |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
Output: ISurveyService_UpdateSupplySurveyTemplate_OutputMessage (soap:body, use = literal)
parameters type UpdateSupplySurveyTemplateResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateSupplySurveyTemplateResult | Optional | SupplySurveyTemplateDto | UpdateSupplySurveyTemplateResult 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | SupplySurveyTemplateContractorApplication | NotApplicable, RequiredForEachSupplier |
| Description | Optional | string | Description parameter (nillable) |
| EvoApplication | Optional | SupplySurveyTemplateEvoApplication | NotApplicable, RequiredForEachSupplier, RequiredForEachResource |
| EvoResponseCompulsory | Optional | SupplySurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, SuspendIfExpiredOrMissing |
| EvoResponseExpected | Optional | SupplySurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, WarnIfExpiredOrMissing |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | SupplySurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachResource |
| FsiGoResponseExpected | Optional | SupplySurveyTemplateFSIGoResponseExpected | NotApplicable, OnDuty, OffDuty |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | SupplySurveyTemplateResponseExpected | NotApplicable, GatewayCompliance |
| ResponseExpiry | Optional | SupplySurveyTemplateResponseExpiry | ValidUntilExpiryDate, NoAutomaticExpiry, SingleUseOnly, ValidUntilMidnightSameDay |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SupplySurveyTemplateDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateSupplySurveyTemplate(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:UpdateSupplySurveyTemplate>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SupplySurveyTemplateDto properties here -->
</bas:dto>
</bas:UpdateSupplySurveyTemplate>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SupplySurveyTemplateDto
# Call the service method
$result = $proxy.UpdateSupplySurveyTemplate($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
29. UpdateSurvey
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_UpdateSurvey_InputMessage (soap:body, use = literal)
parameters type UpdateSurvey
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SurveyDto | 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyClass | Optional | SurveyTemplateSurveyClass | WorkAndAccessRequirement, SupplyChain |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
Output: ISurveyService_UpdateSurvey_OutputMessage (soap:body, use = literal)
parameters type UpdateSurveyResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateSurveyResult | Optional | SurveyDto | UpdateSurveyResult 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyClass | Optional | SurveyTemplateSurveyClass | WorkAndAccessRequirement, SupplyChain |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SurveyDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateSurvey(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:UpdateSurvey>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SurveyDto properties here -->
</bas:dto>
</bas:UpdateSurvey>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SurveyDto
# Call the service method
$result = $proxy.UpdateSurvey($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
30. UpdateSurveyCategory
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_UpdateSurveyCategory_InputMessage (soap:body, use = literal)
parameters type UpdateSurveyCategory
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SurveyCategoryDto | 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 |
| Name | Optional | string | Name parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
Output: ISurveyService_UpdateSurveyCategory_OutputMessage (soap:body, use = literal)
parameters type UpdateSurveyCategoryResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateSurveyCategoryResult | Optional | SurveyCategoryDto | UpdateSurveyCategoryResult 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 |
| Name | Optional | string | Name parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SurveyCategoryDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateSurveyCategory(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:UpdateSurveyCategory>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SurveyCategoryDto properties here -->
</bas:dto>
</bas:UpdateSurveyCategory>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SurveyCategoryDto
# Call the service method
$result = $proxy.UpdateSurveyCategory($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
31. UpdateSurveyTemplate
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_UpdateSurveyTemplate_InputMessage (soap:body, use = literal)
parameters type UpdateSurveyTemplate
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | SurveyTemplateDto | 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | SurveyTemplateContractorApplication | NotApplicable, RequiredForEachTask, RequiredForEachWorkPermit, RequiredForEachSupplier, RequiredForEachResource |
| Description | Optional | string | Description parameter (nillable) |
| EvoApplication | Optional | SurveyTemplateEvoApplication | NotApplicable, RequiredForEachAssignedResource, RequiredOncePerTask, RequiredForEachSupplier, RequiredForEachResource |
| EvoResponseCompulsory | Optional | SurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff, SuspendIfExpiredOrMissing |
| EvoResponseExpected | Optional | SurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff, WarnIfExpiredOrMissing |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | SurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachTask, RequiredForEachSiteVisit, RequiredForEachSupplier, RequiredForEachResource |
| FsiGoResponseExpected | Optional | SurveyTemplateFSIGoResponseExpected | NotApplicable, OnAcceptance, OnArrival, BeforeStartingWork, RiskAssessment, BeforeFinishingWork, OnVisitCompletion, OnDuty, OffDuty, DuringWork, OnPausingATask, OnResumingAPausedTask |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | SurveyTemplateResponseExpected | NotApplicable, GatewayTaskDetails, BeforeStartingWork, DuringWork, BeforeFinishingWork, AfterTaskCompletion, GatewayWorkPermitDetails, GatewayCompliance, GatewayResourceDetails |
| ResponseExpiry | Optional | SurveyTemplateResponseExpiry | ValidUntilExpiryDate, MustBeCompletedForEverySiteVisit, MustBeCompletedForEveryTask, MustBeCompletedForEveryWorkPermit, MustBeCompletedForEveryTimeRecord, NoAutomaticExpiry, SingleUseOnly, ValidUntilMidnightSameDay |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyClass | Optional | SurveyTemplateSurveyClass | WorkAndAccessRequirement, SupplyChain |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
Output: ISurveyService_UpdateSurveyTemplate_OutputMessage (soap:body, use = literal)
parameters type UpdateSurveyTemplateResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateSurveyTemplateResult | Optional | SurveyTemplateDto | UpdateSurveyTemplateResult 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | SurveyTemplateContractorApplication | NotApplicable, RequiredForEachTask, RequiredForEachWorkPermit, RequiredForEachSupplier, RequiredForEachResource |
| Description | Optional | string | Description parameter (nillable) |
| EvoApplication | Optional | SurveyTemplateEvoApplication | NotApplicable, RequiredForEachAssignedResource, RequiredOncePerTask, RequiredForEachSupplier, RequiredForEachResource |
| EvoResponseCompulsory | Optional | SurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff, SuspendIfExpiredOrMissing |
| EvoResponseExpected | Optional | SurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff, WarnIfExpiredOrMissing |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | SurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachTask, RequiredForEachSiteVisit, RequiredForEachSupplier, RequiredForEachResource |
| FsiGoResponseExpected | Optional | SurveyTemplateFSIGoResponseExpected | NotApplicable, OnAcceptance, OnArrival, BeforeStartingWork, RiskAssessment, BeforeFinishingWork, OnVisitCompletion, OnDuty, OffDuty, DuringWork, OnPausingATask, OnResumingAPausedTask |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | SurveyTemplateResponseExpected | NotApplicable, GatewayTaskDetails, BeforeStartingWork, DuringWork, BeforeFinishingWork, AfterTaskCompletion, GatewayWorkPermitDetails, GatewayCompliance, GatewayResourceDetails |
| ResponseExpiry | Optional | SurveyTemplateResponseExpiry | ValidUntilExpiryDate, MustBeCompletedForEverySiteVisit, MustBeCompletedForEveryTask, MustBeCompletedForEveryWorkPermit, MustBeCompletedForEveryTimeRecord, NoAutomaticExpiry, SingleUseOnly, ValidUntilMidnightSameDay |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyClass | Optional | SurveyTemplateSurveyClass | WorkAndAccessRequirement, SupplyChain |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new SurveyTemplateDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateSurveyTemplate(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:UpdateSurveyTemplate>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- SurveyTemplateDto properties here -->
</bas:dto>
</bas:UpdateSurveyTemplate>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object SurveyTemplateDto
# Call the service method
$result = $proxy.UpdateSurveyTemplate($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
32. UpdateWorkSurvey
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_UpdateWorkSurvey_InputMessage (soap:body, use = literal)
parameters type UpdateWorkSurvey
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | WorkSurveyDto | 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
Output: ISurveyService_UpdateWorkSurvey_OutputMessage (soap:body, use = literal)
parameters type UpdateWorkSurveyResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateWorkSurveyResult | Optional | WorkSurveyDto | UpdateWorkSurveyResult 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) |
| ActivatedBy | Optional | long | ActivatedBy parameter (nillable) |
| ActivatedDateUtc | Optional | dateTime | ActivatedDateUtc parameter (nillable) |
| ApprovedBy | Optional | long | ApprovedBy parameter (nillable) |
| ApprovedDateUtc | Optional | dateTime | ApprovedDateUtc parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter (nillable) |
| ExpiryForcedBy | Optional | long | ExpiryForcedBy parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectName | Optional | string | SubjectName parameter (nillable) |
| SubjectPrimaryKeyId | Optional | long | SubjectPrimaryKeyId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SubmittedByName | Optional | string | SubmittedByName parameter (nillable) |
| SubmittedByPrimaryKeyId | Optional | long | SubmittedByPrimaryKeyId parameter (nillable) |
| SubmittedByTableCatalogId | Optional | long | SubmittedByTableCatalogId parameter (nillable) |
| SubmittedDateUtc | Optional | dateTime | SubmittedDateUtc parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyId | Optional | long | SurveyId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyResponseJson | Optional | string | SurveyResponseJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| TaskId | Optional | int | TaskId parameter (nillable) |
| TimeRecordId | Optional | int | TimeRecordId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new WorkSurveyDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateWorkSurvey(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:UpdateWorkSurvey>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- WorkSurveyDto properties here -->
</bas:dto>
</bas:UpdateWorkSurvey>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object WorkSurveyDto
# Call the service method
$result = $proxy.UpdateWorkSurvey($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
33. UpdateWorkSurveyTemplate
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: ISurveyService_UpdateWorkSurveyTemplate_InputMessage (soap:body, use = literal)
parameters type UpdateWorkSurveyTemplate
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | WorkSurveyTemplateDto | 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | WorkSurveyTemplateContractorApplication | NotApplicable, RequiredForEachTask, RequiredForEachWorkPermit |
| Description | Optional | string | Description parameter (nillable) |
| EstimatedTime | Optional | double | EstimatedTime parameter (nillable) |
| EvoApplication | Optional | WorkSurveyTemplateEvoApplication | NotApplicable, RequiredForEachAssignedResource, RequiredOncePerTask |
| EvoResponseCompulsory | Optional | WorkSurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff |
| EvoResponseExpected | Optional | WorkSurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | WorkSurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachTask, RequiredForEachSiteVisit |
| FsiGoResponseExpected | Optional | WorkSurveyTemplateFSIGoResponseExpected | NotApplicable, OnAcceptance, OnArrival, BeforeStartingWork, RiskAssessment, BeforeFinishingWork, OnVisitCompletion, DuringWork, OnPausingATask, OnResumingAPausedTask |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | WorkSurveyTemplateResponseExpected | NotApplicable, GatewayTaskDetails, BeforeStartingWork, DuringWork, BeforeFinishingWork, AfterTaskCompletion, GatewayWorkPermitDetails |
| ResponseExpiry | Optional | WorkSurveyTemplateResponseExpiry | ValidUntilExpiryDate, NoAutomaticExpiry, SingleUseOnly |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
Output: ISurveyService_UpdateWorkSurveyTemplate_OutputMessage (soap:body, use = literal)
parameters type UpdateWorkSurveyTemplateResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateWorkSurveyTemplateResult | Optional | WorkSurveyTemplateDto | UpdateWorkSurveyTemplateResult 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) |
| AllEntities | Optional | boolean | AllEntities parameter (nillable) |
| ConceptReportId | Optional | int | ConceptReportId parameter (nillable) |
| ContractorApplication | Optional | WorkSurveyTemplateContractorApplication | NotApplicable, RequiredForEachTask, RequiredForEachWorkPermit |
| Description | Optional | string | Description parameter (nillable) |
| EstimatedTime | Optional | double | EstimatedTime parameter (nillable) |
| EvoApplication | Optional | WorkSurveyTemplateEvoApplication | NotApplicable, RequiredForEachAssignedResource, RequiredOncePerTask |
| EvoResponseCompulsory | Optional | WorkSurveyTemplateEvoResponseCompulsory | NotApplicable, NotCompulsory, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff |
| EvoResponseExpected | Optional | WorkSurveyTemplateEvoResponseExpected | NotApplicable, NoUserPrompt, BeforeTaskAssignment, BeforeCompletion, BeforeSignOff |
| EvoRoleId | Optional | long | EvoRoleId parameter (nillable) |
| FsiGoApplication | Optional | WorkSurveyTemplateFSIGoApplication | NotApplicable, RequiredForEachTask, RequiredForEachSiteVisit |
| FsiGoResponseExpected | Optional | WorkSurveyTemplateFSIGoResponseExpected | NotApplicable, OnAcceptance, OnArrival, BeforeStartingWork, RiskAssessment, BeforeFinishingWork, OnVisitCompletion, DuringWork, OnPausingATask, OnResumingAPausedTask |
| Name | Optional | string | Name parameter (nillable) |
| NewEntities | Optional | boolean | NewEntities parameter (nillable) |
| ResponseExpected | Optional | WorkSurveyTemplateResponseExpected | NotApplicable, GatewayTaskDetails, BeforeStartingWork, DuringWork, BeforeFinishingWork, AfterTaskCompletion, GatewayWorkPermitDetails |
| ResponseExpiry | Optional | WorkSurveyTemplateResponseExpiry | ValidUntilExpiryDate, NoAutomaticExpiry, SingleUseOnly |
| ResponseExpiryBaseline | Optional | SurveyTemplateResponseExpiryBaseline | AfterApproval, AfterIssue, AfterSubmission |
| ResponseExpiryInterval | Optional | SurveyTemplateResponseExpiryInterval | Years, Months, Weeks, Days |
| ResponseExpiryUnit | Optional | int | ResponseExpiryUnit parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SubjectTableCatalogId | Optional | long | SubjectTableCatalogId parameter (nillable) |
| SurveyCategoryId | Optional | long | SurveyCategoryId parameter (nillable) |
| SurveyJson | Optional | string | SurveyJson parameter (nillable) |
| SurveyTemplateId | Optional | long | SurveyTemplateId parameter (nillable) |
| SurveyVersion | Optional | string | SurveyVersion parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new SurveyServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new WorkSurveyTemplateDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateWorkSurveyTemplate(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:UpdateWorkSurveyTemplate>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- WorkSurveyTemplateDto properties here -->
</bas:dto>
</bas:UpdateWorkSurveyTemplate>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/SurveyService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object WorkSurveyTemplateDto
# Call the service method
$result = $proxy.UpdateWorkSurveyTemplate($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}