Document toolboxDocument toolbox

14.1 Update Special Period SOAP API

On This Page:

Related Pages:

The sp:UpdateSpecialPeriodRequest API method can be used to update the properties of Gantt special periods.

 

Description

For more details on special periods, see the Gantt Special Periods SOAP APIs page.

Definition

The definition of this API is:

 Click here to expand...

Web Service

Type

Description

Req?

Val?

<sp:UpdateSpecialPeriodRequest>

 

 

 

 

 

<PeriodId>?</PeriodId>

SpecialPeriodID

The Period ID that is to be updated.

(tick)

(tick)

 

<startTime>?</ startTime>

spDateTime

The start date and time for the Special Period if it is to be updated

At least one of startTime or endTime should be supplied

(error)

(tick)

 

<endTime>?</endTime>

spDateTime

The end date and time for the Special Period if it is to be updated

At least one of startTime or endTime should be supplied

(error)

(tick)

 

<TZType>?</TZType>

SpecialPeriodTZType

The timezone for the Special Period if it is to be updated .

(error)

(tick)

</sp:AddSpecialPeriodRequest>

 

 

 

 

Return Structure

The API returns the standard return structure.

 

Return Codes

In addition to the Standard Return Codes, the possible Return Codes from this API are:

 Click here to expand...
  • SP_OK (0)
  • SP_END_NOT_GT_START_TIME (31)
  • SP_OUTSIDE_HORIZON (53)
  • SP_START_TIME_INVALID (62)
  • SP_END_TIME_INVALID (63)
  • SP_SPANS_POSTINGS (286)
  • SP_DATETIME_NOT_SUPPLIED (620)
  • SP_SPECIAL_PERIOD_ID_INVALID (687)