Overview

This structure includes basic information about a client. The information represented in this structure is not comprehensive and only includes certain key attributes of a client deemed to be useful in a listing of clients.

Format

PwsClientSummary

PwsClientSummary
- ClientId: Int32
- ClientNumber: String (20)
- ClientUid: Int64
- ClientName: String (50)
- InactiveFlag: Boolean
- ParentClientIdentity: PwsClientRef

Elements

Element	Data Type	Required?	Default	Description	Sample Data
ClientId	Int32	No		The client Id is a unique identifier for a client. For internal use only.
ClientNumber	String (20)	One of ClientNumber, ClientUid and ClientName is required		The client number is a unique identifier for a client.	C000121
ClientUid	Int64	See ClientNumber		A unique and immutable identifier for a client.	1152921504606998462
ClientName	String (50)	See ClientNumber		The client name.	Parent Inc.
InactiveFlag	Boolean	No	false	If set to 'true' the client has a status of "Inactive", if set to 'false' the client has a status of "Active".	false
ParentClientIdentity	PwsClientRef	No		The parent client identity associated with the client (if any).

Usage Example(s)

Example 01 - Client without parent

               <b:PwsClientSummary>
                  <b:ClientId i:nil="true"/>
                  <b:ClientNumber>C000121</b:ClientNumber>
                  <b:ClientUid>1152921504606998462</b:ClientUid>
                  <b:ClientName>Parent Inc.</b:ClientName>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:ParentClientIdentity i:nil="true"/>
               </b:PwsClientSummary>

Example 02 - Client with parent

               <b:PwsClientSummary>
                  <b:ClientId i:nil="true"/>
                  <b:ClientNumber>C000123</b:ClientNumber>
                  <b:ClientUid>1152921504606998464</b:ClientUid>
                  <b:ClientName>Child Inc.</b:ClientName>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:ParentClientIdentity>
                     <b:ClientId i:nil="true"/>
                     <b:ClientNumber>C000121</b:ClientNumber>
                     <b:ClientUid>1152921504606998462</b:ClientUid>
                  </b:ParentClientIdentity>
               </b:PwsClientSummary>

API Documentation

PwsClientSummary

Analytics

Overview

Format

Elements

Usage Example(s)

Related content