GET api/v1/allNotificationSchedules?additionalInput={additionalInput}

Get the list of notification schedules available. Equivalent SOAP API: GetAllNotificationSchedules

Request Information

URI Parameters

Name	Description	Type	Additional information
additionalInput	additionalInput	string	None.

Body Parameters

None.

Response Information

Resource Description

NotificationScheduleResult

Name	Type	Additional information
NotificationSchedules	Collection of NotificationSchedule	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "NotificationSchedules": [
    {
      "NotificationScheduleID": 1,
      "NotificationScheduleName": "sample string 2",
      "DayID": 3,
      "StartTime": "sample string 4",
      "EndTime": "sample string 5",
      "IsInUse": true
    },
    {
      "NotificationScheduleID": 1,
      "NotificationScheduleName": "sample string 2",
      "DayID": 3,
      "StartTime": "sample string 4",
      "EndTime": "sample string 5",
      "IsInUse": true
    }
  ],
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<NotificationScheduleResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models.ResultData">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">1</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData>
  <NotificationSchedules xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.EventNotificationConfiguration">
    <d2p1:NotificationSchedule>
      <d2p1:DayID>3</d2p1:DayID>
      <d2p1:EndTime>sample string 5</d2p1:EndTime>
      <d2p1:IsInUse>true</d2p1:IsInUse>
      <d2p1:NotificationScheduleID>1</d2p1:NotificationScheduleID>
      <d2p1:NotificationScheduleName>sample string 2</d2p1:NotificationScheduleName>
      <d2p1:StartTime>sample string 4</d2p1:StartTime>
    </d2p1:NotificationSchedule>
    <d2p1:NotificationSchedule>
      <d2p1:DayID>3</d2p1:DayID>
      <d2p1:EndTime>sample string 5</d2p1:EndTime>
      <d2p1:IsInUse>true</d2p1:IsInUse>
      <d2p1:NotificationScheduleID>1</d2p1:NotificationScheduleID>
      <d2p1:NotificationScheduleName>sample string 2</d2p1:NotificationScheduleName>
      <d2p1:StartTime>sample string 4</d2p1:StartTime>
    </d2p1:NotificationSchedule>
  </NotificationSchedules>
</NotificationScheduleResult>