POST api/Schedule/ScheduleDetail
Request Information
URI Parameters
None.
Body Parameters
ScheduleNumRequest| Name | Description | Type | Additional 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
ScheduleDetailQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ExcludeColumnList | Collection of string |
None. |
|
| ResultSet | Collection of ScheduleDetailResult |
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,
"EarlyCloseEventCode": "sample string 1",
"EarlyCloseEventDescr": "sample string 2",
"EarlyCloseMinutes": 1,
"EarlyOpenEventCode": "sample string 3",
"EarlyOpenEventDescr": "sample string 4",
"EarlyOpenMinutes": 1,
"EffectiveDate": "2025-12-14T17:41:42.7948569-05:00",
"EndDay": 1,
"EndDayDescription": 1,
"EndMonth": 1,
"EndMonthName": "sample string 5",
"ExpireDate": "2025-12-14T17:41:42.810478-05:00",
"FailCloseEventCode": "sample string 6",
"FailCloseEventDescr": "sample string 7",
"FailOpenEventCode": "sample string 8",
"FailOpenEventDescr": "sample string 9",
"LateCloseEventCode": "sample string 10",
"LateCloseEventDescr": "sample string 11",
"LateCloseMinutes": 1,
"LateOpenEventCode": "sample string 12",
"LateOpenEventDescr": "sample string 13",
"LateOpenMinutes": 1,
"MultiAreaOption": "sample string 14",
"MultiAreaOptionDescription": "sample string 15",
"Option": "sample string 16",
"SchedListDescription": "sample string 17",
"SchedNum": 1,
"SchedNumDescription": "sample string 18",
"ScheduleDescription": "sample string 19",
"ScheduleType": "sample string 20",
"StartDay": 1,
"StartDayDescription": 1,
"StartMonth": 1,
"StartMonthName": "sample string 21",
"TempNum": 1,
"TransmitterCode": "sample string 22",
"LateCloseWarningEventCode": "sample string 23",
"LateCloseWarningEventDescription": "sample string 24",
"LateCloseWarningMinutes": 1,
"LateOpenWarningEventCode": "sample string 25",
"LateOpenWarningEventDescription": "sample string 26",
"LateOpenWarningMinutes": 1,
"TempFlag": true
},
{
"DevNum": 1,
"EarlyCloseEventCode": "sample string 1",
"EarlyCloseEventDescr": "sample string 2",
"EarlyCloseMinutes": 1,
"EarlyOpenEventCode": "sample string 3",
"EarlyOpenEventDescr": "sample string 4",
"EarlyOpenMinutes": 1,
"EffectiveDate": "2025-12-14T17:41:42.7948569-05:00",
"EndDay": 1,
"EndDayDescription": 1,
"EndMonth": 1,
"EndMonthName": "sample string 5",
"ExpireDate": "2025-12-14T17:41:42.810478-05:00",
"FailCloseEventCode": "sample string 6",
"FailCloseEventDescr": "sample string 7",
"FailOpenEventCode": "sample string 8",
"FailOpenEventDescr": "sample string 9",
"LateCloseEventCode": "sample string 10",
"LateCloseEventDescr": "sample string 11",
"LateCloseMinutes": 1,
"LateOpenEventCode": "sample string 12",
"LateOpenEventDescr": "sample string 13",
"LateOpenMinutes": 1,
"MultiAreaOption": "sample string 14",
"MultiAreaOptionDescription": "sample string 15",
"Option": "sample string 16",
"SchedListDescription": "sample string 17",
"SchedNum": 1,
"SchedNumDescription": "sample string 18",
"ScheduleDescription": "sample string 19",
"ScheduleType": "sample string 20",
"StartDay": 1,
"StartDayDescription": 1,
"StartMonth": 1,
"StartMonthName": "sample string 21",
"TempNum": 1,
"TransmitterCode": "sample string 22",
"LateCloseWarningEventCode": "sample string 23",
"LateCloseWarningEventDescription": "sample string 24",
"LateCloseWarningMinutes": 1,
"LateOpenWarningEventCode": "sample string 25",
"LateOpenWarningEventDescription": "sample string 26",
"LateOpenWarningMinutes": 1,
"TempFlag": true
}
],
"Success": true,
"UserErrorMessage": "sample string 2",
"ErrorTypeNum": 3,
"SqlConnectionLost": true,
"ClientVersion": "sample string 5"
}
application/xml, text/xml
Sample:
<ScheduleDetailQueryResult 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>
<ScheduleDetailResult>
<DevNum>1</DevNum>
<EarlyCloseEventCode>sample string 1</EarlyCloseEventCode>
<EarlyCloseEventDescr>sample string 2</EarlyCloseEventDescr>
<EarlyCloseMinutes>1</EarlyCloseMinutes>
<EarlyOpenEventCode>sample string 3</EarlyOpenEventCode>
<EarlyOpenEventDescr>sample string 4</EarlyOpenEventDescr>
<EarlyOpenMinutes>1</EarlyOpenMinutes>
<EffectiveDate>2025-12-14T17:41:42.7948569-05:00</EffectiveDate>
<EndDay>1</EndDay>
<EndDayDescription>1</EndDayDescription>
<EndMonth>1</EndMonth>
<EndMonthName>sample string 5</EndMonthName>
<ExpireDate>2025-12-14T17:41:42.810478-05:00</ExpireDate>
<FailCloseEventCode>sample string 6</FailCloseEventCode>
<FailCloseEventDescr>sample string 7</FailCloseEventDescr>
<FailOpenEventCode>sample string 8</FailOpenEventCode>
<FailOpenEventDescr>sample string 9</FailOpenEventDescr>
<LateCloseEventCode>sample string 10</LateCloseEventCode>
<LateCloseEventDescr>sample string 11</LateCloseEventDescr>
<LateCloseMinutes>1</LateCloseMinutes>
<LateCloseWarningEventCode>sample string 23</LateCloseWarningEventCode>
<LateCloseWarningEventDescription>sample string 24</LateCloseWarningEventDescription>
<LateCloseWarningMinutes>1</LateCloseWarningMinutes>
<LateOpenEventCode>sample string 12</LateOpenEventCode>
<LateOpenEventDescr>sample string 13</LateOpenEventDescr>
<LateOpenMinutes>1</LateOpenMinutes>
<LateOpenWarningEventCode>sample string 25</LateOpenWarningEventCode>
<LateOpenWarningEventDescription>sample string 26</LateOpenWarningEventDescription>
<LateOpenWarningMinutes>1</LateOpenWarningMinutes>
<MultiAreaOption>sample string 14</MultiAreaOption>
<MultiAreaOptionDescription>sample string 15</MultiAreaOptionDescription>
<Option>sample string 16</Option>
<SchedListDescription>sample string 17</SchedListDescription>
<SchedNum>1</SchedNum>
<SchedNumDescription>sample string 18</SchedNumDescription>
<ScheduleDescription>sample string 19</ScheduleDescription>
<ScheduleType>sample string 20</ScheduleType>
<StartDay>1</StartDay>
<StartDayDescription>1</StartDayDescription>
<StartMonth>1</StartMonth>
<StartMonthName>sample string 21</StartMonthName>
<TempFlag>true</TempFlag>
<TempNum>1</TempNum>
<TransmitterCode>sample string 22</TransmitterCode>
</ScheduleDetailResult>
<ScheduleDetailResult>
<DevNum>1</DevNum>
<EarlyCloseEventCode>sample string 1</EarlyCloseEventCode>
<EarlyCloseEventDescr>sample string 2</EarlyCloseEventDescr>
<EarlyCloseMinutes>1</EarlyCloseMinutes>
<EarlyOpenEventCode>sample string 3</EarlyOpenEventCode>
<EarlyOpenEventDescr>sample string 4</EarlyOpenEventDescr>
<EarlyOpenMinutes>1</EarlyOpenMinutes>
<EffectiveDate>2025-12-14T17:41:42.7948569-05:00</EffectiveDate>
<EndDay>1</EndDay>
<EndDayDescription>1</EndDayDescription>
<EndMonth>1</EndMonth>
<EndMonthName>sample string 5</EndMonthName>
<ExpireDate>2025-12-14T17:41:42.810478-05:00</ExpireDate>
<FailCloseEventCode>sample string 6</FailCloseEventCode>
<FailCloseEventDescr>sample string 7</FailCloseEventDescr>
<FailOpenEventCode>sample string 8</FailOpenEventCode>
<FailOpenEventDescr>sample string 9</FailOpenEventDescr>
<LateCloseEventCode>sample string 10</LateCloseEventCode>
<LateCloseEventDescr>sample string 11</LateCloseEventDescr>
<LateCloseMinutes>1</LateCloseMinutes>
<LateCloseWarningEventCode>sample string 23</LateCloseWarningEventCode>
<LateCloseWarningEventDescription>sample string 24</LateCloseWarningEventDescription>
<LateCloseWarningMinutes>1</LateCloseWarningMinutes>
<LateOpenEventCode>sample string 12</LateOpenEventCode>
<LateOpenEventDescr>sample string 13</LateOpenEventDescr>
<LateOpenMinutes>1</LateOpenMinutes>
<LateOpenWarningEventCode>sample string 25</LateOpenWarningEventCode>
<LateOpenWarningEventDescription>sample string 26</LateOpenWarningEventDescription>
<LateOpenWarningMinutes>1</LateOpenWarningMinutes>
<MultiAreaOption>sample string 14</MultiAreaOption>
<MultiAreaOptionDescription>sample string 15</MultiAreaOptionDescription>
<Option>sample string 16</Option>
<SchedListDescription>sample string 17</SchedListDescription>
<SchedNum>1</SchedNum>
<SchedNumDescription>sample string 18</SchedNumDescription>
<ScheduleDescription>sample string 19</ScheduleDescription>
<ScheduleType>sample string 20</ScheduleType>
<StartDay>1</StartDay>
<StartDayDescription>1</StartDayDescription>
<StartMonth>1</StartMonth>
<StartMonthName>sample string 21</StartMonthName>
<TempFlag>true</TempFlag>
<TempNum>1</TempNum>
<TransmitterCode>sample string 22</TransmitterCode>
</ScheduleDetailResult>
</ResultSet>
</ScheduleDetailQueryResult>