SWI Eligibility Compatibility Matrix Operations
For a list of operations associated with this REST API service, see the following table.
| Name | Description |
|---|---|
|
InsertOrUpdate |
Creates or updates an eligibility or compatibility matrix. |
|
Update |
Updates an existing eligibility or compatibility matrix. |
|
Synchronize |
Synchronizes an eligibility or compatibility matrix. |
|
QueryById |
Queries for an existing eligibility or compatibility matrix using the Row ID. |
|
QueryByExample |
Queries for an existing eligibility or compatibility matrix using the QueryByExample method. |
|
Delete |
Deletes an eligibility or compatibility matrix. |
|
Insert |
Creates an eligibility or compatibility matrix. |
Message Description: SWI Eligibility Compatibility Matrix - InsertOrUpdate
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Adjustment Group |
An instance of the integration object Base Adjustment Group. |
Integration Object |
|
Adjustment Group |
An integration component (XML tag) corresponding to the Adjustment Group business component. You can create multiple instances of Adjustment Group under ListOfBase Adjustment Group. |
Integration Component |
|
Name |
Name of the eligibility or compatibility matrix |
String |
|
Adjustment Group Type E&C |
Start date for an eligibility or compatibility matrix. |
String |
|
Start Date |
Start date for an eligibility or compatibility matrix |
String |
|
End Date |
End date for an eligibility or compatibility matrix |
String |
|
ListOfProduct Eligibility |
List of eligibility rules. |
Integration component |
|
Type |
Type of eligibility rule. |
String |
|
Matrix Rule Num |
Matrix rule number for eligibility rule. |
String |
|
ListOfProduct Compatibility |
Contains list of compatibility rules. |
Integration Component |
|
Type |
Type of compatibility rule. |
String |
|
Matrix Rule Num |
Matrix rule number for compatibility rule. |
String |
|
Adjustment Group |
Adjustment group name. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Adjustment Group |
An instance of the integration object Base Adjustment Group. |
Integration Object |
|
Name |
Name of the eligibility or compatibility matrix |
String |
|
Adjustment Group Type E&C |
Start date for an eligibility or compatibility matrix. |
String |
|
Start Date |
Start date for an eligibility or compatibility matrix |
String |
|
End Date |
End date for an eligibility or compatibility matrix |
String |
|
ListOfProduct Eligibility |
List of eligibility rules. |
Integration Component |
|
ListOfProduct Compatibility |
Container element for a list of compatibility rules. |
Integration Component |
Message Description: SWI Eligibility Compatibility Matrix - Update
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Adjustment Group |
An instance of the integration object Base Adjustment Group. |
Integration Object |
|
Adjustment Group |
An integration component (XML tag) corresponding to the Adjustment Group business component. You can create multiple instances of Adjustment Group under ListOfBase Adjustment Group. |
Integration Component |
|
Name |
Name of the eligibility or compatibility matrix. |
String |
|
Adjustment Group Type E&C |
Start date for an eligibility or compatibility matrix. |
String |
|
Start Date |
Start date for an eligibility or compatibility matrix. |
String |
|
End Date |
End date for an eligibility or compatibility matrix. |
String |
|
ListOfProduct Eligibility |
List of eligibility rules. |
Integration Component |
|
Type |
Type of eligibility rule. |
String |
|
Matrix Rule Num |
Matrix rule number for eligibility rule. |
String |
|
ListOfProduct Compatibility |
Container element for a list of compatibility rules. |
Integration Component |
|
Type |
Type of compatibility rule. |
String |
|
Matrix Rule Num |
Matrix rule number for compatibility rule. |
String |
|
Adjustment Group |
Adjustment group name. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Adjustment Group |
An instance of the integration object Base Adjustment Group. |
Integration Object |
|
Name |
Name of the eligibility or compatibility matrix. |
String |
|
Adjustment Group Type E&C |
Start date for an eligibility or compatibility matrix. |
String |
|
Start Date |
Start date for an eligibility or compatibility matrix. |
String |
|
End Date |
End date for an eligibility or compatibility matrix |
String |
|
ListOfProduct Eligibility |
List of eligibility rules. |
Integration Component |
|
ListOfProduct Compatibility |
Container element for a list of compatibility rules. |
Integration Component |
Message Description: SWI Eligibility Compatibility Matrix - Synchronize
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Adjustment Group |
An instance of the integration object Base Adjustment Group. |
Integration Object |
|
Adjustment Group |
An integration component (XML tag) corresponding to the Adjustment Group business component. You can create multiple instances of Adjustment Group under ListOfBase Adjustment Group. |
Integration Component |
|
Name |
Name of the eligibility or compatibility matrix . |
String |
|
Adjustment Group Type E&C |
Type of eligibility or compatibility rules. |
String |
|
Start Date |
Start date for an eligibility or compatibility matrix. |
String |
|
End Date |
End date for an eligibility or compatibility matrix . |
String |
|
ListOfProduct Eligibility |
Container element for a list of eligibility rules. |
Integration Component |
|
Type |
Type of eligibility rule. |
String |
|
Matrix Rule Num |
Matrix rule number for eligibility rule. |
String |
|
ListOfProduct Compatibility |
Container element for a list of compatibility rules. |
Integration Component |
|
Type |
Type of compatibility rule. |
String |
|
Matrix Rule Num |
Matrix rule number for compatibility rule. |
String |
|
Adjustment Group |
Adjustment group name. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Adjustment Group |
An instance of the integration object Base Adjustment Group. |
Integration Object |
|
Name |
Name of the eligibility or compatibility matrix. |
String |
|
Adjustment Group Type E&C |
Type of eligibility or compatibility rules. |
String |
|
Start Date |
Start date for an eligibility or compatibility matrix. |
String |
|
End Date |
End date for an eligibility or compatibility matrix. |
String |
|
ListOfProduct Eligibility |
Container element for a list of eligibility rules. |
Integration Component |
|
ListOfProduct Compatibility |
Container element for a list of compatibility rules. |
Integration Component |
Message Description: SWI Eligibility Compatibility Matrix - QueryById
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
PrimaryRowId |
The row ID of the eligibility or compatibility matrix. |
String |
|
OutputIntObjectName |
Name of the output integration object. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Adjustment Group |
An instance of the integration object Base Adjustment Group. |
Integration Object |
|
Name |
Name of the eligibility or compatibility matrix. |
String |
|
Adjustment Group Type E&C |
Start date for an eligibility or compatibility matrix. |
String |
|
Start Date |
Start date for an eligibility or compatibility matrix. |
String |
|
End Date |
End date for an eligibility or compatibility matrix. |
String |
|
ListOfProduct Eligibility |
List of eligibility rules. |
Integration Component |
|
ListOfProduct Compatibility |
Container element for a list of compatibility rules. |
Integration Component |
Message Description: SWI Eligibility Compatibility Matrix - QueryByExample
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Adjustment Group |
An instance of the integration object ListOfBase Adjustment Group. |
Integration Object |
|
Adjustment Group |
Integration component corresponding to the Adjustment Group. |
Integration Component |
|
Name |
Name of the eligibility or compatibility matrix to be queried. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Adjustment Group |
An instance of the integration object Base Adjustment Group. |
Integration Object |
|
Name |
Name of the eligibility or compatibility matrix. |
String |
|
Adjustment Group Type E&C |
Start date for an eligibility or compatibility matrix. |
String |
|
Start Date |
Start date for an eligibility or compatibility matrix. |
String |
|
End Date |
End date for an eligibility or compatibility matrix. |
String |
|
ListOfProduct Eligibility |
List of eligibility rules. |
Integration Component |
|
ListOfProduct Compatibility |
Container element for a list of compatibility rules. |
Integration Component |
Message Description: SWI Eligibility Compatibility Matrix - Delete
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Adjustment Group |
An instance of the integration object ListOfBase Adjustment Group. |
Integration Object |
|
Name |
Name of the eligibility matrix or compatibility matrix. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Adjustment Group |
An instance of the integration object Base Adjustment Group. |
Integration Object |
|
Name |
Name of the eligibility or compatibility matrix. |
String |
|
Adjustment Group Type E&C |
Type of eligibility or compatibility rules. |
String |
|
Start Date |
Start date for an eligibility or compatibility matrix. |
String |
|
End Date |
End date for an eligibility or compatibility matrix. |
String |
Message Description: SWI Eligibility Compatibility Matrix - Insert
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Adjustment Group |
An instance of the integration object Base Adjustment Group. |
Integration Object |
|
Adjustment Group |
An integration component (XML tag) corresponding to the Adjustment Group business component. You can create multiple instances of Adjustment Group under ListOfBase Adjustment Group. |
Integration Component |
|
Name |
Name of the eligibility or compatibility matrix. |
String |
|
Adjustment Group Type E&C |
Type of eligibility or compatibility rules. |
String |
|
Start Date |
Start date for an eligibility or compatibility matrix. |
String |
|
End Date |
End date for an eligibility or compatibility matrix. |
String |
|
ListOfProduct Eligibility |
List of eligibility rules. |
Integration Component |
|
Type |
Type of eligibility rule. |
String |
|
Matrix Rule Num |
Matrix rule number for eligibility rule. |
String |
|
ListOfProduct Compatibility |
Container element for a list of compatibility rules. |
Integration Component |
|
Type |
Type of compatibility rule. |
String |
|
Matrix Rule Num |
Matrix rule number for compatibility rule. |
String |
|
Adjustment Group |
Adjustment group name. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Adjustment Group |
An instance of the integration object Base Adjustment Group. |
Integration Object |
|
Name |
Name of the eligibility or compatibility matrix. |
String |
|
Adjustment Group Type E&C |
Type of eligibility or compatibility rules. |
String |
|
Start Date |
Start date for an eligibility or compatibility matrix. |
String |
|
End Date |
End date for an eligibility or compatibility matrix. |
String |
|
ListOfProduct Eligibility |
List of eligibility rules. |
Integration Component |
|
ListOfProduct Compatibility |
Container element for a list of compatibility rules. |
Integration Component |