...
Overview
This structure is used to uniquely identify a client. Clients can be identified by UID ClientNumber or client numberClientUid. When specifying a PwsClientRef as PwsClientRef as an input to a web service, you may specify one or both of the ClientNumber and ClientUid and ClientNumber. 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 PwsClientRef is returned in the response to a web service, both the ClientUid and ClientNumber and ClientUid will be populated, and guaranteed to refer to a single client.
...
Format
| Panel | ||
|---|---|---|
| ||
|
Elements
Element | Data Type | Required? | Default(s) | Description Description | Sample Data |
|---|---|---|---|---|---|
ClientId | Int32 | No | Client IdThe client Id is a unique identifier for a client. For internal use only. | ||
ClientNumber | String | No(20) | One of ClientNumber or ClientUid is required | The client number is a unique identifier for a client. | C000121 |
ClientUid | Int64 | NoSee ClientNumber | The client | UID Uid is a unique and immutable identifier for a client. |
Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<com:PwsClientRef> <!--com:ClientId>?</com:ClientId--> <com:ClientNumber>C000117<ClientNumber>C000121</com:ClientNumber> <!--com:ClientUid>?</com:ClientUid--> </com:PwsClientRef> |