Get Project/Shell List

Support for SOAP is deprecated starting with Unifier 23.10.

Description

This method will allow users to get a list of project/shell instances. User can get information of more than one project/shell at a time.

Support

Installation: ASP and Self host

Level Yes or No
Company Level Yes
Project/Shell Level No

Prototype

public XMLObject getProjectShellList(String shortname, String authcode, String options);

Parameters

Parameter Description
Shortname Identifier of the company, company's short name
Authcode Authentication code for the company, in text string
Options

This parameter allows the user to filter the list based on the following:

  • <status>: select a status of Active, Inactive, On-Hold or View-Only. If no status is provided, all projects/shells are returned.
  • <type>: select the type to be returned. Value can be project, CBS_shell or generic_shell. If no type is provided, all projects/shells are returned.
  • <filter_condition>: filter the results based on either the projectnumber or projectname.

Example:

<gen:options>

<![CDATA[

<options>

<type>CBS_shell</type>

<status>Active</status>

<filter_condition>projectname=Building 101</filter_condition>

</options>

]]>

</gen:options>

Return Value

See Appendix B: Return Values.

Note:

The message will return list of projects/shells based on filter conditions.

Sample Method

getShellList("acme", "acme_authcode", type=CBS_shell);