All Methods return the standard
4.1. Method: GetContainer
Input Parameters:
| Parameter | Data Type | Required | Sample Data | Description |
|---|---|---|---|---|
| Scope | String | Yes | display | XDOC function / need for the Object. |
| Container | String | Yes | 12345 | Primary Id of the Object in the Integrated Application. |
| IncludeLists | Bool | 0,1 | Indicates to include detail lists in the output XML. | |
| IncludeRoles | Bool | 0,1 | Indicates to include the User Role list. |
Method Invocation URL Example:
/xdoc/service.ashx?Method=GetContainer&Scope=display&Container=5565ResponseData Node Content: The ResponseData node must be valid Container XML as defined in section 2. If the container was not found, it should be left empty.
4.2. Method: FindContainer This Method is identical to the GetContainer method, except that the Container parameter may either be the ContainerKey (primary id) or the ContainerReference (user friendly unique key) for the Object.
In many Integrated Applications, if the ContainerReference is un-changeable, then this value is often the same as the ContainerKey. E.g.: Loan Number. In some Integrated Applications however, the ContainerKey may be an internal identifier for the object, while the ContainerReference may be a different human readable identifier. E.g.: PersonId and SSN respectively.
Input Parameters:
| Parameter | Data Type | Required | Sample Data | Description |
|---|---|---|---|---|
| Scope | String | Yes | display | XDOC function / need for the Object. |
| Container | String | Yes | 12345 | ContainerKey or ContainerReference for the Object. |
| IncludeLists | Bool | 0,1 | Indicates to include detail lists in the output XML. | |
| IncludeRoles | Bool | 0,1 | Indicates to include the User Role list. |
Method Invocation URL Example:
/xdoc/service.ashx?Method=FindContainer&Scope=display&Container=5565ResponseData Node Content: The ResponseData node must be valid Container XML as defined in section 2. If the container was not found, it should be left empty.
4.3. Method: GetLastUserContainer Returns the Container XML for the last Container the user was working on in the Integrated Application.
Input Parameters:
| Parameter | Data Type | Required | Sample Data | Description |
|---|---|---|---|---|
| Scope | String | Yes | display | Indicates how XDOC is using the result data. |
| IncludeLists | Bool | Indicates to include detail lists in the output XML. | ||
| IncludeRoles | Bool | 0,1 | Indicates to include the User Role list. |
Method Invocation URL:
/xsuite/xms/webservice/Message/service.ashx?Method=GetLastUserContainer&Scope=display&UserName=jsmithResponseData Node Content: The ResponseData node must be valid Container XML as defined in section 2. If the container was not found, it should be left empty.
4.4. Method: SearchContainers Returns Container List XML for containers matching the input Search Field Criteria.
The Search Field parameters are multi-instance parameters. E.g., multiple instances of each may be passed to the method, each representing a search condition.
Input Parameters:
| Parameter | Data Type | Required | Sample Data | Description |
|---|---|---|---|---|
| Scope | String | Yes | search | Indicates how XDOC is using the result data. |
| IncludeLists | Bool | Indicates to include detail lists in the output XML. | ||
| FieldCode | String | loanType | The field to search on. | |
| FieldOperator | String | inList | The operator to use for the search condition. | |
| FieldValue | String | refi,purchase | The value for the search condition. |
Method Invocation URL:
/xsuite/xms/webservice/Message/service.ashx?Method=SearchContainers&SecurityToken=&UserName=jsmith&FieldCode=loanNumber&FieldOperator=inList&FieldValue=12345,67898&FieldCode=submittedDate&FieldOperator=%3E&FieldValue=20100201ResponseData Node Content: The ResponseData node must be valid ContainerList XML as defined in section 2.
4.5. Method: GetGroupContainers Returns ContainerList XML for containers defined as part of this “Group” in the Integrated Application.
Input Parameters:
| Parameter | Data Type | Required | Sample Data | Description |
|---|---|---|---|---|
| GroupKey | String | Yes | 99 | User Friendly Identifier of the Group in the Integrated Application. |
| GroupScope | String | trade | The type of group being requested. This allows for Integrated Applications that have more than 1 grouping construct for Containers. | |
| IncludeLists | Bool | Indicates to include detail lists in the output XML. | ||
| IncludeRoles | Bool | 0,1 | Indicates to include the User Role list. |
Method Invocation URL:
/xsuite/xms/webservice/Message/service.ashx?Method=GetGroupContainers&UserName=jsmith&GroupKey=99ResponseData Node Content: The ResponseData node must be valid ContainerList XML as defined in section 2.