Versions Compared

Key

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

Overview


This structure represents the contains key fields associated with a client, as well as the client name, and parent client, if any.

Format


Panel
titlePwsClientDescriptor
  • PwsClientDescriptor
    • ClientId: Int32
    • ClientNumber: String (20)
    • ClientUid: Int64
    • ClientName: String (50)
    • ParentClientDescriptor: PwsClientDescriptor

Elements


Element

Data Type

Required?

Description

Sample Data

ClientId

Int32

 

No

 The

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

 


ClientNumber

String

 

 The

(20)

One of the ClientNumber, ClientUid or ClientName is requried

The client number is a unique identifier for a client.

 
PR-PSA

ClientUid

Int64

 

See ClientNumber

 A unique and immutable identifier for a client.

  
1152921504606961482

ClientName

String (50)

 

 

See ClientNumber

The client name is a unique identifier for a client.

Projector PSA

ParentClientDescriptor

PwsClientDescriptor

 

 

 

No

The key fields identifying the parent of this client (if any).


Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
<a:ClientDescriptor>
   <ClientId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
   <ClientNumber xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">PR-PSA</ClientNumber>
   <ClientUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606961482</ClientUid>
   <a:ClientName>Projector PSA</a:ClientName>
   <a:ParentClientDescriptor i:nil="true"/>
</a:ClientDescriptor>