Get Project/Shell List

Description

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

Installation: ASP and Self host

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

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 then all projects and shells are returned. <type>: select the type to be returned. Value can be project, CBS_shell or generic_shell. If no type if provided then all projects and shells will be 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>`

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 then all projects and shells are returned.
<type>: select the type to be returned. Value can be project, CBS_shell or generic_shell. If no type if provided then all projects and shells will be 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>

Note: The message will return list of project and shells based on filter conditions.

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