Description
This method will allow users to get a list of shell instances. User can get information of more than one shell at a time.
Support
Installation: ASP and Self host
Level | Yes or No |
|---|---|
Company Level | Yes |
Project or Shell Level | No |
Program Level | No |
Prototype
public XMLObject getShellList(String shortname, String authcode, String shellType, String filterCondition);
Parameters
Parameter | Description |
|---|---|
shortname | Identifier of the company, company’s short name |
authcode | Authentication code for the company, in text string |
shellType | To identify type of the shell that is getting updated. Ex: Building, Projects, Capital Projects, Properties etc.., |
filtercondition | This will allow user to filter list of shells returned. Following is list of elements that use can filter shell list on <shell number>: data element used to capture shell number <shell name>: data element used to capture shell name Status (uuu_shell_status): Status of the shell |
Return Value
See Return Values.
Note: The message will return list of shells based on filer condition.
Sample Method
getShellList("acme", "acme_authcode", "Buildings", uuu_shell_status=Active);
Additional Information
Only one filter condition can be provided at a time.
Only operator available for filter condition will be "=".
Example:
If user wants to get a list of shells with status Active then filterCondition should be <filterCondition>uuu_shell_status = Active</filterCondition>
If user wants to get a shell with name Building 101 then filterCondition should be <filterCondition>my_building_name = Building 101</filterCondition). Assuming that my_building_name is the data element used to capture name of the shell using SYS Shell Name.