Overview

This web service retrieves a list of engagement element records (PwsEngagementElement), based upon a list of unique engagement identifiers (PwsEngagementRef).

Rate Limiting

In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm. When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate. Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly. For more information please visit: Projector Rate Limiting Behavior.

Request Format

PwsGetEngagement Request

- PwsGetEngagementRq
  - RequestId: Int32
  - SessionTicket: String (50)
  - EngagementIdentities: PwsEngagementRef [1..100]

Request Elements

Element	Data Type	Required?	Description	Sample Data
RequestId	Int32	No	Click here for more information	1
SessionTicket	String (50)	Yes	Click here for more information	AavFwbZgVb9V4tr3R7BbzQ==
EngagementIdentities	PwsEngagementRef [1..100]	Yes	One or more (up to 100) engagements to be retrieved

Request Usage Example(s)

Example 01

<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:PwsGetEngagement>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
            <sch:EngagementIdentities>
               <com:PwsEngagementRef>
                  <com:EngagementCode>P001320</com:EngagementCode>
               </com:PwsEngagementRef>
            </sch:EngagementIdentities>
         </pws:serviceRequest>
      </pws:PwsGetEngagement>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetEngagement Response

- PwsGetEngagementRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - Engagements: PwsEngagementElement [1..100]

Response Elements

Element	DataType	Description	Sample Data
Messages	PwsMessage[]	The web service response status and message. 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-17T19:38:01.0608747Z
Engagements	PwsEngagementElement [1..100]	The details of the engagements that were fetched

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetEngagementResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetEngagementResult 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-17T19:38:01.0608747Z</ServerTimestampUtc>
            <a:Engagements xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsEngagementElement>
                  <b:EngagementDetail>
                     <b:EngagementCode>P001320</b:EngagementCode>
                     <b:EngagementId i:nil="true"/>
                     <b:EngagementUid>1152921504607326368</b:EngagementUid>
                     <b:ClientIdentity>
                        <b:ClientId i:nil="true"/>
                        <b:ClientNumber>C000121</b:ClientNumber>
                        <b:ClientUid>1152921504606998462</b:ClientUid>
                     </b:ClientIdentity>
                     <b:EngagementName>Web Services Documentation</b:EngagementName>
                     <b:Address>
                        <b:AddressLine1>100 Main Street</b:AddressLine1>
                        <b:AddressLine2 i:nil="true"/>
                        <b:Attention>Finance</b:Attention>
                        <b:City>Boston</b:City>
                        <b:CompanyName>Acme 1000</b:CompanyName>
                        <b:Country>USA</b:Country>
                        <b:StateOrProvince>MA</b:StateOrProvince>
                        <b:ZipOrPostalCode>02114</b:ZipOrPostalCode>
                     </b:Address>
                     <b:BillingAdjustedRevenueTimeBudgetAmount i:nil="true"/>
                     <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 this client at the end of each month.</b:BillingInstructions>
                     <b:ClientAmountCostBudgetAmount i:nil="true"/>
                     <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>T</b:CostContractTerms>
                     <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>Executive - Contract Type</b:EngagementTypeName>
                        <b:EngagementTypeShortName>ECT</b:EngagementTypeShortName>
                        <b:EngagementTypeUid>1152921504606873528</b:EngagementTypeUid>
                     </b:EngagementTypeIdentity>
                     <b:ExpenseAmountCostBudgetAmount i:nil="true"/>
                     <b:HoldbackAmount i:nil="true"/>
                     <b:HoldbackPercent i:nil="true"/>
                     <b:HoldbackType>N</b:HoldbackType>
                     <b:InheritAddressFlag>true</b:InheritAddressFlag>
                     <b:InheritBillingCycleFlag>true</b:InheritBillingCycleFlag>
                     <b:InheritBillingInstructionsFlag>true</b:InheritBillingInstructionsFlag>
                     <b:InheritClientMessageFlag>true</b:InheritClientMessageFlag>
                     <b:InheritInvoiceContentFlag>true</b:InheritInvoiceContentFlag>
                     <b:InheritInvoiceScopeFlag>true</b:InheritInvoiceScopeFlag>
                     <b:InheritInvoiceTemplateFlag>true</b:InheritInvoiceTemplateFlag>
                     <b:InheritPaymentTermFlag>true</b:InheritPaymentTermFlag>
                     <b:InheritPurchaseOrderNumberFlag>true</b:InheritPurchaseOrderNumberFlag>
                     <b:InheritTimeBillingTypeFlag>true</b:InheritTimeBillingTypeFlag>
                     <b:InvoiceContent>B</b:InvoiceContent>
                     <b:InvoiceScope>E</b:InvoiceScope>
                     <b:InvoiceTemplateIdentity>
                        <b:InvoiceTemplateId i:nil="true"/>
                        <b:InvoiceTemplateName>A100</b:InvoiceTemplateName>
                        <b:InvoiceTemplateUid>1152921504606878901</b:InvoiceTemplateUid>
                     </b:InvoiceTemplateIdentity>
                     <b:ManagerIdentity>
                        <b:UserDisplayName>Betty Smith</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                        <b:UserUid>1152921504607011056</b:UserUid>
                     </b:ManagerIdentity>
                     <b:MaxCostContractAmount i:nil="true"/>
                     <b:MaxTimeContractAmount>30000</b:MaxTimeContractAmount>
                     <b:MinCostContractAmount i:nil="true"/>
                     <b:MinTimeContractAmount>30000</b:MinTimeContractAmount>
                     <b:NewEngagementCode i:nil="true"/>
                     <b:PaymentTermIdentity>
                        <b:PaymentTermId i:nil="true"/>
                        <b:PaymentTermName>Net 30</b:PaymentTermName>
                        <b:PaymentTermUid>1152921504606856054</b:PaymentTermUid>
                     </b:PaymentTermIdentity>
                     <b:PurchaseOrderNumber>P-001</b:PurchaseOrderNumber>
                     <b:ResourceDirectCostTimeBudgetAmount i:nil="true"/>
                     <b:RevenueEarnedByDate i:nil="true"/>
                     <b:RevenueRecognitionMethod>R</b:RevenueRecognitionMethod>
                     <b:TimeAlertsBasisType>E</b:TimeAlertsBasisType>
                     <b:TimeBillingType>H</b:TimeBillingType>
                     <b:TimeBudgetMetric>B</b:TimeBudgetMetric>
                     <b:TimeContractTerms>F</b:TimeContractTerms>
                     <b:Timestamp>AAAAAA97Wl0=</b:Timestamp>
                     <b:UserDefinedFields>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>EN-Date</b:UdfName>
                           <b:UdfUid>1152921504606856799</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>D</b:DataType>
                           <b:DateValue>2018-01-17T00:00:00Z</b:DateValue>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>EN-Numeric</b:UdfName>
                           <b:UdfUid>1152921504606856800</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>I</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue>1</b:IntegerValue>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue>1</b:NumericValue>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>EN-Resource</b:UdfName>
                           <b:UdfUid>1152921504606856801</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>R</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue>
                              <b:ResourceDisplayName>John Doe</b:ResourceDisplayName>
                              <b:ResourceId i:nil="true"/>
                              <b:ResourceReferenceSystemId>E123</b:ResourceReferenceSystemId>
                              <b:ResourceUid>1152921504607062225</b:ResourceUid>
                           </b:ResourceIdentityValue>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>EN-Text</b:UdfName>
                           <b:UdfUid>1152921504606856802</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>T</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue>Web Services Documentation</b:TextValue>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <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:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>EN-Boolean</b:UdfName>
                           <b:UdfUid>1152921504606856804</b:UdfUid>
                           <b:BooleanValue>true</b:BooleanValue>
                           <b:DataType>Y</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>EN-Stoplight</b:UdfName>
                           <b:UdfUid>1152921504606856813</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>S</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues>
                              <b:PwsStoplightValue>
                                 <b:AsOfDate>2018-01-17T00:00:00Z</b:AsOfDate>
                                 <b:SortOrder>3</b:SortOrder>
                              </b:PwsStoplightValue>
                           </b:StoplightValues>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>EN-Multiline</b:UdfName>
                           <b:UdfUid>1152921504606858520</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>T</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue>Web Services Documentation</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>true</b:InheritInvoiceEmailSettingsFlag>
                     <b:InvoiceEmailSettings>
                        <b:EmailFromUserIdentity>
                           <b:UserDisplayName>Bob 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>E001</b:InvoiceTemplateName>
                           <b:InvoiceTemplateUid>1152921504606878906</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>Abby Whelan</b:UserDisplayName>
                                 <b:UserId i:nil="true"/>
                                 <b:UserReferenceSystemId>OPA02</b:UserReferenceSystemId>
                                 <b:UserUid>1152921504607062210</b:UserUid>
                              </b:UserIdentity>
                           </b:PwsInvoiceEmailRecipient>
                        </b:Recipients>
                     </b:InvoiceEmailSettings>
                     <b:InheritRenderReceiptsFlag>true</b:InheritRenderReceiptsFlag>
                     <b:RenderReceiptsFlag>false</b:RenderReceiptsFlag>
                     <b:AutoApplyAvailableBalanceFlag>false</b:AutoApplyAvailableBalanceFlag>
                     <b:InheritAutoApplyAvailableBalanceFlag>true</b:InheritAutoApplyAvailableBalanceFlag>
                     <b:InheritTaxTypesFlag>true</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:PwsProjectRef>
                        <b:ProjectCode>P001320-001</b:ProjectCode>
                        <b:ProjectId i:nil="true"/>
                        <b:ProjectUid>1152921504607410915</b:ProjectUid>
                     </b:PwsProjectRef>
                  </b:ProjectIdentities>
                  <b:ContractLineItems>
                     <b:PwsContractLineItemElement>
                        <b:ContractLineItemDetail>
                           <b:ContractLineItemCode>P001320-CL1</b:ContractLineItemCode>
                           <b:ContractLineItemId i:nil="true"/>
                           <b:ContractLineItemUid>1152921504607083461</b:ContractLineItemUid>
                           <b:ContractLineItemName>Web Services Documentation</b:ContractLineItemName>
                           <b:EngagementIdentity>
                              <b:EngagementCode>P001320</b:EngagementCode>
                              <b:EngagementId i:nil="true"/>
                              <b:EngagementUid>1152921504607326368</b:EngagementUid>
                           </b:EngagementIdentity>
                           <b:CostContractTerms>T</b:CostContractTerms>
                           <b:DeferredRevenueOpeningBalanceEngCurrency>0</b:DeferredRevenueOpeningBalanceEngCurrency>
                           <b:DeferredRevenueOpeningBalanceEngGLCurrency>0</b:DeferredRevenueOpeningBalanceEngGLCurrency>
                           <b:HoldbackAmount i:nil="true"/>
                           <b:HoldbackPercent i:nil="true"/>
                           <b:HoldbackType>N</b:HoldbackType>
                           <b:MaxCostContractAmount i:nil="true"/>
                           <b:MaxTimeContractAmount>30000</b:MaxTimeContractAmount>
                           <b:MinCostContractAmount i:nil="true"/>
                           <b:MinTimeContractAmount>30000</b:MinTimeContractAmount>
                           <b:RevenueEarnedByDate i:nil="true"/>
                           <b:RevenueRecognitionMethod>R</b:RevenueRecognitionMethod>
                           <b:RevenueSchedule>
                              <b:PwsRevenueScheduleItem>
                                 <b:EndDate>2018-01-31T00:00:00Z</b:EndDate>
                                 <b:ScheduledRevenueAmount>10000</b:ScheduledRevenueAmount>
                                 <b:StartDate i:nil="true"/>
                                 <b:ContractedMinutes i:nil="true"/>
                                 <b:Notes>January Bucket</b:Notes>
                              </b:PwsRevenueScheduleItem>
                              <b:PwsRevenueScheduleItem>
                                 <b:EndDate>2018-02-28T00:00:00Z</b:EndDate>
                                 <b:ScheduledRevenueAmount>10000</b:ScheduledRevenueAmount>
                                 <b:StartDate>2018-02-01T00:00:00Z</b:StartDate>
                                 <b:ContractedMinutes i:nil="true"/>
                                 <b:Notes>February Bucket</b:Notes>
                              </b:PwsRevenueScheduleItem>
                              <b:PwsRevenueScheduleItem>
                                 <b:EndDate>2018-03-31T00:00:00Z</b:EndDate>
                                 <b:ScheduledRevenueAmount>10000</b:ScheduledRevenueAmount>
                                 <b:StartDate>2018-03-01T00:00:00Z</b:StartDate>
                                 <b:ContractedMinutes i:nil="true"/>
                                 <b:Notes>March Bucket</b:Notes>
                              </b:PwsRevenueScheduleItem>
                           </b:RevenueSchedule>
                           <b:TimeContractTerms>F</b:TimeContractTerms>
                           <b:ContractTypeIdentity i:nil="true"/>
                           <b:InheritPurchaseOrderNumberFlag>true</b:InheritPurchaseOrderNumberFlag>
                           <b:ModelContractedHoursAndOveragesFlag>false</b:ModelContractedHoursAndOveragesFlag>
                           <b:OverageProjectIdentity i:nil="true"/>
                           <b:PurchaseOrderNumber>P-001</b:PurchaseOrderNumber>
                        </b:ContractLineItemDetail>
                        <b:LastFroTimeCardDate i:nil="true"/>
                        <b:LastRevenueRecognitionCutoffDate i:nil="true"/>
                        <b:Milestones>
                           <b:PwsContractLineItemMilestoneElement>
                              <b:CreatedByUserIdentity>
                                 <b:UserDisplayName>Betty Smith</b:UserDisplayName>
                                 <b:UserId i:nil="true"/>
                                 <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                                 <b:UserUid>1152921504607011056</b:UserUid>
                              </b:CreatedByUserIdentity>
                              <b:CreatedTimestamp>2018-01-17T14:33:57.233</b:CreatedTimestamp>
                              <b:InvoiceIdentity i:nil="true"/>
                              <b:LastUpdatedByUserIdentity>
                                 <b:UserDisplayName>Betty Smith</b:UserDisplayName>
                                 <b:UserId i:nil="true"/>
                                 <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                                 <b:UserUid>1152921504607011056</b:UserUid>
                              </b:LastUpdatedByUserIdentity>
                              <b:LastUpdatedTimestamp>2018-01-17T14:36:06.583</b:LastUpdatedTimestamp>
                              <b:MilestoneDetail>
                                 <b:ContractLineItemMilestoneId i:nil="true"/>
                                 <b:ContractLineItemMilestoneUid>1152921504607106569</b:ContractLineItemMilestoneUid>
                                 <b:AchievedDate i:nil="true"/>
                                 <b:ContractLineItemIdentity>
                                    <b:ContractLineItemCode>P001320-CL1</b:ContractLineItemCode>
                                    <b:ContractLineItemId i:nil="true"/>
                                    <b:ContractLineItemUid>1152921504607083461</b:ContractLineItemUid>
                                 </b:ContractLineItemIdentity>
                                 <b:ContractLineItemMilestoneName>Milestone for period starting 01-Feb-2018</b:ContractLineItemMilestoneName>
                                 <b:MilestoneAmount>10000</b:MilestoneAmount>
                                 <b:PlannedDate i:nil="true"/>
                                 <b:Description>February Milestone</b:Description>
                                 <b:ForegoneFlag>false</b:ForegoneFlag>
                                 <b:ProjectIdentity>
                                    <b:ProjectCode>P001320-001</b:ProjectCode>
                                    <b:ProjectId i:nil="true"/>
                                    <b:ProjectUid>1152921504607410915</b:ProjectUid>
                                 </b:ProjectIdentity>
                                 <b:ProjectTaskIdentity>
                                    <b:ExternalSystemIdentifier i:nil="true"/>
                                    <b:ProjectTaskId i:nil="true"/>
                                    <b:ProjectTaskUid>1152921504608715269</b:ProjectTaskUid>
                                 </b:ProjectTaskIdentity>
                              </b:MilestoneDetail>
                              <b:MilestoneStatus>P</b:MilestoneStatus>
                              <b:PurchaseOrderNumber i:nil="true"/>
                           </b:PwsContractLineItemMilestoneElement>
                           <b:PwsContractLineItemMilestoneElement>
                              <b:CreatedByUserIdentity>
                                 <b:UserDisplayName>Betty Smith</b:UserDisplayName>
                                 <b:UserId i:nil="true"/>
                                 <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                                 <b:UserUid>1152921504607011056</b:UserUid>
                              </b:CreatedByUserIdentity>
                              <b:CreatedTimestamp>2018-01-17T14:33:57.143</b:CreatedTimestamp>
                              <b:InvoiceIdentity i:nil="true"/>
                              <b:LastUpdatedByUserIdentity>
                                 <b:UserDisplayName>Betty Smith</b:UserDisplayName>
                                 <b:UserId i:nil="true"/>
                                 <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                                 <b:UserUid>1152921504607011056</b:UserUid>
                              </b:LastUpdatedByUserIdentity>
                              <b:LastUpdatedTimestamp>2018-01-17T14:36:06.58</b:LastUpdatedTimestamp>
                              <b:MilestoneDetail>
                                 <b:ContractLineItemMilestoneId i:nil="true"/>
                                 <b:ContractLineItemMilestoneUid>1152921504607106568</b:ContractLineItemMilestoneUid>
                                 <b:AchievedDate i:nil="true"/>
                                 <b:ContractLineItemIdentity>
                                    <b:ContractLineItemCode>P001320-CL1</b:ContractLineItemCode>
                                    <b:ContractLineItemId i:nil="true"/>
                                    <b:ContractLineItemUid>1152921504607083461</b:ContractLineItemUid>
                                 </b:ContractLineItemIdentity>
                                 <b:ContractLineItemMilestoneName>Milestone for period starting 01-Jan-2018</b:ContractLineItemMilestoneName>
                                 <b:MilestoneAmount>10000</b:MilestoneAmount>
                                 <b:PlannedDate i:nil="true"/>
                                 <b:Description>January Milestone</b:Description>
                                 <b:ForegoneFlag>false</b:ForegoneFlag>
                                 <b:ProjectIdentity>
                                    <b:ProjectCode>P001320-001</b:ProjectCode>
                                    <b:ProjectId i:nil="true"/>
                                    <b:ProjectUid>1152921504607410915</b:ProjectUid>
                                 </b:ProjectIdentity>
                                 <b:ProjectTaskIdentity>
                                    <b:ExternalSystemIdentifier i:nil="true"/>
                                    <b:ProjectTaskId i:nil="true"/>
                                    <b:ProjectTaskUid>1152921504608715269</b:ProjectTaskUid>
                                 </b:ProjectTaskIdentity>
                              </b:MilestoneDetail>
                              <b:MilestoneStatus>P</b:MilestoneStatus>
                              <b:PurchaseOrderNumber i:nil="true"/>
                           </b:PwsContractLineItemMilestoneElement>
                           <b:PwsContractLineItemMilestoneElement>
                              <b:CreatedByUserIdentity>
                                 <b:UserDisplayName>Betty Smith</b:UserDisplayName>
                                 <b:UserId i:nil="true"/>
                                 <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                                 <b:UserUid>1152921504607011056</b:UserUid>
                              </b:CreatedByUserIdentity>
                              <b:CreatedTimestamp>2018-01-17T14:33:57.237</b:CreatedTimestamp>
                              <b:InvoiceIdentity i:nil="true"/>
                              <b:LastUpdatedByUserIdentity>
                                 <b:UserDisplayName>Betty Smith</b:UserDisplayName>
                                 <b:UserId i:nil="true"/>
                                 <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                                 <b:UserUid>1152921504607011056</b:UserUid>
                              </b:LastUpdatedByUserIdentity>
                              <b:LastUpdatedTimestamp>2018-01-17T14:36:06.587</b:LastUpdatedTimestamp>
                              <b:MilestoneDetail>
                                 <b:ContractLineItemMilestoneId i:nil="true"/>
                                 <b:ContractLineItemMilestoneUid>1152921504607106570</b:ContractLineItemMilestoneUid>
                                 <b:AchievedDate i:nil="true"/>
                                 <b:ContractLineItemIdentity>
                                    <b:ContractLineItemCode>P001320-CL1</b:ContractLineItemCode>
                                    <b:ContractLineItemId i:nil="true"/>
                                    <b:ContractLineItemUid>1152921504607083461</b:ContractLineItemUid>
                                 </b:ContractLineItemIdentity>
                                 <b:ContractLineItemMilestoneName>Milestone for period starting 01-Mar-2018</b:ContractLineItemMilestoneName>
                                 <b:MilestoneAmount>10000</b:MilestoneAmount>
                                 <b:PlannedDate i:nil="true"/>
                                 <b:Description>March Milestone</b:Description>
                                 <b:ForegoneFlag>false</b:ForegoneFlag>
                                 <b:ProjectIdentity>
                                    <b:ProjectCode>P001320-001</b:ProjectCode>
                                    <b:ProjectId i:nil="true"/>
                                    <b:ProjectUid>1152921504607410915</b:ProjectUid>
                                 </b:ProjectIdentity>
                                 <b:ProjectTaskIdentity>
                                    <b:ExternalSystemIdentifier i:nil="true"/>
                                    <b:ProjectTaskId i:nil="true"/>
                                    <b:ProjectTaskUid>1152921504608715269</b:ProjectTaskUid>
                                 </b:ProjectTaskIdentity>
                              </b:MilestoneDetail>
                              <b:MilestoneStatus>P</b:MilestoneStatus>
                              <b:PurchaseOrderNumber i:nil="true"/>
                           </b:PwsContractLineItemMilestoneElement>
                        </b:Milestones>
                        <b:RevenueCutoffDate>1753-01-01T00:00:00Z</b:RevenueCutoffDate>
                     </b:PwsContractLineItemElement>
                  </b:ContractLineItems>
                  <b:Client>
                     <b:ClientId i:nil="true"/>
                     <b:ClientNumber>C000121</b:ClientNumber>
                     <b:ClientUid>1152921504606998462</b:ClientUid>
                     <b:ClientName>Parent 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>Betty Smith</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                     <b:UserUid>1152921504607011056</b:UserUid>
                     <b:EmailAddress>betty@revcorp.bb</b:EmailAddress>
                     <b:FirstName>Betty</b:FirstName>
                     <b:LastName>Smith</b:LastName>
                     <b:MiddleName i:nil="true"/>
                  </b:Manager>
               </b:PwsEngagementElement>
            </a:Engagements>
         </PwsGetEngagementResult>
      </PwsGetEngagementResponse>
   </s:Body>
</s:Envelope>

PwsGetEngagement - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText
105	AtLeastOneItemNotFound	One or more specified engagements not found
12042	NoEngagementsSpecified	No engagements specified for retrieval
12044	MaximumEngagementIdentitiesExceeded	Attempt to retrieve more than the maximum allowable number of engagements at once
50045	ViewPermissionDenied	Permission denied
54059	EngagementNotSpecified	A specified engagement reference was incomplete or missing
54064	UnexpectedErrorRetrievingEngagements	Unexpected error retrieving engagements
54370	NoPermissionToViewEngagement	Permission denied to view specific engagement

API Documentation

PwsGetEngagement

Analytics

Overview

Request Format

Request Elements

Request Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

PwsGetEngagement - Common Errors and Warnings

Related content

PwsGetEngagement

[data-colorid=d4zknpbzk6]{color:#292a2e} html[data-color-mode=dark] [data-colorid=d4zknpbzk6]{color:#d1d2d6}[data-colorid=llwpfgrafe]{color:#292a2e} html[data-color-mode=dark] [data-colorid=llwpfgrafe]{color:#d1d2d6}Overview

Request Format

Request Elements

Request Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

PwsGetEngagement - Common Errors and Warnings

Related content

Overview