Versions Compared

Key

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

Overview


This specifies the fields associated with a client Client record.

Format


Panel
titlePwsClientSummary
  • PwsClientSummary
    • ClientId: Int32
    • ClientNumber: String
    • ClientUid: Int64
    • ClientName: String
    • InactiveFlag: Boolean
    • ParentClientIdentity: PwsClientRef

Elements


Element

Data Type

Description

Required?

Default

(on insert/update)

Description

Sample Data

ClientId

Int32

 

 

 Client Id. For internal use only.


ClientNumber

String

The client number

 

 

 The Client Number is a unique identifier for a

client

Client.

Client-001

ClientUid

Int64

 

 

 The

client UID

Client Uid is a unique and immutable identifier for a

client

Client

1152921504606961482

ClientName

String

The client name

 

 

 The Client Name is a unique identifier for a

client

Client.

Acme 123
Projector PSA

InactiveFlag

Boolean

Valid values for this field include "true" or false".

 

 

 If "true" the client has a status of "Inactive", if "false" the client has a status of "Active".

true/false

ParentClientIdentity

PwsClientRef

 

 

 Parent

client identity

Client Identity associated with the

client

Client


Usage Example(s)


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

...