14.1 Create Special Period SOAP API
- Billy Sewell (Unlicensed)
- Jason Andrew
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:
Web Service | Type | Description | Req? | Val? | |
|
|
|
|
| |
|
|
| The Emp ID indicates the operative (aka employee) to whom the Special Period is to be assigned. |
|
|
|
|
| The start date and time for the Special Period. Start Time is a mandatory parameter |
|
|
|
|
| The end date and time for the Special Period. End Time is optional and, if omitted, indicates that the Special Period lasts ‘forever’. |
|
|
|
|
| If not supplied, the operative’s timezone will be used. |
|
|
|
|
|
|
| |
Return Structure
The API returns a non-standard return structure.
Web Service | Type | Description | Req? | Val? | |
|
|
|
|
| |
|
|
|
|
|
|
|
|
| Unique identifier for the Special Period created |
|
|
|
|
|
|
| |
Return Codes
In addition to the Standard Return Codes, the possible Return Codes from this API are: