POST api/Search/ShortSiteDeviceList
Request Information
URI Parameters
None.
Body Parameters
ShortSiteDeviceRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| SiteGroupSearch | string |
None. |
|
| StartTransmitterCode | string |
None. |
|
| EndTransmitterCode | string |
None. |
|
| AgencySearch | string |
None. |
|
| DeviceType | string |
None. |
|
| SiteType | string |
None. |
|
| DispatchType | string |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| ZipCode | string |
None. |
|
| County | string |
None. |
|
| ExcludeOOSFlag | boolean |
None. |
|
| OnlyAcctsWithSecondaryXmitFlag | boolean |
None. |
|
| OnlyAcctsWithAlternateXmitFlag | boolean |
None. |
|
| OnlyAcctsWithScheduleFlag | boolean |
None. |
|
| OrderBySiteNameFlag | boolean |
None. |
|
| UDFCode | string |
None. |
|
| UDFValue | string |
None. |
|
| Option | string |
None. |
|
| SessionNum | integer |
None. |
|
| SessionPassword | Collection of byte |
None. |
|
| ApplicationCode | string |
None. |
|
| StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"SiteGroupSearch": "sample string 1",
"StartTransmitterCode": "sample string 2",
"EndTransmitterCode": "sample string 3",
"AgencySearch": "sample string 4",
"DeviceType": "sample string 5",
"SiteType": "sample string 6",
"DispatchType": "sample string 7",
"City": "sample string 8",
"State": "sample string 9",
"ZipCode": "sample string 10",
"County": "sample string 11",
"ExcludeOOSFlag": true,
"OnlyAcctsWithSecondaryXmitFlag": true,
"OnlyAcctsWithAlternateXmitFlag": true,
"OnlyAcctsWithScheduleFlag": true,
"OrderBySiteNameFlag": true,
"UDFCode": "sample string 12",
"UDFValue": "sample string 13",
"Option": "sample string 14",
"SessionNum": 15,
"SessionPassword": "QEA=",
"ApplicationCode": "sample string 16",
"StagesURL": "sample string 17"
}
application/xml, text/xml
Sample:
<ShortSiteDeviceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 17</StagesURL> <ApplicationCode>sample string 16</ApplicationCode> <SessionNum>15</SessionNum> <SessionPassword>QEA=</SessionPassword> <AgencySearch>sample string 4</AgencySearch> <City>sample string 8</City> <County>sample string 11</County> <DeviceType>sample string 5</DeviceType> <DispatchType>sample string 7</DispatchType> <EndTransmitterCode>sample string 3</EndTransmitterCode> <ExcludeOOSFlag>true</ExcludeOOSFlag> <OnlyAcctsWithAlternateXmitFlag>true</OnlyAcctsWithAlternateXmitFlag> <OnlyAcctsWithScheduleFlag>true</OnlyAcctsWithScheduleFlag> <OnlyAcctsWithSecondaryXmitFlag>true</OnlyAcctsWithSecondaryXmitFlag> <Option>sample string 14</Option> <OrderBySiteNameFlag>true</OrderBySiteNameFlag> <SiteGroupSearch>sample string 1</SiteGroupSearch> <SiteType>sample string 6</SiteType> <StartTransmitterCode>sample string 2</StartTransmitterCode> <State>sample string 9</State> <UDFCode>sample string 12</UDFCode> <UDFValue>sample string 13</UDFValue> <ZipCode>sample string 10</ZipCode> </ShortSiteDeviceRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ShortSiteDeviceListQueryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ExcludeColumnList | Collection of string |
None. |
|
| ResultSet | Collection of ShortSiteDeviceListResult |
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",
"AgencySearch": "sample string 3",
"AlternateXmitList": "sample string 4",
"City": "sample string 5",
"County": "sample string 6",
"DeviceType": "sample string 7",
"DeviceTypeDescription": "sample string 8",
"DispatchType": "sample string 9",
"DispatchTypeListDisplay": "sample string 10",
"EndTransmitterCode": "sample string 11",
"ExcludeOOSFlag": true,
"FirstSignalDate": "2025-12-14T17:43:03.892318-05:00",
"OnlyAcctsWithAlternateXmitFlag": true,
"OnlyAcctsWithScheduleFlag": true,
"OnlyAcctsWithSecondaryXmitFlag": true,
"OrderBySiteNameFlag": true,
"Phone": "sample string 12",
"SiteGroupListDisplay": "sample string 13",
"SiteGroupSearch": "sample string 14",
"SiteName": "sample string 15",
"SiteType": "sample string 16",
"SiteTypeDescription": "sample string 17",
"StartTransmitterCode": "sample string 18",
"State": "sample string 19",
"TransmitterCode": "sample string 20",
"XmitList": "sample string 21",
"ZipCode": "sample string 22",
"UDFCode": "sample string 23",
"UDFValue": "sample string 24",
"Latitude": 1.0,
"Longitude": 1.0,
"MapMarker": "sample string 25"
},
{
"Address": "sample string 1",
"Address2": "sample string 2",
"AgencySearch": "sample string 3",
"AlternateXmitList": "sample string 4",
"City": "sample string 5",
"County": "sample string 6",
"DeviceType": "sample string 7",
"DeviceTypeDescription": "sample string 8",
"DispatchType": "sample string 9",
"DispatchTypeListDisplay": "sample string 10",
"EndTransmitterCode": "sample string 11",
"ExcludeOOSFlag": true,
"FirstSignalDate": "2025-12-14T17:43:03.892318-05:00",
"OnlyAcctsWithAlternateXmitFlag": true,
"OnlyAcctsWithScheduleFlag": true,
"OnlyAcctsWithSecondaryXmitFlag": true,
"OrderBySiteNameFlag": true,
"Phone": "sample string 12",
"SiteGroupListDisplay": "sample string 13",
"SiteGroupSearch": "sample string 14",
"SiteName": "sample string 15",
"SiteType": "sample string 16",
"SiteTypeDescription": "sample string 17",
"StartTransmitterCode": "sample string 18",
"State": "sample string 19",
"TransmitterCode": "sample string 20",
"XmitList": "sample string 21",
"ZipCode": "sample string 22",
"UDFCode": "sample string 23",
"UDFValue": "sample string 24",
"Latitude": 1.0,
"Longitude": 1.0,
"MapMarker": "sample string 25"
}
],
"Success": true,
"UserErrorMessage": "sample string 2",
"ErrorTypeNum": 3,
"SqlConnectionLost": true,
"ClientVersion": "sample string 5"
}
application/xml, text/xml
Sample:
<ShortSiteDeviceListQueryResult 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>
<ShortSiteDeviceListResult>
<Address>sample string 1</Address>
<Address2>sample string 2</Address2>
<AgencySearch>sample string 3</AgencySearch>
<AlternateXmitList>sample string 4</AlternateXmitList>
<City>sample string 5</City>
<County>sample string 6</County>
<DeviceType>sample string 7</DeviceType>
<DeviceTypeDescription>sample string 8</DeviceTypeDescription>
<DispatchType>sample string 9</DispatchType>
<DispatchTypeListDisplay>sample string 10</DispatchTypeListDisplay>
<EndTransmitterCode>sample string 11</EndTransmitterCode>
<ExcludeOOSFlag>true</ExcludeOOSFlag>
<FirstSignalDate>2025-12-14T17:43:03.892318-05:00</FirstSignalDate>
<Latitude>1</Latitude>
<Longitude>1</Longitude>
<MapMarker>sample string 25</MapMarker>
<OnlyAcctsWithAlternateXmitFlag>true</OnlyAcctsWithAlternateXmitFlag>
<OnlyAcctsWithScheduleFlag>true</OnlyAcctsWithScheduleFlag>
<OnlyAcctsWithSecondaryXmitFlag>true</OnlyAcctsWithSecondaryXmitFlag>
<OrderBySiteNameFlag>true</OrderBySiteNameFlag>
<Phone>sample string 12</Phone>
<SiteGroupListDisplay>sample string 13</SiteGroupListDisplay>
<SiteGroupSearch>sample string 14</SiteGroupSearch>
<SiteName>sample string 15</SiteName>
<SiteType>sample string 16</SiteType>
<SiteTypeDescription>sample string 17</SiteTypeDescription>
<StartTransmitterCode>sample string 18</StartTransmitterCode>
<State>sample string 19</State>
<TransmitterCode>sample string 20</TransmitterCode>
<UDFCode>sample string 23</UDFCode>
<UDFValue>sample string 24</UDFValue>
<XmitList>sample string 21</XmitList>
<ZipCode>sample string 22</ZipCode>
</ShortSiteDeviceListResult>
<ShortSiteDeviceListResult>
<Address>sample string 1</Address>
<Address2>sample string 2</Address2>
<AgencySearch>sample string 3</AgencySearch>
<AlternateXmitList>sample string 4</AlternateXmitList>
<City>sample string 5</City>
<County>sample string 6</County>
<DeviceType>sample string 7</DeviceType>
<DeviceTypeDescription>sample string 8</DeviceTypeDescription>
<DispatchType>sample string 9</DispatchType>
<DispatchTypeListDisplay>sample string 10</DispatchTypeListDisplay>
<EndTransmitterCode>sample string 11</EndTransmitterCode>
<ExcludeOOSFlag>true</ExcludeOOSFlag>
<FirstSignalDate>2025-12-14T17:43:03.892318-05:00</FirstSignalDate>
<Latitude>1</Latitude>
<Longitude>1</Longitude>
<MapMarker>sample string 25</MapMarker>
<OnlyAcctsWithAlternateXmitFlag>true</OnlyAcctsWithAlternateXmitFlag>
<OnlyAcctsWithScheduleFlag>true</OnlyAcctsWithScheduleFlag>
<OnlyAcctsWithSecondaryXmitFlag>true</OnlyAcctsWithSecondaryXmitFlag>
<OrderBySiteNameFlag>true</OrderBySiteNameFlag>
<Phone>sample string 12</Phone>
<SiteGroupListDisplay>sample string 13</SiteGroupListDisplay>
<SiteGroupSearch>sample string 14</SiteGroupSearch>
<SiteName>sample string 15</SiteName>
<SiteType>sample string 16</SiteType>
<SiteTypeDescription>sample string 17</SiteTypeDescription>
<StartTransmitterCode>sample string 18</StartTransmitterCode>
<State>sample string 19</State>
<TransmitterCode>sample string 20</TransmitterCode>
<UDFCode>sample string 23</UDFCode>
<UDFValue>sample string 24</UDFValue>
<XmitList>sample string 21</XmitList>
<ZipCode>sample string 22</ZipCode>
</ShortSiteDeviceListResult>
</ResultSet>
</ShortSiteDeviceListQueryResult>