POST api/Search/XtSummaryDetailList
Request Information
URI Parameters
None.
Body Parameters
XtSummaryDetailRequestName | Description | Type | Additional information |
---|---|---|---|
DetailType | string |
None. |
|
IncludeOOSFlag | boolean |
None. |
|
SiteGroupNum | integer |
None. |
|
SessionNum | integer |
None. |
|
SessionPassword | Collection of byte |
None. |
|
ApplicationCode | string |
None. |
|
StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "DetailType": "sample string 1", "IncludeOOSFlag": true, "SiteGroupNum": 1, "SessionNum": 2, "SessionPassword": "QEA=", "ApplicationCode": "sample string 3", "StagesURL": "sample string 4" }
application/xml, text/xml
Sample:
<XtSummaryDetailRequest 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> <SiteGroupNum>1</SiteGroupNum> <DetailType>sample string 1</DetailType> <IncludeOOSFlag>true</IncludeOOSFlag> </XtSummaryDetailRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
XtSummaryDetailListQueryResultName | Description | Type | Additional information |
---|---|---|---|
ExcludeColumnList | Collection of string |
None. |
|
ResultSet | Collection of XtSummaryDetailListResult |
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": [ { "AlarmFlag": true, "DetailType": "sample string 1", "DevNum": 1, "IncludeOOSFlag": true, "SiteName": "sample string 2", "SiteNum": 1, "TransmitterCode": "sample string 3" }, { "AlarmFlag": true, "DetailType": "sample string 1", "DevNum": 1, "IncludeOOSFlag": true, "SiteName": "sample string 2", "SiteNum": 1, "TransmitterCode": "sample string 3" } ], "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5" }
application/xml, text/xml
Sample:
<XtSummaryDetailListQueryResult 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> <XtSummaryDetailListResult> <AlarmFlag>true</AlarmFlag> <DetailType>sample string 1</DetailType> <DevNum>1</DevNum> <IncludeOOSFlag>true</IncludeOOSFlag> <SiteName>sample string 2</SiteName> <SiteNum>1</SiteNum> <TransmitterCode>sample string 3</TransmitterCode> </XtSummaryDetailListResult> <XtSummaryDetailListResult> <AlarmFlag>true</AlarmFlag> <DetailType>sample string 1</DetailType> <DevNum>1</DevNum> <IncludeOOSFlag>true</IncludeOOSFlag> <SiteName>sample string 2</SiteName> <SiteNum>1</SiteNum> <TransmitterCode>sample string 3</TransmitterCode> </XtSummaryDetailListResult> </ResultSet> </XtSummaryDetailListQueryResult>