POST api/DataExport/ScheduleList

Request Information

URI Parameters

None.

Body Parameters

DataExportRequest
NameDescriptionTypeAdditional information
SiteNum

integer

None.

TargetSiteGroup

integer

None.

SessionNum

integer

None.

SessionPassword

Collection of byte

None.

ApplicationCode

string

None.

StagesURL

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SiteNum": 1,
  "TargetSiteGroup": 1,
  "SessionNum": 1,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 2",
  "StagesURL": "sample string 3"
}

application/xml, text/xml

Sample:
<DataExportRequest 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>
  <SiteNum>1</SiteNum>
  <TargetSiteGroup>1</TargetSiteGroup>
</DataExportRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ExportSchedulesQueryResult
NameDescriptionTypeAdditional information
Success

boolean

None.

ErrorMessage

string

None.

ScheduleList

Collection of ExportSchedulesResult

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "ErrorMessage": "sample string 2",
  "ScheduleList": [
    {
      "SiteNum": 1,
      "DevNum": 2,
      "SchedNum": 3,
      "TempNum": 4,
      "EffectiveDate": "2024-05-01T11:30:27.2741551-04:00",
      "ExpireDate": "2024-05-01T11:30:27.2741551-04:00",
      "ScheduleType": "sample string 7",
      "Description": "sample string 8",
      "FailOpenEventCode": "sample string 9",
      "FailCloseEventCode": "sample string 10",
      "EarlyOpenMinutes": 1,
      "LateOpenMinutes": 1,
      "EarlyCloseMinutes": 1,
      "LateCloseMinutes": 1,
      "EarlyOpenEventCode": "sample string 11",
      "LateOpenEventCode": "sample string 12",
      "EarlyCloseEventCode": "sample string 13",
      "LateCloseEventCode": "sample string 14",
      "StartMonth": 1,
      "StartDay": 1,
      "EndMonth": 1,
      "EndDay": 1,
      "MultiAreaOption": "sample string 15"
    },
    {
      "SiteNum": 1,
      "DevNum": 2,
      "SchedNum": 3,
      "TempNum": 4,
      "EffectiveDate": "2024-05-01T11:30:27.2741551-04:00",
      "ExpireDate": "2024-05-01T11:30:27.2741551-04:00",
      "ScheduleType": "sample string 7",
      "Description": "sample string 8",
      "FailOpenEventCode": "sample string 9",
      "FailCloseEventCode": "sample string 10",
      "EarlyOpenMinutes": 1,
      "LateOpenMinutes": 1,
      "EarlyCloseMinutes": 1,
      "LateCloseMinutes": 1,
      "EarlyOpenEventCode": "sample string 11",
      "LateOpenEventCode": "sample string 12",
      "EarlyCloseEventCode": "sample string 13",
      "LateCloseEventCode": "sample string 14",
      "StartMonth": 1,
      "StartDay": 1,
      "EndMonth": 1,
      "EndDay": 1,
      "MultiAreaOption": "sample string 15"
    }
  ]
}

application/xml, text/xml

Sample:
<ExportSchedulesQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <ScheduleList>
    <ExportSchedulesResult>
      <Description>sample string 8</Description>
      <DevNum>2</DevNum>
      <EarlyCloseEventCode>sample string 13</EarlyCloseEventCode>
      <EarlyCloseMinutes>1</EarlyCloseMinutes>
      <EarlyOpenEventCode>sample string 11</EarlyOpenEventCode>
      <EarlyOpenMinutes>1</EarlyOpenMinutes>
      <EffectiveDate>2024-05-01T11:30:27.2741551-04:00</EffectiveDate>
      <EndDay>1</EndDay>
      <EndMonth>1</EndMonth>
      <ExpireDate>2024-05-01T11:30:27.2741551-04:00</ExpireDate>
      <FailCloseEventCode>sample string 10</FailCloseEventCode>
      <FailOpenEventCode>sample string 9</FailOpenEventCode>
      <LateCloseEventCode>sample string 14</LateCloseEventCode>
      <LateCloseMinutes>1</LateCloseMinutes>
      <LateOpenEventCode>sample string 12</LateOpenEventCode>
      <LateOpenMinutes>1</LateOpenMinutes>
      <MultiAreaOption>sample string 15</MultiAreaOption>
      <SchedNum>3</SchedNum>
      <ScheduleType>sample string 7</ScheduleType>
      <SiteNum>1</SiteNum>
      <StartDay>1</StartDay>
      <StartMonth>1</StartMonth>
      <TempNum>4</TempNum>
    </ExportSchedulesResult>
    <ExportSchedulesResult>
      <Description>sample string 8</Description>
      <DevNum>2</DevNum>
      <EarlyCloseEventCode>sample string 13</EarlyCloseEventCode>
      <EarlyCloseMinutes>1</EarlyCloseMinutes>
      <EarlyOpenEventCode>sample string 11</EarlyOpenEventCode>
      <EarlyOpenMinutes>1</EarlyOpenMinutes>
      <EffectiveDate>2024-05-01T11:30:27.2741551-04:00</EffectiveDate>
      <EndDay>1</EndDay>
      <EndMonth>1</EndMonth>
      <ExpireDate>2024-05-01T11:30:27.2741551-04:00</ExpireDate>
      <FailCloseEventCode>sample string 10</FailCloseEventCode>
      <FailOpenEventCode>sample string 9</FailOpenEventCode>
      <LateCloseEventCode>sample string 14</LateCloseEventCode>
      <LateCloseMinutes>1</LateCloseMinutes>
      <LateOpenEventCode>sample string 12</LateOpenEventCode>
      <LateOpenMinutes>1</LateOpenMinutes>
      <MultiAreaOption>sample string 15</MultiAreaOption>
      <SchedNum>3</SchedNum>
      <ScheduleType>sample string 7</ScheduleType>
      <SiteNum>1</SiteNum>
      <StartDay>1</StartDay>
      <StartMonth>1</StartMonth>
      <TempNum>4</TempNum>
    </ExportSchedulesResult>
  </ScheduleList>
  <Success>true</Success>
</ExportSchedulesQueryResult>