POST api/History/HistorySelectDefault
Request Information
URI Parameters
None.
Body Parameters
SiteRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| SiteNum | integer |
None. |
|
| DevNum | integer |
None. |
|
| TransmitterCode | string |
None. |
|
| SessionNum | integer |
None. |
|
| SessionPassword | Collection of byte |
None. |
|
| ApplicationCode | string |
None. |
|
| StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"SiteNum": 1,
"DevNum": 1,
"TransmitterCode": "sample string 1",
"SessionNum": 2,
"SessionPassword": "QEA=",
"ApplicationCode": "sample string 3",
"StagesURL": "sample string 4"
}
application/xml, text/xml
Sample:
<SiteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 4</StagesURL> <ApplicationCode>sample string 3</ApplicationCode> <SessionNum>2</SessionNum> <SessionPassword>QEA=</SessionPassword> <DevNum>1</DevNum> <SiteNum>1</SiteNum> <TransmitterCode>sample string 1</TransmitterCode> </SiteRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HistorySelectDefaultQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ExcludeColumnList | Collection of string |
None. |
|
| ResultSet | Collection of HistorySelectDefaultResult |
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": [
{
"AreaNum": 1,
"CustomOption": "sample string 1",
"EndDate": "2025-12-14T17:38:28.2652304-05:00",
"IncludeOpActFlag": true,
"MsgCenterFlag": true,
"MultiSiteFlag": true,
"Option": "sample string 2",
"SelectXmit": "sample string 3",
"SiteGroupNum": 1,
"SiteName": "sample string 4",
"SiteNum": 1,
"Title": "sample string 5",
"ReportCodeList": [
{
"ReportCode": "sample string 1",
"SelectedFlag": true
},
{
"ReportCode": "sample string 1",
"SelectedFlag": true
}
],
"ReportCodeListDisplay": "sample string 6"
},
{
"AreaNum": 1,
"CustomOption": "sample string 1",
"EndDate": "2025-12-14T17:38:28.2652304-05:00",
"IncludeOpActFlag": true,
"MsgCenterFlag": true,
"MultiSiteFlag": true,
"Option": "sample string 2",
"SelectXmit": "sample string 3",
"SiteGroupNum": 1,
"SiteName": "sample string 4",
"SiteNum": 1,
"Title": "sample string 5",
"ReportCodeList": [
{
"ReportCode": "sample string 1",
"SelectedFlag": true
},
{
"ReportCode": "sample string 1",
"SelectedFlag": true
}
],
"ReportCodeListDisplay": "sample string 6"
}
],
"Success": true,
"UserErrorMessage": "sample string 2",
"ErrorTypeNum": 3,
"SqlConnectionLost": true,
"ClientVersion": "sample string 5"
}
application/xml, text/xml
Sample:
<HistorySelectDefaultQueryResult 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>
<HistorySelectDefaultResult>
<AreaNum>1</AreaNum>
<CustomOption>sample string 1</CustomOption>
<EndDate>2025-12-14T17:38:28.2652304-05:00</EndDate>
<IncludeOpActFlag>true</IncludeOpActFlag>
<MsgCenterFlag>true</MsgCenterFlag>
<MultiSiteFlag>true</MultiSiteFlag>
<Option>sample string 2</Option>
<ReportCodeList>
<ReportCodeListRow>
<ReportCode>sample string 1</ReportCode>
<SelectedFlag>true</SelectedFlag>
</ReportCodeListRow>
<ReportCodeListRow>
<ReportCode>sample string 1</ReportCode>
<SelectedFlag>true</SelectedFlag>
</ReportCodeListRow>
</ReportCodeList>
<ReportCodeListDisplay>sample string 6</ReportCodeListDisplay>
<SelectXmit>sample string 3</SelectXmit>
<SiteGroupNum>1</SiteGroupNum>
<SiteName>sample string 4</SiteName>
<SiteNum>1</SiteNum>
<Title>sample string 5</Title>
</HistorySelectDefaultResult>
<HistorySelectDefaultResult>
<AreaNum>1</AreaNum>
<CustomOption>sample string 1</CustomOption>
<EndDate>2025-12-14T17:38:28.2652304-05:00</EndDate>
<IncludeOpActFlag>true</IncludeOpActFlag>
<MsgCenterFlag>true</MsgCenterFlag>
<MultiSiteFlag>true</MultiSiteFlag>
<Option>sample string 2</Option>
<ReportCodeList>
<ReportCodeListRow>
<ReportCode>sample string 1</ReportCode>
<SelectedFlag>true</SelectedFlag>
</ReportCodeListRow>
<ReportCodeListRow>
<ReportCode>sample string 1</ReportCode>
<SelectedFlag>true</SelectedFlag>
</ReportCodeListRow>
</ReportCodeList>
<ReportCodeListDisplay>sample string 6</ReportCodeListDisplay>
<SelectXmit>sample string 3</SelectXmit>
<SiteGroupNum>1</SiteGroupNum>
<SiteName>sample string 4</SiteName>
<SiteNum>1</SiteNum>
<Title>sample string 5</Title>
</HistorySelectDefaultResult>
</ResultSet>
</HistorySelectDefaultQueryResult>