Description
This method gets a specific Planning Item record in Unifier. This works for both company level and project or shell level Planning Items.
Support
This process supports all type of Planning Items.
Installation: ASP and Self host
Level | Yes or No |
|---|---|
Company Level | Yes |
Project and Shell Level | Yes |
Prototype
public XMLObject getPlanningItem (String shortname, String authcode, string projectNumber, String BPName, String planning Item);
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 shell in Unifier. Pass null for Company Level Planning Items |
BPName | identifier of the planning item type in Unifier, for example: Capital Projects |
planningItem | identifier of the planning item example: Tower |
Return Value
See Return Values.
Sample Method
getPlanningItem("acme", "acme_authcode", "proj-01", "Capital Projects","Tower") will return the XML Record of the Planning Item.
Additional Information
If the planningItem is left blank or invalid planningItem then the method will returns the Planning Item’s skeletal XML.
To get company level Planning Item record information, send null for projectNumber parameter. If you send a project number for a Planning Item type that is at Company level then you will get an error that Planning Item type is not correct.
This service can be used for both Project (Standard) and Shells of cost code type CBS and Generic.