...
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. 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 ClientNumber and ClientUid will be populated, and guaranteed to refer to a single Clientclient.
Format
| Panel | ||
|---|---|---|
| ||
|
Elements
Element | Data Type | Required? | Description | Sample Data | |
|---|---|---|---|---|---|
ClientId | Int32 | No | The Client client Id is a unique identifier for a Clientclient. For internal use only. | ||
ClientNumber | String The Client Number (20) | One of ClientNumber or ClientUid is required | The client number is a unique identifier for a Clientclient. | C001001C000121 | |
ClientUid | Int64 | See ClientNumber | The Client client Uid is a unique and immutable identifier for a Clientclient. | 1152921504606989814 |
Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<com:PwsClientRef> <PwsClientRef> <ClientNumber>C001001</<com:ClientNumber>C000121</com:ClientNumber> </com:PwsClientRef> | ||||||
| Code Block | ||||||
| ||||||
<PwsClientRef>
<ClientNumber>C001001</b:ClientNumber>
<ClientUid>1152921504606989814</b:ClientUid>
<PwsClientRef>
|