Get Column Data
Description
This method gets data from a project/shell (with cost codes CBS) cost sheet column.
Support
This method is only supported for cost sheet columns. The Get Column Data Web Services call method will only fetch data for the following combination of Type and Datasource:
(1) Type = Direct Entry and Datasource = Project Cost (1 - 100)
(2) Type = Line Item Content and Datasource = Project Cost (1 - 100)
(3) Type = Line Item Content and Datasource = AFC
(4) Type = Line Item Content and Datasource = YTB (Yet To Buy)
Installation: ASP and Self host
Level | Yes or No |
---|---|
Company Level | No |
Project/Shell Level | Yes |
Prototype
public XMLObject getColumnData(String shortname, String authcode, string projectNumber, String ColumnName);
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/shell. |
columnName | Identifier of the cost sheet column. This is case-sensitive and should be the name of Column that is defined in Unifier. |
Return Value
See Appendix A: Return Values. Response will contain following data elements.
Tag Name | Description |
---|---|
<CBS_code> | CBS Code is a required field. |
<short_description> | Short Description |
<long_description> | Long Description |
<work_package> | Work Package Name |
<spends_category> | Spends Category Label |
<quantity> | Quantity |
<unit_of_measure> | Unit of Measure |
<unit_cost> | Unit Cost Label |
<amount> | Amount |
Sample Method
getColumnData("acme", "acme_authcode", "project_info","my column name")
Additional Information
Following are the failure reasons and descriptions:
Reason | Description |
---|---|
Column is not valid | Invalid Column Name |
Column is not manual | Column is not defined as manual entry |
If the cost sheet column entry method is "Line Item Content," this web service call will only return lines for CBS Code which has valid lines. For example, if there are 2 CBS Codes on cost sheet and one has line item content and other does not then only CBS Code with line item content will be returned.
If the cost sheet column entry method is "Direct Entry," this web service call will return a line for a CBS Code even if there is no data manually entered against that CBS Code in project/shell cost sheet. For example, if there are 2 CBS Codes on cost sheet and one has a value entered directly on cost sheet and other does not have any value, even then this service call will return 2 lines, one for each CBS Code. Following are the elements that will be returned as part of each CBS Code.
Observe that short_description element will automatically get a value "Direct Entry Line Item". This is to indicate that the value was entered directly on cost sheet.
This service can be used for projects/shells of cost code type CBS.
Related Topics
Last Published Wednesday, April 9, 2025