GET api/usercode_IB2/usersWithProgress?UserName={UserName}&Password={Password}&Mac={Mac}&ICCID={ICCID}&IsIpPath={IsIpPath}&IsRadioPath={IsRadioPath}&RadioIP={RadioIP}&SessionId={SessionId}&Account={Account}

Request Information

URI Parameters

Name	Type	Additional information
UserName	string	None.
Password	string	None.
Mac	string	None.
ICCID	string	None.
IsIpPath	boolean	None.
IsRadioPath	boolean	None.
RadioIP	string	None.
SessionId	string	None.
Account	string	None.

Body Parameters

DeviceInfo

Name	Type	Additional information
Account	string	None.
RadioIP	string	None.
RadioPort	string	None.
RadioSerialNumber	string	None.
ICCID	string	None.
ManufacturerType	integer	None.
PanelType	string	None.
PanelCode	string	None.
Expected_Panel	string	None.
PCSecurityCode	string	None.
SocketServerHttpACMPath	string	None.
SocketServerHttpAI2Path	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Account": "sample string 1",
  "RadioIP": "sample string 2",
  "RadioPort": "sample string 3",
  "RadioSerialNumber": "sample string 4",
  "ICCID": "sample string 5",
  "ManufacturerType": 6,
  "PanelType": "sample string 7",
  "PanelCode": "sample string 8",
  "Expected_Panel": "sample string 9",
  "PCSecurityCode": "sample string 10",
  "SocketServerHttpACMPath": "sample string 11",
  "SocketServerHttpAI2Path": "sample string 12"
}

application/xml, text/xml

Sample:

<DeviceInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GeminiiSecureWebAPI.Model">
  <Account>sample string 1</Account>
  <Expected_Panel>sample string 9</Expected_Panel>
  <ICCID>sample string 5</ICCID>
  <ManufacturerType>6</ManufacturerType>
  <PCSecurityCode>sample string 10</PCSecurityCode>
  <PanelCode>sample string 8</PanelCode>
  <PanelType>sample string 7</PanelType>
  <RadioIP>sample string 2</RadioIP>
  <RadioPort>sample string 3</RadioPort>
  <RadioSerialNumber>sample string 4</RadioSerialNumber>
  <SocketServerHttpACMPath>sample string 11</SocketServerHttpACMPath>
  <SocketServerHttpAI2Path>sample string 12</SocketServerHttpAI2Path>
</DeviceInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UserCode_IB2ServerResponce

Name	Type	Additional information
UserCode	Collection of UserCode_IB2	None.
AmbushCode	string	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:

{
  "UserCode": [
    {
      "Account": "sample string 1",
      "PanelUserNo": 2,
      "Description": "sample string 3",
      "Type": 4,
      "Code": "sample string 5",
      "Level": "sample string 6",
      "Area": "sample string 7",
      "ACMArea": "sample string 8",
      "BV": "sample string 9",
      "UP": "sample string 10",
      "BE": "sample string 11",
      "OV": "sample string 12",
      "AL": "sample string 13",
      "Scheduled": 14
    },
    {
      "Account": "sample string 1",
      "PanelUserNo": 2,
      "Description": "sample string 3",
      "Type": 4,
      "Code": "sample string 5",
      "Level": "sample string 6",
      "Area": "sample string 7",
      "ACMArea": "sample string 8",
      "BV": "sample string 9",
      "UP": "sample string 10",
      "BE": "sample string 11",
      "OV": "sample string 12",
      "AL": "sample string 13",
      "Scheduled": 14
    }
  ],
  "AmbushCode": "sample string 1",
  "ResponseStatus": "sample string 2",
  "InitialConnectWithServer": "sample string 3",
  "ResponseBridgedWithRCM": "sample string 4",
  "ResponseCmdType": "sample string 5",
  "ResponseMessage": "sample string 6",
  "ResponseDebugMessage": "sample string 7",
  "ResponseErrorMessage": "sample string 8",
  "RetryCount": 9,
  "SocketServerTimeoutCount": 10,
  "ResponseACKIndex": "sample string 11",
  "PendingRCMResponseInQueue": "sample string 12",
  "D1Response": "sample string 13",
  "ResendCommand": "sample string 14",
  "ResponseText": "sample string 15",
  "WebSessionID": "sample string 16",
  "SourceID": "sample string 17",
  "Percent": 18
}

application/xml, text/xml

Sample:

<UserCode_IB2ServerResponce xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GeminiiSecureWebAPI.Model">
  <D1Response>sample string 13</D1Response>
  <InitialConnectWithServer>sample string 3</InitialConnectWithServer>
  <PendingRCMResponseInQueue>sample string 12</PendingRCMResponseInQueue>
  <Percent>18</Percent>
  <ResendCommand>sample string 14</ResendCommand>
  <ResponseACKIndex>sample string 11</ResponseACKIndex>
  <ResponseBridgedWithRCM>sample string 4</ResponseBridgedWithRCM>
  <ResponseCmdType>sample string 5</ResponseCmdType>
  <ResponseDebugMessage>sample string 7</ResponseDebugMessage>
  <ResponseErrorMessage>sample string 8</ResponseErrorMessage>
  <ResponseMessage>sample string 6</ResponseMessage>
  <ResponseStatus>sample string 2</ResponseStatus>
  <ResponseText>sample string 15</ResponseText>
  <RetryCount>9</RetryCount>
  <SocketServerTimeoutCount>10</SocketServerTimeoutCount>
  <SourceID>sample string 17</SourceID>
  <WebSessionID>sample string 16</WebSessionID>
  <AmbushCode>sample string 1</AmbushCode>
  <UserCode>
    <UserCode_IB2>
      <ACMArea>sample string 8</ACMArea>
      <AL>sample string 13</AL>
      <Account>sample string 1</Account>
      <Area>sample string 7</Area>
      <BE>sample string 11</BE>
      <BV>sample string 9</BV>
      <Code>sample string 5</Code>
      <Description>sample string 3</Description>
      <Level>sample string 6</Level>
      <OV>sample string 12</OV>
      <PanelUserNo>2</PanelUserNo>
      <Scheduled>14</Scheduled>
      <Type>4</Type>
      <UP>sample string 10</UP>
    </UserCode_IB2>
    <UserCode_IB2>
      <ACMArea>sample string 8</ACMArea>
      <AL>sample string 13</AL>
      <Account>sample string 1</Account>
      <Area>sample string 7</Area>
      <BE>sample string 11</BE>
      <BV>sample string 9</BV>
      <Code>sample string 5</Code>
      <Description>sample string 3</Description>
      <Level>sample string 6</Level>
      <OV>sample string 12</OV>
      <PanelUserNo>2</PanelUserNo>
      <Scheduled>14</Scheduled>
      <Type>4</Type>
      <UP>sample string 10</UP>
    </UserCode_IB2>
  </UserCode>
</UserCode_IB2ServerResponce>