Web Service: ContactService
Port ContactService
- CreateCONTACTLINKERDetail
- CreateContactDetail
- CreateContactClassDetail
- CreateF_DESK_STATUSDetail
- CreateF_EMPTYPEDetail
- DeleteContactLinkerByIdDetail
- GetAllContactClassesDetail
- GetAllContactsDetail
- GetCONTACTLINKERByDtoDetail
- GetCONTACTLINKERByIdDetail
- GetContactByIdDetail
- GetContactClassByIdDetail
- GetContactsByDtoDetail
- GetF_DESK_STATUSByDtoDetail
- GetF_DESK_STATUSByIdDetail
- GetF_EMPTYPEByDtoDetail
- GetF_EMPTYPEByIdDetail
- GetLinkedContactsDetail
- Get_x0020_Contacts_x0020_by_x0020_CountryIdDetail
- UpdateCONTACTLINKERDetail
- UpdateContactDetail
- UpdateContactClassDetail
- UpdateF_DESK_STATUSDetail
- UpdateF_EMPTYPEDetail
Port type IContactService
1. CreateCONTACTLINKER
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_CreateCONTACTLINKER_InputMessage (soap:body, use = literal)
parameters type CreateCONTACTLINKER
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | CONTACTLINKERDto | 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 |
| ContactLinkerId | Optional | int | ContactLinkerId parameter (nillable) |
| LinkedContactId | Optional | int | LinkedContactId parameter (nillable) |
| LinkedDatabaseTable | Optional | string | LinkedDatabaseTable parameter (nillable) |
| LinkedDatabaseTableId | Optional | int | LinkedDatabaseTableId parameter (nillable) |
Output: IContactService_CreateCONTACTLINKER_OutputMessage (soap:body, use = literal)
parameters type CreateCONTACTLINKERResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateCONTACTLINKERResult | Optional | CONTACTLINKERDto | CreateCONTACTLINKERResult 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 |
| ContactLinkerId | Optional | int | ContactLinkerId parameter (nillable) |
| LinkedContactId | Optional | int | LinkedContactId parameter (nillable) |
| LinkedDatabaseTable | Optional | string | LinkedDatabaseTable parameter (nillable) |
| LinkedDatabaseTableId | Optional | int | LinkedDatabaseTableId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new CONTACTLINKERDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateCONTACTLINKER(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:CreateCONTACTLINKER>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- CONTACTLINKERDto properties here -->
</bas:dto>
</bas:CreateCONTACTLINKER>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object CONTACTLINKERDto
# Call the service method
$result = $proxy.CreateCONTACTLINKER($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
2. CreateContact
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_CreateContact_InputMessage (soap:body, use = literal)
parameters type CreateContact
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| contactDto | Optional | ContactDto | contactDto 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) |
| Address | Optional | string | Address parameter (nillable) |
| AlternativeEmailAddress | Optional | string | AlternativeEmailAddress parameter (nillable) |
| BeeperNumber | Optional | string | BeeperNumber parameter (nillable) |
| ClassTypeId | Optional | long | ClassTypeId parameter (nillable) |
| CommsMethod | Optional | int | CommsMethod parameter (nillable) |
| CommsPref | Optional | CommsPrefType | OptIn, OptOut |
| CommsPrefChangeBy | Optional | long | CommsPrefChangeBy parameter (nillable) |
| CommsPrefChangeDate | Optional | dateTime | CommsPrefChangeDate parameter (nillable) |
| ContactId | Optional | long | ContactId parameter (nillable) |
| CountryLibraryId | Optional | long | CountryLibraryId parameter (nillable) |
| DreamscapeObjectRefId | Optional | long | DreamscapeObjectRefId parameter (nillable) |
| EmailAddress | Optional | string | EmailAddress parameter (nillable) |
| FaxNumber | Optional | string | FaxNumber parameter (nillable) |
| FirstName | Optional | string | FirstName parameter (nillable) |
| HomeTelephoneNumber | Optional | string | HomeTelephoneNumber parameter (nillable) |
| JobTitle | Optional | string | JobTitle parameter (nillable) |
| KP_CAR_PARK | Optional | string | KP_CAR_PARK parameter (nillable) |
| KP_COMMENTS | Optional | string | KP_COMMENTS parameter (nillable) |
| KP_COMPANY | Optional | string | KP_COMPANY parameter (nillable) |
| KP_DEPARTUtc | Optional | dateTime | KP_DEPARTUtc parameter (nillable) |
| KP_DESK_NO | Optional | string | KP_DESK_NO parameter (nillable) |
| KP_DIRNO | Optional | int | KP_DIRNO parameter (nillable) |
| KP_DISABILITIES | Optional | unsignedByte | KP_DISABILITIES parameter (nillable) |
| KP_FAID | Optional | boolean | KP_FAID parameter (nillable) |
| KP_FAID_EXPIREUtc | Optional | dateTime | KP_FAID_EXPIREUtc parameter (nillable) |
| KP_FIRE_WARDEN | Optional | unsignedByte | KP_FIRE_WARDEN parameter (nillable) |
| KP_FKEY_BG_SEQ | Optional | int | KP_FKEY_BG_SEQ parameter (nillable) |
| KP_FKEY_DP_SEQ | Optional | int | KP_FKEY_DP_SEQ parameter (nillable) |
| KP_FKEY_DRT_SEQ | Optional | int | KP_FKEY_DRT_SEQ parameter (nillable) |
| KP_FKEY_DS_SEQ | Optional | int | KP_FKEY_DS_SEQ parameter (nillable) |
| KP_FKEY_ELE_SEQ | Optional | int | KP_FKEY_ELE_SEQ parameter (nillable) |
| KP_FKEY_EMPTYPE_SEQ | Optional | int | KP_FKEY_EMPTYPE_SEQ parameter (nillable) |
| KP_FKEY_FCC_SEQ | Optional | int | KP_FKEY_FCC_SEQ parameter (nillable) |
| KP_FKEY_FC_SEQ | Optional | int | KP_FKEY_FC_SEQ parameter (nillable) |
| KP_FKEY_GRADE_SEQ | Optional | int | KP_FKEY_GRADE_SEQ parameter (nillable) |
| KP_FKEY_KP_SEQ | Optional | int | KP_FKEY_KP_SEQ parameter (nillable) |
| KP_FKEY_LO_SEQ | Optional | int | KP_FKEY_LO_SEQ parameter (nillable) |
| KP_FKEY_POS_SEQ | Optional | int | KP_FKEY_POS_SEQ parameter (nillable) |
| KP_GRIDREF | Optional | string | KP_GRIDREF parameter (nillable) |
| KP_JOINEDUtc | Optional | dateTime | KP_JOINEDUtc parameter (nillable) |
| KP_KEY_NAME | Optional | string | KP_KEY_NAME parameter (nillable) |
| KP_REG1 | Optional | string | KP_REG1 parameter (nillable) |
| KP_REG2 | Optional | string | KP_REG2 parameter (nillable) |
| KP_SECNO | Optional | string | KP_SECNO parameter (nillable) |
| KP_SEC_EXPIREUtc | Optional | dateTime | KP_SEC_EXPIREUtc parameter (nillable) |
| KP_SEC_FKEY_DP_SEQ | Optional | int | KP_SEC_FKEY_DP_SEQ parameter (nillable) |
| KP_SPNEEDS | Optional | string | KP_SPNEEDS parameter (nillable) |
| KP_STAFF_TYPE | Optional | string | KP_STAFF_TYPE parameter (nillable) |
| KP_TEL_FAX | Optional | string | KP_TEL_FAX parameter (nillable) |
| LdapAccount | Optional | string | LdapAccount parameter (nillable) |
| MobileTelephoneNumber | Optional | string | MobileTelephoneNumber parameter (nillable) |
| OfficeTelephoneNumber | Optional | string | OfficeTelephoneNumber parameter (nillable) |
| OtherTelephoneNumber | Optional | string | OtherTelephoneNumber parameter (nillable) |
| PictureUrl | Optional | string | PictureUrl parameter (nillable) |
| Postcode | Optional | string | Postcode parameter (nillable) |
| StaffIdentifier | Optional | string | StaffIdentifier parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SupplierId | Optional | long | SupplierId parameter (nillable) |
| Surname | Optional | string | Surname parameter (nillable) |
| Title | Optional | string | Title parameter (nillable) |
| UserAccountId | Optional | long | UserAccountId parameter (nillable) |
Output: IContactService_CreateContact_OutputMessage (soap:body, use = literal)
parameters type CreateContactResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateContactResult | Optional | long | CreateContactResult parameter |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var contactDto = new ContactDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateContact(sessionId, impersonateAccountId, contactDto);
// 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:CreateContact>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:contactDto>
<!-- ContactDto properties here -->
</bas:contactDto>
</bas:CreateContact>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$contactDto = New-Object ContactDto
# Call the service method
$result = $proxy.CreateContact($sessionId, $impersonateAccountId, $contactDto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
3. CreateContactClass
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_CreateContactClass_InputMessage (soap:body, use = literal)
parameters type CreateContactClass
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| contactClassDto | Optional | ContactClassDto | contactClassDto 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 |
| ContactClassId | Optional | long | ContactClassId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
Output: IContactService_CreateContactClass_OutputMessage (soap:body, use = literal)
parameters type CreateContactClassResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateContactClassResult | Optional | long | CreateContactClassResult parameter |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var contactClassDto = new ContactClassDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateContactClass(sessionId, impersonateAccountId, contactClassDto);
// 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:CreateContactClass>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:contactClassDto>
<!-- ContactClassDto properties here -->
</bas:contactClassDto>
</bas:CreateContactClass>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$contactClassDto = New-Object ContactClassDto
# Call the service method
$result = $proxy.CreateContactClass($sessionId, $impersonateAccountId, $contactClassDto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
4. CreateF_DESK_STATUS
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_CreateF_DESK_STATUS_InputMessage (soap:body, use = literal)
parameters type CreateF_DESK_STATUS
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | F_DESK_STATUSDto | 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 |
| DeskStatusCode | Optional | string | DeskStatusCode parameter (nillable) |
| DeskStatusDescription | Optional | string | DeskStatusDescription parameter (nillable) |
| DeskStatusId | Optional | int | DeskStatusId parameter (nillable) |
Output: IContactService_CreateF_DESK_STATUS_OutputMessage (soap:body, use = literal)
parameters type CreateF_DESK_STATUSResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateF_DESK_STATUSResult | Optional | F_DESK_STATUSDto | CreateF_DESK_STATUSResult 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 |
| DeskStatusCode | Optional | string | DeskStatusCode parameter (nillable) |
| DeskStatusDescription | Optional | string | DeskStatusDescription parameter (nillable) |
| DeskStatusId | Optional | int | DeskStatusId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new F_DESK_STATUSDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateF_DESK_STATUS(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:CreateF_DESK_STATUS>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- F_DESK_STATUSDto properties here -->
</bas:dto>
</bas:CreateF_DESK_STATUS>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object F_DESK_STATUSDto
# Call the service method
$result = $proxy.CreateF_DESK_STATUS($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
5. CreateF_EMPTYPE
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_CreateF_EMPTYPE_InputMessage (soap:body, use = literal)
parameters type CreateF_EMPTYPE
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | F_EMPTYPEDto | 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 |
| EmployeeTypeCode | Optional | string | EmployeeTypeCode parameter (nillable) |
| EmployeeTypeDescription | Optional | string | EmployeeTypeDescription parameter (nillable) |
| EmployeeTypeId | Optional | int | EmployeeTypeId parameter (nillable) |
Output: IContactService_CreateF_EMPTYPE_OutputMessage (soap:body, use = literal)
parameters type CreateF_EMPTYPEResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateF_EMPTYPEResult | Optional | F_EMPTYPEDto | CreateF_EMPTYPEResult 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 |
| EmployeeTypeCode | Optional | string | EmployeeTypeCode parameter (nillable) |
| EmployeeTypeDescription | Optional | string | EmployeeTypeDescription parameter (nillable) |
| EmployeeTypeId | Optional | int | EmployeeTypeId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new F_EMPTYPEDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateF_EMPTYPE(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:CreateF_EMPTYPE>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- F_EMPTYPEDto properties here -->
</bas:dto>
</bas:CreateF_EMPTYPE>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object F_EMPTYPEDto
# Call the service method
$result = $proxy.CreateF_EMPTYPE($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
6. DeleteContactLinkerById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_DeleteContactLinkerById_InputMessage (soap:body, use = literal)
parameters type DeleteContactLinkerById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.DeleteContactLinkerById(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:DeleteContactLinkerById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:DeleteContactLinkerById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.DeleteContactLinkerById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
7. GetAllContactClasses
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_GetAllContactClasses_InputMessage (soap:body, use = literal)
parameters type GetAllContactClasses
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
Output: IContactService_GetAllContactClasses_OutputMessage (soap:body, use = literal)
parameters type GetAllContactClassesResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetAllContactClassesResult | Optional | ArrayOfContactClassDto | GetAllContactClassesResult parameter (nillable) |
| ContactClassDto | Optional | ContactClassDto | ContactClassDto 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 |
| ContactClassId | Optional | long | ContactClassId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
// Call the service method
var response = client.GetAllContactClasses(sessionId, impersonateAccountId);
// 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:GetAllContactClasses>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
</bas:GetAllContactClasses>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
# Call the service method
$result = $proxy.GetAllContactClasses($sessionId, $impersonateAccountId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
8. GetAllContacts
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_GetAllContacts_InputMessage (soap:body, use = literal)
parameters type GetAllContacts
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
Output: IContactService_GetAllContacts_OutputMessage (soap:body, use = literal)
parameters type GetAllContactsResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetAllContactsResult | Optional | ArrayOfContactDto | GetAllContactsResult parameter (nillable) |
| ContactDto | Optional | ContactDto | ContactDto 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) |
| Address | Optional | string | Address parameter (nillable) |
| AlternativeEmailAddress | Optional | string | AlternativeEmailAddress parameter (nillable) |
| BeeperNumber | Optional | string | BeeperNumber parameter (nillable) |
| ClassTypeId | Optional | long | ClassTypeId parameter (nillable) |
| CommsMethod | Optional | int | CommsMethod parameter (nillable) |
| CommsPref | Optional | CommsPrefType | OptIn, OptOut |
| CommsPrefChangeBy | Optional | long | CommsPrefChangeBy parameter (nillable) |
| CommsPrefChangeDate | Optional | dateTime | CommsPrefChangeDate parameter (nillable) |
| ContactId | Optional | long | ContactId parameter (nillable) |
| CountryLibraryId | Optional | long | CountryLibraryId parameter (nillable) |
| DreamscapeObjectRefId | Optional | long | DreamscapeObjectRefId parameter (nillable) |
| EmailAddress | Optional | string | EmailAddress parameter (nillable) |
| FaxNumber | Optional | string | FaxNumber parameter (nillable) |
| FirstName | Optional | string | FirstName parameter (nillable) |
| HomeTelephoneNumber | Optional | string | HomeTelephoneNumber parameter (nillable) |
| JobTitle | Optional | string | JobTitle parameter (nillable) |
| KP_CAR_PARK | Optional | string | KP_CAR_PARK parameter (nillable) |
| KP_COMMENTS | Optional | string | KP_COMMENTS parameter (nillable) |
| KP_COMPANY | Optional | string | KP_COMPANY parameter (nillable) |
| KP_DEPARTUtc | Optional | dateTime | KP_DEPARTUtc parameter (nillable) |
| KP_DESK_NO | Optional | string | KP_DESK_NO parameter (nillable) |
| KP_DIRNO | Optional | int | KP_DIRNO parameter (nillable) |
| KP_DISABILITIES | Optional | unsignedByte | KP_DISABILITIES parameter (nillable) |
| KP_FAID | Optional | boolean | KP_FAID parameter (nillable) |
| KP_FAID_EXPIREUtc | Optional | dateTime | KP_FAID_EXPIREUtc parameter (nillable) |
| KP_FIRE_WARDEN | Optional | unsignedByte | KP_FIRE_WARDEN parameter (nillable) |
| KP_FKEY_BG_SEQ | Optional | int | KP_FKEY_BG_SEQ parameter (nillable) |
| KP_FKEY_DP_SEQ | Optional | int | KP_FKEY_DP_SEQ parameter (nillable) |
| KP_FKEY_DRT_SEQ | Optional | int | KP_FKEY_DRT_SEQ parameter (nillable) |
| KP_FKEY_DS_SEQ | Optional | int | KP_FKEY_DS_SEQ parameter (nillable) |
| KP_FKEY_ELE_SEQ | Optional | int | KP_FKEY_ELE_SEQ parameter (nillable) |
| KP_FKEY_EMPTYPE_SEQ | Optional | int | KP_FKEY_EMPTYPE_SEQ parameter (nillable) |
| KP_FKEY_FCC_SEQ | Optional | int | KP_FKEY_FCC_SEQ parameter (nillable) |
| KP_FKEY_FC_SEQ | Optional | int | KP_FKEY_FC_SEQ parameter (nillable) |
| KP_FKEY_GRADE_SEQ | Optional | int | KP_FKEY_GRADE_SEQ parameter (nillable) |
| KP_FKEY_KP_SEQ | Optional | int | KP_FKEY_KP_SEQ parameter (nillable) |
| KP_FKEY_LO_SEQ | Optional | int | KP_FKEY_LO_SEQ parameter (nillable) |
| KP_FKEY_POS_SEQ | Optional | int | KP_FKEY_POS_SEQ parameter (nillable) |
| KP_GRIDREF | Optional | string | KP_GRIDREF parameter (nillable) |
| KP_JOINEDUtc | Optional | dateTime | KP_JOINEDUtc parameter (nillable) |
| KP_KEY_NAME | Optional | string | KP_KEY_NAME parameter (nillable) |
| KP_REG1 | Optional | string | KP_REG1 parameter (nillable) |
| KP_REG2 | Optional | string | KP_REG2 parameter (nillable) |
| KP_SECNO | Optional | string | KP_SECNO parameter (nillable) |
| KP_SEC_EXPIREUtc | Optional | dateTime | KP_SEC_EXPIREUtc parameter (nillable) |
| KP_SEC_FKEY_DP_SEQ | Optional | int | KP_SEC_FKEY_DP_SEQ parameter (nillable) |
| KP_SPNEEDS | Optional | string | KP_SPNEEDS parameter (nillable) |
| KP_STAFF_TYPE | Optional | string | KP_STAFF_TYPE parameter (nillable) |
| KP_TEL_FAX | Optional | string | KP_TEL_FAX parameter (nillable) |
| LdapAccount | Optional | string | LdapAccount parameter (nillable) |
| MobileTelephoneNumber | Optional | string | MobileTelephoneNumber parameter (nillable) |
| OfficeTelephoneNumber | Optional | string | OfficeTelephoneNumber parameter (nillable) |
| OtherTelephoneNumber | Optional | string | OtherTelephoneNumber parameter (nillable) |
| PictureUrl | Optional | string | PictureUrl parameter (nillable) |
| Postcode | Optional | string | Postcode parameter (nillable) |
| StaffIdentifier | Optional | string | StaffIdentifier parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SupplierId | Optional | long | SupplierId parameter (nillable) |
| Surname | Optional | string | Surname parameter (nillable) |
| Title | Optional | string | Title parameter (nillable) |
| UserAccountId | Optional | long | UserAccountId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
// Call the service method
var response = client.GetAllContacts(sessionId, impersonateAccountId);
// 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:GetAllContacts>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
</bas:GetAllContacts>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
# Call the service method
$result = $proxy.GetAllContacts($sessionId, $impersonateAccountId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
9. GetCONTACTLINKERByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_GetCONTACTLINKERByDto_InputMessage (soap:body, use = literal)
parameters type GetCONTACTLINKERByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | CONTACTLINKERDto | 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 |
| ContactLinkerId | Optional | int | ContactLinkerId parameter (nillable) |
| LinkedContactId | Optional | int | LinkedContactId parameter (nillable) |
| LinkedDatabaseTable | Optional | string | LinkedDatabaseTable parameter (nillable) |
| LinkedDatabaseTableId | Optional | int | LinkedDatabaseTableId parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: IContactService_GetCONTACTLINKERByDto_OutputMessage (soap:body, use = literal)
parameters type GetCONTACTLINKERByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetCONTACTLINKERByDtoResult | Optional | ArrayOfCONTACTLINKERDto | GetCONTACTLINKERByDtoResult parameter (nillable) |
| CONTACTLINKERDto | Optional | CONTACTLINKERDto | CONTACTLINKERDto 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 |
| ContactLinkerId | Optional | int | ContactLinkerId parameter (nillable) |
| LinkedContactId | Optional | int | LinkedContactId parameter (nillable) |
| LinkedDatabaseTable | Optional | string | LinkedDatabaseTable parameter (nillable) |
| LinkedDatabaseTableId | Optional | int | LinkedDatabaseTableId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new CONTACTLINKERDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetCONTACTLINKERByDto(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:GetCONTACTLINKERByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- CONTACTLINKERDto properties here -->
</bas:dto>
</bas:GetCONTACTLINKERByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object CONTACTLINKERDto
# Call the service method
$result = $proxy.GetCONTACTLINKERByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
10. GetCONTACTLINKERById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_GetCONTACTLINKERById_InputMessage (soap:body, use = literal)
parameters type GetCONTACTLINKERById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: IContactService_GetCONTACTLINKERById_OutputMessage (soap:body, use = literal)
parameters type GetCONTACTLINKERByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetCONTACTLINKERByIdResult | Optional | CONTACTLINKERDto | GetCONTACTLINKERByIdResult 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 |
| ContactLinkerId | Optional | int | ContactLinkerId parameter (nillable) |
| LinkedContactId | Optional | int | LinkedContactId parameter (nillable) |
| LinkedDatabaseTable | Optional | string | LinkedDatabaseTable parameter (nillable) |
| LinkedDatabaseTableId | Optional | int | LinkedDatabaseTableId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetCONTACTLINKERById(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:GetCONTACTLINKERById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetCONTACTLINKERById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetCONTACTLINKERById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
11. GetContactById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_GetContactById_InputMessage (soap:body, use = literal)
parameters type GetContactById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| contactId | Optional | long | contactId parameter |
Output: IContactService_GetContactById_OutputMessage (soap:body, use = literal)
parameters type GetContactByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetContactByIdResult | Optional | ContactDto | GetContactByIdResult 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) |
| Address | Optional | string | Address parameter (nillable) |
| AlternativeEmailAddress | Optional | string | AlternativeEmailAddress parameter (nillable) |
| BeeperNumber | Optional | string | BeeperNumber parameter (nillable) |
| ClassTypeId | Optional | long | ClassTypeId parameter (nillable) |
| CommsMethod | Optional | int | CommsMethod parameter (nillable) |
| CommsPref | Optional | CommsPrefType | OptIn, OptOut |
| CommsPrefChangeBy | Optional | long | CommsPrefChangeBy parameter (nillable) |
| CommsPrefChangeDate | Optional | dateTime | CommsPrefChangeDate parameter (nillable) |
| ContactId | Optional | long | ContactId parameter (nillable) |
| CountryLibraryId | Optional | long | CountryLibraryId parameter (nillable) |
| DreamscapeObjectRefId | Optional | long | DreamscapeObjectRefId parameter (nillable) |
| EmailAddress | Optional | string | EmailAddress parameter (nillable) |
| FaxNumber | Optional | string | FaxNumber parameter (nillable) |
| FirstName | Optional | string | FirstName parameter (nillable) |
| HomeTelephoneNumber | Optional | string | HomeTelephoneNumber parameter (nillable) |
| JobTitle | Optional | string | JobTitle parameter (nillable) |
| KP_CAR_PARK | Optional | string | KP_CAR_PARK parameter (nillable) |
| KP_COMMENTS | Optional | string | KP_COMMENTS parameter (nillable) |
| KP_COMPANY | Optional | string | KP_COMPANY parameter (nillable) |
| KP_DEPARTUtc | Optional | dateTime | KP_DEPARTUtc parameter (nillable) |
| KP_DESK_NO | Optional | string | KP_DESK_NO parameter (nillable) |
| KP_DIRNO | Optional | int | KP_DIRNO parameter (nillable) |
| KP_DISABILITIES | Optional | unsignedByte | KP_DISABILITIES parameter (nillable) |
| KP_FAID | Optional | boolean | KP_FAID parameter (nillable) |
| KP_FAID_EXPIREUtc | Optional | dateTime | KP_FAID_EXPIREUtc parameter (nillable) |
| KP_FIRE_WARDEN | Optional | unsignedByte | KP_FIRE_WARDEN parameter (nillable) |
| KP_FKEY_BG_SEQ | Optional | int | KP_FKEY_BG_SEQ parameter (nillable) |
| KP_FKEY_DP_SEQ | Optional | int | KP_FKEY_DP_SEQ parameter (nillable) |
| KP_FKEY_DRT_SEQ | Optional | int | KP_FKEY_DRT_SEQ parameter (nillable) |
| KP_FKEY_DS_SEQ | Optional | int | KP_FKEY_DS_SEQ parameter (nillable) |
| KP_FKEY_ELE_SEQ | Optional | int | KP_FKEY_ELE_SEQ parameter (nillable) |
| KP_FKEY_EMPTYPE_SEQ | Optional | int | KP_FKEY_EMPTYPE_SEQ parameter (nillable) |
| KP_FKEY_FCC_SEQ | Optional | int | KP_FKEY_FCC_SEQ parameter (nillable) |
| KP_FKEY_FC_SEQ | Optional | int | KP_FKEY_FC_SEQ parameter (nillable) |
| KP_FKEY_GRADE_SEQ | Optional | int | KP_FKEY_GRADE_SEQ parameter (nillable) |
| KP_FKEY_KP_SEQ | Optional | int | KP_FKEY_KP_SEQ parameter (nillable) |
| KP_FKEY_LO_SEQ | Optional | int | KP_FKEY_LO_SEQ parameter (nillable) |
| KP_FKEY_POS_SEQ | Optional | int | KP_FKEY_POS_SEQ parameter (nillable) |
| KP_GRIDREF | Optional | string | KP_GRIDREF parameter (nillable) |
| KP_JOINEDUtc | Optional | dateTime | KP_JOINEDUtc parameter (nillable) |
| KP_KEY_NAME | Optional | string | KP_KEY_NAME parameter (nillable) |
| KP_REG1 | Optional | string | KP_REG1 parameter (nillable) |
| KP_REG2 | Optional | string | KP_REG2 parameter (nillable) |
| KP_SECNO | Optional | string | KP_SECNO parameter (nillable) |
| KP_SEC_EXPIREUtc | Optional | dateTime | KP_SEC_EXPIREUtc parameter (nillable) |
| KP_SEC_FKEY_DP_SEQ | Optional | int | KP_SEC_FKEY_DP_SEQ parameter (nillable) |
| KP_SPNEEDS | Optional | string | KP_SPNEEDS parameter (nillable) |
| KP_STAFF_TYPE | Optional | string | KP_STAFF_TYPE parameter (nillable) |
| KP_TEL_FAX | Optional | string | KP_TEL_FAX parameter (nillable) |
| LdapAccount | Optional | string | LdapAccount parameter (nillable) |
| MobileTelephoneNumber | Optional | string | MobileTelephoneNumber parameter (nillable) |
| OfficeTelephoneNumber | Optional | string | OfficeTelephoneNumber parameter (nillable) |
| OtherTelephoneNumber | Optional | string | OtherTelephoneNumber parameter (nillable) |
| PictureUrl | Optional | string | PictureUrl parameter (nillable) |
| Postcode | Optional | string | Postcode parameter (nillable) |
| StaffIdentifier | Optional | string | StaffIdentifier parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SupplierId | Optional | long | SupplierId parameter (nillable) |
| Surname | Optional | string | Surname parameter (nillable) |
| Title | Optional | string | Title parameter (nillable) |
| UserAccountId | Optional | long | UserAccountId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long contactId = 123;
// Call the service method
var response = client.GetContactById(sessionId, impersonateAccountId, contactId);
// 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:GetContactById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:contactId>123</bas:contactId>
</bas:GetContactById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$contactId = 123
# Call the service method
$result = $proxy.GetContactById($sessionId, $impersonateAccountId, $contactId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
12. GetContactClassById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_GetContactClassById_InputMessage (soap:body, use = literal)
parameters type GetContactClassById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| contactClassId | Optional | long | contactClassId parameter |
Output: IContactService_GetContactClassById_OutputMessage (soap:body, use = literal)
parameters type GetContactClassByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetContactClassByIdResult | Optional | ContactClassDto | GetContactClassByIdResult 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 |
| ContactClassId | Optional | long | ContactClassId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long contactClassId = 123;
// Call the service method
var response = client.GetContactClassById(sessionId, impersonateAccountId, contactClassId);
// 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:GetContactClassById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:contactClassId>123</bas:contactClassId>
</bas:GetContactClassById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$contactClassId = 123
# Call the service method
$result = $proxy.GetContactClassById($sessionId, $impersonateAccountId, $contactClassId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
13. GetContactsByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_GetContactsByDto_InputMessage (soap:body, use = literal)
parameters type GetContactsByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | ContactDto | 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) |
| Address | Optional | string | Address parameter (nillable) |
| AlternativeEmailAddress | Optional | string | AlternativeEmailAddress parameter (nillable) |
| BeeperNumber | Optional | string | BeeperNumber parameter (nillable) |
| ClassTypeId | Optional | long | ClassTypeId parameter (nillable) |
| CommsMethod | Optional | int | CommsMethod parameter (nillable) |
| CommsPref | Optional | CommsPrefType | OptIn, OptOut |
| CommsPrefChangeBy | Optional | long | CommsPrefChangeBy parameter (nillable) |
| CommsPrefChangeDate | Optional | dateTime | CommsPrefChangeDate parameter (nillable) |
| ContactId | Optional | long | ContactId parameter (nillable) |
| CountryLibraryId | Optional | long | CountryLibraryId parameter (nillable) |
| DreamscapeObjectRefId | Optional | long | DreamscapeObjectRefId parameter (nillable) |
| EmailAddress | Optional | string | EmailAddress parameter (nillable) |
| FaxNumber | Optional | string | FaxNumber parameter (nillable) |
| FirstName | Optional | string | FirstName parameter (nillable) |
| HomeTelephoneNumber | Optional | string | HomeTelephoneNumber parameter (nillable) |
| JobTitle | Optional | string | JobTitle parameter (nillable) |
| KP_CAR_PARK | Optional | string | KP_CAR_PARK parameter (nillable) |
| KP_COMMENTS | Optional | string | KP_COMMENTS parameter (nillable) |
| KP_COMPANY | Optional | string | KP_COMPANY parameter (nillable) |
| KP_DEPARTUtc | Optional | dateTime | KP_DEPARTUtc parameter (nillable) |
| KP_DESK_NO | Optional | string | KP_DESK_NO parameter (nillable) |
| KP_DIRNO | Optional | int | KP_DIRNO parameter (nillable) |
| KP_DISABILITIES | Optional | unsignedByte | KP_DISABILITIES parameter (nillable) |
| KP_FAID | Optional | boolean | KP_FAID parameter (nillable) |
| KP_FAID_EXPIREUtc | Optional | dateTime | KP_FAID_EXPIREUtc parameter (nillable) |
| KP_FIRE_WARDEN | Optional | unsignedByte | KP_FIRE_WARDEN parameter (nillable) |
| KP_FKEY_BG_SEQ | Optional | int | KP_FKEY_BG_SEQ parameter (nillable) |
| KP_FKEY_DP_SEQ | Optional | int | KP_FKEY_DP_SEQ parameter (nillable) |
| KP_FKEY_DRT_SEQ | Optional | int | KP_FKEY_DRT_SEQ parameter (nillable) |
| KP_FKEY_DS_SEQ | Optional | int | KP_FKEY_DS_SEQ parameter (nillable) |
| KP_FKEY_ELE_SEQ | Optional | int | KP_FKEY_ELE_SEQ parameter (nillable) |
| KP_FKEY_EMPTYPE_SEQ | Optional | int | KP_FKEY_EMPTYPE_SEQ parameter (nillable) |
| KP_FKEY_FCC_SEQ | Optional | int | KP_FKEY_FCC_SEQ parameter (nillable) |
| KP_FKEY_FC_SEQ | Optional | int | KP_FKEY_FC_SEQ parameter (nillable) |
| KP_FKEY_GRADE_SEQ | Optional | int | KP_FKEY_GRADE_SEQ parameter (nillable) |
| KP_FKEY_KP_SEQ | Optional | int | KP_FKEY_KP_SEQ parameter (nillable) |
| KP_FKEY_LO_SEQ | Optional | int | KP_FKEY_LO_SEQ parameter (nillable) |
| KP_FKEY_POS_SEQ | Optional | int | KP_FKEY_POS_SEQ parameter (nillable) |
| KP_GRIDREF | Optional | string | KP_GRIDREF parameter (nillable) |
| KP_JOINEDUtc | Optional | dateTime | KP_JOINEDUtc parameter (nillable) |
| KP_KEY_NAME | Optional | string | KP_KEY_NAME parameter (nillable) |
| KP_REG1 | Optional | string | KP_REG1 parameter (nillable) |
| KP_REG2 | Optional | string | KP_REG2 parameter (nillable) |
| KP_SECNO | Optional | string | KP_SECNO parameter (nillable) |
| KP_SEC_EXPIREUtc | Optional | dateTime | KP_SEC_EXPIREUtc parameter (nillable) |
| KP_SEC_FKEY_DP_SEQ | Optional | int | KP_SEC_FKEY_DP_SEQ parameter (nillable) |
| KP_SPNEEDS | Optional | string | KP_SPNEEDS parameter (nillable) |
| KP_STAFF_TYPE | Optional | string | KP_STAFF_TYPE parameter (nillable) |
| KP_TEL_FAX | Optional | string | KP_TEL_FAX parameter (nillable) |
| LdapAccount | Optional | string | LdapAccount parameter (nillable) |
| MobileTelephoneNumber | Optional | string | MobileTelephoneNumber parameter (nillable) |
| OfficeTelephoneNumber | Optional | string | OfficeTelephoneNumber parameter (nillable) |
| OtherTelephoneNumber | Optional | string | OtherTelephoneNumber parameter (nillable) |
| PictureUrl | Optional | string | PictureUrl parameter (nillable) |
| Postcode | Optional | string | Postcode parameter (nillable) |
| StaffIdentifier | Optional | string | StaffIdentifier parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SupplierId | Optional | long | SupplierId parameter (nillable) |
| Surname | Optional | string | Surname parameter (nillable) |
| Title | Optional | string | Title parameter (nillable) |
| UserAccountId | Optional | long | UserAccountId parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: IContactService_GetContactsByDto_OutputMessage (soap:body, use = literal)
parameters type GetContactsByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetContactsByDtoResult | Optional | ArrayOfContactDto | GetContactsByDtoResult parameter (nillable) |
| ContactDto | Optional | ContactDto | ContactDto 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) |
| Address | Optional | string | Address parameter (nillable) |
| AlternativeEmailAddress | Optional | string | AlternativeEmailAddress parameter (nillable) |
| BeeperNumber | Optional | string | BeeperNumber parameter (nillable) |
| ClassTypeId | Optional | long | ClassTypeId parameter (nillable) |
| CommsMethod | Optional | int | CommsMethod parameter (nillable) |
| CommsPref | Optional | CommsPrefType | OptIn, OptOut |
| CommsPrefChangeBy | Optional | long | CommsPrefChangeBy parameter (nillable) |
| CommsPrefChangeDate | Optional | dateTime | CommsPrefChangeDate parameter (nillable) |
| ContactId | Optional | long | ContactId parameter (nillable) |
| CountryLibraryId | Optional | long | CountryLibraryId parameter (nillable) |
| DreamscapeObjectRefId | Optional | long | DreamscapeObjectRefId parameter (nillable) |
| EmailAddress | Optional | string | EmailAddress parameter (nillable) |
| FaxNumber | Optional | string | FaxNumber parameter (nillable) |
| FirstName | Optional | string | FirstName parameter (nillable) |
| HomeTelephoneNumber | Optional | string | HomeTelephoneNumber parameter (nillable) |
| JobTitle | Optional | string | JobTitle parameter (nillable) |
| KP_CAR_PARK | Optional | string | KP_CAR_PARK parameter (nillable) |
| KP_COMMENTS | Optional | string | KP_COMMENTS parameter (nillable) |
| KP_COMPANY | Optional | string | KP_COMPANY parameter (nillable) |
| KP_DEPARTUtc | Optional | dateTime | KP_DEPARTUtc parameter (nillable) |
| KP_DESK_NO | Optional | string | KP_DESK_NO parameter (nillable) |
| KP_DIRNO | Optional | int | KP_DIRNO parameter (nillable) |
| KP_DISABILITIES | Optional | unsignedByte | KP_DISABILITIES parameter (nillable) |
| KP_FAID | Optional | boolean | KP_FAID parameter (nillable) |
| KP_FAID_EXPIREUtc | Optional | dateTime | KP_FAID_EXPIREUtc parameter (nillable) |
| KP_FIRE_WARDEN | Optional | unsignedByte | KP_FIRE_WARDEN parameter (nillable) |
| KP_FKEY_BG_SEQ | Optional | int | KP_FKEY_BG_SEQ parameter (nillable) |
| KP_FKEY_DP_SEQ | Optional | int | KP_FKEY_DP_SEQ parameter (nillable) |
| KP_FKEY_DRT_SEQ | Optional | int | KP_FKEY_DRT_SEQ parameter (nillable) |
| KP_FKEY_DS_SEQ | Optional | int | KP_FKEY_DS_SEQ parameter (nillable) |
| KP_FKEY_ELE_SEQ | Optional | int | KP_FKEY_ELE_SEQ parameter (nillable) |
| KP_FKEY_EMPTYPE_SEQ | Optional | int | KP_FKEY_EMPTYPE_SEQ parameter (nillable) |
| KP_FKEY_FCC_SEQ | Optional | int | KP_FKEY_FCC_SEQ parameter (nillable) |
| KP_FKEY_FC_SEQ | Optional | int | KP_FKEY_FC_SEQ parameter (nillable) |
| KP_FKEY_GRADE_SEQ | Optional | int | KP_FKEY_GRADE_SEQ parameter (nillable) |
| KP_FKEY_KP_SEQ | Optional | int | KP_FKEY_KP_SEQ parameter (nillable) |
| KP_FKEY_LO_SEQ | Optional | int | KP_FKEY_LO_SEQ parameter (nillable) |
| KP_FKEY_POS_SEQ | Optional | int | KP_FKEY_POS_SEQ parameter (nillable) |
| KP_GRIDREF | Optional | string | KP_GRIDREF parameter (nillable) |
| KP_JOINEDUtc | Optional | dateTime | KP_JOINEDUtc parameter (nillable) |
| KP_KEY_NAME | Optional | string | KP_KEY_NAME parameter (nillable) |
| KP_REG1 | Optional | string | KP_REG1 parameter (nillable) |
| KP_REG2 | Optional | string | KP_REG2 parameter (nillable) |
| KP_SECNO | Optional | string | KP_SECNO parameter (nillable) |
| KP_SEC_EXPIREUtc | Optional | dateTime | KP_SEC_EXPIREUtc parameter (nillable) |
| KP_SEC_FKEY_DP_SEQ | Optional | int | KP_SEC_FKEY_DP_SEQ parameter (nillable) |
| KP_SPNEEDS | Optional | string | KP_SPNEEDS parameter (nillable) |
| KP_STAFF_TYPE | Optional | string | KP_STAFF_TYPE parameter (nillable) |
| KP_TEL_FAX | Optional | string | KP_TEL_FAX parameter (nillable) |
| LdapAccount | Optional | string | LdapAccount parameter (nillable) |
| MobileTelephoneNumber | Optional | string | MobileTelephoneNumber parameter (nillable) |
| OfficeTelephoneNumber | Optional | string | OfficeTelephoneNumber parameter (nillable) |
| OtherTelephoneNumber | Optional | string | OtherTelephoneNumber parameter (nillable) |
| PictureUrl | Optional | string | PictureUrl parameter (nillable) |
| Postcode | Optional | string | Postcode parameter (nillable) |
| StaffIdentifier | Optional | string | StaffIdentifier parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SupplierId | Optional | long | SupplierId parameter (nillable) |
| Surname | Optional | string | Surname parameter (nillable) |
| Title | Optional | string | Title parameter (nillable) |
| UserAccountId | Optional | long | UserAccountId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new ContactDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetContactsByDto(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:GetContactsByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- ContactDto properties here -->
</bas:dto>
</bas:GetContactsByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object ContactDto
# Call the service method
$result = $proxy.GetContactsByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
14. GetF_DESK_STATUSByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_GetF_DESK_STATUSByDto_InputMessage (soap:body, use = literal)
parameters type GetF_DESK_STATUSByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | F_DESK_STATUSDto | 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 |
| DeskStatusCode | Optional | string | DeskStatusCode parameter (nillable) |
| DeskStatusDescription | Optional | string | DeskStatusDescription parameter (nillable) |
| DeskStatusId | Optional | int | DeskStatusId parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: IContactService_GetF_DESK_STATUSByDto_OutputMessage (soap:body, use = literal)
parameters type GetF_DESK_STATUSByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetF_DESK_STATUSByDtoResult | Optional | ArrayOfF_DESK_STATUSDto | GetF_DESK_STATUSByDtoResult parameter (nillable) |
| F_DESK_STATUSDto | Optional | F_DESK_STATUSDto | F_DESK_STATUSDto 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 |
| DeskStatusCode | Optional | string | DeskStatusCode parameter (nillable) |
| DeskStatusDescription | Optional | string | DeskStatusDescription parameter (nillable) |
| DeskStatusId | Optional | int | DeskStatusId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new F_DESK_STATUSDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetF_DESK_STATUSByDto(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:GetF_DESK_STATUSByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- F_DESK_STATUSDto properties here -->
</bas:dto>
</bas:GetF_DESK_STATUSByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object F_DESK_STATUSDto
# Call the service method
$result = $proxy.GetF_DESK_STATUSByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
15. GetF_DESK_STATUSById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_GetF_DESK_STATUSById_InputMessage (soap:body, use = literal)
parameters type GetF_DESK_STATUSById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| deskStatusId | Optional | long | deskStatusId parameter |
Output: IContactService_GetF_DESK_STATUSById_OutputMessage (soap:body, use = literal)
parameters type GetF_DESK_STATUSByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetF_DESK_STATUSByIdResult | Optional | F_DESK_STATUSDto | GetF_DESK_STATUSByIdResult 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 |
| DeskStatusCode | Optional | string | DeskStatusCode parameter (nillable) |
| DeskStatusDescription | Optional | string | DeskStatusDescription parameter (nillable) |
| DeskStatusId | Optional | int | DeskStatusId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long deskStatusId = 123;
// Call the service method
var response = client.GetF_DESK_STATUSById(sessionId, impersonateAccountId, deskStatusId);
// 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:GetF_DESK_STATUSById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:deskStatusId>123</bas:deskStatusId>
</bas:GetF_DESK_STATUSById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$deskStatusId = 123
# Call the service method
$result = $proxy.GetF_DESK_STATUSById($sessionId, $impersonateAccountId, $deskStatusId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
16. GetF_EMPTYPEByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_GetF_EMPTYPEByDto_InputMessage (soap:body, use = literal)
parameters type GetF_EMPTYPEByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | F_EMPTYPEDto | 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 |
| EmployeeTypeCode | Optional | string | EmployeeTypeCode parameter (nillable) |
| EmployeeTypeDescription | Optional | string | EmployeeTypeDescription parameter (nillable) |
| EmployeeTypeId | Optional | int | EmployeeTypeId parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: IContactService_GetF_EMPTYPEByDto_OutputMessage (soap:body, use = literal)
parameters type GetF_EMPTYPEByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetF_EMPTYPEByDtoResult | Optional | ArrayOfF_EMPTYPEDto | GetF_EMPTYPEByDtoResult parameter (nillable) |
| F_EMPTYPEDto | Optional | F_EMPTYPEDto | F_EMPTYPEDto 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 |
| EmployeeTypeCode | Optional | string | EmployeeTypeCode parameter (nillable) |
| EmployeeTypeDescription | Optional | string | EmployeeTypeDescription parameter (nillable) |
| EmployeeTypeId | Optional | int | EmployeeTypeId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new F_EMPTYPEDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetF_EMPTYPEByDto(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:GetF_EMPTYPEByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- F_EMPTYPEDto properties here -->
</bas:dto>
</bas:GetF_EMPTYPEByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object F_EMPTYPEDto
# Call the service method
$result = $proxy.GetF_EMPTYPEByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
17. GetF_EMPTYPEById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_GetF_EMPTYPEById_InputMessage (soap:body, use = literal)
parameters type GetF_EMPTYPEById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: IContactService_GetF_EMPTYPEById_OutputMessage (soap:body, use = literal)
parameters type GetF_EMPTYPEByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetF_EMPTYPEByIdResult | Optional | F_EMPTYPEDto | GetF_EMPTYPEByIdResult 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 |
| EmployeeTypeCode | Optional | string | EmployeeTypeCode parameter (nillable) |
| EmployeeTypeDescription | Optional | string | EmployeeTypeDescription parameter (nillable) |
| EmployeeTypeId | Optional | int | EmployeeTypeId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetF_EMPTYPEById(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:GetF_EMPTYPEById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetF_EMPTYPEById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetF_EMPTYPEById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
18. GetLinkedContacts
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_GetLinkedContacts_InputMessage (soap:body, use = literal)
parameters type GetLinkedContacts
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| linkedDatabaseTable | Optional | string | linkedDatabaseTable parameter (nillable) |
| linkedDatabaseTableId | Optional | long | linkedDatabaseTableId parameter |
Output: IContactService_GetLinkedContacts_OutputMessage (soap:body, use = literal)
parameters type GetLinkedContactsResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetLinkedContactsResult | Optional | ArrayOfContactDto | GetLinkedContactsResult parameter (nillable) |
| ContactDto | Optional | ContactDto | ContactDto 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) |
| Address | Optional | string | Address parameter (nillable) |
| AlternativeEmailAddress | Optional | string | AlternativeEmailAddress parameter (nillable) |
| BeeperNumber | Optional | string | BeeperNumber parameter (nillable) |
| ClassTypeId | Optional | long | ClassTypeId parameter (nillable) |
| CommsMethod | Optional | int | CommsMethod parameter (nillable) |
| CommsPref | Optional | CommsPrefType | OptIn, OptOut |
| CommsPrefChangeBy | Optional | long | CommsPrefChangeBy parameter (nillable) |
| CommsPrefChangeDate | Optional | dateTime | CommsPrefChangeDate parameter (nillable) |
| ContactId | Optional | long | ContactId parameter (nillable) |
| CountryLibraryId | Optional | long | CountryLibraryId parameter (nillable) |
| DreamscapeObjectRefId | Optional | long | DreamscapeObjectRefId parameter (nillable) |
| EmailAddress | Optional | string | EmailAddress parameter (nillable) |
| FaxNumber | Optional | string | FaxNumber parameter (nillable) |
| FirstName | Optional | string | FirstName parameter (nillable) |
| HomeTelephoneNumber | Optional | string | HomeTelephoneNumber parameter (nillable) |
| JobTitle | Optional | string | JobTitle parameter (nillable) |
| KP_CAR_PARK | Optional | string | KP_CAR_PARK parameter (nillable) |
| KP_COMMENTS | Optional | string | KP_COMMENTS parameter (nillable) |
| KP_COMPANY | Optional | string | KP_COMPANY parameter (nillable) |
| KP_DEPARTUtc | Optional | dateTime | KP_DEPARTUtc parameter (nillable) |
| KP_DESK_NO | Optional | string | KP_DESK_NO parameter (nillable) |
| KP_DIRNO | Optional | int | KP_DIRNO parameter (nillable) |
| KP_DISABILITIES | Optional | unsignedByte | KP_DISABILITIES parameter (nillable) |
| KP_FAID | Optional | boolean | KP_FAID parameter (nillable) |
| KP_FAID_EXPIREUtc | Optional | dateTime | KP_FAID_EXPIREUtc parameter (nillable) |
| KP_FIRE_WARDEN | Optional | unsignedByte | KP_FIRE_WARDEN parameter (nillable) |
| KP_FKEY_BG_SEQ | Optional | int | KP_FKEY_BG_SEQ parameter (nillable) |
| KP_FKEY_DP_SEQ | Optional | int | KP_FKEY_DP_SEQ parameter (nillable) |
| KP_FKEY_DRT_SEQ | Optional | int | KP_FKEY_DRT_SEQ parameter (nillable) |
| KP_FKEY_DS_SEQ | Optional | int | KP_FKEY_DS_SEQ parameter (nillable) |
| KP_FKEY_ELE_SEQ | Optional | int | KP_FKEY_ELE_SEQ parameter (nillable) |
| KP_FKEY_EMPTYPE_SEQ | Optional | int | KP_FKEY_EMPTYPE_SEQ parameter (nillable) |
| KP_FKEY_FCC_SEQ | Optional | int | KP_FKEY_FCC_SEQ parameter (nillable) |
| KP_FKEY_FC_SEQ | Optional | int | KP_FKEY_FC_SEQ parameter (nillable) |
| KP_FKEY_GRADE_SEQ | Optional | int | KP_FKEY_GRADE_SEQ parameter (nillable) |
| KP_FKEY_KP_SEQ | Optional | int | KP_FKEY_KP_SEQ parameter (nillable) |
| KP_FKEY_LO_SEQ | Optional | int | KP_FKEY_LO_SEQ parameter (nillable) |
| KP_FKEY_POS_SEQ | Optional | int | KP_FKEY_POS_SEQ parameter (nillable) |
| KP_GRIDREF | Optional | string | KP_GRIDREF parameter (nillable) |
| KP_JOINEDUtc | Optional | dateTime | KP_JOINEDUtc parameter (nillable) |
| KP_KEY_NAME | Optional | string | KP_KEY_NAME parameter (nillable) |
| KP_REG1 | Optional | string | KP_REG1 parameter (nillable) |
| KP_REG2 | Optional | string | KP_REG2 parameter (nillable) |
| KP_SECNO | Optional | string | KP_SECNO parameter (nillable) |
| KP_SEC_EXPIREUtc | Optional | dateTime | KP_SEC_EXPIREUtc parameter (nillable) |
| KP_SEC_FKEY_DP_SEQ | Optional | int | KP_SEC_FKEY_DP_SEQ parameter (nillable) |
| KP_SPNEEDS | Optional | string | KP_SPNEEDS parameter (nillable) |
| KP_STAFF_TYPE | Optional | string | KP_STAFF_TYPE parameter (nillable) |
| KP_TEL_FAX | Optional | string | KP_TEL_FAX parameter (nillable) |
| LdapAccount | Optional | string | LdapAccount parameter (nillable) |
| MobileTelephoneNumber | Optional | string | MobileTelephoneNumber parameter (nillable) |
| OfficeTelephoneNumber | Optional | string | OfficeTelephoneNumber parameter (nillable) |
| OtherTelephoneNumber | Optional | string | OtherTelephoneNumber parameter (nillable) |
| PictureUrl | Optional | string | PictureUrl parameter (nillable) |
| Postcode | Optional | string | Postcode parameter (nillable) |
| StaffIdentifier | Optional | string | StaffIdentifier parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SupplierId | Optional | long | SupplierId parameter (nillable) |
| Surname | Optional | string | Surname parameter (nillable) |
| Title | Optional | string | Title parameter (nillable) |
| UserAccountId | Optional | long | UserAccountId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
string linkedDatabaseTable = "your_value_here";
// Call the service method
var response = client.GetLinkedContacts(sessionId, impersonateAccountId, linkedDatabaseTable);
// 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:GetLinkedContacts>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:linkedDatabaseTable>sample_value</bas:linkedDatabaseTable>
</bas:GetLinkedContacts>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$linkedDatabaseTable = "your_value_here"
# Call the service method
$result = $proxy.GetLinkedContacts($sessionId, $impersonateAccountId, $linkedDatabaseTable)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
19. Get_x0020_Contacts_x0020_by_x0020_CountryId
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_Get_x0020_Contacts_x0020_by_x0020_CountryId_InputMessage (soap:body, use = literal)
parameters type Get_x0020_Contacts_x0020_by_x0020_CountryId
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| countryId | Optional | long | countryId parameter |
Output: IContactService_Get_x0020_Contacts_x0020_by_x0020_CountryId_OutputMessage (soap:body, use = literal)
parameters type Get_x0020_Contacts_x0020_by_x0020_CountryIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Get_x0020_Contacts_x0020_by_x0020_CountryIdResult | Optional | ArrayOfContactDto | Get_x0020_Contacts_x0020_by_x0020_CountryIdResult parameter (nillable) |
| ContactDto | Optional | ContactDto | ContactDto 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) |
| Address | Optional | string | Address parameter (nillable) |
| AlternativeEmailAddress | Optional | string | AlternativeEmailAddress parameter (nillable) |
| BeeperNumber | Optional | string | BeeperNumber parameter (nillable) |
| ClassTypeId | Optional | long | ClassTypeId parameter (nillable) |
| CommsMethod | Optional | int | CommsMethod parameter (nillable) |
| CommsPref | Optional | CommsPrefType | OptIn, OptOut |
| CommsPrefChangeBy | Optional | long | CommsPrefChangeBy parameter (nillable) |
| CommsPrefChangeDate | Optional | dateTime | CommsPrefChangeDate parameter (nillable) |
| ContactId | Optional | long | ContactId parameter (nillable) |
| CountryLibraryId | Optional | long | CountryLibraryId parameter (nillable) |
| DreamscapeObjectRefId | Optional | long | DreamscapeObjectRefId parameter (nillable) |
| EmailAddress | Optional | string | EmailAddress parameter (nillable) |
| FaxNumber | Optional | string | FaxNumber parameter (nillable) |
| FirstName | Optional | string | FirstName parameter (nillable) |
| HomeTelephoneNumber | Optional | string | HomeTelephoneNumber parameter (nillable) |
| JobTitle | Optional | string | JobTitle parameter (nillable) |
| KP_CAR_PARK | Optional | string | KP_CAR_PARK parameter (nillable) |
| KP_COMMENTS | Optional | string | KP_COMMENTS parameter (nillable) |
| KP_COMPANY | Optional | string | KP_COMPANY parameter (nillable) |
| KP_DEPARTUtc | Optional | dateTime | KP_DEPARTUtc parameter (nillable) |
| KP_DESK_NO | Optional | string | KP_DESK_NO parameter (nillable) |
| KP_DIRNO | Optional | int | KP_DIRNO parameter (nillable) |
| KP_DISABILITIES | Optional | unsignedByte | KP_DISABILITIES parameter (nillable) |
| KP_FAID | Optional | boolean | KP_FAID parameter (nillable) |
| KP_FAID_EXPIREUtc | Optional | dateTime | KP_FAID_EXPIREUtc parameter (nillable) |
| KP_FIRE_WARDEN | Optional | unsignedByte | KP_FIRE_WARDEN parameter (nillable) |
| KP_FKEY_BG_SEQ | Optional | int | KP_FKEY_BG_SEQ parameter (nillable) |
| KP_FKEY_DP_SEQ | Optional | int | KP_FKEY_DP_SEQ parameter (nillable) |
| KP_FKEY_DRT_SEQ | Optional | int | KP_FKEY_DRT_SEQ parameter (nillable) |
| KP_FKEY_DS_SEQ | Optional | int | KP_FKEY_DS_SEQ parameter (nillable) |
| KP_FKEY_ELE_SEQ | Optional | int | KP_FKEY_ELE_SEQ parameter (nillable) |
| KP_FKEY_EMPTYPE_SEQ | Optional | int | KP_FKEY_EMPTYPE_SEQ parameter (nillable) |
| KP_FKEY_FCC_SEQ | Optional | int | KP_FKEY_FCC_SEQ parameter (nillable) |
| KP_FKEY_FC_SEQ | Optional | int | KP_FKEY_FC_SEQ parameter (nillable) |
| KP_FKEY_GRADE_SEQ | Optional | int | KP_FKEY_GRADE_SEQ parameter (nillable) |
| KP_FKEY_KP_SEQ | Optional | int | KP_FKEY_KP_SEQ parameter (nillable) |
| KP_FKEY_LO_SEQ | Optional | int | KP_FKEY_LO_SEQ parameter (nillable) |
| KP_FKEY_POS_SEQ | Optional | int | KP_FKEY_POS_SEQ parameter (nillable) |
| KP_GRIDREF | Optional | string | KP_GRIDREF parameter (nillable) |
| KP_JOINEDUtc | Optional | dateTime | KP_JOINEDUtc parameter (nillable) |
| KP_KEY_NAME | Optional | string | KP_KEY_NAME parameter (nillable) |
| KP_REG1 | Optional | string | KP_REG1 parameter (nillable) |
| KP_REG2 | Optional | string | KP_REG2 parameter (nillable) |
| KP_SECNO | Optional | string | KP_SECNO parameter (nillable) |
| KP_SEC_EXPIREUtc | Optional | dateTime | KP_SEC_EXPIREUtc parameter (nillable) |
| KP_SEC_FKEY_DP_SEQ | Optional | int | KP_SEC_FKEY_DP_SEQ parameter (nillable) |
| KP_SPNEEDS | Optional | string | KP_SPNEEDS parameter (nillable) |
| KP_STAFF_TYPE | Optional | string | KP_STAFF_TYPE parameter (nillable) |
| KP_TEL_FAX | Optional | string | KP_TEL_FAX parameter (nillable) |
| LdapAccount | Optional | string | LdapAccount parameter (nillable) |
| MobileTelephoneNumber | Optional | string | MobileTelephoneNumber parameter (nillable) |
| OfficeTelephoneNumber | Optional | string | OfficeTelephoneNumber parameter (nillable) |
| OtherTelephoneNumber | Optional | string | OtherTelephoneNumber parameter (nillable) |
| PictureUrl | Optional | string | PictureUrl parameter (nillable) |
| Postcode | Optional | string | Postcode parameter (nillable) |
| StaffIdentifier | Optional | string | StaffIdentifier parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SupplierId | Optional | long | SupplierId parameter (nillable) |
| Surname | Optional | string | Surname parameter (nillable) |
| Title | Optional | string | Title parameter (nillable) |
| UserAccountId | Optional | long | UserAccountId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long countryId = 123;
// Call the service method
var response = client.Get_x0020_Contacts_x0020_by_x0020_CountryId(sessionId, impersonateAccountId, countryId);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:Get_x0020_Contacts_x0020_by_x0020_CountryId>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:countryId>123</bas:countryId>
</bas:Get_x0020_Contacts_x0020_by_x0020_CountryId>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$countryId = 123
# Call the service method
$result = $proxy.Get_x0020_Contacts_x0020_by_x0020_CountryId($sessionId, $impersonateAccountId, $countryId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
20. UpdateCONTACTLINKER
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_UpdateCONTACTLINKER_InputMessage (soap:body, use = literal)
parameters type UpdateCONTACTLINKER
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | CONTACTLINKERDto | 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 |
| ContactLinkerId | Optional | int | ContactLinkerId parameter (nillable) |
| LinkedContactId | Optional | int | LinkedContactId parameter (nillable) |
| LinkedDatabaseTable | Optional | string | LinkedDatabaseTable parameter (nillable) |
| LinkedDatabaseTableId | Optional | int | LinkedDatabaseTableId parameter (nillable) |
Output: IContactService_UpdateCONTACTLINKER_OutputMessage (soap:body, use = literal)
parameters type UpdateCONTACTLINKERResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateCONTACTLINKERResult | Optional | CONTACTLINKERDto | UpdateCONTACTLINKERResult 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 |
| ContactLinkerId | Optional | int | ContactLinkerId parameter (nillable) |
| LinkedContactId | Optional | int | LinkedContactId parameter (nillable) |
| LinkedDatabaseTable | Optional | string | LinkedDatabaseTable parameter (nillable) |
| LinkedDatabaseTableId | Optional | int | LinkedDatabaseTableId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new CONTACTLINKERDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateCONTACTLINKER(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:UpdateCONTACTLINKER>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- CONTACTLINKERDto properties here -->
</bas:dto>
</bas:UpdateCONTACTLINKER>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object CONTACTLINKERDto
# Call the service method
$result = $proxy.UpdateCONTACTLINKER($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
21. UpdateContact
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_UpdateContact_InputMessage (soap:body, use = literal)
parameters type UpdateContact
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| contactDto | Optional | ContactDto | contactDto 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) |
| Address | Optional | string | Address parameter (nillable) |
| AlternativeEmailAddress | Optional | string | AlternativeEmailAddress parameter (nillable) |
| BeeperNumber | Optional | string | BeeperNumber parameter (nillable) |
| ClassTypeId | Optional | long | ClassTypeId parameter (nillable) |
| CommsMethod | Optional | int | CommsMethod parameter (nillable) |
| CommsPref | Optional | CommsPrefType | OptIn, OptOut |
| CommsPrefChangeBy | Optional | long | CommsPrefChangeBy parameter (nillable) |
| CommsPrefChangeDate | Optional | dateTime | CommsPrefChangeDate parameter (nillable) |
| ContactId | Optional | long | ContactId parameter (nillable) |
| CountryLibraryId | Optional | long | CountryLibraryId parameter (nillable) |
| DreamscapeObjectRefId | Optional | long | DreamscapeObjectRefId parameter (nillable) |
| EmailAddress | Optional | string | EmailAddress parameter (nillable) |
| FaxNumber | Optional | string | FaxNumber parameter (nillable) |
| FirstName | Optional | string | FirstName parameter (nillable) |
| HomeTelephoneNumber | Optional | string | HomeTelephoneNumber parameter (nillable) |
| JobTitle | Optional | string | JobTitle parameter (nillable) |
| KP_CAR_PARK | Optional | string | KP_CAR_PARK parameter (nillable) |
| KP_COMMENTS | Optional | string | KP_COMMENTS parameter (nillable) |
| KP_COMPANY | Optional | string | KP_COMPANY parameter (nillable) |
| KP_DEPARTUtc | Optional | dateTime | KP_DEPARTUtc parameter (nillable) |
| KP_DESK_NO | Optional | string | KP_DESK_NO parameter (nillable) |
| KP_DIRNO | Optional | int | KP_DIRNO parameter (nillable) |
| KP_DISABILITIES | Optional | unsignedByte | KP_DISABILITIES parameter (nillable) |
| KP_FAID | Optional | boolean | KP_FAID parameter (nillable) |
| KP_FAID_EXPIREUtc | Optional | dateTime | KP_FAID_EXPIREUtc parameter (nillable) |
| KP_FIRE_WARDEN | Optional | unsignedByte | KP_FIRE_WARDEN parameter (nillable) |
| KP_FKEY_BG_SEQ | Optional | int | KP_FKEY_BG_SEQ parameter (nillable) |
| KP_FKEY_DP_SEQ | Optional | int | KP_FKEY_DP_SEQ parameter (nillable) |
| KP_FKEY_DRT_SEQ | Optional | int | KP_FKEY_DRT_SEQ parameter (nillable) |
| KP_FKEY_DS_SEQ | Optional | int | KP_FKEY_DS_SEQ parameter (nillable) |
| KP_FKEY_ELE_SEQ | Optional | int | KP_FKEY_ELE_SEQ parameter (nillable) |
| KP_FKEY_EMPTYPE_SEQ | Optional | int | KP_FKEY_EMPTYPE_SEQ parameter (nillable) |
| KP_FKEY_FCC_SEQ | Optional | int | KP_FKEY_FCC_SEQ parameter (nillable) |
| KP_FKEY_FC_SEQ | Optional | int | KP_FKEY_FC_SEQ parameter (nillable) |
| KP_FKEY_GRADE_SEQ | Optional | int | KP_FKEY_GRADE_SEQ parameter (nillable) |
| KP_FKEY_KP_SEQ | Optional | int | KP_FKEY_KP_SEQ parameter (nillable) |
| KP_FKEY_LO_SEQ | Optional | int | KP_FKEY_LO_SEQ parameter (nillable) |
| KP_FKEY_POS_SEQ | Optional | int | KP_FKEY_POS_SEQ parameter (nillable) |
| KP_GRIDREF | Optional | string | KP_GRIDREF parameter (nillable) |
| KP_JOINEDUtc | Optional | dateTime | KP_JOINEDUtc parameter (nillable) |
| KP_KEY_NAME | Optional | string | KP_KEY_NAME parameter (nillable) |
| KP_REG1 | Optional | string | KP_REG1 parameter (nillable) |
| KP_REG2 | Optional | string | KP_REG2 parameter (nillable) |
| KP_SECNO | Optional | string | KP_SECNO parameter (nillable) |
| KP_SEC_EXPIREUtc | Optional | dateTime | KP_SEC_EXPIREUtc parameter (nillable) |
| KP_SEC_FKEY_DP_SEQ | Optional | int | KP_SEC_FKEY_DP_SEQ parameter (nillable) |
| KP_SPNEEDS | Optional | string | KP_SPNEEDS parameter (nillable) |
| KP_STAFF_TYPE | Optional | string | KP_STAFF_TYPE parameter (nillable) |
| KP_TEL_FAX | Optional | string | KP_TEL_FAX parameter (nillable) |
| LdapAccount | Optional | string | LdapAccount parameter (nillable) |
| MobileTelephoneNumber | Optional | string | MobileTelephoneNumber parameter (nillable) |
| OfficeTelephoneNumber | Optional | string | OfficeTelephoneNumber parameter (nillable) |
| OtherTelephoneNumber | Optional | string | OtherTelephoneNumber parameter (nillable) |
| PictureUrl | Optional | string | PictureUrl parameter (nillable) |
| Postcode | Optional | string | Postcode parameter (nillable) |
| StaffIdentifier | Optional | string | StaffIdentifier parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| SupplierId | Optional | long | SupplierId parameter (nillable) |
| Surname | Optional | string | Surname parameter (nillable) |
| Title | Optional | string | Title parameter (nillable) |
| UserAccountId | Optional | long | UserAccountId parameter (nillable) |
Output: IContactService_UpdateContact_OutputMessage (soap:body, use = literal)
parameters type UpdateContactResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateContactResult | Optional | long | UpdateContactResult parameter |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var contactDto = new ContactDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateContact(sessionId, impersonateAccountId, contactDto);
// 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:UpdateContact>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:contactDto>
<!-- ContactDto properties here -->
</bas:contactDto>
</bas:UpdateContact>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$contactDto = New-Object ContactDto
# Call the service method
$result = $proxy.UpdateContact($sessionId, $impersonateAccountId, $contactDto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
22. UpdateContactClass
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_UpdateContactClass_InputMessage (soap:body, use = literal)
parameters type UpdateContactClass
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| contactClassDto | Optional | ContactClassDto | contactClassDto 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 |
| ContactClassId | Optional | long | ContactClassId parameter (nillable) |
| Description | Optional | string | Description parameter (nillable) |
Output: IContactService_UpdateContactClass_OutputMessage (soap:body, use = literal)
parameters type UpdateContactClassResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateContactClassResult | Optional | long | UpdateContactClassResult parameter |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var contactClassDto = new ContactClassDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateContactClass(sessionId, impersonateAccountId, contactClassDto);
// 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:UpdateContactClass>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:contactClassDto>
<!-- ContactClassDto properties here -->
</bas:contactClassDto>
</bas:UpdateContactClass>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$contactClassDto = New-Object ContactClassDto
# Call the service method
$result = $proxy.UpdateContactClass($sessionId, $impersonateAccountId, $contactClassDto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
23. UpdateF_DESK_STATUS
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_UpdateF_DESK_STATUS_InputMessage (soap:body, use = literal)
parameters type UpdateF_DESK_STATUS
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | F_DESK_STATUSDto | 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 |
| DeskStatusCode | Optional | string | DeskStatusCode parameter (nillable) |
| DeskStatusDescription | Optional | string | DeskStatusDescription parameter (nillable) |
| DeskStatusId | Optional | int | DeskStatusId parameter (nillable) |
Output: IContactService_UpdateF_DESK_STATUS_OutputMessage (soap:body, use = literal)
parameters type UpdateF_DESK_STATUSResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateF_DESK_STATUSResult | Optional | F_DESK_STATUSDto | UpdateF_DESK_STATUSResult 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 |
| DeskStatusCode | Optional | string | DeskStatusCode parameter (nillable) |
| DeskStatusDescription | Optional | string | DeskStatusDescription parameter (nillable) |
| DeskStatusId | Optional | int | DeskStatusId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new F_DESK_STATUSDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateF_DESK_STATUS(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:UpdateF_DESK_STATUS>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- F_DESK_STATUSDto properties here -->
</bas:dto>
</bas:UpdateF_DESK_STATUS>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object F_DESK_STATUSDto
# Call the service method
$result = $proxy.UpdateF_DESK_STATUS($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
24. UpdateF_EMPTYPE
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IContactService_UpdateF_EMPTYPE_InputMessage (soap:body, use = literal)
parameters type UpdateF_EMPTYPE
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | F_EMPTYPEDto | 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 |
| EmployeeTypeCode | Optional | string | EmployeeTypeCode parameter (nillable) |
| EmployeeTypeDescription | Optional | string | EmployeeTypeDescription parameter (nillable) |
| EmployeeTypeId | Optional | int | EmployeeTypeId parameter (nillable) |
Output: IContactService_UpdateF_EMPTYPE_OutputMessage (soap:body, use = literal)
parameters type UpdateF_EMPTYPEResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateF_EMPTYPEResult | Optional | F_EMPTYPEDto | UpdateF_EMPTYPEResult 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 |
| EmployeeTypeCode | Optional | string | EmployeeTypeCode parameter (nillable) |
| EmployeeTypeDescription | Optional | string | EmployeeTypeDescription parameter (nillable) |
| EmployeeTypeId | Optional | int | EmployeeTypeId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ContactServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new F_EMPTYPEDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateF_EMPTYPE(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:UpdateF_EMPTYPE>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- F_EMPTYPEDto properties here -->
</bas:dto>
</bas:UpdateF_EMPTYPE>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ContactService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object F_EMPTYPEDto
# Call the service method
$result = $proxy.UpdateF_EMPTYPE($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}