Overview

This specifies the fields associated with a client record.

Format

PwsClientSummary

PwsClientSummary
- ClientId: Int32
- ClientNumber: String
- ClientUid: Int64
- ClientName: String
- InactiveFlag: Boolean
- ParentClientIdentity: PwsClientRef

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.	Client-001
ClientUid	Int64	The client Uid is a unique and immutable identifier for a client	1152921504606961482
ClientName	String	The client name is a unique identifier for a client.	Projector PSA
InactiveFlag	Boolean	If "true" the client has a status of "Inactive", if "false" the client has a status of "Active".	true/false
ParentClientIdentity	PwsClientRef	The parent client identity associated with the client (if any).

Usage Example(s)

Example 01 - Client without parent

              <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>Projector PSA</ClientNumber>
                  <ClientUid>1152921504606961482</ClientUid>
                  <ClientName>Projector PSA</ClientName>
                  <InactiveFlag>false</InactiveFlag>
                  <ParentClientIdentity i:nil="true"/>
               </PwsClientSummary>

Example 02 - Client with parent

             <PwsClientSummary>
                  <ClientId i:nil="true"/>
                  <ClientNumber>C001000</ClientNumber>
                  <ClientUid>1152921504606989813</ClientUid>
                  <ClientName>Acme 1000-01</ClientName>
                  <InactiveFlag>false</InactiveFlag>
                  <ParentClientIdentity>
                     <ClientId i:nil="true"/>
                     <ClientNumber>C000118</ClientNumber>
                     <ClientUid>1152921504606989807</ClientUid>
                  </ParentClientIdentity>
               </PwsClientSummary>