Sort Cost Sheet
Description
This method sorts the project Cost Sheet on CBS code.
Support
This method only supports sorting of CBS code for project/shell.
Level | Yes or No |
|---|---|
Company Level | No |
Project/Shell Level | Yes |
Prototype
Public XMLObject sortCostSheet (String shortname, String authcode, String projectNumber, String type, String sortOrder );
Parameters
The following is a list of parameters.
Parameter | Description |
|---|---|
shortname | identifier of the company, company's short name |
authcode | authentication key for the company, in text string |
projectNumber | identifier of the project or a shell |
The following is a list of optional parameters.
Parameter | Description |
|---|---|
type | Identifier for the column (the column that the sorting must happen). The only supported value is: CBS. This is an optional parameter, and if the parameter is not present the project Cost Sheet will be sorted based on CBS codes. |
sortOrder | Identifier to define the sort order (ascending or descending). The values are: 'asc' or 'desc'. This is an optional input parameter. By default, the sort order is ascending. |
Return Value
The Return values for this service are:
Code | Description |
|---|---|
200 | Ok |
602 | Project/Shell Number is not correct. |
605 | No Budget set up for the project. |
500 | Server Error, contact the system administrator. |
1059 | The type name does not match the column name from cost sheet. |
1060 | Invalid sort order. You must provide a value for either 'asc' or 'desc'. |
Sample Method
sortCostSheet ("acme", "acme_authcode", “CBS","desc");
Additional Information
The following are the rules for sorting:
- For a flat structured Project Cost Sheet, there will be a simple alphanumeric sort on all the segment codes. The sorting will be case insensitive.
- For a tree structured Cost Sheet, the level sorting will happen first (the parent level first followed by the child level). Further alphanumeric sorting will happen within the level. The sorting will be case insensitive.
Note: The user must not perform any action on the project Cost Sheet when sortCostSheet webservice is running.
Last Published Tuesday, July 1, 2025