PwsGetBaselineBucketDateIntervals

Overview


This web service retrieves baseline bucket date intervals given an interval count, start date and time phase. This is intended to be used to facility creation of time and cost baselines. The response to this web service will be a list of bucket date intervals, each consisting of a start date and an end date. These are the dates that PwsCreateProjectCostBaseline, PwsUpdateProjectCostBaseline, PwsCreateProjectTimeBaseline and PwsUpdateProjectTimeBaseline will expect as bucket dates when creating or updating baselines.

Request Format


PwsGetBaselineBucketDateIntervals Request
  • PwsGetBaselineBucketDateIntervals
    • serviceRequest: PwsGetBaselineBucketDateIntervalsRq

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

IntervalCount

Int32

Yes - unless TimePhase = 'N' for None

The number of intervals in the baseline.

StartDate

DateTime

Yes - unless TimePhase = 'N' for None

The start date (in UTC format) of the first bucket in the baseline.

2018-01-01T00:00:00.000Z

TimePhase

String

Yes

 The time phase of the baseline. Valid values are D for Daily, W for Weekly, H for Hourly, M for Monthly, Q for Quarterly, Y for Yearly, and N for None.

M

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/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetBaselineBucketDateIntervals>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AbHODMrb8ng+PCV+B7BzmQ==</req:SessionTicket>
            <sch:IntervalCount>3</sch:IntervalCount>
            <sch:StartDate>2018-01-01T00:00:00.000Z</sch:StartDate>
            <sch:TimePhase>M</sch:TimePhase>
         </pws:serviceRequest>
      </pws:PwsGetBaselineBucketDateIntervals>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsGetBaselineBucketDateIntervals 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

1

Status

RequestStatus

Click here for more information

Ok 

ServerTimestampUtc

DateTime

Click here for more information

2018-03-15T17:03:19.430982Z

BaselineBucketDateIntervals

PwsDateInterval[]

The baseline bucket date intervals (in UTC format)


Response Usage Example(s)


Example 01
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetBaselineBucketDateIntervalsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetBaselineBucketDateIntervalsResult 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-15T17:03:19.430982Z</ServerTimestampUtc>
            <a:BaselineBucketDateIntervals xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <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>
            </a:BaselineBucketDateIntervals>
         </PwsGetBaselineBucketDateIntervalsResult>
      </PwsGetBaselineBucketDateIntervalsResponse>
   </s:Body>
</s:Envelope>

PwsGetBaselineBucketDateIntervals - Common Errors and Warnings


ErrorNumber

ErrorCode

ErrorText

34004InvalidValueForBaselineTimePhaseThe value specified for baseline time phase is invalid. Valid values are D for Daily, W for Weekly, H for Hourly, M for Monthly, Q for Quarterly, Y for Yearly, and N for None.
34007ParametersIgnoredForTimePhaseNoneTime Phase Parameters StartDate and IntervalCount are ignored when Time Phase specified as N for None.
34008IllegalNullStartDateForTimePhaseTime Phase may not have a null Start Date.
34009IllegalIntervalCountForTimePhaseTime Phase must have a positive non-zero Interval Count.