Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 37 Next »

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 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.


ElementData TypeDescriptionDefault (on insert/update)Sample Data
ClientIdInt32Client Id. For internal use only.

ClientNumberStringThe client number is a unique identifier for a client.
C001001
ClientUidInt64

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>C000117</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>
  • No labels