Versions Compared

Key

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

Overview


The PwsResourceSummary data type This structure includes basic information about a resource. The information represented in this structure is not comprehensive and only includes certain key attributes of a resource likely deemed to be useful in a listing of resources.

Format


Panel
titlePwsResourceSummary
  • PwsResourceSummary
    • ResourceDisplayName: String (30)
    • ResourceId: Int32
    • ResourceReferenceSystemId: String (20)
    • ResourceUid: Int64
    • EmailAddress: String (100)
    • FirstName: String
    • LastName: String
    • MiddleName: String
    • InactiveFlag: Boolean

Elements


Element

Data Type

Required?

Default

Description

Sample Data

ResourceDisplayName

String

On Insert: Yes

On Update: Yes (if

One of ResourceDisplayName, ResourceReferenceSystemId or ResourceUid

or EmailAddress

is

not supplied)

required

 


The resource display name.

 
Matt Jones

ResourceId

Int32

On Insert: No

On Update: No 

 


The resource Id is a unique identifier for a resource. For internal use

only 

only.

 


ResourceReferenceSystemId

String

On Insert: No

On Update: Yes (if ResourceDisplayName or ResourceUid or EmailAddress is not supplied)

 

See ResourceDisplayName


The resource reference system id / employee id is a unique identifier for a resource

 

.

IT (USA) - 01

ResourceUid

Int64

On Insert: No

On Update: Yes (if ResourceDisplayName or ResourceReferenceSystemId or EmailAddress is not supplied)

 

See ResourceDisplayName



A unique and immutable identifier for a resource.

 
1152921504607057128

EmailAddress

String

On Insert: Yes

On Update:

Yes (if ResourceDisplayName or ResourceReferenceSystemId or ResourceUid is not supplied)

 

No


The resource's email address. This is a unique identifier for a resource. 

 
matt@revcorp.bb

FirstName

String

On Insert: Yes

On Update: No

 


The resource's first

name 

name.

 
Matt

LastName

String

On Insert: Yes

On Update: No 

 


The resource's last name.

 
Jones

MiddleName

String

On Insert: Yes

On Update: No

 


The resource's middle

name 

name.

 


InactiveFlag

Boolean

On Insert: Yes

On Update: No

 false

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

 
false

Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
               <b:PwsResourceSummary>
                  <b:ResourceDisplayName>Matt Jones</b:ResourceDisplayName>
                  <b:ResourceId i:nil="true"/>
                  <b:ResourceReferenceSystemId>IT (USA) - 01</b:ResourceReferenceSystemId>
                  <b:ResourceUid>1152921504607057128</b:ResourceUid>
                  <b:EmailAddress>matt@revcorp.bb</b:EmailAddress>
                  <b:FirstName>Matt</b:FirstName>
                  <b:LastName>Jones</b:LastName>
                  <b:MiddleName i:nil="true"/>
                  <b:InactiveFlag>false</b:InactiveFlag>
               </b:PwsResourceSummary>