Versions Compared

Old Version 75

changes.mady.by.user Luke Wright

Saved on

compared with

New Version Current

changes.mady.by.user Luke Wright

Saved on

Key

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

Overview


This web service inserts or updates a single project role based on a detailed project role structure (PwsProjectRoleDetail). The service returns the identity (PwsProjectRoleRef) of the project role that has been inserted or updated. 

...

Panel
titlePwsSaveProjectRole Request
  • PwsSaveProjectRole
    • serviceRequest: PwsSaveProjectRoleRq
      • RequestId: Int32
      • SessionTicket: String
      • BaseRatesOnTitleClearFlag: Boolean
      • CandidatesClearFlag: Boolean
      • CostCenterClearFlag: Boolean
      • CostCenterCriteriaClearFlag: Boolean
      • DescriptionClearFlag: Boolean
      • EngagementTimestamp: String **deprecated**
      • InitialAllocation: PwsProjectRoleHoursPattern
      • KeywordsClearFlag: Boolean
      • LocationClearFlag: Boolean
      • LocationCriteriaClearFlag: Boolean
      • Mode: String (1)
      • ProjectIdentity: PwsProjectRef
      • ProjectRole: PwsProjectRoleDetail
      • ResourceClearFlag: Boolean
      • RoleEndDateClearFlag: Boolean
      • RoleStartDateClearFlag: Boolean
      • ShareCostCenterClearFlag: Boolean
      • SkillCriteriaClearFlag: Boolean
      • StealLockFlag: Boolean **deprecated**
      • TitleClearFlag: Boolean
      • TitleCriteriaClearFlag: Boolean
      • RdcTransferHourlyRateClearFlag: Boolean
      • RevenueTransferHourlyRateClearFlag: Boolean
      • RateExceptionsClearFlag: Boolean
      • RdcExceptionsClearFlag: Boolean
      • ResourceTypeCriteriaClearFlag: Boolean
      • FullDetailFlag: Boolean
      • LocksToSteal: PwsEntityLockSummary[1.100]
      • MakeRoleNameUniqueFlag: Boolean
      • NameRoleFlag: Boolean
      • ProjectorLockSetId: Int32
      • ResourceTypeClearFlag: Boolean
      • ShareUserClearFlag: Boolean
      • WarnOnPermissionErrorFlag: Boolean
      • ExcludeReadNotesFlag: Boolean
      • PurchaseOrderNumberClearFlag: Boolean
      • ReplaceAllocatedCriteriaWithRequestedFlag: Boolean
      • RetrievalMode: String
      • RevalueAction: String
      • RoleTypeClearFlag: Boolean

...

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.


SessionTicket

String

Yes


Click here for more information.

Ae9v30fDNwFMx833f5Hesg==

BaseRatesOnTitleClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', existing base-rate-on-title setting will be cleared (rates will be based on resource's title).

false

CandidatesClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', existing named candidates will be cleared (candidate identities defined inPwsProjectRoleDetail are ignored).

false

CostCenterClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', preferred cost center for unnamed candidate is cleared (preferred cost center identity defined in PwsProjectRoleDetail is ignored).

false

CostCenterCriteriaClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', cost center criteria for unnamed candidate is cleared (cost center criteria defined in PwsProjectRoleDetail is ignored).

false

DescriptionClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', the existing description will be cleared.

false

EngagementTimestamp

String

**deprecated**




InitialAllocationPwsProjectRoleHoursPattern

On Insert: No

On Update: No


The allocation set up for the project role upon creation.

KeywordsClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', existing keywords for unnamed candidate is cleared.

false

LocationClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', preferred location for unnamed candidate is cleared. Please note, if System Settings' Scheduling is set to "Show Location Criteria", then this flag cannot be set to 'true' because location criteria is required.

false

LocationCriteriaClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', location criteria for unnamed candidate is cleared and location criteria (LocationIdentities) defined in PwsProjectRoleDetail is ignored; If set to 'false', location criteria (LocationIdentities) will be updated if provided in PwsProjectRoleDetail.

false

Mode

String (1)

On Insert: Yes

On Update: Yes


Determine whether specified criteria applies to booked or requested criteria settings.

A: booked data for roles

R: requested data for roles

A

ProjectIdentity

PwsProjectRef

On Insert: Yes

On Update: Yes


The identity of the project that contains the project role. Click here for more information.


ProjectRole

PwsProjectRoleDetail

On Insert: Yes

On Update: Yes


Structure that contains the complete information of the project role. Please click here for more information.. If it refers to an existing project role, this request updates this project role; otherwise, this request creates a new project role.


ResourceClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', existing named resource is cleared.

false

RoleEndDateClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', existing role end date is cleared.

false

RoleStartDateClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', existing role start date is cleared.

false

ShareCostCenterClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', role's shared cost center is cleared.

false

SkillCriteriaClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', skill criteria for unnamed candidate is cleared (skill criteria defined in PwsProjectRoleDetail is ignored).

false

StealLockFlag

Boolean

**deprecated**




TitleClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', preferred title for unnamed candidate is cleared.

false

TitleCriteriaClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', title criteria for unnamed candidate is cleared (title criteria (TitleIdentities) defined in PwsProjectRoleDetail is ignored).

false

RdcTransferHourlyRateClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', RDC transfer hourly rate is cleared (RdcTransferHourlyRate defined in PwsProjectRoleDetail is ignored).

false

RevenueTransferHourlyRateClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', revenue transfer hourly rate is cleared (RevenueTransferHourlyRate defined in PwsProjectRoleDetail is ignored).

false

RateExceptionsClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', overriding rate is cleared (RateExceptions defined in PwsProjectRoleDetail is ignored).

false

RdcExceptionsClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', overriding RDC rate is cleared (RdcExceptions defined in PwsProjectRoleDetail is ignored).

false

ResourceTypeCriteriaClearFlag

Boolean

On Insert: No

On Update: No

falseIf set to 'true', the resource type criteria will be cleared. Note this will not clear the preferred or allocated resource type. Empty resource type criteria means that any resource type is acceptable.
FullDetailFlagBoolean

On Insert: No

On Update: No

falseIf set to 'true', the complete project role element structure will be included in the response.
LocksToStealPwsEntityLockSummary[1.100]

On Insert: No

On Update: No


The detailed information of the locks that are to be stolen. If not specified, the request will fail if any requested locks are already held. If specified, the information supplied must exactly match the current state of existing locks or the attempt to steal the existing locks will fail. Typically, this service is invoked with LocksToSteal empty or null. If there are existing locks, they will be returned in the LockHolders member of PwsFault. This data can then be sent, as is, back to the server in a second invocation of this service, as LocksToSteal, if the caller desires to steal the locks.
MakeRoleNameUniqueFlagBoolean

On Insert: No

On Update: No

falseIf set to 'true', and the specified role name is already in use, the service will append a number onto the end of the role name in order to make it unique. Otherwise, the service will fail if the specified role name is in use.
NameRoleFlagBoolean

On Insert: No

On Update: No

falseIf set to 'true', and no role name is specified, the service will use the resource display name to generate a role name if the role has assigned resource. Either role name or resource has to be specified. If set to 'false' (the default value), then a role name must be supplied.
ProjectorLockSetIdInt32

On Insert: No

On Update: No


A projector lock set id is an identifier for a group of one or more locks held as a unit.
ResourceTypeClearFlagBoolean

On Insert: No

On Update: No

falseIf set to 'true', the preferred or allocated resource type is cleared.
ShareUserClearFlagBoolean

On Insert: No

On Update: No

falseIf set to 'true', the shared to user is cleared for the role.
WarnOnPermissionErrorFlagBoolean

On Insert: No

On Update: No

false

If set to 'true', request will result in warnings instead of errors if user has no permission (on insert only):

- Attempt to set sharing (by user or cost center) without permission to share scheduling.
- Attempt to set billing title override without permission to maintain rates
- Attempt to set revenue transfer hourly rate without permission to maintain rates
- Attempt to set RDC transfer hourly rate without permission to maintain rates
- Attempt to set rate or RDC exceptions without permission to maintain rates

false
ExcludeReadNotesFlagBoolean

On Insert: No

On Update: No

falseIf true, notes that have been marked as read by the current user are excluded from the data returned. Applies only when FullDetailFlag is true.
PurchaseOrderNumberClearFlagBoolean

On Insert: No

On Update: No

falseIf set to 'true', the purchase order number for the role is cleared.
ReplaceAllocatedCriteriaWithRequestedFlagBoolean

On Insert: No

On Update: No

falseWhen in scheduling mode (Mode = 'A') and updating an existing role that has incomplete booked criteria, if this flag is set, any existing booked criteria is overwritten with requested criteria. Note any criteria values specified in this request will overwrite what is copied from the requested criteria.
RetrievalModeString

On Insert: No

On Update: No


Required if FullDetailFlag is set, Designate whether assigned (A), requested (R) or effective (E) criteria is returned for the role.
RevalueActionString

On Insert: No

On Update: No

N

This indicates how the service should respond if there are time cards that would become in need of revalue as a result of the changes. The valid values are:

  • N (No Revalue): Time cards are left as is and the save is completed.
  • R (Revalue): Time cards that can be revalued are revalued and the save is completed.
  • C (Check): The save operation will only proceed if there are no time cards that would be in need of revalue. RevalueReport in the response will provide details about the affected time cards.

RoleTypeClearFlagBoolean

On Insert: No

On Update: No

falseIf set to 'true' the role type for the role will be cleared.

...

Panel
titlePwsSaveProjectRole Response

...

Element

Data Type

Description

Sample Data

Messages

PwsMessage[]

The web service response status and message. Click here for more information.


ResponseId

Int32

Click here for more information.

0

Status

RequestStatus

Click here for more information.

Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018-02-14T15:34:53.8497124Z

ProjectRoleIdentity

PwsProjectRoleRef

The identity of the project role just created/updated. Click here for more information.


EngagementTimestamp

String

**deprecated**


LockStolenFromUserIdentity

PwsUserRef

**deprecated**


ProjectRolePwsProjectRoleElementThe full element structure for the role that was saved. This will be populated only if FullDetailFlag is set to 'true' in the request.
ProjectRoleTimestampStringThis is an optimistic locking timestamp that, if provided on update request, will cause the request to fail when the timestamp stored in the database does not match the provided value.
StolenLocksPwsEntityLockSummaryThis structure contains information about the locks that were stolen in order to complete this request, Will be included only when LocksToSteal is specified in the request.
ResourcePartiallyInactiveFlagBooleanIf an initial allocation is specified in the input, this will be true if the role is a named role, and the resource was inactive for at least one day during the period of time over which there are requested or booked minutes.
RevalueReportPwsRevalueReportInformation on the about time cards from on the project or project role that could be revaluedwere affected by the change. Populated only when RevalueAction is R (Revalue) or C (Check). If RevalueAction is R, the values included in this structure reflect what was done. If RevalueAction is C, the values reflect what would be done if the service were invoked again with RevalueAction set to R. 
TotalRequestedOrScheduledMinutesDoubleIf an initial allocation is specified in the input, this will be the total number of minutes that were requested or booked (depending on Mode) for the role.

...