Versions Compared

Key

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

Overview


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


Panel
titlePwsProjectRef
  • PwsProjectRef
    • ProjectCode: String (24)
    • ProjectId: Int32
    • ProjectUid: Int64

Elements


This is the project code, which can uniquely identify a projectThis is the project idThis is the unique identifier of

Element

Data Type

Required?

Description

Sample Data

ProjectCode

String

(24)

One of ProjectCode or ProjectUid is required

The project code is a unique identifier for a project.

P001395-001

ProjectId

Int32

No

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


ProjectUid

Int64

See ProjectCode

A unique and immutable identifier for a project.

1152921504607412209
1152921504607412208

Usage Example(s)


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


Code Block
languagexml
titleExample 02 - ProjectCode and ProjectUid
collapsetrue
               <com:PwsProjectRef>
                  <com:ProjectCode>P001395-001</com:ProjectCode>
                  <!--com:ProjectId>?</com:ProjectId-->
                  <com:ProjectUid>1152921504607412209</com:ProjectUid>
               </com:PwsProjectRef>

...