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 Current »

Overview


This structure represents the unique key fields associated with a resource candidate for a role

Format


PwsProjectRoleCandidate
  • PwsProjectRoleCandidate
    • AllowBookOwnTimeFlag: Boolean
    • AllowRequestOwnTimeFlag: Boolean
    • AssignedCandidateFlag: Boolean
    • RequestedCandidateFlag: Boolean
    • RequesterCanRequestHoursFlag: Boolean
    • RequesterCanSwitchToThisCandidateFlag: Boolean
    • ResourceIdentity: PwsResourceRef
    • SchedulerCanBookHoursFlag: Boolean
    • SchedulerCanSwitchToThisCandidateFlag: Boolean
    • SelectedCandidateFlag: Boolean
    • UnnamedCandidateCostCenterIdentity: PwsCostCenterRef
    • UnnamedCandidateFlag: Boolean
    • UnnamedCandidateLocationIdentity: PwsLocationRef
    • UnnamedCandidateResourceTypeIdentity: PwsResourceTypeRef
    • UnnamedCandidateTitleIdentity: PwsTitleRef

Elements


Element

Data Type

Description

Sample Data

AllowBookOwnTimeFlag

Boolean

If 'true', the resource has permission to book his/her own time on a role

false

AllowRequestOwnTimeFlag

Boolean

If 'true', the resource has permission to request his/her own time on a role

false

AssignedCandidateFlag

Boolean

If 'true', the resource is assigned to the role

true

RequestedCandidateFlag

Boolean

If 'true', the resource is requested for the role 

false

RequesterCanRequestHoursFlag

Boolean

If 'true', the requester can request hours against this role

true

RequesterCanSwitchToThisCandidateFlag

Boolean

If 'true', the requester can switch the preferred resource candidate on this role

false

ResourceIdentity

PwsResourceRef

This structure represents the unique key fields associated with identifying a resource. Resources can be identified by ResourceDisplayName,  ResourceReferenceSystemId or ResourceUid. When specifying a PwsResourceRef as an input to a web service, you may specify any combination of the three fields. However, if you do specify more than one, they must all refer to the same resource or the resource reference will not be considered valid. When a PwsResourceRef is returned in the response to a web service, the ResourceDisplayName, ResourceReferenceSystemId or ResourceUid will be populated, and guaranteed to refer to a single resource.


SchedulerCanBookHoursFlag

Boolean

If 'true', the scheduler can book hours against this role

true

SchedulerCanSwitchToThisCandidateFlag

Boolean

If 'true', the scheduler can switch the assigned resource candidate on this role

false

SelectedCandidateFlag

Boolean

If 'true', a preferred candidate has been selected

true

UnnamedCandidateCostCenterIdentity

PwsCostCenterRef

This structure is used to uniquely identify a cost center. Cost Centers can be identified by CostCenterName, CostCenterNumber, and/or CostCenterUid. When specifying a PwsCostCenterRef as an input to a web service, you may specify any combination of these fields. However, if you specify multiple fields, they must all refer to the same cost center or the cost center reference will not be considered valid. When a CostCenterRef is returned in the response to a web service, the CostCenterName, CostCenterNumber and CostCenterUid will all be populated, and guaranteed to refer to a single cost center.


UnnamedCandidateFlag

Boolean

If 'true', the role is assigned to an unnamed resource

false

UnnamedCandidateLocationIdentity

PwsLocationRef

This structure contains the unique key fields associated with a location. Locations can be identified by LocationName or LocationUid. When specifying a PwsLocationRef as an input to a web service, you may specify one or both of LocationName and LocationUid. However, if you do specify both, they must both refer to the same location or the location reference will not be considered valid. When a PwsLocationRef is returned in the response to a web service, both the LocationName or LocationUid will be populated, and guaranteed to refer to a single location.


UnnamedCandidateResourceTypeIdentity

PwsResourceTypeRef

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.


UnnamedCandidateTitleIdentity

PwsTitleRef

This structure represents the unique key fields associated with identifying a resource title. Titles are used when requesting and booking resources during the resource scheduling workflow, in the determination of default billing. A title can be identified either by a unique identifier (UID), or the combination of department identity and name. The department identity or title name alone do not sufficiently identify a single title. When passing a title identity as input to a web service, you need only specify the unique identifier or the department identity and title name. You may specify all three values if you wish, but if you do so, they must all refer to the same title, or the reference will not be considered valid. When this structure is returned as part of the response from a web service, all fields will be specified, and will be guaranteed to refer to a single title.


Usage Example(s)


Example 01
                     <b:PwsProjectRoleCandidate>
                        <b:AllowBookOwnTimeFlag>false</b:AllowBookOwnTimeFlag>
                        <b:AllowRequestOwnTimeFlag>false</b:AllowRequestOwnTimeFlag>
                        <b:AssignedCandidateFlag>true</b:AssignedCandidateFlag>
                        <b:RequestedCandidateFlag>false</b:RequestedCandidateFlag>
                        <b:RequesterCanRequestHoursFlag>true</b:RequesterCanRequestHoursFlag>
                        <b:RequesterCanSwitchToThisCandidateFlag>false</b:RequesterCanSwitchToThisCandidateFlag>
                        <b:ResourceIdentity>
                           <b:ResourceDisplayName>Matt</b:ResourceDisplayName>
                           <b:ResourceId i:nil="true"/>
                           <b:ResourceReferenceSystemId>IT (USA) - 01</b:ResourceReferenceSystemId>
                           <b:ResourceUid>1152921504607057128</b:ResourceUid>
                        </b:ResourceIdentity>
                        <b:SchedulerCanBookHoursFlag>true</b:SchedulerCanBookHoursFlag>
                        <b:SchedulerCanSwitchToThisCandidateFlag>false</b:SchedulerCanSwitchToThisCandidateFlag>
                        <b:SelectedCandidateFlag>true</b:SelectedCandidateFlag>
                        <b:UnnamedCandidateCostCenterIdentity i:nil="true"/>
                        <b:UnnamedCandidateFlag>false</b:UnnamedCandidateFlag>
                        <b:UnnamedCandidateLocationIdentity i:nil="true"/>
                        <b:UnnamedCandidateResourceTypeIdentity i:nil="true"/>
                        <b:UnnamedCandidateTitleIdentity i:nil="true"/>
                     </b:PwsProjectRoleCandidate>


  • No labels