...
This structure is used to uniquely identify a Clientclient. 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 and ClientNumber. However, if you do specify both they must both refer to the same Client client or the Client Reference client reference will not be considered valid. When a 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 Clientclient.
Format
| Panel | ||
|---|---|---|
| ||
|
Elements
Element | Data Type | Required? |
|---|
Default
Description | Sample Data |
|---|---|
ClientId | 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. |
C000121 | |
ClientUid | Int64 |
See ClientNumber |
The |
client Uid is a unique and immutable identifier for a |
client. |
1152921504606989814Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<PwsClientRef>
<!--ClientId>?</ClientId-->
<ClientNumber>C001001</ClientNumber>
<!--ClientUid>?</ClientUid-->
</com:PwsClientRef>
| ||||||
| Code Block | ||||||
| ||||||
<com:PwsClientRef> <PwsClientRef> <ClientId i:nil="true"/> <ClientNumber>C001001</b<com:ClientNumber>C000121</com:ClientNumber> <ClientUid>1152921504606989814</b:ClientUid> <PwsClientRef></com:PwsClientRef> |