DELETE api/grp/TimeSchedule/Event/Delete?locationAccountNumber={locationAccountNumber}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| locationAccountNumber | string |
Required |
Body Parameters
Collection of ScheduleEventDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ScheduleName | string |
None. |
|
| ScheduleType | ScheduleTypeDTO |
None. |
|
| EventName | string |
None. |
|
| NewEventName | string |
None. |
|
| StartDate | date |
None. |
|
| EndDate | date |
None. |
|
| AllDayEvent | boolean |
None. |
|
| StartTime | HourMinuteDTO |
None. |
|
| EndTime | HourMinuteDTO |
None. |
|
| Announcement | EventGreetingDTO |
None. |
|
| RecurrenceType | RecurrenceTypeDTO |
None. |
|
| RecurEndType | RecurEndTypeDTO |
None. |
|
| RecurEndDate | date |
None. |
|
| RecurEndOccurrence | integer |
None. |
|
| RecurForEver | boolean |
None. |
|
| DailyRecurrence | DailyRecurrenceDTO |
None. |
|
| WeeklyRecurrence | WeeklyRecurrenceDTO |
None. |
|
| MonthlyByDayRecurrence | MonthlyByDayRecurrenceDTO |
None. |
|
| MonthlyByWeekRecurrence | MonthlyByWeekRecurrenceDTO |
None. |
|
| YearlyByDayRecurrence | YearlyByDayRecurrenceDTO |
None. |
|
| YearlyByWeekRecurrence | YearlyByWeekRecurrenceDTO |
None. |
Request Formats
application/json, text/json
Sample:
[
{
"ScheduleName": "sample string 1",
"ScheduleType": 0,
"EventName": "sample string 2",
"NewEventName": "sample string 3",
"StartDate": "2026-03-29T17:24:18.4357957-04:00",
"EndDate": "2026-03-29T17:24:18.4357957-04:00",
"AllDayEvent": true,
"StartTime": {
"Hour": 1,
"Minute": 2
},
"EndTime": {
"Hour": 1,
"Minute": 2
},
"Announcement": {
"StartEventGreeting": {
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
},
"EndEventGreeting": {
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
}
},
"RecurrenceType": 0,
"RecurEndType": 0,
"RecurEndDate": "2026-03-29T17:24:18.4357957-04:00",
"RecurEndOccurrence": 7,
"RecurForEver": true,
"DailyRecurrence": {
"Interval": 1
},
"WeeklyRecurrence": {
"Sunday": true,
"Monday": true,
"Tuesday": true,
"Wednesday": true,
"Thursday": true,
"Friday": true,
"Saturday": true,
"Interval": 8
},
"MonthlyByDayRecurrence": {
"DayOfMonth": 1,
"Interval": 2
},
"MonthlyByWeekRecurrence": {
"DayOfWeekInMonth": 1,
"DayOfWeek": 2,
"Interval": 3
},
"YearlyByDayRecurrence": {
"DayOfMonth": 1,
"Month": 2,
"Interval": 3
},
"YearlyByWeekRecurrence": {
"DayOfWeekInMonth": 1,
"DayOfWeek": 2,
"Month": 3,
"Interval": 4
}
},
{
"ScheduleName": "sample string 1",
"ScheduleType": 0,
"EventName": "sample string 2",
"NewEventName": "sample string 3",
"StartDate": "2026-03-29T17:24:18.4357957-04:00",
"EndDate": "2026-03-29T17:24:18.4357957-04:00",
"AllDayEvent": true,
"StartTime": {
"Hour": 1,
"Minute": 2
},
"EndTime": {
"Hour": 1,
"Minute": 2
},
"Announcement": {
"StartEventGreeting": {
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
},
"EndEventGreeting": {
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
}
},
"RecurrenceType": 0,
"RecurEndType": 0,
"RecurEndDate": "2026-03-29T17:24:18.4357957-04:00",
"RecurEndOccurrence": 7,
"RecurForEver": true,
"DailyRecurrence": {
"Interval": 1
},
"WeeklyRecurrence": {
"Sunday": true,
"Monday": true,
"Tuesday": true,
"Wednesday": true,
"Thursday": true,
"Friday": true,
"Saturday": true,
"Interval": 8
},
"MonthlyByDayRecurrence": {
"DayOfMonth": 1,
"Interval": 2
},
"MonthlyByWeekRecurrence": {
"DayOfWeekInMonth": 1,
"DayOfWeek": 2,
"Interval": 3
},
"YearlyByDayRecurrence": {
"DayOfMonth": 1,
"Month": 2,
"Interval": 3
},
"YearlyByWeekRecurrence": {
"DayOfWeekInMonth": 1,
"DayOfWeek": 2,
"Month": 3,
"Interval": 4
}
}
]
application/xml, text/xml
Sample:
<ArrayOfScheduleEventDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO.Enterprise">
<ScheduleEventDTO>
<DailyRecurrence xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<Interval>1</Interval>
</DailyRecurrence>
<MonthlyByDayRecurrence xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<Interval>2</Interval>
<DayOfMonth>1</DayOfMonth>
</MonthlyByDayRecurrence>
<MonthlyByWeekRecurrence xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<Interval>3</Interval>
<DayOfWeek>2</DayOfWeek>
<DayOfWeekInMonth>1</DayOfWeekInMonth>
</MonthlyByWeekRecurrence>
<RecurEndDate xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">2026-03-29T17:24:18.4357957-04:00</RecurEndDate>
<RecurEndOccurrence xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">7</RecurEndOccurrence>
<RecurEndType xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">Ever</RecurEndType>
<RecurForEver xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">true</RecurForEver>
<RecurrenceType xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">Never</RecurrenceType>
<WeeklyRecurrence xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<Interval>8</Interval>
<Friday>true</Friday>
<Monday>true</Monday>
<Saturday>true</Saturday>
<Sunday>true</Sunday>
<Thursday>true</Thursday>
<Tuesday>true</Tuesday>
<Wednesday>true</Wednesday>
</WeeklyRecurrence>
<YearlyByDayRecurrence xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<Interval>3</Interval>
<DayOfMonth>1</DayOfMonth>
<Month>2</Month>
</YearlyByDayRecurrence>
<YearlyByWeekRecurrence xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<Interval>4</Interval>
<DayOfWeek>2</DayOfWeek>
<DayOfWeekInMonth>1</DayOfWeekInMonth>
<Month>3</Month>
</YearlyByWeekRecurrence>
<AllDayEvent>true</AllDayEvent>
<Announcement>
<EndEventGreeting xmlns:d4p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<d4p1:Level>3</d4p1:Level>
<d4p1:MediaFileType>2</d4p1:MediaFileType>
<d4p1:Name>sample string 1</d4p1:Name>
</EndEventGreeting>
<StartEventGreeting xmlns:d4p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<d4p1:Level>3</d4p1:Level>
<d4p1:MediaFileType>2</d4p1:MediaFileType>
<d4p1:Name>sample string 1</d4p1:Name>
</StartEventGreeting>
</Announcement>
<EndDate>2026-03-29T17:24:18.4357957-04:00</EndDate>
<EndTime>
<Hour>1</Hour>
<Minute>2</Minute>
</EndTime>
<EventName>sample string 2</EventName>
<NewEventName>sample string 3</NewEventName>
<ScheduleName>sample string 1</ScheduleName>
<ScheduleType>Holiday</ScheduleType>
<StartDate>2026-03-29T17:24:18.4357957-04:00</StartDate>
<StartTime>
<Hour>1</Hour>
<Minute>2</Minute>
</StartTime>
</ScheduleEventDTO>
<ScheduleEventDTO>
<DailyRecurrence xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<Interval>1</Interval>
</DailyRecurrence>
<MonthlyByDayRecurrence xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<Interval>2</Interval>
<DayOfMonth>1</DayOfMonth>
</MonthlyByDayRecurrence>
<MonthlyByWeekRecurrence xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<Interval>3</Interval>
<DayOfWeek>2</DayOfWeek>
<DayOfWeekInMonth>1</DayOfWeekInMonth>
</MonthlyByWeekRecurrence>
<RecurEndDate xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">2026-03-29T17:24:18.4357957-04:00</RecurEndDate>
<RecurEndOccurrence xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">7</RecurEndOccurrence>
<RecurEndType xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">Ever</RecurEndType>
<RecurForEver xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">true</RecurForEver>
<RecurrenceType xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">Never</RecurrenceType>
<WeeklyRecurrence xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<Interval>8</Interval>
<Friday>true</Friday>
<Monday>true</Monday>
<Saturday>true</Saturday>
<Sunday>true</Sunday>
<Thursday>true</Thursday>
<Tuesday>true</Tuesday>
<Wednesday>true</Wednesday>
</WeeklyRecurrence>
<YearlyByDayRecurrence xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<Interval>3</Interval>
<DayOfMonth>1</DayOfMonth>
<Month>2</Month>
</YearlyByDayRecurrence>
<YearlyByWeekRecurrence xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<Interval>4</Interval>
<DayOfWeek>2</DayOfWeek>
<DayOfWeekInMonth>1</DayOfWeekInMonth>
<Month>3</Month>
</YearlyByWeekRecurrence>
<AllDayEvent>true</AllDayEvent>
<Announcement>
<EndEventGreeting xmlns:d4p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<d4p1:Level>3</d4p1:Level>
<d4p1:MediaFileType>2</d4p1:MediaFileType>
<d4p1:Name>sample string 1</d4p1:Name>
</EndEventGreeting>
<StartEventGreeting xmlns:d4p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<d4p1:Level>3</d4p1:Level>
<d4p1:MediaFileType>2</d4p1:MediaFileType>
<d4p1:Name>sample string 1</d4p1:Name>
</StartEventGreeting>
</Announcement>
<EndDate>2026-03-29T17:24:18.4357957-04:00</EndDate>
<EndTime>
<Hour>1</Hour>
<Minute>2</Minute>
</EndTime>
<EventName>sample string 2</EventName>
<NewEventName>sample string 3</NewEventName>
<ScheduleName>sample string 1</ScheduleName>
<ScheduleType>Holiday</ScheduleType>
<StartDate>2026-03-29T17:24:18.4357957-04:00</StartDate>
<StartTime>
<Hour>1</Hour>
<Minute>2</Minute>
</StartTime>
</ScheduleEventDTO>
</ArrayOfScheduleEventDTO>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |