/
PwsGetProjectCostBaseline

PwsGetProjectCostBaseline

Overview


This web service retrieves a list of project cost baseline element records (PwsProjectCostBaselineElement), based upon a list of unique project cost baseline identifiers (PwsProjectCostBaselineRef).


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


PwsGetProjectCostBaseline Request

Request Elements


Element

Data Type

Required?

Description

Sample Data

RequestId

Int32

No

Click here for more information.

1

SessionTicket

String

Yes 

Click here for more information.

AbHODMrb8ng+PCV+B7BzmQ== 

ProjectCostBaselineIdentities

PwsProjectCostBaselineRef[]

Yes 

The unique fields identifying the project cost baseline(s) 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:PwsGetProjectCostBaseline>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AbHODMrb8ng+PCV+B7BzmQ==</req:SessionTicket>
            <sch:ProjectCostBaselineIdentities>
               <com:PwsProjectCostBaselineRef>
                  <com:ProjectCostBaselineUid>1152921504607272105</com:ProjectCostBaselineUid>
               </com:PwsProjectCostBaselineRef>
            </sch:ProjectCostBaselineIdentities>
         </pws:serviceRequest>
      </pws:PwsGetProjectCostBaseline>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsGetProjectCostBaseline Response

Response Elements


Element

Data Type

Description

Sample Data

Messages

PwsMessage[]

The web service response status and message. Click here for more information.


ResponseId

Int32

Click here for more information.


Status

RequestStatus

Click here for more information.


ServerTimestampUtc

DateTime

Click here for more information.


ProjectCostBaselines

PwsProjectCostBaselineElement[]

This structure contains the complete set of information about the requested project cost baselines.


Response Usage Example(s)


Example 01
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetProjectCostBaselineResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetProjectCostBaselineResult 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-03-15T20:25:32.5545145Z</ServerTimestampUtc>
            <a:ProjectCostBaselines xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsProjectCostBaselineElement>
                  <b:Basis>N</b:Basis>
                  <b:CreatedByUser>
                     <b:UserDisplayName>Beth Brown</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>E127</b:UserReferenceSystemId>
                     <b:UserUid>1152921504607011056</b:UserUid>
                     <b:EmailAddress>Beth@projectorpsa.com</b:EmailAddress>
                     <b:FirstName>Beth</b:FirstName>
                     <b:LastName>Brown</b:LastName>
                     <b:MiddleName i:nil="true"/>
                  </b:CreatedByUser>
                  <b:CreatedTimestamp>2018-02-12T16:53:58.987Z</b:CreatedTimestamp>
                  <b:Dimension>E</b:Dimension>
                  <b:EndDate>2018-03-31T00:00:00Z</b:EndDate>
                  <b:EngagementTimestamp>AAAAAA64Qwk=</b:EngagementTimestamp>
                  <b:LastUpdatedByUser>
                     <b:UserDisplayName>Beth Brown</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>E127</b:UserReferenceSystemId>
                     <b:UserUid>1152921504607011056</b:UserUid>
                     <b:EmailAddress>Beth@projectorpsa.com</b:EmailAddress>
                     <b:FirstName>Beth</b:FirstName>
                     <b:LastName>Brown</b:LastName>
                     <b:MiddleName i:nil="true"/>
                  </b:LastUpdatedByUser>
                  <b:LastUpdatedTimestamp>2018-02-12T16:53:58.987Z</b:LastUpdatedTimestamp>
                  <b:ProjectCostBaselineBucketDateIntervals>
                     <b:PwsDateInterval>
                        <b:EndDate>2017-12-31T00:00:00Z</b:EndDate>
                        <b:StartDate i:nil="true"/>
                     </b:PwsDateInterval>
                     <b:PwsDateInterval>
                        <b:EndDate>2018-01-31T00:00:00Z</b:EndDate>
                        <b:StartDate>2018-01-01T00:00:00Z</b:StartDate>
                     </b:PwsDateInterval>
                     <b:PwsDateInterval>
                        <b:EndDate>2018-02-28T00:00:00Z</b:EndDate>
                        <b:StartDate>2018-02-01T00:00:00Z</b:StartDate>
                     </b:PwsDateInterval>
                     <b:PwsDateInterval>
                        <b:EndDate>2018-03-31T00:00:00Z</b:EndDate>
                        <b:StartDate>2018-03-01T00:00:00Z</b:StartDate>
                     </b:PwsDateInterval>
                     <b:PwsDateInterval>
                        <b:EndDate i:nil="true"/>
                        <b:StartDate>2018-04-01T00:00:00Z</b:StartDate>
                     </b:PwsDateInterval>
                  </b:ProjectCostBaselineBucketDateIntervals>
                  <b:ProjectCostBaselineDetail>
                     <b:ExternalSystemIdentifier i:nil="true"/>
                     <b:ProjectCostBaselineId i:nil="true"/>
                     <b:ProjectCostBaselineUid>1152921504607272105</b:ProjectCostBaselineUid>
                     <b:ActiveProjectCostBaselineFlag>true</b:ActiveProjectCostBaselineFlag>
                     <b:CaMetricActiveFlag>true</b:CaMetricActiveFlag>
                     <b:DaMetricActiveFlag>true</b:DaMetricActiveFlag>
                     <b:Description>Travel Budget</b:Description>
                     <b:EaMetricActiveFlag>true</b:EaMetricActiveFlag>
                     <b:PrimaryMetric>C</b:PrimaryMetric>
                     <b:ProjectCostBaselineName>Cost Baseline A</b:ProjectCostBaselineName>
                     <b:ProjectCostBaselineBuckets>
                        <b:PwsProjectCostBaselineBucket>
                           <b:ClientAmount>1500</b:ClientAmount>
                           <b:DisbursedAmount>0</b:DisbursedAmount>
                           <b:EndDate>2018-01-31T00:00:00Z</b:EndDate>
                           <b:ExpenseAmount>0</b:ExpenseAmount>
                           <b:ExpenseTypeGroupIdentity i:nil="true"/>
                           <b:ExpenseTypeIdentity>
                              <b:ExpenseTypeId i:nil="true"/>
                              <b:ExpenseTypeName>Travel</b:ExpenseTypeName>
                              <b:ExpenseTypeUid>1152921504606881280</b:ExpenseTypeUid>
                           </b:ExpenseTypeIdentity>
                           <b:StartDate>2018-01-01T00:00:00Z</b:StartDate>
                        </b:PwsProjectCostBaselineBucket>
                        <b:PwsProjectCostBaselineBucket>
                           <b:ClientAmount>1500</b:ClientAmount>
                           <b:DisbursedAmount>0</b:DisbursedAmount>
                           <b:EndDate>2018-02-28T00:00:00Z</b:EndDate>
                           <b:ExpenseAmount>0</b:ExpenseAmount>
                           <b:ExpenseTypeGroupIdentity i:nil="true"/>
                           <b:ExpenseTypeIdentity>
                              <b:ExpenseTypeId i:nil="true"/>
                              <b:ExpenseTypeName>Travel</b:ExpenseTypeName>
                              <b:ExpenseTypeUid>1152921504606881280</b:ExpenseTypeUid>
                           </b:ExpenseTypeIdentity>
                           <b:StartDate>2018-02-01T00:00:00Z</b:StartDate>
                        </b:PwsProjectCostBaselineBucket>
                        <b:PwsProjectCostBaselineBucket>
                           <b:ClientAmount>1500</b:ClientAmount>
                           <b:DisbursedAmount>0</b:DisbursedAmount>
                           <b:EndDate>2018-03-31T00:00:00Z</b:EndDate>
                           <b:ExpenseAmount>0</b:ExpenseAmount>
                           <b:ExpenseTypeGroupIdentity i:nil="true"/>
                           <b:ExpenseTypeIdentity>
                              <b:ExpenseTypeId i:nil="true"/>
                              <b:ExpenseTypeName>Travel</b:ExpenseTypeName>
                              <b:ExpenseTypeUid>1152921504606881280</b:ExpenseTypeUid>
                           </b:ExpenseTypeIdentity>
                           <b:StartDate>2018-03-01T00:00:00Z</b:StartDate>
                        </b:PwsProjectCostBaselineBucket>
                     </b:ProjectCostBaselineBuckets>
                     <b:Timestamp>AAAAAA62MFw=</b:Timestamp>
                  </b:ProjectCostBaselineDetail>
                  <b:StartDate>2018-01-01T00:00:00Z</b:StartDate>
                  <b:TimePhase>M</b:TimePhase>
               </b:PwsProjectCostBaselineElement>
            </a:ProjectCostBaselines>
         </PwsGetProjectCostBaselineResult>
      </PwsGetProjectCostBaselineResponse>
   </s:Body>
</s:Envelope>

PwsGetProjectCostBaseline - Common Errors and Warnings


ErrorNumber

ErrorCode

ErrorText

54879SpecifiedProjectCostBaselineNotFoundSpecified project cost baseline was not found.
54883ProjectCostBaselineRefRequiredA project cost baseline must be specified.