Versions Compared

Key

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

...

This structure is used to uniquely identify a client. Clients can document folder. Folders should be identified by ClientNumber or ClientUid. When specifying a PwsClientRef as an input to a web service, you may specify one or both the ClientNumber and ClientUid. However, if you do specify both they must both refer to the same client or the client reference will not be considered valid. When a PwsClientRef is returned in the response to a web service, both the ClientNumber and ClientUid will be populated, and guaranteed to refer to a single clientthe folder UID.

Format

Panel
titlePwsClientRefPwsFolderRef
  • PwsClientRefPwsFolderRef
    • ClientIdFolderId: Int32
    • ClientNumber: String (20)
    • ClientUid: FolderUid: Int64

Elements

One of ClientNumber or ClientUid is required

C000121

Element

Data TypeRequired?

Description

Sample Data

ClientIdFolderId

Int32No

The client folder Id is a unique identifier for a clientfolder. For internal use only.

ClientNumber

String (20)


The client number is a unique identifier for a client. If not specified, this field will be auto generated.

ClientUid

Int64

See ClientNumber

The client FolderUid

Int64

The folder Uid is a unique and immutable identifier for a clientfolder.

152921504607335265

Usage Example(s)

Code Block
languagexml
titleExample 01
collapsetrue
                  <a:ProjectIssueFolderIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
              <com:PwsClientRef>       <b:FolderId i:nil="true"/>
                     <com<b:ClientNumber>C000121<FolderUid>1152921504607335265</com:ClientNumber>b:FolderUid>
                  </com:PwsClientRef>a:ProjectIssueFolderIdentity>