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 31 Next »

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

On Insert: No

On Update: No


The client Id is a unique identifier for a client. For internal use only


ClientNumber

String (20)

On Insert: No

On Update: Yes (if ClientUid is not supplied) 


The client number is a unique identifier for a client

C000121

ClientUid

Int64

On Insert: No

On Update: Yes (if ClientNumber is not supplied)  


A unique and immutable identifier for a client 

1152921504606998462

ClientName

String (50)

On Insert: Yes

On Update: No 


The client name

Parent Inc.

InactiveFlag

Boolean

On Insert: No

On Update: 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



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