Reference for https://api.silentpassenger.com/rest/v2/{APIKEY}/GeoFences
Add a list of GeoFences to mobile group's GeoFences. GeoFence object array must be passed in the message body.
Url: https://api.silentpassenger.com/rest/v2/{APIKEY}/GeoFences
HTTP Method: POST
| Message direction | Format | Body |
|---|---|---|
| Request | Xml | Example,Schema |
| Request | Json | Example |
| Response | Xml | Example |
| Response | Json | Example |
The following is an example request Xml body:
<ArrayOfGeoFence xmlns="http://schemas.datacontract.org/2004/07/VTS.Business">
<GeoFence>
<Active>true</Active>
<Area>1.26743233E+15</Area>
<Category>
<ID>2147483647</ID>
<Name>String content</Name>
<Notes>String content</Notes>
</Category>
<DateCreated>1999-05-31T11:20:00</DateCreated>
<ID>2147483647</ID>
<Length>1.26743233E+15</Length>
<Name>String content</Name>
<Notes>String content</Notes>
<Points>
<GeoFencePoint>
<GeoFenceID>2147483647</GeoFenceID>
<ID>2147483647</ID>
<Latitude>1.26743233E+15</Latitude>
<Longitude>1.26743233E+15</Longitude>
<Position>2147483647</Position>
</GeoFencePoint>
<GeoFencePoint>
<GeoFenceID>2147483647</GeoFenceID>
<ID>2147483647</ID>
<Latitude>1.26743233E+15</Latitude>
<Longitude>1.26743233E+15</Longitude>
<Position>2147483647</Position>
</GeoFencePoint>
</Points>
<Radius>2147483647</Radius>
<Shape>Circle</Shape>
<SubGroupID>2147483647</SubGroupID>
</GeoFence>
<GeoFence>
<Active>true</Active>
<Area>1.26743233E+15</Area>
<Category>
<ID>2147483647</ID>
<Name>String content</Name>
<Notes>String content</Notes>
</Category>
<DateCreated>1999-05-31T11:20:00</DateCreated>
<ID>2147483647</ID>
<Length>1.26743233E+15</Length>
<Name>String content</Name>
<Notes>String content</Notes>
<Points>
<GeoFencePoint>
<GeoFenceID>2147483647</GeoFenceID>
<ID>2147483647</ID>
<Latitude>1.26743233E+15</Latitude>
<Longitude>1.26743233E+15</Longitude>
<Position>2147483647</Position>
</GeoFencePoint>
<GeoFencePoint>
<GeoFenceID>2147483647</GeoFenceID>
<ID>2147483647</ID>
<Latitude>1.26743233E+15</Latitude>
<Longitude>1.26743233E+15</Longitude>
<Position>2147483647</Position>
</GeoFencePoint>
</Points>
<Radius>2147483647</Radius>
<Shape>Circle</Shape>
<SubGroupID>2147483647</SubGroupID>
</GeoFence>
</ArrayOfGeoFence>
The following is an example request Json body:
[{
"Active":true,
"Area":1.26743233E+15,
"Category":{
"ID":2147483647,
"Name":"String content",
"Notes":"String content"
},
"DateCreated":"\/Date(928164000000-0400)\/",
"ID":2147483647,
"Length":1.26743233E+15,
"Name":"String content",
"Notes":"String content",
"Points":[{
"GeoFenceID":2147483647,
"ID":2147483647,
"Latitude":1.26743233E+15,
"Longitude":1.26743233E+15,
"Position":2147483647
}],
"Radius":2147483647,
"Shape":0,
"SubGroupID":2147483647
}]
The following is an example response Xml body:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>
The following is an example response Json body:
true
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/VTS.Business" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VTS.Business" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
<xs:complexType name="ArrayOfGeoFence">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="GeoFence" nillable="true" type="tns:GeoFence" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfGeoFence" nillable="true" type="tns:ArrayOfGeoFence" />
<xs:complexType name="GeoFence">
<xs:complexContent mixed="false">
<xs:extension base="tns:BaseMappableItemOfGeoFenceGzr685TD">
<xs:sequence>
<xs:element minOccurs="0" name="Active" type="xs:boolean" />
<xs:element minOccurs="0" name="Area" type="xs:double" />
<xs:element minOccurs="0" name="Category" nillable="true" type="tns:GeoFenceCategory" />
<xs:element minOccurs="0" name="DateCreated" type="xs:dateTime" />
<xs:element minOccurs="0" name="ID" type="xs:int" />
<xs:element minOccurs="0" name="Length" type="xs:double" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Notes" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Points" nillable="true" type="tns:ArrayOfGeoFencePoint" />
<xs:element minOccurs="0" name="Radius" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="Shape" type="tns:GeoFenceShape" />
<xs:element minOccurs="0" name="SubGroupID" nillable="true" type="xs:int" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="GeoFence" nillable="true" type="tns:GeoFence" />
<xs:complexType name="BaseMappableItemOfGeoFenceGzr685TD">
<xs:annotation>
<xs:appinfo>
<GenericType Name="BaseMappableItemOf{0}{#}" Namespace="http://schemas.datacontract.org/2004/07/VTS.Business" xmlns="http://schemas.microsoft.com/2003/10/Serialization/">
<GenericParameter Name="GeoFence" Namespace="http://schemas.datacontract.org/2004/07/VTS.Business" />
</GenericType>
</xs:appinfo>
</xs:annotation>
<xs:sequence />
</xs:complexType>
<xs:element name="BaseMappableItemOfGeoFenceGzr685TD" nillable="true" type="tns:BaseMappableItemOfGeoFenceGzr685TD" />
<xs:complexType name="GeoFenceCategory">
<xs:sequence>
<xs:element minOccurs="0" name="ID" type="xs:int" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Notes" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="GeoFenceCategory" nillable="true" type="tns:GeoFenceCategory" />
<xs:complexType name="ArrayOfGeoFencePoint">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="GeoFencePoint" nillable="true" type="tns:GeoFencePoint" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfGeoFencePoint" nillable="true" type="tns:ArrayOfGeoFencePoint" />
<xs:complexType name="GeoFencePoint">
<xs:sequence>
<xs:element minOccurs="0" name="GeoFenceID" type="xs:int" />
<xs:element minOccurs="0" name="ID" type="xs:int" />
<xs:element minOccurs="0" name="Latitude" type="xs:double" />
<xs:element minOccurs="0" name="Longitude" type="xs:double" />
<xs:element minOccurs="0" name="Position" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="GeoFencePoint" nillable="true" type="tns:GeoFencePoint" />
<xs:simpleType name="GeoFenceShape">
<xs:restriction base="xs:string">
<xs:enumeration value="Circle">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Rectangle">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Polygon">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">3</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Line">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:element name="GeoFenceShape" nillable="true" type="tns:GeoFenceShape" />
</xs:schema>
Additional request 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>