PwsResourceTypeRef


Overview


This structure represents the unique key fields associated with identifying a resource type. Resources types enable an organization to easily set up and classify resources. Resource types can be identified by ResourceTypeCode, ResourceTypeName or ResourceTypeUid. When specifying a PwsResourceTypeRef as an input to a web service, you may specify one, two, or  all three identifiers. However, if you do specify multiple identifiers, they must all refer to the same resource type or the resource type reference will not be considered valid. When a PwsResourceTypeRef is returned in the response to a web service, the ResourceTypeCode, ResourceTypeName and ResourceTypeUidwill be populated, and guaranteed to refer to a single resource type.

Format


PwsResourceTypeRef
  • PwsResourceTypeRef
    • ResourceTypeCode: String (20)
    • ResourceTypeId: Int32
    • ResourceTypeName: String (50)
    • ResourceTypeUid: Int64

Elements


Element

Data Type

Required?

Description

Sample Data

ResourceTypeCode

String (20)

One of ResourceTypeCode, ResourceTypeName or ResourceTypeUid is required

The resource type code is a unique identifier for a resource type.

FTE

ResourceTypeId

Int32

No

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


ResourceTypeName

String (50)

See ResourceTypeCode

The resource type name is a unique identifier for a resource type.

Full Time Employee

ResourceTypeUid

Int64

See ResoruceTypeCode

The resource type Uid is a unique and immutable identifier for a resource type.

1152921504606847348


Usage Example(s)


Example 01
                          <b:ResourceTypeIdentity>
                              <b:ResourceTypeCode>FTE</b:ResourceTypeCode>
                              <b:ResourceTypeId i:nil="true"/>
                              <b:ResourceTypeName>Full Time Employee</b:ResourceTypeName>
                              <b:ResourceTypeUid>1152921504606847348</b:ResourceTypeUid>
                           </b:ResourceTypeIdentity>