Overview
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 | ||
|---|---|---|
| ||
|
Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
ClientId | Int32 | On Insert: No On Update: No | The client Id is a unique identifier for a client. For internal use only. | ||
ClientNumber | String (20) | On Insert: No On Update: Yes (if ClientUid is not supplied) | The client number is a unique identifier for a client. | C001001 | |
ClientUid | Int64 | On Insert: No On Update: Yes (if ClientNumber is not supplied) | The client Uid is a unique and immutable identifier for a client. | 1152921504606989814 |
Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<PwsClientRef>
<ClientNumber>C001001</ClientNumber>
</com:PwsClientRef>
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<PwsClientRef>
<ClientUid>1152921504606989814</b:ClientUid>
<PwsClientRef> |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<PwsClientRef>
<ClientNumber>C001001</b:ClientNumber>
<ClientUid>1152921504606989814</b:ClientUid>
<PwsClientRef>
|