POST api/Site/DataEntrySiteView
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
DataEntrySiteViewQueryResultName | Description | Type | Additional information |
---|---|---|---|
ExcludeColumnList | Collection of string |
None. |
|
ResultSet | Collection of DataEntrySiteViewResult |
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": [ { "AdditionalData3Flag": true, "Address": "sample string 1", "Address2": "sample string 2", "AddressDisplay": "sample string 3", "AddressDisplayURL": "sample string 4", "AddressURL": "sample string 5", "AlarmFlag": true, "AlternateXmitFlag": true, "AuditFlag": true, "Authority": "sample string 6", "AuthorityDescription": "sample string 7", "BarcodePrinterFlag": true, "CallingSource": "sample string 8", "City": "sample string 9", "CrossStreet": "sample string 10", "CurrentTestFlag": true, "DeviceTestOnDataEntryFlag": true, "DevNum": 1, "Directions": "sample string 11", "DocumentFlag": true, "FieldDevice": "sample string 12", "FromAlarmDispatchFlag": "sample string 13", "FunctionOption": "sample string 14", "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" } ] } ] }, "IntegrationPlatform": "sample string 15", "Map": "sample string 16", "MapCoordinates": "sample string 17", "MapPage": "sample string 18", "MsgCtrAcctFlag": true, "MultiSiteFlag": true, "NavigatorFlag": true, "OOSCat": "sample string 19", "OOSCatDescription": "sample string 20", "OOSFlag": true, "Option": "sample string 21", "PendingFollowUpFlag": true, "Pets": "sample string 22", "PinVerificationMethod": "sample string 23", "PrimaryDevNum": 1, "Region": "sample string 24", "RegionDescription": "sample string 25", "RulesInEffectFlag": true, "SiteDispatchTypes": "sample string 26", "SiteGroupNum": 1, "SiteGroupSetupPermissionFlag": true, "SiteName": "sample string 27", "SiteNum": 1, "SiteStatus": "sample string 28", "SiteStatusDescription": "sample string 29", "SiteType": "sample string 30", "SiteTypeDescription": "sample string 31", "State": "sample string 32", "Status": "sample string 33", "StyleCode": "sample string 34", "SuppressAddressURLFlag": true, "TestStatus": "sample string 35", "TimeZoneDescription": "sample string 36", "TimeZoneNum": 1, "TitleXmit": "sample string 37", "TransmitterCode": "sample string 38", "ZipCode": "sample string 39", "SiteHasAlarmFlag": true }, { "AdditionalData3Flag": true, "Address": "sample string 1", "Address2": "sample string 2", "AddressDisplay": "sample string 3", "AddressDisplayURL": "sample string 4", "AddressURL": "sample string 5", "AlarmFlag": true, "AlternateXmitFlag": true, "AuditFlag": true, "Authority": "sample string 6", "AuthorityDescription": "sample string 7", "BarcodePrinterFlag": true, "CallingSource": "sample string 8", "City": "sample string 9", "CrossStreet": "sample string 10", "CurrentTestFlag": true, "DeviceTestOnDataEntryFlag": true, "DevNum": 1, "Directions": "sample string 11", "DocumentFlag": true, "FieldDevice": "sample string 12", "FromAlarmDispatchFlag": "sample string 13", "FunctionOption": "sample string 14", "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" } ] } ] }, "IntegrationPlatform": "sample string 15", "Map": "sample string 16", "MapCoordinates": "sample string 17", "MapPage": "sample string 18", "MsgCtrAcctFlag": true, "MultiSiteFlag": true, "NavigatorFlag": true, "OOSCat": "sample string 19", "OOSCatDescription": "sample string 20", "OOSFlag": true, "Option": "sample string 21", "PendingFollowUpFlag": true, "Pets": "sample string 22", "PinVerificationMethod": "sample string 23", "PrimaryDevNum": 1, "Region": "sample string 24", "RegionDescription": "sample string 25", "RulesInEffectFlag": true, "SiteDispatchTypes": "sample string 26", "SiteGroupNum": 1, "SiteGroupSetupPermissionFlag": true, "SiteName": "sample string 27", "SiteNum": 1, "SiteStatus": "sample string 28", "SiteStatusDescription": "sample string 29", "SiteType": "sample string 30", "SiteTypeDescription": "sample string 31", "State": "sample string 32", "Status": "sample string 33", "StyleCode": "sample string 34", "SuppressAddressURLFlag": true, "TestStatus": "sample string 35", "TimeZoneDescription": "sample string 36", "TimeZoneNum": 1, "TitleXmit": "sample string 37", "TransmitterCode": "sample string 38", "ZipCode": "sample string 39", "SiteHasAlarmFlag": true } ], "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5" }
application/xml, text/xml
Sample:
<DataEntrySiteViewQueryResult 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> <DataEntrySiteViewResult> <AdditionalData3Flag>true</AdditionalData3Flag> <Address>sample string 1</Address> <Address2>sample string 2</Address2> <AddressDisplay>sample string 3</AddressDisplay> <AddressDisplayURL>sample string 4</AddressDisplayURL> <AddressURL>sample string 5</AddressURL> <AlarmFlag>true</AlarmFlag> <AlternateXmitFlag>true</AlternateXmitFlag> <AuditFlag>true</AuditFlag> <Authority>sample string 6</Authority> <AuthorityDescription>sample string 7</AuthorityDescription> <BarcodePrinterFlag>true</BarcodePrinterFlag> <CallingSource>sample string 8</CallingSource> <City>sample string 9</City> <CrossStreet>sample string 10</CrossStreet> <CurrentTestFlag>true</CurrentTestFlag> <DevNum>1</DevNum> <DeviceTestOnDataEntryFlag>true</DeviceTestOnDataEntryFlag> <Directions>sample string 11</Directions> <DocumentFlag>true</DocumentFlag> <FieldDevice>sample string 12</FieldDevice> <FromAlarmDispatchFlag>sample string 13</FromAlarmDispatchFlag> <FunctionOption>sample string 14</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> <IntegrationPlatform>sample string 15</IntegrationPlatform> <Map>sample string 16</Map> <MapCoordinates>sample string 17</MapCoordinates> <MapPage>sample string 18</MapPage> <MsgCtrAcctFlag>true</MsgCtrAcctFlag> <MultiSiteFlag>true</MultiSiteFlag> <NavigatorFlag>true</NavigatorFlag> <OOSCat>sample string 19</OOSCat> <OOSCatDescription>sample string 20</OOSCatDescription> <OOSFlag>true</OOSFlag> <Option>sample string 21</Option> <PendingFollowUpFlag>true</PendingFollowUpFlag> <Pets>sample string 22</Pets> <PinVerificationMethod>sample string 23</PinVerificationMethod> <PrimaryDevNum>1</PrimaryDevNum> <Region>sample string 24</Region> <RegionDescription>sample string 25</RegionDescription> <RulesInEffectFlag>true</RulesInEffectFlag> <SiteDispatchTypes>sample string 26</SiteDispatchTypes> <SiteGroupNum>1</SiteGroupNum> <SiteGroupSetupPermissionFlag>true</SiteGroupSetupPermissionFlag> <SiteHasAlarmFlag>true</SiteHasAlarmFlag> <SiteName>sample string 27</SiteName> <SiteNum>1</SiteNum> <SiteStatus>sample string 28</SiteStatus> <SiteStatusDescription>sample string 29</SiteStatusDescription> <SiteType>sample string 30</SiteType> <SiteTypeDescription>sample string 31</SiteTypeDescription> <State>sample string 32</State> <Status>sample string 33</Status> <StyleCode>sample string 34</StyleCode> <SuppressAddressURLFlag>true</SuppressAddressURLFlag> <TestStatus>sample string 35</TestStatus> <TimeZoneDescription>sample string 36</TimeZoneDescription> <TimeZoneNum>1</TimeZoneNum> <TitleXmit>sample string 37</TitleXmit> <TransmitterCode>sample string 38</TransmitterCode> <ZipCode>sample string 39</ZipCode> </DataEntrySiteViewResult> <DataEntrySiteViewResult> <AdditionalData3Flag>true</AdditionalData3Flag> <Address>sample string 1</Address> <Address2>sample string 2</Address2> <AddressDisplay>sample string 3</AddressDisplay> <AddressDisplayURL>sample string 4</AddressDisplayURL> <AddressURL>sample string 5</AddressURL> <AlarmFlag>true</AlarmFlag> <AlternateXmitFlag>true</AlternateXmitFlag> <AuditFlag>true</AuditFlag> <Authority>sample string 6</Authority> <AuthorityDescription>sample string 7</AuthorityDescription> <BarcodePrinterFlag>true</BarcodePrinterFlag> <CallingSource>sample string 8</CallingSource> <City>sample string 9</City> <CrossStreet>sample string 10</CrossStreet> <CurrentTestFlag>true</CurrentTestFlag> <DevNum>1</DevNum> <DeviceTestOnDataEntryFlag>true</DeviceTestOnDataEntryFlag> <Directions>sample string 11</Directions> <DocumentFlag>true</DocumentFlag> <FieldDevice>sample string 12</FieldDevice> <FromAlarmDispatchFlag>sample string 13</FromAlarmDispatchFlag> <FunctionOption>sample string 14</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> <IntegrationPlatform>sample string 15</IntegrationPlatform> <Map>sample string 16</Map> <MapCoordinates>sample string 17</MapCoordinates> <MapPage>sample string 18</MapPage> <MsgCtrAcctFlag>true</MsgCtrAcctFlag> <MultiSiteFlag>true</MultiSiteFlag> <NavigatorFlag>true</NavigatorFlag> <OOSCat>sample string 19</OOSCat> <OOSCatDescription>sample string 20</OOSCatDescription> <OOSFlag>true</OOSFlag> <Option>sample string 21</Option> <PendingFollowUpFlag>true</PendingFollowUpFlag> <Pets>sample string 22</Pets> <PinVerificationMethod>sample string 23</PinVerificationMethod> <PrimaryDevNum>1</PrimaryDevNum> <Region>sample string 24</Region> <RegionDescription>sample string 25</RegionDescription> <RulesInEffectFlag>true</RulesInEffectFlag> <SiteDispatchTypes>sample string 26</SiteDispatchTypes> <SiteGroupNum>1</SiteGroupNum> <SiteGroupSetupPermissionFlag>true</SiteGroupSetupPermissionFlag> <SiteHasAlarmFlag>true</SiteHasAlarmFlag> <SiteName>sample string 27</SiteName> <SiteNum>1</SiteNum> <SiteStatus>sample string 28</SiteStatus> <SiteStatusDescription>sample string 29</SiteStatusDescription> <SiteType>sample string 30</SiteType> <SiteTypeDescription>sample string 31</SiteTypeDescription> <State>sample string 32</State> <Status>sample string 33</Status> <StyleCode>sample string 34</StyleCode> <SuppressAddressURLFlag>true</SuppressAddressURLFlag> <TestStatus>sample string 35</TestStatus> <TimeZoneDescription>sample string 36</TimeZoneDescription> <TimeZoneNum>1</TimeZoneNum> <TitleXmit>sample string 37</TitleXmit> <TransmitterCode>sample string 38</TransmitterCode> <ZipCode>sample string 39</ZipCode> </DataEntrySiteViewResult> </ResultSet> </DataEntrySiteViewQueryResult>