- Created by Min Zeng , last modified on Jan 17, 2018
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 3 Next »
Overview
This web service retrieves a list of engagement element records (PwsEngagementElement), based upon a list of unique engagement identifiers (PwsEngagementRef).
Request Format
PwsGetProject Request
- PwsGetProject
- serviceRequest: PwsGetProjectRq
- RequestId: Int32
- SessionTicket: String
- Mode: String
- ProjectIdentities: PwsProjectRef[1..100]
- serviceRequest: PwsGetProjectRq
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information | 1 | ||
String (50) | Yes | Click here for more information | AW1yokY4MDImXfp9pM5NRw== | ||
| Mode | String (1) | Yes | The mode determines the hours returned in response. If set to "R", requested hours; "A", booked hours; and "E" effective hours (requested hours for requested roles and booked hours for booked roles). | R/A/E | |
ProjectIdentities | PwsEngagementRef [1..100] | Yes | The details of the projects that are returned |
Request Usage Example(s)
Example 01 Expand source
<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:PwsGetProject>
<pws:serviceRequest>
<req:SessionTicket>AW1yokY4MDImXfp9pM5NRw==</req:SessionTicket>
<sch:Mode>R</sch:Mode>
<sch:ProjectIdentities>
<com:PwsProjectRef>
<com:ProjectCode>P001053-001</com:ProjectCode>
</com:PwsProjectRef>
</sch:ProjectIdentities>
</pws:serviceRequest>
</pws:PwsGetProject>
</soapenv:Body>
</soapenv:Envelope>
Response Format
PwsGetEngagement Response
- PwsGetEngagementRs
- Messages: PwsMessage
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- Engagements: PwsEngagementElement [0..100]
- PwsGetEngagementRs
Response Elements
| Element | DataType | Description | Sample Data |
|---|---|---|---|
| Messages | PwsMessage | Click here for more information | |
| ResponseId | Int32 | Click here for more information | 1 |
| Status | String | Click here for more information | Ok |
| ServerTimestampUtc | DateTime | Click here for more information | 2018-01-06T18:13:56.3412573Z |
| Engagements | PwsEngagementElement [0..100] | The details of the engagements that were fetched |
Response Usage Example(s)
Example 01 - Single Engagement Expand source
<PwsGetEngagementResponse>
<PwsGetEngagementResult>
<Messages i:nil="true"/>
<ResponseId>1</ResponseId>
<Status>Ok</Status>
<ServerTimestampUtc>2018-01-06T18:13:56.3412573Z</ServerTimestampUtc>
<a:Engagements>
<PwsEngagementElement>
<EngagementDetail>
<EngagementCode>E001396</EngagementCode>
<EngagementId i:nil="true"/>
<EngagementUid>1152921504607324699</EngagementUid>
<ClientIdentity>
<ClientId i:nil="true"/>
<ClientNumber>Projector PSA</ClientNumber>
<ClientUid>1152921504606961482</ClientUid>
</ClientIdentity>
<EngagementName>Web Services Engagement</EngagementName>
<Address>
<AddressLine1>85 Merrimac Street</AddressLine1>
<AddressLine2>200</AddressLine2>
<Attention i:nil="true"/>
<City>Boston</City>
<CompanyName>Projector PSA</CompanyName>
<Country>USA</Country>
<StateOrProvince>MA</StateOrProvince>
<ZipOrPostalCode>02114</ZipOrPostalCode>
</Address>
<BillingAdjustedRevenueTimeBudgetAmount>25000</BillingAdjustedRevenueTimeBudgetAmount>
<BillingCultureIdentity>
<CultureId i:nil="true"/>
<CultureName>en-US</CultureName>
<CultureUid>1152921504606851419</CultureUid>
</BillingCultureIdentity>
<BillingCycleIdentity>
<BillingCycleId i:nil="true"/>
<BillingCycleName>Monthly</BillingCycleName>
<BillingCycleUid>1152921504606853180</BillingCycleUid>
</BillingCycleIdentity>
<BillingInstructions>This client should be billed on the 15th of each month.</BillingInstructions>
<ClientAmountCostBudgetAmount>10000</ClientAmountCostBudgetAmount>
<ClientMessage>Thank you for using revcorp-bb. We appreciate your business.</ClientMessage>
<ClientMessagePlain>Thank you for using revcorp-bb. We appreciate your business.</ClientMessagePlain>
<ContractRevenueTimeBudgetAmount i:nil="true"/>
<CostAlertsBasisType>E</CostAlertsBasisType>
<CostBudgetMetric>C</CostBudgetMetric>
<CostCenterIdentity>
<CostCenterId i:nil="true"/>
<CostCenterName>Executive Team (USA)</CostCenterName>
<CostCenterNumber>Executive Team (USA)</CostCenterNumber>
<CostCenterUid>1152921504606867363</CostCenterUid>
</CostCenterIdentity>
<CostContractTerms>T</CostContractTerms>
<CurrencyIdentity>
<CurrencyCode>USD</CurrencyCode>
<CurrencyId i:nil="true"/>
<CurrencyUid>1152921504606851838</CurrencyUid>
</CurrencyIdentity>
<DisbursedAmountCostBudgetAmount i:nil="true"/>
<EngagementStageIdentity>
<EngagementStageId i:nil="true"/>
<EngagementStageName>Open</EngagementStageName>
<EngagementStageShortName>Open</EngagementStageShortName>
<EngagementStageUid>1152921504606849675</EngagementStageUid>
</EngagementStageIdentity>
<EngagementTypeIdentity>
<EngagementTypeId i:nil="true"/>
<EngagementTypeName>Billable - Time and Materials</EngagementTypeName>
<EngagementTypeShortName>T&M</EngagementTypeShortName>
<EngagementTypeUid>1152921504606863884</EngagementTypeUid>
</EngagementTypeIdentity>
<ExpenseAmountCostBudgetAmount i:nil="true"/>
<HoldbackAmount i:nil="true"/>
<HoldbackPercent i:nil="true"/>
<HoldbackType>N</HoldbackType>
<InheritAddressFlag>true</InheritAddressFlag>
<InheritBillingCycleFlag>true</InheritBillingCycleFlag>
<InheritBillingInstructionsFlag>true</InheritBillingInstructionsFlag>
<InheritClientMessageFlag>true</InheritClientMessageFlag>
<InheritInvoiceContentFlag>true</InheritInvoiceContentFlag>
<InheritInvoiceScopeFlag>true</InheritInvoiceScopeFlag>
<InheritInvoiceTemplateFlag>true</InheritInvoiceTemplateFlag>
<InheritPaymentTermFlag>true</InheritPaymentTermFlag>
<InheritPurchaseOrderNumberFlag>true</InheritPurchaseOrderNumberFlag>
<InheritTimeBillingTypeFlag>true</InheritTimeBillingTypeFlag>
<InvoiceContent>B</InvoiceContent>
<InvoiceScope>E</InvoiceScope>
<InvoiceTemplateIdentity>
<InvoiceTemplateId i:nil="true"/>
<InvoiceTemplateName>A200</InvoiceTemplateName>
<InvoiceTemplateUid>1152921504606878904</InvoiceTemplateUid>
</InvoiceTemplateIdentity>
<ManagerIdentity>
<UserDisplayName>Jack Spratt</UserDisplayName>
<UserId i:nil="true"/>
<UserReferenceSystemId>E123</UserReferenceSystemId>
<UserUid>1152921504607112369</UserUid>
</ManagerIdentity>
<MaxCostContractAmount i:nil="true"/>
<MaxTimeContractAmount>120000</MaxTimeContractAmount>
<MinCostContractAmount i:nil="true"/>
<MinTimeContractAmount>120000</MinTimeContractAmount>
<NewEngagementCode i:nil="true"/>
<PaymentTermIdentity>
<PaymentTermId i:nil="true"/>
<PaymentTermName>Net 30</PaymentTermName>
<PaymentTermUid>1152921504606856054</PaymentTermUid>
</PaymentTermIdentity>
<PurchaseOrderNumber>PO Projector PSA</PurchaseOrderNumber>
<ResourceDirectCostTimeBudgetAmount i:nil="true"/>
<RevenueEarnedByDate i:nil="true"/>
<RevenueRecognitionMethod>R</RevenueRecognitionMethod>
<TimeAlertsBasisType>E</TimeAlertsBasisType>
<TimeBillingType>H</TimeBillingType>
<TimeBudgetMetric>B</TimeBudgetMetric>
<TimeContractTerms>F</TimeContractTerms>
<Timestamp>AAAAAA61gU8=</Timestamp>
<UserDefinedFields/>
<WorkMinutesTimeBudgetAmount i:nil="true"/>
<CalculateEngagementBudgetFlag>true</CalculateEngagementBudgetFlag>
<ChargeableMinutesTimeBudgetAmount i:nil="true"/>
<InheritInvoiceEmailSettingsFlag>true</InheritInvoiceEmailSettingsFlag>
<InvoiceEmailSettings>
<EmailFromUserIdentity>
<UserDisplayName>Bob Smith</UserDisplayName>
<UserId i:nil="true"/>
<UserReferenceSystemId>Partner - 01</UserReferenceSystemId>
<UserUid>1152921504607011056</UserUid>
</EmailFromUserIdentity>
<EmailInvoiceTemplateIdentity>
<InvoiceTemplateId i:nil="true"/>
<InvoiceTemplateName>E004</InvoiceTemplateName>
<InvoiceTemplateUid>1152921504606878909</InvoiceTemplateUid>
</EmailInvoiceTemplateIdentity>
<InvoiceEmailEnabledFlag>true</InvoiceEmailEnabledFlag>
<InvoiceEmailType>H</InvoiceEmailType>
<Recipients>
<PwsInvoiceEmailRecipient>
<RecipientType>T</RecipientType>
<UserIdentity>
<UserDisplayName>Jane Doe</UserDisplayName>
<UserId i:nil="true"/>
<UserReferenceSystemId>E124</UserReferenceSystemId>
<UserUid>1152921504607112368</UserUid>
</UserIdentity>
</PwsInvoiceEmailRecipient>
</Recipients>
</InvoiceEmailSettings>
<InheritRenderReceiptsFlag>true</InheritRenderReceiptsFlag>
<RenderReceiptsFlag>true</RenderReceiptsFlag>
<AutoApplyAvailableBalanceFlag>true</AutoApplyAvailableBalanceFlag>
<InheritAutoApplyAvailableBalanceFlag>true</InheritAutoApplyAvailableBalanceFlag>
<InheritTaxTypesFlag>true</InheritTaxTypesFlag>
<TaxType1Identity>
<TaxTypeCode>VAT</TaxTypeCode>
<TaxTypeId i:nil="true"/>
<TaxTypeUid>1152921504606868258</TaxTypeUid>
</TaxType1Identity>
<TaxType2Identity i:nil="true"/>
<TaxType3Identity i:nil="true"/>
</EngagementDetail>
<ProjectIdentities>
<PwsProjectRef>
<ProjectCode>P001396-001</ProjectCode>
<ProjectId i:nil="true"/>
<ProjectUid>1152921504607412210</ProjectUid>
</PwsProjectRef>
</ProjectIdentities>
<ContractLineItems>
<PwsContractLineItemElement>
<ContractLineItemDetail>
<ContractLineItemCode>P001396-CL1</ContractLineItemCode>
<ContractLineItemId i:nil="true"/>
<ContractLineItemUid>1152921504607083378</ContractLineItemUid>
<ContractLineItemName>Web Services Engagement (A)</ContractLineItemName>
<EngagementIdentity>
<EngagementCode>E001396</EngagementCode>
<EngagementId i:nil="true"/>
<EngagementUid>1152921504607324699</EngagementUid>
</EngagementIdentity>
<CostContractTerms>T</CostContractTerms>
<DeferredRevenueOpeningBalanceEngCurrency>0</DeferredRevenueOpeningBalanceEngCurrency>
<DeferredRevenueOpeningBalanceEngGLCurrency>0</DeferredRevenueOpeningBalanceEngGLCurrency>
<HoldbackAmount i:nil="true"/>
<HoldbackPercent i:nil="true"/>
<HoldbackType>N</HoldbackType>
<MaxCostContractAmount i:nil="true"/>
<MaxTimeContractAmount>120000</MaxTimeContractAmount>
<MinCostContractAmount i:nil="true"/>
<MinTimeContractAmount>120000</MinTimeContractAmount>
<RevenueEarnedByDate i:nil="true"/>
<RevenueRecognitionMethod>R</RevenueRecognitionMethod>
<RevenueSchedule>
<PwsRevenueScheduleItem>
<EndDate>2018-01-31T00:00:00Z</EndDate>
<ScheduledRevenueAmount>10000</ScheduledRevenueAmount>
<StartDate i:nil="true"/>
<ContractedMinutes i:nil="true"/>
<Notes i:nil="true"/>
</PwsRevenueScheduleItem>
<PwsRevenueScheduleItem>
<EndDate>2018-02-28T00:00:00Z</EndDate>
<ScheduledRevenueAmount>10000</ScheduledRevenueAmount>
<StartDate>2018-02-01T00:00:00Z</StartDate>
<ContractedMinutes i:nil="true"/>
<Notes i:nil="true"/>
</PwsRevenueScheduleItem>
<PwsRevenueScheduleItem>
<EndDate>2018-03-31T00:00:00Z</EndDate>
<ScheduledRevenueAmount>10000</ScheduledRevenueAmount>
<StartDate>2018-03-01T00:00:00Z</StartDate>
<ContractedMinutes i:nil="true"/>
<Notes i:nil="true"/>
</PwsRevenueScheduleItem>
<PwsRevenueScheduleItem>
<EndDate>2018-04-30T00:00:00Z</EndDate>
<ScheduledRevenueAmount>10000</ScheduledRevenueAmount>
<StartDate>2018-04-01T00:00:00Z</StartDate>
<ContractedMinutes i:nil="true"/>
<Notes i:nil="true"/>
</PwsRevenueScheduleItem>
<PwsRevenueScheduleItem>
<EndDate>2018-05-31T00:00:00Z</EndDate>
<ScheduledRevenueAmount>10000</ScheduledRevenueAmount>
<StartDate>2018-05-01T00:00:00Z</StartDate>
<ContractedMinutes i:nil="true"/>
<Notes i:nil="true"/>
</PwsRevenueScheduleItem>
<PwsRevenueScheduleItem>
<EndDate>2018-06-30T00:00:00Z</EndDate>
<ScheduledRevenueAmount>10000</ScheduledRevenueAmount>
<StartDate>2018-06-01T00:00:00Z</StartDate>
<ContractedMinutes i:nil="true"/>
<Notes i:nil="true"/>
</PwsRevenueScheduleItem>
<PwsRevenueScheduleItem>
<EndDate>2018-07-31T00:00:00Z</EndDate>
<ScheduledRevenueAmount>10000</ScheduledRevenueAmount>
<StartDate>2018-07-01T00:00:00Z</StartDate>
<ContractedMinutes i:nil="true"/>
<Notes i:nil="true"/>
</PwsRevenueScheduleItem>
<PwsRevenueScheduleItem>
<EndDate>2018-08-31T00:00:00Z</EndDate>
<ScheduledRevenueAmount>10000</ScheduledRevenueAmount>
<StartDate>2018-08-01T00:00:00Z</StartDate>
<ContractedMinutes i:nil="true"/>
<Notes i:nil="true"/>
</PwsRevenueScheduleItem>
<PwsRevenueScheduleItem>
<EndDate>2018-09-30T00:00:00Z</EndDate>
<ScheduledRevenueAmount>10000</ScheduledRevenueAmount>
<StartDate>2018-09-01T00:00:00Z</StartDate>
<ContractedMinutes i:nil="true"/>
<Notes i:nil="true"/>
</PwsRevenueScheduleItem>
<PwsRevenueScheduleItem>
<EndDate>2018-10-31T00:00:00Z</EndDate>
<ScheduledRevenueAmount>10000</ScheduledRevenueAmount>
<StartDate>2018-10-01T00:00:00Z</StartDate>
<ContractedMinutes i:nil="true"/>
<Notes i:nil="true"/>
</PwsRevenueScheduleItem>
<PwsRevenueScheduleItem>
<EndDate>2018-11-30T00:00:00Z</EndDate>
<ScheduledRevenueAmount>10000</ScheduledRevenueAmount>
<StartDate>2018-11-01T00:00:00Z</StartDate>
<ContractedMinutes i:nil="true"/>
<Notes i:nil="true"/>
</PwsRevenueScheduleItem>
<PwsRevenueScheduleItem>
<EndDate>2018-12-31T00:00:00Z</EndDate>
<ScheduledRevenueAmount>10000</ScheduledRevenueAmount>
<StartDate>2018-12-01T00:00:00Z</StartDate>
<ContractedMinutes i:nil="true"/>
<Notes i:nil="true"/>
</PwsRevenueScheduleItem>
</RevenueSchedule>
<TimeContractTerms>F</TimeContractTerms>
<ContractTypeIdentity i:nil="true"/>
<InheritPurchaseOrderNumberFlag>true</InheritPurchaseOrderNumberFlag>
<ModelContractedHoursAndOveragesFlag>false</ModelContractedHoursAndOveragesFlag>
<OverageProjectIdentity i:nil="true"/>
<PurchaseOrderNumber>PO Projector PSA</PurchaseOrderNumber>
<Timestamp>AAAAAA61gVA=</Timestamp>
</ContractLineItemDetail>
<LastFroTimeCardDate i:nil="true"/>
<LastRevenueRecognitionCutoffDate i:nil="true"/>
<Milestones>
<PwsContractLineItemMilestoneElement>
<CreatedByUserIdentity>
<UserDisplayName>Bob Smith</UserDisplayName>
<UserId i:nil="true"/>
<UserReferenceSystemId>Partner - 01</UserReferenceSystemId>
<UserUid>1152921504607011056</UserUid>
</CreatedByUserIdentity>
<CreatedTimestamp>2018-01-06T16:53:25.15Z</CreatedTimestamp>
<InvoiceIdentity i:nil="true"/>
<LastUpdatedByUserIdentity>
<UserDisplayName>Bob Smith</UserDisplayName>
<UserId i:nil="true"/>
<UserReferenceSystemId>Partner - 01</UserReferenceSystemId>
<UserUid>1152921504607011056</UserUid>
</LastUpdatedByUserIdentity>
<LastUpdatedTimestamp>2018-01-06T18:12:48.527Z</LastUpdatedTimestamp>
<MilestoneDetail>
<ContractLineItemMilestoneId i:nil="true"/>
<ContractLineItemMilestoneUid>1152921504607104692</ContractLineItemMilestoneUid>
<AchievedDate i:nil="true"/>
<ContractLineItemIdentity>
<ContractLineItemCode>P001396-CL1</ContractLineItemCode>
<ContractLineItemId i:nil="true"/>
<ContractLineItemUid>1152921504607083378</ContractLineItemUid>
</ContractLineItemIdentity>
<ContractLineItemMilestoneName>Milestone for period starting 01-Jan-2018</ContractLineItemMilestoneName>
<MilestoneAmount>10000</MilestoneAmount>
<PlannedDate i:nil="true"/>
<Description>Milestone for start of project</Description>
<ForegoneFlag>false</ForegoneFlag>
<ProjectIdentity>
<ProjectCode>P001396-001</ProjectCode>
<ProjectId i:nil="true"/>
<ProjectUid>1152921504607412210</ProjectUid>
</ProjectIdentity>
<ProjectTaskIdentity>
<ExternalSystemIdentifier i:nil="true"/>
<ProjectTaskId i:nil="true"/>
<ProjectTaskUid>1152921504608637343</ProjectTaskUid>
</ProjectTaskIdentity>
</MilestoneDetail>
<MilestoneStatus>P</MilestoneStatus>
<PurchaseOrderNumber i:nil="true"/>
</PwsContractLineItemMilestoneElement>
</Milestones>
<RevenueCutoffDate>1753-01-01T00:00:00Z</RevenueCutoffDate>
</PwsContractLineItemElement>
</ContractLineItems>
<Client>
<ClientId i:nil="true"/>
<ClientNumber>Projector PSA</ClientNumber>
<ClientUid>1152921504606961482</ClientUid>
<ClientName>Projector PSA</ClientName>
<InactiveFlag>false</InactiveFlag>
<ParentClientIdentity i:nil="true"/>
</Client>
<EffectiveCurrencySymbol>$</EffectiveCurrencySymbol>
<EffectiveCurrencySymbolPlacement>0</EffectiveCurrencySymbolPlacement>
<EffectiveDecimalDigits>2</EffectiveDecimalDigits>
<EffectiveDefaultOpsCultureIdentity>
<OpsCultureId i:nil="true"/>
<OpsCultureName>en-US</OpsCultureName>
<OpsCultureNumber>1033</OpsCultureNumber>
</EffectiveDefaultOpsCultureIdentity>
<EffectiveExcelCurrencyFormat>[$$-409]#,##0.00_);[Red]([$$-409]#,##0.00);</EffectiveExcelCurrencyFormat>
<EffectiveExcelCurrencyFormatRounded>[$$-409]#,##0_);[Red]([$$-409]#,##0);</EffectiveExcelCurrencyFormatRounded>
<Manager>
<UserDisplayName>Jack Spratt</UserDisplayName>
<UserId i:nil="true"/>
<UserReferenceSystemId>E123</UserReferenceSystemId>
<UserUid>1152921504607112369</UserUid>
<EmailAddress>jack@revcorp.bb</EmailAddress>
<FirstName>Jack</FirstName>
<LastName>Spratt</LastName>
<MiddleName i:nil="true"/>
</Manager>
</PwsEngagementElement>
</a:Engagements>
</PwsGetEngagementResult>
</PwsGetEngagementResponse>
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 |
- No labels