POST api/Schedule/ScheduleList

Request Information

URI Parameters

None.

Body Parameters

ScheduleNumRequest
NameDescriptionTypeAdditional information
SchedNum

integer

None.

TempNum

integer

None.

DevNum

integer

None.

SiteFlag

boolean

None.

SessionNum

integer

None.

SessionPassword

Collection of byte

None.

ApplicationCode

string

None.

StagesURL

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SchedNum": 1,
  "TempNum": 1,
  "DevNum": 1,
  "SiteFlag": true,
  "SessionNum": 1,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 2",
  "StagesURL": "sample string 3"
}

application/xml, text/xml

Sample:
<ScheduleNumRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 3</StagesURL>
  <ApplicationCode>sample string 2</ApplicationCode>
  <SessionNum>1</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <DevNum>1</DevNum>
  <SiteFlag>true</SiteFlag>
  <SchedNum>1</SchedNum>
  <TempNum>1</TempNum>
</ScheduleNumRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ScheduleListQueryResult
NameDescriptionTypeAdditional information
ExcludeColumnList

Collection of string

None.

ResultSet

Collection of ScheduleListResult

None.

Success

boolean

None.

UserErrorMessage

string

None.

ErrorTypeNum

integer

None.

SqlConnectionLost

boolean

None.

ClientVersion

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ExcludeColumnList": [
    "sample string 1",
    "sample string 2"
  ],
  "ResultSet": [
    {
      "DevNum": 1,
      "EffectiveDate": "2024-05-01T18:47:04.4532836-04:00",
      "ExpireDate": "2024-05-01T18:47:04.4532836-04:00",
      "HighlightFlag": true,
      "SchedListDescription": "sample string 1",
      "SchedNum": 1,
      "SchedNumDescription": "sample string 2",
      "ScheduleDescription": "sample string 3",
      "ScheduleType": "sample string 4",
      "TempNum": 1,
      "TransmitterCode": "sample string 5"
    },
    {
      "DevNum": 1,
      "EffectiveDate": "2024-05-01T18:47:04.4532836-04:00",
      "ExpireDate": "2024-05-01T18:47:04.4532836-04:00",
      "HighlightFlag": true,
      "SchedListDescription": "sample string 1",
      "SchedNum": 1,
      "SchedNumDescription": "sample string 2",
      "ScheduleDescription": "sample string 3",
      "ScheduleType": "sample string 4",
      "TempNum": 1,
      "TransmitterCode": "sample string 5"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:
<ScheduleListQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Stages">
  <ClientVersion>sample string 5</ClientVersion>
  <ErrorTypeNum>3</ErrorTypeNum>
  <SqlConnectionLost>true</SqlConnectionLost>
  <Success>true</Success>
  <UserErrorMessage>sample string 2</UserErrorMessage>
  <ExcludeColumnList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExcludeColumnList>
  <ResultSet>
    <ScheduleListResult>
      <DevNum>1</DevNum>
      <EffectiveDate>2024-05-01T18:47:04.4532836-04:00</EffectiveDate>
      <ExpireDate>2024-05-01T18:47:04.4532836-04:00</ExpireDate>
      <HighlightFlag>true</HighlightFlag>
      <SchedListDescription>sample string 1</SchedListDescription>
      <SchedNum>1</SchedNum>
      <SchedNumDescription>sample string 2</SchedNumDescription>
      <ScheduleDescription>sample string 3</ScheduleDescription>
      <ScheduleType>sample string 4</ScheduleType>
      <TempNum>1</TempNum>
      <TransmitterCode>sample string 5</TransmitterCode>
    </ScheduleListResult>
    <ScheduleListResult>
      <DevNum>1</DevNum>
      <EffectiveDate>2024-05-01T18:47:04.4532836-04:00</EffectiveDate>
      <ExpireDate>2024-05-01T18:47:04.4532836-04:00</ExpireDate>
      <HighlightFlag>true</HighlightFlag>
      <SchedListDescription>sample string 1</SchedListDescription>
      <SchedNum>1</SchedNum>
      <SchedNumDescription>sample string 2</SchedNumDescription>
      <ScheduleDescription>sample string 3</ScheduleDescription>
      <ScheduleType>sample string 4</ScheduleType>
      <TempNum>1</TempNum>
      <TransmitterCode>sample string 5</TransmitterCode>
    </ScheduleListResult>
  </ResultSet>
</ScheduleListQueryResult>