Versions Compared

Key

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

...

This structure includes basic information about a title. The information represented in this structure is not comprehensive and only includes certain key attributes of a title deemed to be useful in a listing of clientstitles.

Format

Panel
titlePwsTitleSummary
  • PwsTitleSummary
    • DepartmentIdentity: PwsDepartmentRef
    • TitleId: Int32
    • TitleName: String
    • TitleUid: Int64
    • InactiveFlag: Boolean

Elements

Element

Data Type

Description

Sample Data

DepartmentIdentity

PwsDepartmentRef

 The department associated with this

 The department identity and title name together are a unique identifier for a title. Click here for more information.

 


TitleId

Int32

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

 


TitleName

String (50)

 The department identity and title name

is

together are a unique identifier for a title.

 Administrator

TitleUid

Int64

 The title uid is a unique and immutable identifier for a title.

 152921504606862838

InactiveFlag

Boolean

 If set to 'true', the title has a status of "Inactive", if set to 'false', the client has a status of "Active"

 false

Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
               <b:PwsTitleSummary>
                  <b:DepartmentIdentity>
                     <b:DepartmentId i:nil="true"/>
                     <b:DepartmentName>Management</b:DepartmentName>
                     <b:DepartmentUid>1152921504606851319</b:DepartmentUid>
                  </b:DepartmentIdentity>
                  <b:TitleId i:nil="true"/>
                  <b:TitleName>Administrator</b:TitleName>
                  <b:TitleUid>1152921504606862838</b:TitleUid>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsTitleSummary>

...