Service |  |
Deletes a specified HolidayList by its ID or Name and returns a list of
DeleteResult status structures
Namespace: AppOne.Services.V2
Assembly: AppOne.Web.Service (in AppOne.Web.Service.dll) Version: 1.0.141
Syntaxpublic DeleteHolidayListOut DeleteHolidayList( DeleteHolidayListIn input )
Parameters
- input DeleteHolidayListIn
- A new DeleteHolidayListIn object
Return Value
DeleteHolidayListOutA DeleteHolidayListOut results structure
Remarks
Deletes a specified HolidayList by its ID or Name and returns a list
of DeleteResult status structures.
The structures give a status for each of the ID or Name values passed in.
The structures give a status for each of the ID or Name values passed in.
 Note |
|---|
| A HolidayList that is in use or has been used in calculating time cannot be deleted completely from the system. Rather it will be marked as inactive and if any employees are assigned to it they will automatically be unassigned from the HolidayList as of the current day. |
ExampleJSON Request
{
"AuthToken":"{{ACCESS_TOKEN}}",
"DataAction":{
"Name":"SELECT-ID",
"Values":[5]
}
}JSON Response
{
"Report": {
"APIVersion": "2.0",
"ProcessTime": "0.0236093",
"RequestTime": "/Date(1559659509903-0700)/",
"ResponseTime": "/Date(1559659509927-0700)/",
"Results": 1
},
"Results": [
{
"ID": 5,
"Messages": [
"HolidayListID : '5' - Name: 'Test Holiday List' has been deleted."
],
"Status": 1
}
]
}See Also