Overview
This web service inserts, updates or deletes project rate type(s) based on a detailed project rate type structure (PwsSaveProjectRateTypeDetail). replaces the entire collection of project rate types on the specified project with the new designated collection.
Request Format
| Panel | ||
|---|---|---|
| ||
|
...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information. | 1 | ||
String | Yes | Click here for more information. | Ab62GYARtqWE8wJFv6Pd8g== | ||
LocksToSteal | PwsEntityLockSummary[1..100] | 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. | ||
ProjectIdentity | Yes | The identity of the project. Click here for more information. | |||
ProjectRateTypes | Yes | All the project The full collection of rate types that are currently on for the project and need to be retained as well as the project rate type(s) to be added, updated or deletedto replace the prior full collection. | |||
ProjectorLockSetId | Int32 | No | A projector lock set id is an identifier for a group of one or more locks held as a unit. | ||
RateTaskTimestamp | String | No | This 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. |
...
Response Format
| Panel | ||
|---|---|---|
| ||
|
...
Element
...
Data Type
...
Required?
...
Default
...
Description
...
...
Int32
...
...
String
...
LocksToSteal
...
...
ProjectIdentity
...
...
ProjectRateTypes
...
...
ProjectorLockSetId
...
Int32
...
RateTaskTimestamp
...
String
Response Elements
Element | Data Type | Description |
|---|---|---|
Messages | The web service response status and message. Click here for more information. | |
Int32 | Click here for more information. |
RequestStatus | Click here for more information | |
DateTime | Click here for more information. |
Boolean
This flag is set to true if one or more tasks have been marked as inactive as a result of the update
RateTaskTimestamp | String | This 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. |
StolenLocks | This 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 |
RevalueReport
. |
Response Usage Example(s)
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsSaveProjectTaskTypesResponse<PwsSaveProjectRateTypesResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsSaveProjectTaskTypesResult<PwsSaveProjectRateTypesResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Scheduling/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:PwsMessage>
<b:AdditionalErrorText>Message 136: This request was executed against the QA [appqa.projectorpsa.com] environment.</b:AdditionalErrorText>
<b:ErrorCode>NonProductionEnvironment</b:ErrorCode>
<b:ErrorNumber>136</b:ErrorNumber>
<b:ErrorText>This web service request was executed against a non-production instance of Projector.</b:ErrorText>
<b:Type>Information</b:Type>
<b:ReferenceId1 i:nil="true"/>
<b:ReferenceId2 i:nil="true"/>
</b:PwsMessage>
</Messages>
<ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2020>2023-1109-30T1807T20:1703:0728.0099106Z<35366Z</ServerTimestampUtc>
<a:InactivatedFlag>true</a:InactivatedFlag>
<a:RateTaskTimestamp>AAAAABcxbqARateTaskTimestamp>AAAAADFChm4=</a:RateTaskTimestamp>
<a:StolenLocks i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<a:RevalueReport i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
</PwsSaveProjectTaskTypesResult></PwsSaveProjectRateTypesResult>
</PwsSaveProjectTaskTypesResponse>PwsSaveProjectRateTypesResponse>
</s:Body>
</s:Envelope> |
...
PwsSaveProjectRateTypes - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
| ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 15002 | ProjectNotSpecifiedForSaveTaskType | No project was specified for saving project task type. |
| 54645 | ProjectTaskTypeNameIsRequired | The project task type name is required for new project task types. |
| 54646 | ProjectTaskTypeNameAlreadyInUse | The specified project task|
| 64616 | DuplicateEntityInXml | Duplicate PwsProjectRateType entity found in input XML. |
| 54701 | ProjectRateTypeReferencedByTaskType | The project rate type <project-rate-type-name> cannot be deleted because there is at least one project task type that references it. |
| 54784 | PermissionDeniedToUpdateProjectRateType | You do not have appropriate permission to update this project rate type. |
| 54785 | StandardRateTypeInactive | The specified standard rate type is inactive. |
| 54787 | ProjectRateTypeNameInUse | The specified project rate type name is already in use by a different project rate type on this project. |
| 5464754788 | ProjectRateTypeIsRequiredProjectRateTypeExternalSystemIdentifierInUse | The default specified project rate type is required for new project task types. |
| 54650 | ProjectRateTypeNotFound | The specified default project rate type does not exist. |
| 55069 | TaskTypePurchaseOrderSpecifiedWhenInheriting | Purchase order number may not be specified when inheriting purchase order number. |
| 57556 | TaskTypeNotSpecified | The standard task type is required for new project task typesexternal system identifier is already in use by a different project rate type. External system identifiers must be globally unique. |
| 54884 | ProjectRateTypeReferencedByBaseline | The project rate type <project-rate-type-name> cannot be deleted because it is referenced by one or more baselines. |
| 54731 | ProjectRateTypeReferencedByInvoice | The project rate type <project-rate-type-name> cannot be deleted because it is referenced by at least one invoice. |
| 54761 | ProjectRateTypeReferencedByTimecard | The project rate type <project-rate-type-name> cannot be deleted because it is referenced by at least one time card. |