...
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 and is set to basing rate (rates will be based on resource's title. BaseRateOnTitleIdentity in PwsProjectRoleDetail must be undefined*; if set to 'false', base-rate-on-title will be updated if BaseRateOnTitleIdentity provided in PwsProjectRoleDetail. ). | false | ||||
CandidatesClearFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', existing named candidates will be cleared and (candidate identities defined inPwsProjectRoleDetail is ignored; If set to 'false', candidates will be updated if identities are provided in PwsProjectRoleDetail are ignored). | false | ||||
CostCenterClearFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', preferred cost center for unnamed candidate is cleared and (preferred cost center identity defined in PwsProjectRoleDetail is ignored; If set to 'false', preferred cost center identities will be updated if provided in PwsProjectRoleDetail). | false | ||||
CostCenterCriteriaClearFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', cost center criteria for unnamed candidate is cleared and (cost center criteria defined in PwsProjectRoleDetail is ignored; If set to 'false', cost center criteria will be updated if provided in PwsProjectRoleDetail). | false | ||||
DescriptionClearFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', the existing description will be cleared. Description in PwsProjectRoleDetail must be undefined*; if set to 'false', description will be updated if provided in PwsProjectRoleDetail. | false | ||||
EngagementTimestamp | String | No | This is a Base64 encoded timestamp utilized for engagement locking. To protect against overwriting other changes, you may optionally echo back the timestamp returned by PwsGetProject or a prior call to PwsSaveProjectRole. This will cause the request to fail if any change has been made between invocations of PwsGetProject and PwsSaveProjectRole. | ||||||
KeywordsClearFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', existing keywords for unnamed candidate is cleared. Keywords in PwsProjectRoleDetail must be undefined*; If set to 'false', keywords will be updated if provided in PwsProjectRoleDetail. | false | ||||
LocationClearFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', preferred location for unnamed candidate is cleared. LocationIdentity in PwsProjectRoleDetail must be undefined*; If set to 'false', preferred location will be updated if provided in PwsProjectRoleDetail. Please note, if System Settings' Scheduling is set to "Show Location Criteria", then this flag cannot be set to 'true' because it will trigger either error 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: YesA: booked data | Determine whether specified criteria applies to booked or requested criteria settings. A: booked data for roles R: requested data for roles | A | |||||
ProjectIdentity | On Insert: Yes On Update: Yes | The identity of the project that contains the project role(s). Click here for more information. | |||||||
ProjectRole | 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. Named resource (resourceIdentity) in PwsProjectRoleDetail must be undefined*; If set to 'false', named resource (resourceIdentity) will be updated if provided in PwsProjectRoleDetail. | false | ||||
RoleEndDateClearFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', existing role end date is cleared. Role end date in PwsProjectRoleDetail must be undefined*; If set to 'false', existing role end date will be updated if provided in PwsProjectRoleDetail. | false | RoleStartDateClearFlag | Boolean | false | |
RoleStartDateClearFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', existing role start date is cleared. Role end date in PwsProjectRoleDetail must be undefined*; If set to 'false', existing role start date will be updated if provided in PwsProjectRoleDetail. | false | ||||
ShareCostCenterClearFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', role's shared cost center is cleared. Shared cost center (shareCostCenterIdentity) in PwsProjectRoleDetail must be undefined*; If set to 'false', Shared cost center (shareCostCenterIdentity)will be updated if provided in PwsProjectRoleDetail. | false | ||||
SkillCriteriaClearFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', skill criteria for unnamed candidate is cleared and (skill criteria defined in PwsProjectRoleDetail is ignored; If set to 'false', skill criteria will be updated if provided in PwsProjectRoleDetail). | false | ||||
StealLockFlag | Boolean | No | false | True to steal lock if it is currently locked (otherwise, service will fail if engagement is locked) . | false | ||||
TitleClearFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', preferred title for unnamed candidate is cleared. Preferred title (TitleIdentity) in PwsProjectRoleDetail must be undefined*; If set to 'false', preferred title (TitleIdentity)will be updated if provided in PwsProjectRoleDetail. | false | ||||
TitleCriteriaClearFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', title criteria for unnamed candidate is cleared and (title criteria (TitleIdentities) defined in PwsProjectRoleDetail is ignored; If set to 'false', title criteria (TitleIdentities) will be updated if provided in PwsProjectRoleDetail. | false | ||||
RdcTransferHourlyRateClearFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', RDC transfer hourly rate is cleared and RdcTransferHourlyRate defined in PwsProjectRoleDetail is ignored; If set to 'false', RdcTransferHourlyRate will be updated if provided in PwsProjectRoleDetail(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 and (RevenueTransferHourlyRate defined in PwsProjectRoleDetail is ignored; If set to 'false', RevenueTransferHourlyRate will be updated if provided in PwsProjectRoleDetail). | false | ||||
RateExceptionsClearFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', overriding rate is cleared and (RateExceptions defined in PwsProjectRoleDetail is ignored; If set to 'false', RateExceptions will be updated if provided in PwsProjectRoleDetail). | false | ||||
RdcExceptionsClearFlag | Boolean | On Insert: No On Update: No | false | If set to 'true', overriding RDC rate is cleared and (RdcExceptions defined in PwsProjectRoleDetail is ignored; If set to 'false', RdcExceptions will be updated if provided in PwsProjectRoleDetail). | false |
Request Usage Example(s)
...
Element | Data Type | Description | Sample Data |
---|---|---|---|
Messages | 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 | The identity of the project role just created/updated. Click here for more information. | ||
EngagementTimestamp | String | This is a Base64 encoded timestamp utilized for engagement locking. To protect against overwriting other changes, you may optionally echo back the timestamp returned by a call to PwsSaveEngagement(or a prior call to PwsSaveEngagement). This will cause the request to fail if any change has been made between invocations of PwsGetEngagement and PwsSaveEngagement.See Request Elements above for more details. | AAAAAA+d7G0= |
LockStolenFromUserIdentity | The If an existing lock was stolen, this is the identity of the user from whom the engagement lock is was stolen from. Click here for more information. |
...