/
PwsGetProjectTimeBaseline

PwsGetProjectTimeBaseline

Overview


This web service retrieves a list of project time baseline element records (PwsProjectTimeBaselineElement), based upon a list of unique project time baseline identifiers (PwsProjectTimeBaselineRef).


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


PwsGetProjectTimeBaseline 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==

ProjectTimeBaselineIdentities

PwsProjectTimeBaselineRef[]

Yes

The unique fields identifying the project time 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:PwsGetProjectTimeBaseline>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AbHODMrb8ng+PCV+B7BzmQ==</req:SessionTicket>
            <sch:ProjectTimeBaselineIdentities>
               <com:PwsProjectTimeBaselineRef>
                  <com:ProjectTimeBaselineUid>1152921504607411677</com:ProjectTimeBaselineUid>
               </com:PwsProjectTimeBaselineRef>
            </sch:ProjectTimeBaselineIdentities>
         </pws:serviceRequest>
      </pws:PwsGetProjectTimeBaseline>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsGetProjectTimeBaseline 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.

Ok 

ServerTimestampUtc

DateTime

Click here for more information.

2018-03-15T19:51:51.4592605Z

ProjectTimeBaselines

PwsProjectTimeBaselineElement[]

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


Response Usage Example(s)


Example 01
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetProjectTimeBaselineResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetProjectTimeBaselineResult 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-15T19:51:51.4592605Z</ServerTimestampUtc>
            <a:ProjectTimeBaselines xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsProjectTimeBaselineElement>
                  <b:Basis>T</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-13T15:30:47.207Z</b:CreatedTimestamp>
                  <b:Dimension>K</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-03-15T19:46:55.25Z</b:LastUpdatedTimestamp>
                  <b:ProjectTimeBaselineBucketDateIntervals>
                     <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:ProjectTimeBaselineBucketDateIntervals>
                  <b:ProjectTimeBaselineDetail>
                     <b:ExternalSystemIdentifier i:nil="true"/>
                     <b:ProjectTimeBaselineId i:nil="true"/>
                     <b:ProjectTimeBaselineUid>1152921504607411677</b:ProjectTimeBaselineUid>
                     <b:ActiveProjectTimeBaselineFlag>true</b:ActiveProjectTimeBaselineFlag>
                     <b:BarMetricActiveFlag>true</b:BarMetricActiveFlag>
                     <b:ChgMetricActiveFlag>true</b:ChgMetricActiveFlag>
                     <b:CrMetricActiveFlag>true</b:CrMetricActiveFlag>
                     <b:Description>Task Plan Baseline</b:Description>
                     <b:HrsMetricActiveFlag>true</b:HrsMetricActiveFlag>
                     <b:PrimaryMetric>B</b:PrimaryMetric>
                     <b:ProjectTimeBaselineName>Time Baseline A</b:ProjectTimeBaselineName>
                     <b:RdcMetricActiveFlag>true</b:RdcMetricActiveFlag>
                     <b:ProjectTimeBaselineBuckets>
                        <b:PwsProjectTimeBaselineBucket>
                           <b:BillingAdjustedRevenue>80</b:BillingAdjustedRevenue>
                           <b:ChargeableMinutes>0</b:ChargeableMinutes>
                           <b:ContractRevenue>0</b:ContractRevenue>
                           <b:DepartmentIdentity i:nil="true"/>
                           <b:EndDate>2018-01-31T00:00:00Z</b:EndDate>
                           <b:ProjectRateTypeIdentity i:nil="true"/>
                           <b:ProjectRoleIdentity i:nil="true"/>
                           <b:ProjectTaskTypeIdentity>
                              <b:ExternalSystemIdentifier i:nil="true"/>
                              <b:ProjectTaskTypeId i:nil="true"/>
                              <b:ProjectTaskTypeUid>1152921504608115974</b:ProjectTaskTypeUid>
                           </b:ProjectTaskTypeIdentity>
                           <b:ResourceDirectCost>0</b:ResourceDirectCost>
                           <b:ResourceIdentity i:nil="true"/>
                           <b:StartDate>2018-01-01T00:00:00Z</b:StartDate>
                           <b:TitleIdentity i:nil="true"/>
                           <b:WorkMinutes>0</b:WorkMinutes>
                        </b:PwsProjectTimeBaselineBucket>
                        <b:PwsProjectTimeBaselineBucket>
                           <b:BillingAdjustedRevenue>240</b:BillingAdjustedRevenue>
                           <b:ChargeableMinutes>0</b:ChargeableMinutes>
                           <b:ContractRevenue>0</b:ContractRevenue>
                           <b:DepartmentIdentity i:nil="true"/>
                           <b:EndDate>2018-02-28T00:00:00Z</b:EndDate>
                           <b:ProjectRateTypeIdentity i:nil="true"/>
                           <b:ProjectRoleIdentity i:nil="true"/>
                           <b:ProjectTaskTypeIdentity i:nil="true"/>
                           <b:ResourceDirectCost>0</b:ResourceDirectCost>
                           <b:ResourceIdentity i:nil="true"/>
                           <b:StartDate>2018-02-01T00:00:00Z</b:StartDate>
                           <b:TitleIdentity i:nil="true"/>
                           <b:WorkMinutes>0</b:WorkMinutes>
                        </b:PwsProjectTimeBaselineBucket>
                        <b:PwsProjectTimeBaselineBucket>
                           <b:BillingAdjustedRevenue>80</b:BillingAdjustedRevenue>
                           <b:ChargeableMinutes>0</b:ChargeableMinutes>
                           <b:ContractRevenue>0</b:ContractRevenue>
                           <b:DepartmentIdentity i:nil="true"/>
                           <b:EndDate>2018-03-31T00:00:00Z</b:EndDate>
                           <b:ProjectRateTypeIdentity i:nil="true"/>
                           <b:ProjectRoleIdentity i:nil="true"/>
                           <b:ProjectTaskTypeIdentity>
                              <b:ExternalSystemIdentifier i:nil="true"/>
                              <b:ProjectTaskTypeId i:nil="true"/>
                              <b:ProjectTaskTypeUid>1152921504608115974</b:ProjectTaskTypeUid>
                           </b:ProjectTaskTypeIdentity>
                           <b:ResourceDirectCost>0</b:ResourceDirectCost>
                           <b:ResourceIdentity i:nil="true"/>
                           <b:StartDate>2018-03-01T00:00:00Z</b:StartDate>
                           <b:TitleIdentity i:nil="true"/>
                           <b:WorkMinutes>0</b:WorkMinutes>
                        </b:PwsProjectTimeBaselineBucket>
                     </b:ProjectTimeBaselineBuckets>
                  </b:ProjectTimeBaselineDetail>
                  <b:StartDate>2018-01-01T00:00:00Z</b:StartDate>
                  <b:TimePhase>M</b:TimePhase>
               </b:PwsProjectTimeBaselineElement>
            </a:ProjectTimeBaselines>
         </PwsGetProjectTimeBaselineResult>
      </PwsGetProjectTimeBaselineResponse>
   </s:Body>
</s:Envelope>

PwsGetProjectTimeBaseline - Common Errors and Warnings


ErrorNumber

ErrorCode

ErrorText

54923SpecifiedProjectTimeBaselineNotFoundSpecified project time baseline was not found.
54961ProjectTimeBaselineRefRequiredA project time baseline must be specified.

Related content

PwsGetTimeCards
PwsGetTimeCards
Read with this
PwsGetProjectCostBaseline
PwsGetProjectCostBaseline
More like this
PwsGetProject
PwsGetProject
Read with this
PwsCreateProjectTimeBaseline
PwsCreateProjectTimeBaseline
More like this
PwsGetResource
PwsGetResource
Read with this
PwsGetTimeEntryParameters
PwsGetTimeEntryParameters
More like this