On This Page:

Related Pages:

The sp:AddSpecialPeriodRequest API method can be used to create 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:AddSpecialPeriodRequest>`
	`<empID>?</empID>`	`EmpID`	The Emp ID indicates the operative (aka employee) to whom the Special Period is to be assigned.
	`<startTime>?</ startTime>`		The start date and time for the Special Period. Start Time is a mandatory parameter
	`<endTime>?</endTime>`		The end date and time for the Special Period. End Time is optional and, if omitted, indicates that the Special Period lasts ‘forever’.
	`<TZType>?</TZType>`	`SpecialPeriodTZType`	If not supplied, the operative’s timezone will be used.
`</sp:AddSpecialPeriodRequest>`

The API returns a non-standard return structure.

Web Service		Type	Description	Req?	Val?
`<sp:AddSpecialPeriodResponse>`
	`<result>?</result>`
	`<PeriodID>?</PeriodID>`		Unique identifier for the Special Period created
`</sp:AddSpecialPeriodResponse>`

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

Click here to expand...