POST api/Search/XtSearch
Request Information
URI Parameters
None.
Body Parameters
XtSearchRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Search | string |
None. |
|
| SiteGroupSearch | string |
None. |
|
| IncludeOOSFlag | boolean |
None. |
|
| SessionNum | integer |
None. |
|
| SessionPassword | Collection of byte |
None. |
|
| ApplicationCode | string |
None. |
|
| StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Search": "sample string 1",
"SiteGroupSearch": "sample string 2",
"IncludeOOSFlag": true,
"SessionNum": 3,
"SessionPassword": "QEA=",
"ApplicationCode": "sample string 4",
"StagesURL": "sample string 5"
}
application/xml, text/xml
Sample:
<XtSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 5</StagesURL> <ApplicationCode>sample string 4</ApplicationCode> <SessionNum>3</SessionNum> <SessionPassword>QEA=</SessionPassword> <IncludeOOSFlag>true</IncludeOOSFlag> <Search>sample string 1</Search> <SiteGroupSearch>sample string 2</SiteGroupSearch> </XtSearchRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
XtSearchQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ExcludeColumnList | Collection of string |
None. |
|
| ResultSet | Collection of XtSearchResult |
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": [
{
"Address": "sample string 1",
"Address2": "sample string 2",
"AlarmFlag": true,
"ApplicationNum": 1,
"City": "sample string 3",
"DeviceStatus": "sample string 4",
"DevNum": 1,
"DispatchTypeListDisplay": "sample string 5",
"IncludeOOSFlag": true,
"MatchColumn": "sample string 6",
"Phone": "sample string 7",
"Region": "sample string 8",
"RegionDescription": "sample string 9",
"Search": "sample string 10",
"SiteGroupName": "sample string 11",
"SiteGroupNum": 1,
"SiteGroupSearch": "sample string 12",
"SiteName": "sample string 13",
"SiteNum": 1,
"SiteStatus": "sample string 14",
"SiteStatusDescription": "sample string 15",
"SiteType": "sample string 16",
"SiteTypeDescription": "sample string 17",
"State": "sample string 18",
"StreetName": "sample string 19",
"Title": "sample string 20",
"TransmitterCode": "sample string 21",
"XmitList": "sample string 22",
"ZipCode": "sample string 23"
},
{
"Address": "sample string 1",
"Address2": "sample string 2",
"AlarmFlag": true,
"ApplicationNum": 1,
"City": "sample string 3",
"DeviceStatus": "sample string 4",
"DevNum": 1,
"DispatchTypeListDisplay": "sample string 5",
"IncludeOOSFlag": true,
"MatchColumn": "sample string 6",
"Phone": "sample string 7",
"Region": "sample string 8",
"RegionDescription": "sample string 9",
"Search": "sample string 10",
"SiteGroupName": "sample string 11",
"SiteGroupNum": 1,
"SiteGroupSearch": "sample string 12",
"SiteName": "sample string 13",
"SiteNum": 1,
"SiteStatus": "sample string 14",
"SiteStatusDescription": "sample string 15",
"SiteType": "sample string 16",
"SiteTypeDescription": "sample string 17",
"State": "sample string 18",
"StreetName": "sample string 19",
"Title": "sample string 20",
"TransmitterCode": "sample string 21",
"XmitList": "sample string 22",
"ZipCode": "sample string 23"
}
],
"Success": true,
"UserErrorMessage": "sample string 2",
"ErrorTypeNum": 3,
"SqlConnectionLost": true,
"ClientVersion": "sample string 5"
}
application/xml, text/xml
Sample:
<XtSearchQueryResult 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>
<XtSearchResult>
<Address>sample string 1</Address>
<Address2>sample string 2</Address2>
<AlarmFlag>true</AlarmFlag>
<ApplicationNum>1</ApplicationNum>
<City>sample string 3</City>
<DevNum>1</DevNum>
<DeviceStatus>sample string 4</DeviceStatus>
<DispatchTypeListDisplay>sample string 5</DispatchTypeListDisplay>
<IncludeOOSFlag>true</IncludeOOSFlag>
<MatchColumn>sample string 6</MatchColumn>
<Phone>sample string 7</Phone>
<Region>sample string 8</Region>
<RegionDescription>sample string 9</RegionDescription>
<Search>sample string 10</Search>
<SiteGroupName>sample string 11</SiteGroupName>
<SiteGroupNum>1</SiteGroupNum>
<SiteGroupSearch>sample string 12</SiteGroupSearch>
<SiteName>sample string 13</SiteName>
<SiteNum>1</SiteNum>
<SiteStatus>sample string 14</SiteStatus>
<SiteStatusDescription>sample string 15</SiteStatusDescription>
<SiteType>sample string 16</SiteType>
<SiteTypeDescription>sample string 17</SiteTypeDescription>
<State>sample string 18</State>
<StreetName>sample string 19</StreetName>
<Title>sample string 20</Title>
<TransmitterCode>sample string 21</TransmitterCode>
<XmitList>sample string 22</XmitList>
<ZipCode>sample string 23</ZipCode>
</XtSearchResult>
<XtSearchResult>
<Address>sample string 1</Address>
<Address2>sample string 2</Address2>
<AlarmFlag>true</AlarmFlag>
<ApplicationNum>1</ApplicationNum>
<City>sample string 3</City>
<DevNum>1</DevNum>
<DeviceStatus>sample string 4</DeviceStatus>
<DispatchTypeListDisplay>sample string 5</DispatchTypeListDisplay>
<IncludeOOSFlag>true</IncludeOOSFlag>
<MatchColumn>sample string 6</MatchColumn>
<Phone>sample string 7</Phone>
<Region>sample string 8</Region>
<RegionDescription>sample string 9</RegionDescription>
<Search>sample string 10</Search>
<SiteGroupName>sample string 11</SiteGroupName>
<SiteGroupNum>1</SiteGroupNum>
<SiteGroupSearch>sample string 12</SiteGroupSearch>
<SiteName>sample string 13</SiteName>
<SiteNum>1</SiteNum>
<SiteStatus>sample string 14</SiteStatus>
<SiteStatusDescription>sample string 15</SiteStatusDescription>
<SiteType>sample string 16</SiteType>
<SiteTypeDescription>sample string 17</SiteTypeDescription>
<State>sample string 18</State>
<StreetName>sample string 19</StreetName>
<Title>sample string 20</Title>
<TransmitterCode>sample string 21</TransmitterCode>
<XmitList>sample string 22</XmitList>
<ZipCode>sample string 23</ZipCode>
</XtSearchResult>
</ResultSet>
</XtSearchQueryResult>