Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


This structure is used to uniquely identify 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


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

Elements


ElementData TypeDescriptionDefault (on insert/update)Sample Data
ProjectCodeStringThis is the project code, which can uniquely identify a project
P001395-001
ProjectIdInt32This is the project id. For internal use only.

ProjectUidInt64This is the unique identifier of a project
1152921504607412209

Element

Data Type

Required?

Default

Description

Sample Data

ProjectCode

String

 

 

 


ProjectId

Int32

 

 

 


ProjectUid

Int64

 

 

 


Usage Example(s)


Code Block
languagexml
titleExample 01 - Project Code Only
collapsetrue
               <com:PwsProjectRef>
                  <com:ProjectCode>P001395-001</com:ProjectCode>
                  <!--com:ProjectId>?</com:ProjectId-->
                  <!--com:ProjectUid>?</com:ProjectUid-->
               </com:PwsProjectRef>

...