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

PwsClientRef

PwsClientRef
- ClientId: Int32
- ClientNumber: String
- ClientUid: Int64

Elements

Element	Data Type	Description	Sample Data
ClientId	Int32	The Client Id is a unique identifier for a Client. For internal use only.
ClientNumber	String	The Client Number is a unique identifier for a Client.	C001001
ClientUid	Int64	The Client Uid is a unique and immutable identifier for a Client.	1152921504606989814

Usage Example(s)

Example 01 - Client Number Only

              <PwsClientRef>
                  <!--ClientId>?</ClientId-->
                  <ClientNumber>C001001</ClientNumber>
                  <!--ClientUid>?</ClientUid-->
               </com:PwsClientRef>

Example 02 - Client Number and Client Uid

           <PwsClientRef>
               <ClientId i:nil="true"/>
               <ClientNumber>C001001</b:ClientNumber>
               <ClientUid>1152921504606989814</b:ClientUid>
            <PwsClientRef>