Versions Compared

Version Old Version 16 New Version Current
Changes made by

Bettina Borces

Luke Wright

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


This specifies the fields associated with a client recordstructure 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


Panel
titlePwsClientSummary
  • 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

On Insert: No

On Update: Yes (if ClientUid is not supplied) 

 

(20)

One of ClientNumber, ClientUid and ClientName is required


The client number is a unique identifier for a client.

PR-PSA
C000121

ClientUid

Int64

On Insert: No

On Update: Yes (if ClientNumber is not supplied)  

 

The client Uid is a

See ClientNumber


A unique and immutable identifier for a client

 

.

1152921504606961482
1152921504606998462

ClientName

String

On Insert: Yes

On Update: No 

 

(50)

See ClientNumber



The client name.

Projector
Parent
PSA 
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".

true/
false
 
ParentClientIdentity
PwsClientRef
 
No
 

The parent client identity associated with the client (if any).
 

Usage Example(s)

 Code Block
languagexml
titleExample 01 - Client without parent
collapsetrue
               <PwsClientSummary><b:PwsClientSummary>
                  <ClientId<b:ClientId i:nil="true"/>
                  <ClientNumber>PR-PSA</<b:ClientNumber>C000121</b:ClientNumber>
                  <ClientUid>1152921504606961482<<b:ClientUid>1152921504606998462</b:ClientUid>
                  <ClientName>Projector PSA</<b:ClientName>Parent Inc.</b:ClientName>
                  <InactiveFlag>false<<b:InactiveFlag>false</b:InactiveFlag>
                  <ParentClientIdentity<b:ParentClientIdentity i:nil="true"/>
               </b:PwsClientSummary>

 Code Block
languagexml
titleExample 02 - Client with parent
collapsetrue
              <PwsClientSummary> <b:PwsClientSummary>
                  <ClientId<b:ClientId i:nil="true"/>
                  <ClientNumber>PR-PSA(W)</<b:ClientNumber>C000123</b:ClientNumber>
                  <ClientUid>1152921504606989813<<b:ClientUid>1152921504606998464</b:ClientUid>
                  <ClientName>Projector PSA - West</<b:ClientName>Child Inc.</b:ClientName>
                  <InactiveFlag>false<<b:InactiveFlag>false</b:InactiveFlag>
                  <ParentClientIdentity><b:ParentClientIdentity>
                     <ClientId<b:ClientId i:nil="true"/>
                     <ClientNumber>PR-PSA</<b:ClientNumber>C000121</b:ClientNumber>
                     <ClientUid>1152921504606961482<<b:ClientUid>1152921504606998462</b:ClientUid>
                  </b:ParentClientIdentity>
               </b:PwsClientSummary>