Reference for https://pcmiler.alk.com/APIs/REST/v1.0/Service.svc/GeofenceSets/{SETID}?name={SETNAME}&tag={SETTAG}&includeFences={INCLUDEFENCES}
Url: https://pcmiler.alk.com/APIs/REST/v1.0/Service.svc/GeofenceSets/{SETID}?name={SETNAME}&tag={SETTAG}&includeFences={INCLUDEFENCES}
HTTP Method: GET
| 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:
<ArrayOfGeofenceSet xmlns="http://pcmiler.alk.com/APIs/v1.0">
<GeofenceSet>
<ActiveState>Off</ActiveState>
<BorderAlpha>255</BorderAlpha>
<BorderColor>2147483647</BorderColor>
<BorderWidth>255</BorderWidth>
<EndTime>String content</EndTime>
<FillAlpha>255</FillAlpha>
<FillColor>2147483647</FillColor>
<Name>String content</Name>
<StartTime>String content</StartTime>
<Tag>String content</Tag>
<Visible>true</Visible>
<Deleted>true</Deleted>
<Fences>
<Geofence>
<EndTime>String content</EndTime>
<Label>String content</Label>
<Name>String content</Name>
<Radius>1.26743233E+15</Radius>
<SetId>2147483647</SetId>
<ShapePoints>
<ArrayOfdouble xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<double>1.26743233E+15</double>
<double>1.26743233E+15</double>
</ArrayOfdouble>
<ArrayOfdouble xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<double>1.26743233E+15</double>
<double>1.26743233E+15</double>
</ArrayOfdouble>
</ShapePoints>
<ShapeType>Circle</ShapeType>
<StartTime>String content</StartTime>
<Id>2147483647</Id>
</Geofence>
<Geofence>
<EndTime>String content</EndTime>
<Label>String content</Label>
<Name>String content</Name>
<Radius>1.26743233E+15</Radius>
<SetId>2147483647</SetId>
<ShapePoints>
<ArrayOfdouble xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<double>1.26743233E+15</double>
<double>1.26743233E+15</double>
</ArrayOfdouble>
<ArrayOfdouble xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<double>1.26743233E+15</double>
<double>1.26743233E+15</double>
</ArrayOfdouble>
</ShapePoints>
<ShapeType>Circle</ShapeType>
<StartTime>String content</StartTime>
<Id>2147483647</Id>
</Geofence>
</Fences>
<Id>2147483647</Id>
</GeofenceSet>
<GeofenceSet>
<ActiveState>Off</ActiveState>
<BorderAlpha>255</BorderAlpha>
<BorderColor>2147483647</BorderColor>
<BorderWidth>255</BorderWidth>
<EndTime>String content</EndTime>
<FillAlpha>255</FillAlpha>
<FillColor>2147483647</FillColor>
<Name>String content</Name>
<StartTime>String content</StartTime>
<Tag>String content</Tag>
<Visible>true</Visible>
<Deleted>true</Deleted>
<Fences>
<Geofence>
<EndTime>String content</EndTime>
<Label>String content</Label>
<Name>String content</Name>
<Radius>1.26743233E+15</Radius>
<SetId>2147483647</SetId>
<ShapePoints>
<ArrayOfdouble xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<double>1.26743233E+15</double>
<double>1.26743233E+15</double>
</ArrayOfdouble>
<ArrayOfdouble xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<double>1.26743233E+15</double>
<double>1.26743233E+15</double>
</ArrayOfdouble>
</ShapePoints>
<ShapeType>Circle</ShapeType>
<StartTime>String content</StartTime>
<Id>2147483647</Id>
</Geofence>
<Geofence>
<EndTime>String content</EndTime>
<Label>String content</Label>
<Name>String content</Name>
<Radius>1.26743233E+15</Radius>
<SetId>2147483647</SetId>
<ShapePoints>
<ArrayOfdouble xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<double>1.26743233E+15</double>
<double>1.26743233E+15</double>
</ArrayOfdouble>
<ArrayOfdouble xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<double>1.26743233E+15</double>
<double>1.26743233E+15</double>
</ArrayOfdouble>
</ShapePoints>
<ShapeType>Circle</ShapeType>
<StartTime>String content</StartTime>
<Id>2147483647</Id>
</Geofence>
</Fences>
<Id>2147483647</Id>
</GeofenceSet>
</ArrayOfGeofenceSet>
The following is an example response Json body:
[{
"ActiveState":0,
"BorderAlpha":255,
"BorderColor":2147483647,
"BorderWidth":255,
"EndTime":"String content",
"FillAlpha":255,
"FillColor":2147483647,
"Name":"String content",
"StartTime":"String content",
"Tag":"String content",
"Visible":true,
"Deleted":true,
"Fences":[{
"EndTime":"String content",
"Label":"String content",
"Name":"String content",
"Radius":1.26743233E+15,
"SetId":2147483647,
"ShapePoints":[[1.26743233E+15]],
"ShapeType":0,
"StartTime":"String content",
"Id":2147483647
}],
"Id":2147483647
}]
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://pcmiler.alk.com/APIs/v1.0" elementFormDefault="qualified" targetNamespace="http://pcmiler.alk.com/APIs/v1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
<xs:complexType name="ArrayOfGeofenceSet">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="GeofenceSet" nillable="true" type="tns:GeofenceSet" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfGeofenceSet" nillable="true" type="tns:ArrayOfGeofenceSet" />
<xs:complexType name="GeofenceSet">
<xs:complexContent mixed="false">
<xs:extension base="tns:AddGeofenceSet">
<xs:sequence>
<xs:element minOccurs="0" name="Deleted" type="xs:boolean" />
<xs:element minOccurs="0" name="Fences" nillable="true" type="tns:ArrayOfGeofence" />
<xs:element minOccurs="0" name="Id" type="xs:int" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="GeofenceSet" nillable="true" type="tns:GeofenceSet" />
<xs:complexType name="AddGeofenceSet">
<xs:sequence>
<xs:element minOccurs="0" name="ActiveState" nillable="true" type="tns:GeofenceState" />
<xs:element minOccurs="0" name="BorderAlpha" nillable="true" type="xs:unsignedByte" />
<xs:element minOccurs="0" name="BorderColor" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="BorderWidth" nillable="true" type="xs:unsignedByte" />
<xs:element minOccurs="0" name="EndTime" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="FillAlpha" nillable="true" type="xs:unsignedByte" />
<xs:element minOccurs="0" name="FillColor" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="StartTime" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Tag" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Visible" nillable="true" type="xs:boolean" />
</xs:sequence>
</xs:complexType>
<xs:element name="AddGeofenceSet" nillable="true" type="tns:AddGeofenceSet" />
<xs:simpleType name="GeofenceState">
<xs:annotation>
<xs:appinfo>
<ActualType Name="unsignedByte" Namespace="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="Off" />
<xs:enumeration value="Warn" />
<xs:enumeration value="Avoid" />
</xs:restriction>
</xs:simpleType>
<xs:element name="GeofenceState" nillable="true" type="tns:GeofenceState" />
<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:AddGeofence">
<xs:sequence>
<xs:element minOccurs="0" name="Id" type="xs:int" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="Geofence" nillable="true" type="tns:Geofence" />
<xs:complexType name="AddGeofence">
<xs:sequence>
<xs:element minOccurs="0" name="EndTime" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Label" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Radius" type="xs:double" />
<xs:element minOccurs="0" name="SetId" type="xs:int" />
<xs:element minOccurs="0" name="ShapePoints" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfArrayOfdouble" />
<xs:element minOccurs="0" name="ShapeType" type="tns:GeofenceShape" />
<xs:element minOccurs="0" name="StartTime" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="AddGeofence" nillable="true" type="tns:AddGeofence" />
<xs:simpleType name="GeofenceShape">
<xs:annotation>
<xs:appinfo>
<ActualType Name="unsignedByte" Namespace="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
<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="Polygon">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">5</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:element name="GeofenceShape" nillable="true" type="tns:GeofenceShape" />
</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>
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/Arrays" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="ArrayOfArrayOfdouble">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="ArrayOfdouble" nillable="true" type="tns:ArrayOfdouble" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfArrayOfdouble" nillable="true" type="tns:ArrayOfArrayOfdouble" />
<xs:complexType name="ArrayOfdouble">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="double" type="xs:double" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfdouble" nillable="true" type="tns:ArrayOfdouble" />
</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>