SSHost

<back to all web services

AddGatewayOrMeterRequest

Requires Authentication
Required role:ApiUser
The following routes are available for this service:
All Verbs/Gateway/AddGatewayOrMeter
AddGatewayOrMeterRequest Parameters:
NameParameterData TypeRequiredDescription
OrgNamequerystringNo
AreaNamequerystringNo
GatewayTypequerystringNo
GatewayUIDquerylongNo
GatewayNamequerystringNo
PlanNamequerystringNo
Longitudequerydouble?No
Latitudequerydouble?No
SIMquerystringNo
AddMeterqueryboolNo
SectionNamequerystringNo
MeterAddress10querylongNo
MeterNamequerystringNo
ProtocolCodequerystringNo
CommunicationSpeedquerystringNo
SamplingPeriodquerystringNo
IMEIquerystringNo
IBaseRequest Parameters:
NameParameterData TypeRequiredDescription
CommandformstringNo
OptionsformRequestOptionsNo
RequestOptions Parameters:
NameParameterData TypeRequiredDescription
SendNoWaitformboolNo
RequestTimeoutformintNo
DebugformboolNo
AddGatewayOrMeterResponse Parameters:
NameParameterData TypeRequiredDescription
AddGatewayResultformboolNo
GatewayIdformlongNo
AddGatewayErrorMessageformstringNo
AddMeterResultformboolNo
MeterIdformlongNo
AddMeterErrorMessageformstringNo
IBaseResult Parameters:
NameParameterData TypeRequiredDescription
CommandformstringNo
StatusformstringNo
ErrorMessageformstringNo
ErrListformList<long>No
DeviceListformList<DeviceData>No
DeviceData Parameters:
NameParameterData TypeRequiredDescription
ActionNameformstringNo
DeviceNumberformstringNo
ActionResultformstringNo
ByteDataformbyte[]No
ByteResultformbyte[]No
ErrorMessageformstringNo
ConnectStatusformintNo
ByteDataHstrformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Gateway/AddGatewayOrMeter HTTP/1.1 
Host: 188.68.237.94 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddGatewayOrMeterRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LedServer.SS">
  <Command>String</Command>
  <Options>
    <Debug>false</Debug>
    <RequestTimeout>0</RequestTimeout>
    <SendNoWait>false</SendNoWait>
  </Options>
  <AddMeter>false</AddMeter>
  <AreaName>String</AreaName>
  <CommunicationSpeed>String</CommunicationSpeed>
  <GatewayName>String</GatewayName>
  <GatewayType>String</GatewayType>
  <GatewayUID>0</GatewayUID>
  <IMEI>String</IMEI>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
  <MeterAddress10>0</MeterAddress10>
  <MeterName>String</MeterName>
  <OrgName>String</OrgName>
  <PlanName>String</PlanName>
  <ProtocolCode>String</ProtocolCode>
  <SIM>String</SIM>
  <SamplingPeriod>String</SamplingPeriod>
  <SectionName>String</SectionName>
</AddGatewayOrMeterRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddGatewayOrMeterResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LedServer.SS">
  <Command>String</Command>
  <DeviceList xmlns:d2p1="http://schemas.datacontract.org/2004/07/LedServer.Models">
    <d2p1:DeviceData>
      <d2p1:ActionName>String</d2p1:ActionName>
      <d2p1:ActionResult>String</d2p1:ActionResult>
      <d2p1:ByteData>AA==</d2p1:ByteData>
      <d2p1:ByteResult>AA==</d2p1:ByteResult>
      <d2p1:ConnectStatus>0</d2p1:ConnectStatus>
      <d2p1:DeviceNumber>String</d2p1:DeviceNumber>
      <d2p1:ErrorMessage>String</d2p1:ErrorMessage>
    </d2p1:DeviceData>
  </DeviceList>
  <ErrList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </ErrList>
  <ErrorMessage>String</ErrorMessage>
  <Status>String</Status>
  <AddGatewayErrorMessage>String</AddGatewayErrorMessage>
  <AddGatewayResult>false</AddGatewayResult>
  <AddMeterErrorMessage>String</AddMeterErrorMessage>
  <AddMeterResult>false</AddMeterResult>
  <GatewayId>0</GatewayId>
  <MeterId>0</MeterId>
</AddGatewayOrMeterResponse>