This structure is used to uniquely identify a client. Clients can be identified by Uid or ClientNumber. When specifying a PwsClientDetail as an input to a web service, you may specify one or both of 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 returned in the response to a web service, both the ClientUid and ClientNumber will be populated, and guaranteed to refer to a single client.
| Name | Data Type | Required | Default(s) | Description |
|---|
| ClientId | Int32 | No |
| Client Id. For internal use only. |
| ClientNumber | String | No |
| The client number is a unique identifier for a client. |
| ClientUid | Int64 | No |
| The client UID is a unique and immutable identifier for a client. |
Usage Example(s)
| Code Block |
|---|
| language | xml |
|---|
| title | Example 01 - Client Number Only |
|---|
| collapse | true |
|---|
|
<PwsClientRef>
<!--ClientId>?</ClientId-->
<ClientNumber>C000117</ClientNumber>
<!--ClientUid>?</ClientUid-->
</com:PwsClientRef>
|
| Code Block |
|---|
| language | xml |
|---|
| title | Example 02 - Client Number and Client Uid |
|---|
| collapse | true |
|---|
|
<PwsClientRef>
<ClientId i:nil="true"/>
<ClientNumber>C001001</b:ClientNumber>
<ClientUid>1152921504606989814</b:ClientUid>
<PwsClientRef>
|