...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | On Insert: No On Update: No | Click here for more information | 1 | |
SessionTicket | String (50) | On Insert: Yes On Update: Yes | Click here for more information | AUcfZP60RNdWSqGygrg5fw== | |
Engagement | On Insert: Yes On Update: Yes | Engagement detail element containing identity of engagement and data to be saved about the engagement | |||
FullDetailFlag | Boolean | On Insert: Yes On Update: Yes | If set to 'true', the full detailed engagement element will be included in the response | true | |
StealLockFlag | Boolean | On Insert: Yes On Update: Yes | If set to 'true', any locks on the engagement will be stolen if it is currently locked, otherwise, if it is set to 'false' and a lock is in place the service will fail | true | |
UseEtEngagementProjectDefaultsFlag | Boolean | On Insert: Yes On Update: Yes | If set to 'true', and the engagement type is updated, the engagement type defaults for the engagement and the underlying projects (except project workspace defaults) will override existing settings (and any settings explicitly specified here for engagement attributes with defaults at the engagement type level) | true | |
UseEtProjectWorkspaceDefaultsFlag | Boolean | On Insert: Yes On Update: Yes | If set to 'true', and engagement type is being changed, the engagement type defaults for the project workspace settings for underlying projects will override existing settings | true | |
EngagementTimestamp | String | On Insert: No On Update: No | This is a Base64 encoded timestamp utilized for engagement locking. For internal use only. | ||
SuppressCliCreationOnInsertFlag | Boolean | On Insert: Yes On Update: Yes | If set to 'true', a contract line item will not be created upon creation of a new engagement | true |
...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Messages | Click here for more information | ||||
ResponseId | Int32 | Click here for more information. | 1 | ||
Status | RequestStatus | Click here for more information. | Ok | ||
ServerTimestampUtc | DateTime | Click here for more information. | 2018-01-18T17:08:48.5836504Z | ||
Engagement | The complete set of information about the engagement | ||||
EngagementIdentity | The unique keys used to identify the engagement | ||||
EngagementTimestamp | String | This is a Base64 encoded timestamp utilized for engagement locking. For internal use only. | AAAAAA98Yvs= | ||
LockStolenFromUserIdentity | If a lock is stolen in the process of updating an engagement, this identifies the user from which the lock was stolen from |
Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsSaveEngagementResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsSaveEngagementResult 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/"/>
<ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-18T17:08:48.5836504Z</ServerTimestampUtc>
<a:Engagement xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:EngagementDetail>
<b:EngagementCode>P001322</b:EngagementCode>
<b:EngagementId i:nil="true"/>
<b:EngagementUid>1152921504607326388</b:EngagementUid>
<b:ClientIdentity>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000124</b:ClientNumber>
<b:ClientUid>1152921504606998465</b:ClientUid>
</b:ClientIdentity>
<b:EngagementName>Web Services Inc. - New</b:EngagementName>
<b:Address>
<b:AddressLine1>123 Main Street</b:AddressLine1>
<b:AddressLine2>100</b:AddressLine2>
<b:Attention>Billing</b:Attention>
<b:City>Boston</b:City>
<b:CompanyName>Web Services Inc.</b:CompanyName>
<b:Country>USA</b:Country>
<b:StateOrProvince>MA</b:StateOrProvince>
<b:ZipOrPostalCode>02114</b:ZipOrPostalCode>
</b:Address>
<b:BillingAdjustedRevenueTimeBudgetAmount>0</b:BillingAdjustedRevenueTimeBudgetAmount>
<b:BillingCultureIdentity>
<b:CultureId i:nil="true"/>
<b:CultureName>en-US</b:CultureName>
<b:CultureUid>1152921504606851419</b:CultureUid>
</b:BillingCultureIdentity>
<b:BillingCycleIdentity>
<b:BillingCycleId i:nil="true"/>
<b:BillingCycleName>Monthly</b:BillingCycleName>
<b:BillingCycleUid>1152921504606853180</b:BillingCycleUid>
</b:BillingCycleIdentity>
<b:BillingInstructions>Please bill on the 15th of every month.</b:BillingInstructions>
<b:ClientAmountCostBudgetAmount>0</b:ClientAmountCostBudgetAmount>
<b:ClientMessage>We appreciate your business!</b:ClientMessage>
<b:ClientMessagePlain>We appreciate your business!</b:ClientMessagePlain>
<b:ContractRevenueTimeBudgetAmount i:nil="true"/>
<b:CostAlertsBasisType>E</b:CostAlertsBasisType>
<b:CostBudgetMetric>C</b:CostBudgetMetric>
<b:CostCenterIdentity>
<b:CostCenterId i:nil="true"/>
<b:CostCenterName>Executive Team (USA)</b:CostCenterName>
<b:CostCenterNumber>Executive Team (USA)</b:CostCenterNumber>
<b:CostCenterUid>1152921504606867363</b:CostCenterUid>
</b:CostCenterIdentity>
<b:CostContractTerms i:nil="true"/>
<b:CurrencyIdentity>
<b:CurrencyCode>USD</b:CurrencyCode>
<b:CurrencyId i:nil="true"/>
<b:CurrencyUid>1152921504606851838</b:CurrencyUid>
</b:CurrencyIdentity>
<b:DisbursedAmountCostBudgetAmount i:nil="true"/>
<b:EngagementStageIdentity>
<b:EngagementStageId i:nil="true"/>
<b:EngagementStageName>Open</b:EngagementStageName>
<b:EngagementStageShortName>Open</b:EngagementStageShortName>
<b:EngagementStageUid>1152921504606849675</b:EngagementStageUid>
</b:EngagementStageIdentity>
<b:EngagementTypeIdentity>
<b:EngagementTypeId i:nil="true"/>
<b:EngagementTypeName>Billable - Time and Materials</b:EngagementTypeName>
<b:EngagementTypeShortName>TandM</b:EngagementTypeShortName>
<b:EngagementTypeUid>1152921504606863884</b:EngagementTypeUid>
</b:EngagementTypeIdentity>
<b:ExpenseAmountCostBudgetAmount i:nil="true"/>
<b:HoldbackAmount i:nil="true"/>
<b:HoldbackPercent i:nil="true"/>
<b:HoldbackType i:nil="true"/>
<b:InheritAddressFlag>false</b:InheritAddressFlag>
<b:InheritBillingCycleFlag>false</b:InheritBillingCycleFlag>
<b:InheritBillingInstructionsFlag>false</b:InheritBillingInstructionsFlag>
<b:InheritClientMessageFlag>false</b:InheritClientMessageFlag>
<b:InheritInvoiceContentFlag>false</b:InheritInvoiceContentFlag>
<b:InheritInvoiceScopeFlag>false</b:InheritInvoiceScopeFlag>
<b:InheritInvoiceTemplateFlag>false</b:InheritInvoiceTemplateFlag>
<b:InheritPaymentTermFlag>false</b:InheritPaymentTermFlag>
<b:InheritPurchaseOrderNumberFlag>false</b:InheritPurchaseOrderNumberFlag>
<b:InheritTimeBillingTypeFlag>false</b:InheritTimeBillingTypeFlag>
<b:InvoiceContent>B</b:InvoiceContent>
<b:InvoiceScope>E</b:InvoiceScope>
<b:InvoiceTemplateIdentity>
<b:InvoiceTemplateId i:nil="true"/>
<b:InvoiceTemplateName>A200</b:InvoiceTemplateName>
<b:InvoiceTemplateUid>1152921504606878904</b:InvoiceTemplateUid>
</b:InvoiceTemplateIdentity>
<b:ManagerIdentity>
<b:UserDisplayName>John Doe</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
<b:UserUid>1152921504607054221</b:UserUid>
</b:ManagerIdentity>
<b:MaxCostContractAmount i:nil="true"/>
<b:MaxTimeContractAmount i:nil="true"/>
<b:MinCostContractAmount i:nil="true"/>
<b:MinTimeContractAmount i:nil="true"/>
<b:NewEngagementCode i:nil="true"/>
<b:PaymentTermIdentity>
<b:PaymentTermId i:nil="true"/>
<b:PaymentTermName>Net 15</b:PaymentTermName>
<b:PaymentTermUid>1152921504606856053</b:PaymentTermUid>
</b:PaymentTermIdentity>
<b:PurchaseOrderNumber>WS-001</b:PurchaseOrderNumber>
<b:ResourceDirectCostTimeBudgetAmount i:nil="true"/>
<b:RevenueEarnedByDate i:nil="true"/>
<b:RevenueRecognitionMethod i:nil="true"/>
<b:TimeAlertsBasisType>A</b:TimeAlertsBasisType>
<b:TimeBillingType>H</b:TimeBillingType>
<b:TimeBudgetMetric>B</b:TimeBudgetMetric>
<b:TimeContractTerms i:nil="true"/>
<b:Timestamp>AAAAAA98Yvw=</b:Timestamp>
<b:UserDefinedFields>
<b:PwsUserDefinedFieldDetail>
<b:UdfId i:nil="true"/>
<b:UdfName>EN-Text List</b:UdfName>
<b:UdfUid>1152921504606856803</b:UdfUid>
<b:BooleanValue i:nil="true"/>
<b:DataType>L</b:DataType>
<b:DateValue i:nil="true"/>
<b:IntegerValue i:nil="true"/>
<b:ResourceIdentityValue i:nil="true"/>
<b:TextValue>EN-1A</b:TextValue>
<b:UdfTreatment>A</b:UdfTreatment>
<b:StoplightValues/>
<b:NumericValue i:nil="true"/>
<b:RelationValue i:nil="true"/>
</b:PwsUserDefinedFieldDetail>
</b:UserDefinedFields>
<b:WorkMinutesTimeBudgetAmount i:nil="true"/>
<b:CalculateEngagementBudgetFlag>true</b:CalculateEngagementBudgetFlag>
<b:ChargeableMinutesTimeBudgetAmount i:nil="true"/>
<b:InheritInvoiceEmailSettingsFlag>false</b:InheritInvoiceEmailSettingsFlag>
<b:InvoiceEmailSettings>
<b:EmailFromUserIdentity>
<b:UserDisplayName>Betty Smith</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
<b:UserUid>1152921504607011056</b:UserUid>
</b:EmailFromUserIdentity>
<b:EmailInvoiceTemplateIdentity>
<b:InvoiceTemplateId i:nil="true"/>
<b:InvoiceTemplateName>E003</b:InvoiceTemplateName>
<b:InvoiceTemplateUid>1152921504606878908</b:InvoiceTemplateUid>
</b:EmailInvoiceTemplateIdentity>
<b:InvoiceEmailEnabledFlag>true</b:InvoiceEmailEnabledFlag>
<b:InvoiceEmailType>P</b:InvoiceEmailType>
<b:Recipients>
<b:PwsInvoiceEmailRecipient>
<b:RecipientType>T</b:RecipientType>
<b:UserIdentity>
<b:UserDisplayName>John Doe</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
<b:UserUid>1152921504607054221</b:UserUid>
</b:UserIdentity>
</b:PwsInvoiceEmailRecipient>
</b:Recipients>
</b:InvoiceEmailSettings>
<b:InheritRenderReceiptsFlag>false</b:InheritRenderReceiptsFlag>
<b:RenderReceiptsFlag>true</b:RenderReceiptsFlag>
<b:AutoApplyAvailableBalanceFlag>true</b:AutoApplyAvailableBalanceFlag>
<b:InheritAutoApplyAvailableBalanceFlag>true</b:InheritAutoApplyAvailableBalanceFlag>
<b:InheritTaxTypesFlag>false</b:InheritTaxTypesFlag>
<b:TaxType1Identity>
<b:TaxTypeCode>VAT</b:TaxTypeCode>
<b:TaxTypeId i:nil="true"/>
<b:TaxTypeUid>1152921504606868258</b:TaxTypeUid>
</b:TaxType1Identity>
<b:TaxType2Identity i:nil="true"/>
<b:TaxType3Identity i:nil="true"/>
</b:EngagementDetail>
<b:ProjectIdentities/>
<b:ContractLineItems/>
<b:Client>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000124</b:ClientNumber>
<b:ClientUid>1152921504606998465</b:ClientUid>
<b:ClientName>Web Services Inc.</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:Client>
<b:EffectiveCurrencySymbol>$</b:EffectiveCurrencySymbol>
<b:EffectiveCurrencySymbolPlacement>0</b:EffectiveCurrencySymbolPlacement>
<b:EffectiveDecimalDigits>2</b:EffectiveDecimalDigits>
<b:EffectiveDefaultOpsCultureIdentity>
<b:OpsCultureId i:nil="true"/>
<b:OpsCultureName>en-US</b:OpsCultureName>
<b:OpsCultureNumber>1033</b:OpsCultureNumber>
</b:EffectiveDefaultOpsCultureIdentity>
<b:EffectiveExcelCurrencyFormat>[$$-409]#,##0.00_);[Red]([$$-409]#,##0.00);</b:EffectiveExcelCurrencyFormat>
<b:EffectiveExcelCurrencyFormatRounded>[$$-409]#,##0_);[Red]([$$-409]#,##0);</b:EffectiveExcelCurrencyFormatRounded>
<b:Manager>
<b:UserDisplayName>John Doe</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
<b:UserUid>1152921504607054221</b:UserUid>
<b:EmailAddress>john@revcorp.bb</b:EmailAddress>
<b:FirstName>John</b:FirstName>
<b:LastName>Doe</b:LastName>
<b:MiddleName i:nil="true"/>
</b:Manager>
</a:Engagement>
<a:EngagementIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:EngagementCode>P001322</b:EngagementCode>
<b:EngagementId i:nil="true"/>
<b:EngagementUid>1152921504607326388</b:EngagementUid>
</a:EngagementIdentity>
<a:EngagementTimestamp>AAAAAA98Yvs=</a:EngagementTimestamp>
<a:LockStolenFromUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
</PwsSaveEngagementResult>
</PwsSaveEngagementResponse>
</s:Body>
</s:Envelope> |