POST api/iBridge/downloadZoneDescription

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
userInfo		UserInfo	None.
sensor		Sensor	None.

Request Formats

application/json, text/json

Sample:

{
  "userInfo": {
    "UserName": "sample string 1",
    "Password": "sample string 2",
    "Mac": "sample string 3",
    "ICCID": "sample string 4",
    "IsIpPath": true,
    "IsRadioPath": true,
    "RadioIP": "sample string 7",
    "SessionId": "sample string 8",
    "Account": "sample string 9"
  },
  "sensor": {
    "Account": "sample string 1",
    "ZoneId": 2,
    "ZoneNumber": "sample string 3",
    "Description1": "sample string 4",
    "Description2": "sample string 5",
    "DeviceId": 6
  }
}

application/xml, text/xml

Sample:

<UserInfoSensorDownload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GeminiiSecureWebAPI.Model">
  <sensor>
    <Account>sample string 1</Account>
    <Description1>sample string 4</Description1>
    <Description2>sample string 5</Description2>
    <DeviceId>6</DeviceId>
    <ZoneId>2</ZoneId>
    <ZoneNumber>sample string 3</ZoneNumber>
  </sensor>
  <userInfo>
    <Account>sample string 9</Account>
    <ICCID>sample string 4</ICCID>
    <IsIpPath>true</IsIpPath>
    <IsRadioPath>true</IsRadioPath>
    <Mac>sample string 3</Mac>
    <Password>sample string 2</Password>
    <RadioIP>sample string 7</RadioIP>
    <SessionId>sample string 8</SessionId>
    <UserName>sample string 1</UserName>
  </userInfo>
</UserInfoSensorDownload>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PanelZoneServerResponce

Name	Type	Additional information
Zones	Collection of PanelZone	None.
ResponseStatus	string	None.
InitialConnectWithServer	string	None.
ResponseBridgedWithRCM	string	None.
ResponseCmdType	string	None.
ResponseMessage	string	None.
ResponseDebugMessage	string	None.
ResponseErrorMessage	string	None.
RetryCount	integer	None.
SocketServerTimeoutCount	integer	None.
ResponseACKIndex	string	None.
PendingRCMResponseInQueue	string	None.
D1Response	string	None.
ResendCommand	string	None.
ResponseText	string	None.
WebSessionID	string	None.
SourceID	string	None.
Percent	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Zones": [
    {
      "Account": "sample string 1",
      "ZoneID": "sample string 2",
      "ZoneNumber": "sample string 3",
      "ZoneDescription": "sample string 4",
      "ZoneArea": "sample string 5",
      "isSelectiveBypass": true
    },
    {
      "Account": "sample string 1",
      "ZoneID": "sample string 2",
      "ZoneNumber": "sample string 3",
      "ZoneDescription": "sample string 4",
      "ZoneArea": "sample string 5",
      "isSelectiveBypass": true
    }
  ],
  "ResponseStatus": "sample string 1",
  "InitialConnectWithServer": "sample string 2",
  "ResponseBridgedWithRCM": "sample string 3",
  "ResponseCmdType": "sample string 4",
  "ResponseMessage": "sample string 5",
  "ResponseDebugMessage": "sample string 6",
  "ResponseErrorMessage": "sample string 7",
  "RetryCount": 8,
  "SocketServerTimeoutCount": 9,
  "ResponseACKIndex": "sample string 10",
  "PendingRCMResponseInQueue": "sample string 11",
  "D1Response": "sample string 12",
  "ResendCommand": "sample string 13",
  "ResponseText": "sample string 14",
  "WebSessionID": "sample string 15",
  "SourceID": "sample string 16",
  "Percent": 17
}

application/xml, text/xml

Sample:

<PanelZoneServerResponce xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GeminiiSecureWebAPI.Model">
  <D1Response>sample string 12</D1Response>
  <InitialConnectWithServer>sample string 2</InitialConnectWithServer>
  <PendingRCMResponseInQueue>sample string 11</PendingRCMResponseInQueue>
  <Percent>17</Percent>
  <ResendCommand>sample string 13</ResendCommand>
  <ResponseACKIndex>sample string 10</ResponseACKIndex>
  <ResponseBridgedWithRCM>sample string 3</ResponseBridgedWithRCM>
  <ResponseCmdType>sample string 4</ResponseCmdType>
  <ResponseDebugMessage>sample string 6</ResponseDebugMessage>
  <ResponseErrorMessage>sample string 7</ResponseErrorMessage>
  <ResponseMessage>sample string 5</ResponseMessage>
  <ResponseStatus>sample string 1</ResponseStatus>
  <ResponseText>sample string 14</ResponseText>
  <RetryCount>8</RetryCount>
  <SocketServerTimeoutCount>9</SocketServerTimeoutCount>
  <SourceID>sample string 16</SourceID>
  <WebSessionID>sample string 15</WebSessionID>
  <Zones>
    <PanelZone>
      <Account>sample string 1</Account>
      <ZoneArea>sample string 5</ZoneArea>
      <ZoneDescription>sample string 4</ZoneDescription>
      <ZoneID>sample string 2</ZoneID>
      <ZoneNumber>sample string 3</ZoneNumber>
      <isSelectiveBypass>true</isSelectiveBypass>
    </PanelZone>
    <PanelZone>
      <Account>sample string 1</Account>
      <ZoneArea>sample string 5</ZoneArea>
      <ZoneDescription>sample string 4</ZoneDescription>
      <ZoneID>sample string 2</ZoneID>
      <ZoneNumber>sample string 3</ZoneNumber>
      <isSelectiveBypass>true</isSelectiveBypass>
    </PanelZone>
  </Zones>
</PanelZoneServerResponce>