For each client reference, at least one of the fields listed below must be supplied. If more than one value is supplied, the values must reference the same client.
...
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(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 | The Client Number(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 client 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> |