Document toolboxDocument toolbox

Delete Special Period SOAP API

On This Page:

Related Pages:

The sp:DeleteSpecialPeriodRequest API method can be used to delete 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:

Web Service

Type

Description

Req?

Val?

<sp:DeleteSpecialPeriodRequest>

 

 

 

 

 

<PeriodID>?</PeriodID>

SpecialPeriodID

The ID of a SpecialPeriod previously created via the AddSpecialPeriodRequest interface.

(tick)

(tick)

</sp:DeleteSpecialPeriodRequest>

 

 

 

 

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:

  • SP_OK (0)
  • SP_SPECIAL_PERIOD_ID_INVALID (687)