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
« Previous
Version 4
Next »
Overview
This web service inserts or updates a single engagement based on a detailed engagement structure (PwsEngagementDetail). The service returns the identity (PwsEngagementRef) of the engagement that has been inserted or updated. The caller can optionally request that the full engagement detail (PwsEngagementDetail) be included in the response.
- PwsSaveEngagement
- serviceRequest: PwsSaveEngagementRq
- RequestId: Int32
- SessionTicket: String
- Engagement: PwsEngagementDetail
- FullDetailFlag: Boolean
- StealLockFlag: Boolean
- UseEtEngagementProjectDefaultsFlag: Boolean
- UseEtProjectWorkspaceDefaultsFlag: Boolean
- EngagementTimestamp: String
- SuppressCliCreationOnInsertFlag: Boolean
Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|
RequestId | Int32 |
|
| Click here for more information | 1 |
SessionTicket | String |
|
| Click here for more information | AUcfZP60RNdWSqGygrg5fw== |
Engagement | PwsEngagementDetail |
|
|
|
|
FullDetailFlag | Boolean |
|
|
| true |
StealLockFlag | Boolean |
|
|
| true |
UseEtEngagementProjectDefaultsFlag | Boolean |
|
|
| true |
UseEtProjectWorkspaceDefaultsFlag | Boolean |
|
|
| true |
EngagementTimestamp | String |
|
|
|
|
SuppressCliCreationOnInsertFlag | Boolean |
|
|
|
|
Usage Example(s)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:sch="http://projectorpsa.com/DataContracts/Shared/Scheduling/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsSaveEngagement>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>AUcfZP60RNdWSqGygrg5fw==</req:SessionTicket>
<sch:Engagement>
<com:ClientIdentity>
<com:ClientNumber>C000124</com:ClientNumber>
</com:ClientIdentity>
<com:EngagementName>Web Services Inc. - New</com:EngagementName>
<com:Address>
<com:AddressLine1>123 Main Street</com:AddressLine1>
<com:AddressLine2>100</com:AddressLine2>
<com:Attention>Billing</com:Attention>
<com:City>Boston</com:City>
<com:CompanyName>Web Services Inc.</com:CompanyName>
<com:Country>USA</com:Country>
<com:StateOrProvince>MA</com:StateOrProvince>
<com:ZipOrPostalCode>02114</com:ZipOrPostalCode>
</com:Address>
<com:BillingCultureIdentity>
<com:CultureName>en-US</com:CultureName>
</com:BillingCultureIdentity>
<com:BillingCycleIdentity>
<com:BillingCycleName>Monthly</com:BillingCycleName>
</com:BillingCycleIdentity>
<com:BillingInstructions>Please bill on the 15th of every month.</com:BillingInstructions>
<com:ClientMessage>We appreciate your business!</com:ClientMessage>
<com:ClientMessagePlain>We appreciate your business!</com:ClientMessagePlain>
<com:CostAlertsBasisType>E</com:CostAlertsBasisType>
<com:CostBudgetMetric>C</com:CostBudgetMetric>
<com:CostCenterIdentity>
<com:CostCenterName>Executive Team (USA)</com:CostCenterName>
<com:CostCenterNumber>Executive Team (USA)</com:CostCenterNumber>
</com:CostCenterIdentity>
<com:CurrencyIdentity>
<com:CurrencyCode>USD</com:CurrencyCode>
</com:CurrencyIdentity>
<com:EngagementStageIdentity>
<com:EngagementStageName>Open</com:EngagementStageName>
<com:EngagementStageShortName>Open</com:EngagementStageShortName>
</com:EngagementStageIdentity>
<com:EngagementTypeIdentity>
<com:EngagementTypeName>Billable - Time and Materials</com:EngagementTypeName>
<com:EngagementTypeShortName>TandM</com:EngagementTypeShortName>
</com:EngagementTypeIdentity>
<com:InheritAddressFlag>false</com:InheritAddressFlag>
<com:InheritBillingCycleFlag>false</com:InheritBillingCycleFlag>
<com:InheritBillingInstructionsFlag>false</com:InheritBillingInstructionsFlag>
<com:InheritClientMessageFlag>false</com:InheritClientMessageFlag>
<com:InheritInvoiceContentFlag>false</com:InheritInvoiceContentFlag>
<com:InheritInvoiceScopeFlag>false</com:InheritInvoiceScopeFlag>
<com:InheritInvoiceTemplateFlag>false</com:InheritInvoiceTemplateFlag>
<com:InheritPaymentTermFlag>false</com:InheritPaymentTermFlag>
<com:InheritPurchaseOrderNumberFlag>false</com:InheritPurchaseOrderNumberFlag>
<com:InheritTimeBillingTypeFlag>false</com:InheritTimeBillingTypeFlag>
<com:InvoiceContent>B</com:InvoiceContent>
<com:InvoiceScope>E</com:InvoiceScope>
<com:InvoiceTemplateIdentity>
<com:InvoiceTemplateName>A200</com:InvoiceTemplateName>
</com:InvoiceTemplateIdentity>
<com:ManagerIdentity>
<com:UserReferenceSystemId>E123</com:UserReferenceSystemId>
</com:ManagerIdentity>
<com:PaymentTermIdentity>
<com:PaymentTermName>Net 15</com:PaymentTermName>
</com:PaymentTermIdentity>
<com:PurchaseOrderNumber>WS-001</com:PurchaseOrderNumber>
<com:TimeAlertsBasisType>A</com:TimeAlertsBasisType>
<com:TimeBillingType>H</com:TimeBillingType>
<com:TimeBudgetMetric>B</com:TimeBudgetMetric>
<com:UserDefinedFields>
<com:PwsUserDefinedFieldDetail>
<com:UdfName>EN-Text List</com:UdfName>
<com:DataType>L</com:DataType>
<com:TextValue>EN-1A</com:TextValue>
</com:PwsUserDefinedFieldDetail>
</com:UserDefinedFields>
<com:InheritInvoiceEmailSettingsFlag>false</com:InheritInvoiceEmailSettingsFlag>
<com:InvoiceEmailSettings>
<com:EmailFromUserIdentity>
<com:UserReferenceSystemId>Partner - 01</com:UserReferenceSystemId>
</com:EmailFromUserIdentity>
<com:EmailInvoiceTemplateIdentity>
<com:InvoiceTemplateName>E003</com:InvoiceTemplateName>
</com:EmailInvoiceTemplateIdentity>
<com:InvoiceEmailEnabledFlag>true</com:InvoiceEmailEnabledFlag>
<com:InvoiceEmailType>P</com:InvoiceEmailType>
<com:Recipients>
<com:PwsInvoiceEmailRecipient>
<com:RecipientType>T</com:RecipientType>
<com:UserIdentity>
<com:UserReferenceSystemId>E123</com:UserReferenceSystemId>
</com:UserIdentity>
</com:PwsInvoiceEmailRecipient>
</com:Recipients>
</com:InvoiceEmailSettings>
<com:InheritRenderReceiptsFlag>false</com:InheritRenderReceiptsFlag>
<com:RenderReceiptsFlag>true</com:RenderReceiptsFlag>
<com:InheritAutoApplyAvailableBalanceFlag>true</com:InheritAutoApplyAvailableBalanceFlag>
<com:InheritTaxTypesFlag>false</com:InheritTaxTypesFlag>
<com:TaxType1Identity>
<com:TaxTypeCode>VAT</com:TaxTypeCode>
</com:TaxType1Identity>
</sch:Engagement>
<sch:FullDetailFlag>true</sch:FullDetailFlag>
<sch:StealLockFlag>true</sch:StealLockFlag>
<sch:UseEtEngagementProjectDefaultsFlag>true</sch:UseEtEngagementProjectDefaultsFlag>
<sch:UseEtProjectWorkspaceDefaultsFlag>true</sch:UseEtProjectWorkspaceDefaultsFlag>
<sch:SuppressCliCreationOnInsertFlag>true</sch:SuppressCliCreationOnInsertFlag>
</pws:serviceRequest>
</pws:PwsSaveEngagement>
</soapenv:Body>
</soapenv:Envelope>
- PwsSaveEngagementResponse
- PwsSaveEngagementResult: PwsSaveEngagementRs
Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|
Messages | PwsMessage | | | | |
ResponseId | Int32 | | | Click here for more information. | |
Status | RequestStatus | | | Click here for more information. | |
ServerTimestampUtc | DateTime | | | Click here for more information. | |
Engagement | PwsEngagementElement | | | | |
EngagementIdentity | PwsEngagementRef | | | | |
EngagementTimestamp | String | | | | |
LockStolenFromUserIdentity | PwsUserRef | | | | |