Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview


The PwsResourceSummary data type 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 to be useful in a listing of resources.

Format


PwsResourceSummary
  • PwsResourceSummary
    • ResourceDisplayName: String
    • ResourceId: Int32
    • ResourceReferenceSystemId: String
    • ResourceUid: Int64
    • EmailAddress: String
    • 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 ResourceReferenceSystemId or ResourceUid or EmailAddress is not supplied)

 

The resource display name

 

ResourceId

Int32

On Insert: No

On Update: No 

 

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

 

ResourceReferenceSystemId

String

On Insert: No

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

 

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

 

ResourceUid

Int64

On Insert: No

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

 

A unique and immutable identifier for a resource

 

EmailAddress

String

On Insert: Yes

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

 

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

 

FirstName

String

On Insert: Yes

On Update: No

 

The resource's first name 

 

LastName

String

On Insert: Yes

On Update: No 

 

The resource's last name

 

MiddleName

String

On Insert: Yes

On Update: No

 

The resource's middle 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"

 

Usage Example


Example 01 
               <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>
  • No labels