Reference for https://services.sensorbis.cloud/V0100/Service.svc/rest/GetFederation
Url: https://services.sensorbis.cloud/V0100/Service.svc/rest/GetFederation
HTTP Method: POST
| Message direction | Format | Body |
|---|---|---|
| Request | N/A | The Request body is empty. |
| Response | Xml | Example,Schema |
| Response | Json | Example |
The following is an example response Xml body:
<GetFederationResponse xmlns="http://schemas.datacontract.org/2004/07/SensorbisCloud.BackEnd.ServiceV0100">
<error>2147483647</error>
<federation>
<descr>String content</descr>
<devices>
<GetFederationResponseDevice>
<authorization>String content</authorization>
<customerId>String content</customerId>
<descr>String content</descr>
<id>String content</id>
<lat>1.26743233E+15</lat>
<lon>1.26743233E+15</lon>
<name>String content</name>
<notificationUri>String content</notificationUri>
<notificationsMinInterval>2147483647</notificationsMinInterval>
<sensors>
<GetFederationResponseSensor>
<channels>
<GetFederationResponseChannel>
<communicationId>String content</communicationId>
<enumerated>true</enumerated>
<grouping>97</grouping>
<id>String content</id>
<max>1.26743233E+15</max>
<min>1.26743233E+15</min>
<name>String content</name>
<purpose>String content</purpose>
<thresholdOperator1>String content</thresholdOperator1>
<thresholdOperator2>String content</thresholdOperator2>
<thresholdValue1>1.26743233E+15</thresholdValue1>
<thresholdValue2>1.26743233E+15</thresholdValue2>
<unit>String content</unit>
</GetFederationResponseChannel>
<GetFederationResponseChannel>
<communicationId>String content</communicationId>
<enumerated>true</enumerated>
<grouping>97</grouping>
<id>String content</id>
<max>1.26743233E+15</max>
<min>1.26743233E+15</min>
<name>String content</name>
<purpose>String content</purpose>
<thresholdOperator1>String content</thresholdOperator1>
<thresholdOperator2>String content</thresholdOperator2>
<thresholdValue1>1.26743233E+15</thresholdValue1>
<thresholdValue2>1.26743233E+15</thresholdValue2>
<unit>String content</unit>
</GetFederationResponseChannel>
</channels>
<customerId>String content</customerId>
<descr>String content</descr>
<id>String content</id>
<name>String content</name>
</GetFederationResponseSensor>
<GetFederationResponseSensor>
<channels>
<GetFederationResponseChannel>
<communicationId>String content</communicationId>
<enumerated>true</enumerated>
<grouping>97</grouping>
<id>String content</id>
<max>1.26743233E+15</max>
<min>1.26743233E+15</min>
<name>String content</name>
<purpose>String content</purpose>
<thresholdOperator1>String content</thresholdOperator1>
<thresholdOperator2>String content</thresholdOperator2>
<thresholdValue1>1.26743233E+15</thresholdValue1>
<thresholdValue2>1.26743233E+15</thresholdValue2>
<unit>String content</unit>
</GetFederationResponseChannel>
<GetFederationResponseChannel>
<communicationId>String content</communicationId>
<enumerated>true</enumerated>
<grouping>97</grouping>
<id>String content</id>
<max>1.26743233E+15</max>
<min>1.26743233E+15</min>
<name>String content</name>
<purpose>String content</purpose>
<thresholdOperator1>String content</thresholdOperator1>
<thresholdOperator2>String content</thresholdOperator2>
<thresholdValue1>1.26743233E+15</thresholdValue1>
<thresholdValue2>1.26743233E+15</thresholdValue2>
<unit>String content</unit>
</GetFederationResponseChannel>
</channels>
<customerId>String content</customerId>
<descr>String content</descr>
<id>String content</id>
<name>String content</name>
</GetFederationResponseSensor>
</sensors>
<timeZone>2147483647</timeZone>
<token>String content</token>
<uri>String content</uri>
<usesDst>true</usesDst>
<vendorId>String content</vendorId>
</GetFederationResponseDevice>
<GetFederationResponseDevice>
<authorization>String content</authorization>
<customerId>String content</customerId>
<descr>String content</descr>
<id>String content</id>
<lat>1.26743233E+15</lat>
<lon>1.26743233E+15</lon>
<name>String content</name>
<notificationUri>String content</notificationUri>
<notificationsMinInterval>2147483647</notificationsMinInterval>
<sensors>
<GetFederationResponseSensor>
<channels>
<GetFederationResponseChannel>
<communicationId>String content</communicationId>
<enumerated>true</enumerated>
<grouping>97</grouping>
<id>String content</id>
<max>1.26743233E+15</max>
<min>1.26743233E+15</min>
<name>String content</name>
<purpose>String content</purpose>
<thresholdOperator1>String content</thresholdOperator1>
<thresholdOperator2>String content</thresholdOperator2>
<thresholdValue1>1.26743233E+15</thresholdValue1>
<thresholdValue2>1.26743233E+15</thresholdValue2>
<unit>String content</unit>
</GetFederationResponseChannel>
<GetFederationResponseChannel>
<communicationId>String content</communicationId>
<enumerated>true</enumerated>
<grouping>97</grouping>
<id>String content</id>
<max>1.26743233E+15</max>
<min>1.26743233E+15</min>
<name>String content</name>
<purpose>String content</purpose>
<thresholdOperator1>String content</thresholdOperator1>
<thresholdOperator2>String content</thresholdOperator2>
<thresholdValue1>1.26743233E+15</thresholdValue1>
<thresholdValue2>1.26743233E+15</thresholdValue2>
<unit>String content</unit>
</GetFederationResponseChannel>
</channels>
<customerId>String content</customerId>
<descr>String content</descr>
<id>String content</id>
<name>String content</name>
</GetFederationResponseSensor>
<GetFederationResponseSensor>
<channels>
<GetFederationResponseChannel>
<communicationId>String content</communicationId>
<enumerated>true</enumerated>
<grouping>97</grouping>
<id>String content</id>
<max>1.26743233E+15</max>
<min>1.26743233E+15</min>
<name>String content</name>
<purpose>String content</purpose>
<thresholdOperator1>String content</thresholdOperator1>
<thresholdOperator2>String content</thresholdOperator2>
<thresholdValue1>1.26743233E+15</thresholdValue1>
<thresholdValue2>1.26743233E+15</thresholdValue2>
<unit>String content</unit>
</GetFederationResponseChannel>
<GetFederationResponseChannel>
<communicationId>String content</communicationId>
<enumerated>true</enumerated>
<grouping>97</grouping>
<id>String content</id>
<max>1.26743233E+15</max>
<min>1.26743233E+15</min>
<name>String content</name>
<purpose>String content</purpose>
<thresholdOperator1>String content</thresholdOperator1>
<thresholdOperator2>String content</thresholdOperator2>
<thresholdValue1>1.26743233E+15</thresholdValue1>
<thresholdValue2>1.26743233E+15</thresholdValue2>
<unit>String content</unit>
</GetFederationResponseChannel>
</channels>
<customerId>String content</customerId>
<descr>String content</descr>
<id>String content</id>
<name>String content</name>
</GetFederationResponseSensor>
</sensors>
<timeZone>2147483647</timeZone>
<token>String content</token>
<uri>String content</uri>
<usesDst>true</usesDst>
<vendorId>String content</vendorId>
</GetFederationResponseDevice>
</devices>
<id>String content</id>
<name>String content</name>
<protocol>String content</protocol>
</federation>
</GetFederationResponse>
The following is an example response Json body:
{
"error":2147483647,
"federation":{
"descr":"String content",
"devices":[{
"authorization":"String content",
"customerId":"String content",
"descr":"String content",
"id":"String content",
"lat":1.26743233E+15,
"lon":1.26743233E+15,
"name":"String content",
"notificationUri":"String content",
"notificationsMinInterval":2147483647,
"sensors":[{
"channels":[{
"communicationId":"String content",
"enumerated":true,
"grouping":"a",
"id":"String content",
"max":1.26743233E+15,
"min":1.26743233E+15,
"name":"String content",
"purpose":"String content",
"thresholdOperator1":"String content",
"thresholdOperator2":"String content",
"thresholdValue1":1.26743233E+15,
"thresholdValue2":1.26743233E+15,
"unit":"String content"
}],
"customerId":"String content",
"descr":"String content",
"id":"String content",
"name":"String content"
}],
"timeZone":2147483647,
"token":"String content",
"uri":"String content",
"usesDst":true,
"vendorId":"String content"
}],
"id":"String content",
"name":"String content",
"protocol":"String content"
}
}
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/SensorbisCloud.BackEnd.ServiceV0100" xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/SensorbisCloud.BackEnd.ServiceV0100" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
<xs:complexType name="GetFederationResponse">
<xs:complexContent mixed="false">
<xs:extension base="tns:ContractResponse">
<xs:sequence>
<xs:element minOccurs="0" name="federation" nillable="true" type="tns:GetFederationResponseFederation" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="GetFederationResponse" nillable="true" type="tns:GetFederationResponse" />
<xs:complexType name="ContractResponse">
<xs:sequence>
<xs:element minOccurs="0" name="error" type="xs:int">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="ContractResponse" nillable="true" type="tns:ContractResponse" />
<xs:complexType name="GetFederationResponseFederation">
<xs:sequence>
<xs:element minOccurs="0" name="descr" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="devices" nillable="true" type="tns:ArrayOfGetFederationResponseDevice" />
<xs:element name="id" nillable="true" type="xs:string" />
<xs:element name="name" nillable="true" type="xs:string" />
<xs:element name="protocol" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="GetFederationResponseFederation" nillable="true" type="tns:GetFederationResponseFederation" />
<xs:complexType name="ArrayOfGetFederationResponseDevice">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="GetFederationResponseDevice" nillable="true" type="tns:GetFederationResponseDevice" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfGetFederationResponseDevice" nillable="true" type="tns:ArrayOfGetFederationResponseDevice" />
<xs:complexType name="GetFederationResponseDevice">
<xs:sequence>
<xs:element name="authorization" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="customerId" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="descr" nillable="true" type="xs:string" />
<xs:element name="id" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="lat" nillable="true" type="xs:double" />
<xs:element minOccurs="0" name="lon" nillable="true" type="xs:double" />
<xs:element name="name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="notificationUri" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="notificationsMinInterval" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="sensors" nillable="true" type="tns:ArrayOfGetFederationResponseSensor" />
<xs:element minOccurs="0" name="timeZone" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="token" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="uri" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="usesDst" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="vendorId" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="GetFederationResponseDevice" nillable="true" type="tns:GetFederationResponseDevice" />
<xs:complexType name="ArrayOfGetFederationResponseSensor">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="GetFederationResponseSensor" nillable="true" type="tns:GetFederationResponseSensor" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfGetFederationResponseSensor" nillable="true" type="tns:ArrayOfGetFederationResponseSensor" />
<xs:complexType name="GetFederationResponseSensor">
<xs:sequence>
<xs:element minOccurs="0" name="channels" nillable="true" type="tns:ArrayOfGetFederationResponseChannel" />
<xs:element minOccurs="0" name="customerId" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="descr" nillable="true" type="xs:string" />
<xs:element name="id" nillable="true" type="xs:string" />
<xs:element name="name" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="GetFederationResponseSensor" nillable="true" type="tns:GetFederationResponseSensor" />
<xs:complexType name="ArrayOfGetFederationResponseChannel">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="GetFederationResponseChannel" nillable="true" type="tns:GetFederationResponseChannel" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfGetFederationResponseChannel" nillable="true" type="tns:ArrayOfGetFederationResponseChannel" />
<xs:complexType name="GetFederationResponseChannel">
<xs:sequence>
<xs:element name="communicationId" nillable="true" type="xs:string" />
<xs:element name="enumerated" type="xs:boolean" />
<xs:element name="grouping" type="ser:char" />
<xs:element name="id" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="max" nillable="true" type="xs:double" />
<xs:element minOccurs="0" name="min" nillable="true" type="xs:double" />
<xs:element name="name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="purpose" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="thresholdOperator1" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="thresholdOperator2" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="thresholdValue1" nillable="true" type="xs:double" />
<xs:element minOccurs="0" name="thresholdValue2" nillable="true" type="xs:double" />
<xs:element minOccurs="0" name="unit" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="GetFederationResponseChannel" nillable="true" type="tns:GetFederationResponseChannel" />
</xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>