POST api/Site/XtSite
Request Information
URI Parameters
None.
Body Parameters
SiteRequestName | 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
XtSiteQueryResultName | Description | Type | Additional information |
---|---|---|---|
ExcludeColumnList | Collection of string |
None. |
|
ResultSet | Collection of XtSiteResult |
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": [ { "AdditionalData2Flag": true, "AdditionalDataFlag": true, "Address2": "sample string 1", "AddressDisplay": "sample string 2", "AddressDisplayURL": "sample string 3", "AddressURL": "sample string 4", "AlternateXmitFlag": true, "AuditFlag": true, "CallingSource": "sample string 5", "City": "sample string 6", "CrossStreet": "sample string 7", "CurrentTestFlag": true, "CustomOption": "sample string 8", "DevNum": 1, "Directions": "sample string 9", "FieldDevice": "sample string 10", "FromAlarmDispatchFlag": "sample string 11", "HasDeviceFlag": true, "InfoXml": { "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" } ] } ] }, "MapInformation": "sample string 12", "MsgCtrAcctFlag": true, "Name": "sample string 13", "NavigatorFlag": true, "OOSCat": "sample string 14", "OOSCatDescription": "sample string 15", "OOSFlag": true, "Pets": "sample string 16", "PrimaryDevNum": 1, "Region": "sample string 17", "RegionDescription": "sample string 18", "ScheduleFlag": true, "SiteName": "sample string 19", "SiteNum": 1, "SiteStatus": "sample string 20", "SiteStatusDescription": "sample string 21", "SiteType": "sample string 22", "SiteTypeDescription": "sample string 23", "State": "sample string 24", "StyleCode": "sample string 25", "TestStatus": "sample string 26", "TimeZoneDescription": "sample string 27", "TimeZoneNum": 1, "TitleXmit": "sample string 28", "TransmitterCode": "sample string 29", "ZipCode": "sample string 30", "AlarmFlag": true, "FunctionOption": "sample string 31", "ABNewSite": true, "CredentialType": "sample string 32" }, { "AdditionalData2Flag": true, "AdditionalDataFlag": true, "Address2": "sample string 1", "AddressDisplay": "sample string 2", "AddressDisplayURL": "sample string 3", "AddressURL": "sample string 4", "AlternateXmitFlag": true, "AuditFlag": true, "CallingSource": "sample string 5", "City": "sample string 6", "CrossStreet": "sample string 7", "CurrentTestFlag": true, "CustomOption": "sample string 8", "DevNum": 1, "Directions": "sample string 9", "FieldDevice": "sample string 10", "FromAlarmDispatchFlag": "sample string 11", "HasDeviceFlag": true, "InfoXml": { "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" } ] } ] }, "MapInformation": "sample string 12", "MsgCtrAcctFlag": true, "Name": "sample string 13", "NavigatorFlag": true, "OOSCat": "sample string 14", "OOSCatDescription": "sample string 15", "OOSFlag": true, "Pets": "sample string 16", "PrimaryDevNum": 1, "Region": "sample string 17", "RegionDescription": "sample string 18", "ScheduleFlag": true, "SiteName": "sample string 19", "SiteNum": 1, "SiteStatus": "sample string 20", "SiteStatusDescription": "sample string 21", "SiteType": "sample string 22", "SiteTypeDescription": "sample string 23", "State": "sample string 24", "StyleCode": "sample string 25", "TestStatus": "sample string 26", "TimeZoneDescription": "sample string 27", "TimeZoneNum": 1, "TitleXmit": "sample string 28", "TransmitterCode": "sample string 29", "ZipCode": "sample string 30", "AlarmFlag": true, "FunctionOption": "sample string 31", "ABNewSite": true, "CredentialType": "sample string 32" } ], "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5" }
application/xml, text/xml
Sample:
<XtSiteQueryResult 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> <XtSiteResult> <ABNewSite>true</ABNewSite> <AdditionalData2Flag>true</AdditionalData2Flag> <AdditionalDataFlag>true</AdditionalDataFlag> <Address2>sample string 1</Address2> <AddressDisplay>sample string 2</AddressDisplay> <AddressDisplayURL>sample string 3</AddressDisplayURL> <AddressURL>sample string 4</AddressURL> <AlarmFlag>true</AlarmFlag> <AlternateXmitFlag>true</AlternateXmitFlag> <AuditFlag>true</AuditFlag> <CallingSource>sample string 5</CallingSource> <City>sample string 6</City> <CredentialType>sample string 32</CredentialType> <CrossStreet>sample string 7</CrossStreet> <CurrentTestFlag>true</CurrentTestFlag> <CustomOption>sample string 8</CustomOption> <DevNum>1</DevNum> <Directions>sample string 9</Directions> <FieldDevice>sample string 10</FieldDevice> <FromAlarmDispatchFlag>sample string 11</FromAlarmDispatchFlag> <FunctionOption>sample string 31</FunctionOption> <HasDeviceFlag>true</HasDeviceFlag> <InfoXml> <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> </InfoXml> <MapInformation>sample string 12</MapInformation> <MsgCtrAcctFlag>true</MsgCtrAcctFlag> <Name>sample string 13</Name> <NavigatorFlag>true</NavigatorFlag> <OOSCat>sample string 14</OOSCat> <OOSCatDescription>sample string 15</OOSCatDescription> <OOSFlag>true</OOSFlag> <Pets>sample string 16</Pets> <PrimaryDevNum>1</PrimaryDevNum> <Region>sample string 17</Region> <RegionDescription>sample string 18</RegionDescription> <ScheduleFlag>true</ScheduleFlag> <SiteName>sample string 19</SiteName> <SiteNum>1</SiteNum> <SiteStatus>sample string 20</SiteStatus> <SiteStatusDescription>sample string 21</SiteStatusDescription> <SiteType>sample string 22</SiteType> <SiteTypeDescription>sample string 23</SiteTypeDescription> <State>sample string 24</State> <StyleCode>sample string 25</StyleCode> <TestStatus>sample string 26</TestStatus> <TimeZoneDescription>sample string 27</TimeZoneDescription> <TimeZoneNum>1</TimeZoneNum> <TitleXmit>sample string 28</TitleXmit> <TransmitterCode>sample string 29</TransmitterCode> <ZipCode>sample string 30</ZipCode> </XtSiteResult> <XtSiteResult> <ABNewSite>true</ABNewSite> <AdditionalData2Flag>true</AdditionalData2Flag> <AdditionalDataFlag>true</AdditionalDataFlag> <Address2>sample string 1</Address2> <AddressDisplay>sample string 2</AddressDisplay> <AddressDisplayURL>sample string 3</AddressDisplayURL> <AddressURL>sample string 4</AddressURL> <AlarmFlag>true</AlarmFlag> <AlternateXmitFlag>true</AlternateXmitFlag> <AuditFlag>true</AuditFlag> <CallingSource>sample string 5</CallingSource> <City>sample string 6</City> <CredentialType>sample string 32</CredentialType> <CrossStreet>sample string 7</CrossStreet> <CurrentTestFlag>true</CurrentTestFlag> <CustomOption>sample string 8</CustomOption> <DevNum>1</DevNum> <Directions>sample string 9</Directions> <FieldDevice>sample string 10</FieldDevice> <FromAlarmDispatchFlag>sample string 11</FromAlarmDispatchFlag> <FunctionOption>sample string 31</FunctionOption> <HasDeviceFlag>true</HasDeviceFlag> <InfoXml> <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> </InfoXml> <MapInformation>sample string 12</MapInformation> <MsgCtrAcctFlag>true</MsgCtrAcctFlag> <Name>sample string 13</Name> <NavigatorFlag>true</NavigatorFlag> <OOSCat>sample string 14</OOSCat> <OOSCatDescription>sample string 15</OOSCatDescription> <OOSFlag>true</OOSFlag> <Pets>sample string 16</Pets> <PrimaryDevNum>1</PrimaryDevNum> <Region>sample string 17</Region> <RegionDescription>sample string 18</RegionDescription> <ScheduleFlag>true</ScheduleFlag> <SiteName>sample string 19</SiteName> <SiteNum>1</SiteNum> <SiteStatus>sample string 20</SiteStatus> <SiteStatusDescription>sample string 21</SiteStatusDescription> <SiteType>sample string 22</SiteType> <SiteTypeDescription>sample string 23</SiteTypeDescription> <State>sample string 24</State> <StyleCode>sample string 25</StyleCode> <TestStatus>sample string 26</TestStatus> <TimeZoneDescription>sample string 27</TimeZoneDescription> <TimeZoneNum>1</TimeZoneNum> <TitleXmit>sample string 28</TitleXmit> <TransmitterCode>sample string 29</TransmitterCode> <ZipCode>sample string 30</ZipCode> </XtSiteResult> </ResultSet> </XtSiteQueryResult>