Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 22 Next »

Overview


This structure represents the unique key fields associated with identifying a Project. Projects can be identified by ProjectCode or ProjectUid. When specifying a PwsProjectRef as an input to a web service, you may specify one or both the ProjectCode and/or ProjectUid. However, if you do specify both, they must both refer to the same Project or the Project reference will not be considered valid. When a PwsProjectRef is returned in the response to a web service, both the ProjectCode and ProjectUid will be populated, and guaranteed to refer to a single Project.


Format


PwsProjectRef
  • PwsProjectRef
    • ProjectCode: String
    • ProjectId: Int32
    • ProjectUid: Int64

Elements


Element

Data Type

Required?

Default

Description

Sample Data

ProjectCode

String



The Project Code is a unique identifier for a Project.

P001395-001

ProjectId

Int32



The Project Id is a unique identifier for a Project. For internal use only.


ProjectUid

Int64



The Project Uid is a unique and immutable identifier for a Project.

1152921504607412209

Usage Example(s)


Example 01 - Project Code Only
               <com:PwsProjectRef>
                  <com:ProjectCode>P001395-001</com:ProjectCode>
                  <!--com:ProjectId>?</com:ProjectId-->
                  <!--com:ProjectUid>?</com:ProjectUid-->
               </com:PwsProjectRef>
Example 02 - ProjectCode and ProjectUid
               <com:PwsProjectRef>
                  <com:ProjectCode>P001395-001</com:ProjectCode>
                  <!--com:ProjectId>?</com:ProjectId-->
                  <com:ProjectUid>1152921504607412209</com:ProjectUid>
               </com:PwsProjectRef>
  • No labels