Skip to end of metadata
Go to start of metadata
You are viewing an old version of this content. View the current version.
Compare with Current
View Version History
« Previous
Version 27
Next »
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>
|
| | | |
Return Structure
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>
| | | | |
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_EMPID_INVALID (5)
SP_END_NOT_GT_START_TIME (31)
SP_OUTSIDE_HORIZON (53)
SP_START_TIME_INVALID (62)
SP_END_TIME_INVALID (63)
SP_EMPID_DOES_NOT_EXIST (231)
SP_SPANS_POSTINGS (286)
SP_DATETIME_NOT_SUPPLIED (620)