POST api/Search/SiteSearch

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
TransmitterCode	string	None.
SiteName	string	None.
Phone	string	None.
Address	string	None.
Address2	string	None.
City	string	None.
State	string	None.
Zipcode	string	None.
StreetName	string	None.
AlarmNum	integer	None.
Passcode	string	None.
Email	string	None.
SiteGroupSearch	string	None.
County	string	None.
AltPanelId	string	None.
ID2	string	None.
ID1	string	None.
InAlarmFlag	boolean	None.
IncludeOOSFlag	boolean	None.
IncludeExpiredContactsFlag	boolean	None.
FirstName	string	None.
LastName	string	None.
SiteAddressOnlyFlag	boolean	None.
DeviceType	string	None.
UDFCode	string	None.
UDFValue	string	None.
IntegrationPlatform	string	None.
SessionNum	integer	None.
SessionPassword	Collection of byte	None.
ApplicationCode	string	None.
StagesURL	string	None.

Request Formats

application/json, text/json

Sample:

{
  "TransmitterCode": "sample string 1",
  "SiteName": "sample string 2",
  "Phone": "sample string 3",
  "Address": "sample string 4",
  "Address2": "sample string 5",
  "City": "sample string 6",
  "State": "sample string 7",
  "Zipcode": "sample string 8",
  "StreetName": "sample string 9",
  "AlarmNum": 1,
  "Passcode": "sample string 10",
  "Email": "sample string 11",
  "SiteGroupSearch": "sample string 12",
  "County": "sample string 13",
  "AltPanelId": "sample string 14",
  "ID2": "sample string 15",
  "ID1": "sample string 16",
  "InAlarmFlag": true,
  "IncludeOOSFlag": true,
  "IncludeExpiredContactsFlag": true,
  "FirstName": "sample string 17",
  "LastName": "sample string 18",
  "SiteAddressOnlyFlag": true,
  "DeviceType": "sample string 19",
  "UDFCode": "sample string 20",
  "UDFValue": "sample string 21",
  "IntegrationPlatform": "sample string 22",
  "SessionNum": 23,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 24",
  "StagesURL": "sample string 25"
}

application/xml, text/xml

Sample:

<XtAdvancedSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 25</StagesURL>
  <ApplicationCode>sample string 24</ApplicationCode>
  <SessionNum>23</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <Address>sample string 4</Address>
  <Address2>sample string 5</Address2>
  <AlarmNum>1</AlarmNum>
  <AltPanelId>sample string 14</AltPanelId>
  <City>sample string 6</City>
  <County>sample string 13</County>
  <DeviceType>sample string 19</DeviceType>
  <Email>sample string 11</Email>
  <FirstName>sample string 17</FirstName>
  <ID1>sample string 16</ID1>
  <ID2>sample string 15</ID2>
  <InAlarmFlag>true</InAlarmFlag>
  <IncludeExpiredContactsFlag>true</IncludeExpiredContactsFlag>
  <IncludeOOSFlag>true</IncludeOOSFlag>
  <IntegrationPlatform>sample string 22</IntegrationPlatform>
  <LastName>sample string 18</LastName>
  <Passcode>sample string 10</Passcode>
  <Phone>sample string 3</Phone>
  <SiteAddressOnlyFlag>true</SiteAddressOnlyFlag>
  <SiteGroupSearch>sample string 12</SiteGroupSearch>
  <SiteName>sample string 2</SiteName>
  <State>sample string 7</State>
  <StreetName>sample string 9</StreetName>
  <TransmitterCode>sample string 1</TransmitterCode>
  <UDFCode>sample string 20</UDFCode>
  <UDFValue>sample string 21</UDFValue>
  <Zipcode>sample string 8</Zipcode>
</XtAdvancedSearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SiteSearchQueryResult

Name	Type	Additional information
ExcludeColumnList	Collection of string	None.
ResultSet	Collection of SiteSearchResult	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",
      "AKAAccount": "sample string 4",
      "AlarmDate": "2025-05-03T22:02:01.6875821-07:00",
      "AlarmFlag": true,
      "AlarmNum": 1,
      "AltDeviceID": "sample string 5",
      "ApplicationNum": 1,
      "AlarmOnlyFlag": true,
      "AlarmsIn24HrsFlag": true,
      "BillingID": "sample string 6",
      "City": "sample string 7",
      "CityStateZip": "sample string 8",
      "DeviceStatus": "sample string 9",
      "DeviceType": "sample string 10",
      "Category": "sample string 11",
      "DevNum": 1,
      "EmailAddress": "sample string 12",
      "ContactNum": 1,
      "ContactPhone": "sample string 13",
      "IncludeOOSFlag": true,
      "JobNum": 1,
      "County": "sample string 14",
      "CWorPIN": "sample string 15",
      "MsgCenterSiteNum": 1,
      "Phone": "sample string 16",
      "PinCodeWord": "sample string 17",
      "DeviceTypeDescription": "sample string 18",
      "SiteGroupName": "sample string 19",
      "SiteGroupSearch": "sample string 20",
      "SiteID1": "sample string 21",
      "DispatchTypeListDisplay": "sample string 22",
      "SiteID2": "sample string 23",
      "DuressCodeFlag": true,
      "SiteName": "sample string 24",
      "SiteNum": 1,
      "HasDeviceFlag": true,
      "HasScheduleFlag": true,
      "State": "sample string 25",
      "StreetName": "sample string 26",
      "HighlightFlag": true,
      "IncludeExpiredContactsFlag": true,
      "StyleCode": "sample string 27",
      "TransmitterCode": "sample string 28",
      "ULCode": "sample string 29",
      "ULCodeDescription": "sample string 30",
      "MatchColumn": "sample string 31",
      "Permit": "sample string 32",
      "XmitCodePlusSiteName": "sample string 33",
      "ZipCode": "sample string 34",
      "QuickCallFlag": true,
      "Region": "sample string 35",
      "RegionDescription": "sample string 36",
      "SiteCWSeqNum": 1,
      "SiteGroupNum": 1,
      "SiteGroupSummary": {
        "SectionList": [
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          },
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        ]
      },
      "SiteGroupSummaryFO": {
        "SectionList": [
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          },
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        ]
      },
      "SiteType": "sample string 37",
      "SiteTypeDescription": "sample string 38",
      "TransmitterMatchFlag": true,
      "XmitList": "sample string 39",
      "SiteAddressOnlyFlag": true,
      "DisplayOption": "sample string 40",
      "SiteStatus": "sample string 41",
      "SiteStatusDescription": "sample string 42",
      "FunctionOption": "sample string 43",
      "IntegrationPlatform": "sample string 44",
      "IntegrationPlatformDescription": "sample string 45",
      "FirstName": "sample string 46",
      "LastName": "sample string 47",
      "DeviceInfo": "sample string 48"
    },
    {
      "Address": "sample string 1",
      "Address2": "sample string 2",
      "AgencySearch": "sample string 3",
      "AKAAccount": "sample string 4",
      "AlarmDate": "2025-05-03T22:02:01.6875821-07:00",
      "AlarmFlag": true,
      "AlarmNum": 1,
      "AltDeviceID": "sample string 5",
      "ApplicationNum": 1,
      "AlarmOnlyFlag": true,
      "AlarmsIn24HrsFlag": true,
      "BillingID": "sample string 6",
      "City": "sample string 7",
      "CityStateZip": "sample string 8",
      "DeviceStatus": "sample string 9",
      "DeviceType": "sample string 10",
      "Category": "sample string 11",
      "DevNum": 1,
      "EmailAddress": "sample string 12",
      "ContactNum": 1,
      "ContactPhone": "sample string 13",
      "IncludeOOSFlag": true,
      "JobNum": 1,
      "County": "sample string 14",
      "CWorPIN": "sample string 15",
      "MsgCenterSiteNum": 1,
      "Phone": "sample string 16",
      "PinCodeWord": "sample string 17",
      "DeviceTypeDescription": "sample string 18",
      "SiteGroupName": "sample string 19",
      "SiteGroupSearch": "sample string 20",
      "SiteID1": "sample string 21",
      "DispatchTypeListDisplay": "sample string 22",
      "SiteID2": "sample string 23",
      "DuressCodeFlag": true,
      "SiteName": "sample string 24",
      "SiteNum": 1,
      "HasDeviceFlag": true,
      "HasScheduleFlag": true,
      "State": "sample string 25",
      "StreetName": "sample string 26",
      "HighlightFlag": true,
      "IncludeExpiredContactsFlag": true,
      "StyleCode": "sample string 27",
      "TransmitterCode": "sample string 28",
      "ULCode": "sample string 29",
      "ULCodeDescription": "sample string 30",
      "MatchColumn": "sample string 31",
      "Permit": "sample string 32",
      "XmitCodePlusSiteName": "sample string 33",
      "ZipCode": "sample string 34",
      "QuickCallFlag": true,
      "Region": "sample string 35",
      "RegionDescription": "sample string 36",
      "SiteCWSeqNum": 1,
      "SiteGroupNum": 1,
      "SiteGroupSummary": {
        "SectionList": [
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          },
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        ]
      },
      "SiteGroupSummaryFO": {
        "SectionList": [
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          },
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        ]
      },
      "SiteType": "sample string 37",
      "SiteTypeDescription": "sample string 38",
      "TransmitterMatchFlag": true,
      "XmitList": "sample string 39",
      "SiteAddressOnlyFlag": true,
      "DisplayOption": "sample string 40",
      "SiteStatus": "sample string 41",
      "SiteStatusDescription": "sample string 42",
      "FunctionOption": "sample string 43",
      "IntegrationPlatform": "sample string 44",
      "IntegrationPlatformDescription": "sample string 45",
      "FirstName": "sample string 46",
      "LastName": "sample string 47",
      "DeviceInfo": "sample string 48"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<SiteSearchQueryResult 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>
    <SiteSearchResult>
      <AKAAccount>sample string 4</AKAAccount>
      <Address>sample string 1</Address>
      <Address2>sample string 2</Address2>
      <AgencySearch>sample string 3</AgencySearch>
      <AlarmDate>2025-05-03T22:02:01.6875821-07:00</AlarmDate>
      <AlarmFlag>true</AlarmFlag>
      <AlarmNum>1</AlarmNum>
      <AlarmOnlyFlag>true</AlarmOnlyFlag>
      <AlarmsIn24HrsFlag>true</AlarmsIn24HrsFlag>
      <AltDeviceID>sample string 5</AltDeviceID>
      <ApplicationNum>1</ApplicationNum>
      <BillingID>sample string 6</BillingID>
      <CWorPIN>sample string 15</CWorPIN>
      <Category>sample string 11</Category>
      <City>sample string 7</City>
      <CityStateZip>sample string 8</CityStateZip>
      <ContactNum>1</ContactNum>
      <ContactPhone>sample string 13</ContactPhone>
      <County>sample string 14</County>
      <DevNum>1</DevNum>
      <DeviceInfo>sample string 48</DeviceInfo>
      <DeviceStatus>sample string 9</DeviceStatus>
      <DeviceType>sample string 10</DeviceType>
      <DeviceTypeDescription>sample string 18</DeviceTypeDescription>
      <DispatchTypeListDisplay>sample string 22</DispatchTypeListDisplay>
      <DisplayOption>sample string 40</DisplayOption>
      <DuressCodeFlag>true</DuressCodeFlag>
      <EmailAddress>sample string 12</EmailAddress>
      <FirstName>sample string 46</FirstName>
      <FunctionOption>sample string 43</FunctionOption>
      <HasDeviceFlag>true</HasDeviceFlag>
      <HasScheduleFlag>true</HasScheduleFlag>
      <HighlightFlag>true</HighlightFlag>
      <IncludeExpiredContactsFlag>true</IncludeExpiredContactsFlag>
      <IncludeOOSFlag>true</IncludeOOSFlag>
      <IntegrationPlatform>sample string 44</IntegrationPlatform>
      <IntegrationPlatformDescription>sample string 45</IntegrationPlatformDescription>
      <JobNum>1</JobNum>
      <LastName>sample string 47</LastName>
      <MatchColumn>sample string 31</MatchColumn>
      <MsgCenterSiteNum>1</MsgCenterSiteNum>
      <Permit>sample string 32</Permit>
      <Phone>sample string 16</Phone>
      <PinCodeWord>sample string 17</PinCodeWord>
      <QuickCallFlag>true</QuickCallFlag>
      <Region>sample string 35</Region>
      <RegionDescription>sample string 36</RegionDescription>
      <SiteAddressOnlyFlag>true</SiteAddressOnlyFlag>
      <SiteCWSeqNum>1</SiteCWSeqNum>
      <SiteGroupName>sample string 19</SiteGroupName>
      <SiteGroupNum>1</SiteGroupNum>
      <SiteGroupSearch>sample string 20</SiteGroupSearch>
      <SiteGroupSummary>
        <SectionList>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
        </SectionList>
      </SiteGroupSummary>
      <SiteGroupSummaryFO>
        <SectionList>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
        </SectionList>
      </SiteGroupSummaryFO>
      <SiteID1>sample string 21</SiteID1>
      <SiteID2>sample string 23</SiteID2>
      <SiteName>sample string 24</SiteName>
      <SiteNum>1</SiteNum>
      <SiteStatus>sample string 41</SiteStatus>
      <SiteStatusDescription>sample string 42</SiteStatusDescription>
      <SiteType>sample string 37</SiteType>
      <SiteTypeDescription>sample string 38</SiteTypeDescription>
      <State>sample string 25</State>
      <StreetName>sample string 26</StreetName>
      <StyleCode>sample string 27</StyleCode>
      <TransmitterCode>sample string 28</TransmitterCode>
      <TransmitterMatchFlag>true</TransmitterMatchFlag>
      <ULCode>sample string 29</ULCode>
      <ULCodeDescription>sample string 30</ULCodeDescription>
      <XmitCodePlusSiteName>sample string 33</XmitCodePlusSiteName>
      <XmitList>sample string 39</XmitList>
      <ZipCode>sample string 34</ZipCode>
    </SiteSearchResult>
    <SiteSearchResult>
      <AKAAccount>sample string 4</AKAAccount>
      <Address>sample string 1</Address>
      <Address2>sample string 2</Address2>
      <AgencySearch>sample string 3</AgencySearch>
      <AlarmDate>2025-05-03T22:02:01.6875821-07:00</AlarmDate>
      <AlarmFlag>true</AlarmFlag>
      <AlarmNum>1</AlarmNum>
      <AlarmOnlyFlag>true</AlarmOnlyFlag>
      <AlarmsIn24HrsFlag>true</AlarmsIn24HrsFlag>
      <AltDeviceID>sample string 5</AltDeviceID>
      <ApplicationNum>1</ApplicationNum>
      <BillingID>sample string 6</BillingID>
      <CWorPIN>sample string 15</CWorPIN>
      <Category>sample string 11</Category>
      <City>sample string 7</City>
      <CityStateZip>sample string 8</CityStateZip>
      <ContactNum>1</ContactNum>
      <ContactPhone>sample string 13</ContactPhone>
      <County>sample string 14</County>
      <DevNum>1</DevNum>
      <DeviceInfo>sample string 48</DeviceInfo>
      <DeviceStatus>sample string 9</DeviceStatus>
      <DeviceType>sample string 10</DeviceType>
      <DeviceTypeDescription>sample string 18</DeviceTypeDescription>
      <DispatchTypeListDisplay>sample string 22</DispatchTypeListDisplay>
      <DisplayOption>sample string 40</DisplayOption>
      <DuressCodeFlag>true</DuressCodeFlag>
      <EmailAddress>sample string 12</EmailAddress>
      <FirstName>sample string 46</FirstName>
      <FunctionOption>sample string 43</FunctionOption>
      <HasDeviceFlag>true</HasDeviceFlag>
      <HasScheduleFlag>true</HasScheduleFlag>
      <HighlightFlag>true</HighlightFlag>
      <IncludeExpiredContactsFlag>true</IncludeExpiredContactsFlag>
      <IncludeOOSFlag>true</IncludeOOSFlag>
      <IntegrationPlatform>sample string 44</IntegrationPlatform>
      <IntegrationPlatformDescription>sample string 45</IntegrationPlatformDescription>
      <JobNum>1</JobNum>
      <LastName>sample string 47</LastName>
      <MatchColumn>sample string 31</MatchColumn>
      <MsgCenterSiteNum>1</MsgCenterSiteNum>
      <Permit>sample string 32</Permit>
      <Phone>sample string 16</Phone>
      <PinCodeWord>sample string 17</PinCodeWord>
      <QuickCallFlag>true</QuickCallFlag>
      <Region>sample string 35</Region>
      <RegionDescription>sample string 36</RegionDescription>
      <SiteAddressOnlyFlag>true</SiteAddressOnlyFlag>
      <SiteCWSeqNum>1</SiteCWSeqNum>
      <SiteGroupName>sample string 19</SiteGroupName>
      <SiteGroupNum>1</SiteGroupNum>
      <SiteGroupSearch>sample string 20</SiteGroupSearch>
      <SiteGroupSummary>
        <SectionList>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
        </SectionList>
      </SiteGroupSummary>
      <SiteGroupSummaryFO>
        <SectionList>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
        </SectionList>
      </SiteGroupSummaryFO>
      <SiteID1>sample string 21</SiteID1>
      <SiteID2>sample string 23</SiteID2>
      <SiteName>sample string 24</SiteName>
      <SiteNum>1</SiteNum>
      <SiteStatus>sample string 41</SiteStatus>
      <SiteStatusDescription>sample string 42</SiteStatusDescription>
      <SiteType>sample string 37</SiteType>
      <SiteTypeDescription>sample string 38</SiteTypeDescription>
      <State>sample string 25</State>
      <StreetName>sample string 26</StreetName>
      <StyleCode>sample string 27</StyleCode>
      <TransmitterCode>sample string 28</TransmitterCode>
      <TransmitterMatchFlag>true</TransmitterMatchFlag>
      <ULCode>sample string 29</ULCode>
      <ULCodeDescription>sample string 30</ULCodeDescription>
      <XmitCodePlusSiteName>sample string 33</XmitCodePlusSiteName>
      <XmitList>sample string 39</XmitList>
      <ZipCode>sample string 34</ZipCode>
    </SiteSearchResult>
  </ResultSet>
</SiteSearchQueryResult>