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 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 client.

Format

Panel
titlePwsClientRefPwsProjectIssueRef
  • PwsClientRefPwsProjectIssueRef
    • ClientIdProjectIssueId: Int32
    • ClientNumber: String (20)
    • ClientUid: Int64ProjectIssueUid: Int64
    • ReferenceId: String

Elements

Element

Data Type

Required?

Description

Sample Data

ClientId

ProjectIssueId

Int32

 

No

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

ClientNumber

String (20)

One of ClientNumber or ClientUid is required

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

C000121

ClientUid

Int64

See ClientNumber

The client Uid is a unique and immutable identifier for a client

 

 

ProjectIssueUid

Int64

 

 

 

ReferenceId

String

 

 

 

Usage Example(s)


<com:PwsClientRef> <com:ClientNumber>C000121</com:ClientNumber> </com:PwsClientRef>
Code Block
languagexml
titleExample 01
collapsetrue