Reference for https://pcmiler.alk.com/APIs/REST/v1.0/Service.svc/AvoidFavorSets/import?dataset={DATASET}
Url: https://pcmiler.alk.com/APIs/REST/v1.0/Service.svc/AvoidFavorSets/import?dataset={DATASET}
HTTP Method: POST
Message direction | Format | Body |
---|---|---|
Request | Xml | Example,Schema |
Request | Json | Example |
Response | Xml | Example,Schema |
Response | Json | Example |
The following is an example request Xml body:
<ImportAFSetRequestBody xmlns="http://pcmiler.alk.com/APIs/v1.0"> <SetName>String content</SetName> <SetTag>String content</SetTag> <IncludeContents>true</IncludeContents> <SetID>2147483647</SetID> <FileBytes>QmFzZSA2NCBTdHJlYW0=</FileBytes> <Replace>true</Replace> </ImportAFSetRequestBody>
The following is an example request Json body:
{ "SetName":"String content", "SetTag":"String content", "IncludeContents":true, "SetID":2147483647, "FileBytes":[81, 109, 70, 122, 90, 83, 65, 50, 78, 67, 66, 84, 100, 72, 74, 108, 89, 87, 48, 61], "Replace":true }
The following is an example response Xml body:
<ImportAFSetResponseBody xmlns="http://pcmiler.alk.com/APIs/v1.0"> <SetID>2147483647</SetID> </ImportAFSetResponseBody>
The following is an example response Json body:
{ "SetID":2147483647 }
The following is the request 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="ImportAFSetRequestBody"> <xs:complexContent mixed="false"> <xs:extension base="tns:CustomDataSetRequestBody"> <xs:sequence> <xs:element minOccurs="0" name="FileBytes" nillable="true" type="xs:base64Binary" /> <xs:element minOccurs="0" name="Replace" type="xs:boolean" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="ImportAFSetRequestBody" nillable="true" type="tns:ImportAFSetRequestBody" /> <xs:complexType name="CustomDataSetRequestBody"> <xs:complexContent mixed="false"> <xs:extension base="tns:AddCustomDataSetRequestBody"> <xs:sequence> <xs:element minOccurs="0" name="IncludeContents" nillable="true" type="xs:boolean" /> <xs:element minOccurs="0" name="SetID" nillable="true" type="xs:int" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="CustomDataSetRequestBody" nillable="true" type="tns:CustomDataSetRequestBody" /> <xs:complexType name="AddCustomDataSetRequestBody"> <xs:sequence> <xs:element minOccurs="0" name="SetName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="SetTag" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="AddCustomDataSetRequestBody" nillable="true" type="tns:AddCustomDataSetRequestBody" /> <xs:complexType name="AddGeofenceSetRequestBody"> <xs:sequence> <xs:element name="FenceSet" nillable="true" type="xs:anyType"> <xs:annotation> <xs:appinfo> <ActualType Name="AddGeofenceSet" Namespace="http://pcmiler.alk.com/APIs/v1.0" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" /> </xs:appinfo> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> <xs:element name="AddGeofenceSetRequestBody" nillable="true" type="tns:AddGeofenceSetRequestBody" /> <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="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="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:complexType name="UpdateGeofenceSetRequestBody"> <xs:complexContent mixed="false"> <xs:extension base="tns:AddGeofenceSetRequestBody"> <xs:sequence> <xs:element name="FenceSet" nillable="true" type="xs:anyType"> <xs:annotation> <xs:appinfo> <ActualType Name="GeofenceSet" Namespace="http://pcmiler.alk.com/APIs/v1.0" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" /> </xs:appinfo> </xs:annotation> </xs:element> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="UpdateGeofenceSetRequestBody" nillable="true" type="tns:UpdateGeofenceSetRequestBody" /> <xs:complexType name="GetCustomPlaceSetRequestBody"> <xs:complexContent mixed="false"> <xs:extension base="tns:CustomDataSetRequestBody"> <xs:sequence> <xs:element minOccurs="0" name="PlaceName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="CategoryId" nillable="true" type="xs:int" /> <xs:element minOccurs="0" name="CategoryName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Corner1" nillable="true" type="tns:Coordinates" /> <xs:element minOccurs="0" name="Corner2" nillable="true" type="tns:Coordinates" /> <xs:element minOccurs="0" name="IncludePlaces" type="xs:boolean" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="GetCustomPlaceSetRequestBody" nillable="true" type="tns:GetCustomPlaceSetRequestBody" /> <xs:complexType name="Coordinates"> <xs:sequence> <xs:element minOccurs="0" name="Lat" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Lon" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="Coordinates" nillable="true" type="tns:Coordinates" /> <xs:complexType name="GPSPoint"> <xs:complexContent mixed="false"> <xs:extension base="tns:Coordinates"> <xs:sequence> <xs:element minOccurs="0" name="Speed" nillable="true" type="xs:double" /> <xs:element minOccurs="0" name="Heading" nillable="true" type="xs:double" /> <xs:element minOccurs="0" name="Timestamp" nillable="true" type="xs:int" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="GPSPoint" nillable="true" type="tns:GPSPoint" /> <xs:complexType name="GetAvoidFavorSetRequestBody"> <xs:complexContent mixed="false"> <xs:extension base="tns:CustomDataSetRequestBody"> <xs:sequence> <xs:element minOccurs="0" name="Detail" type="xs:boolean" /> <xs:element minOccurs="0" name="Corner1" nillable="true" type="tns:Coordinates" /> <xs:element minOccurs="0" name="Corner2" nillable="true" type="tns:Coordinates" /> <xs:element minOccurs="0" name="PLIDOnly" type="xs:boolean" /> <xs:element minOccurs="0" name="InexactNameMatch" type="xs:boolean" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="GetAvoidFavorSetRequestBody" nillable="true" type="tns:GetAvoidFavorSetRequestBody" /> <xs:complexType name="GeofenceIntersectRequestBody"> <xs:sequence> <xs:element minOccurs="0" name="fenceNames" nillable="true" xmlns:q2="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q2:ArrayOfstring" /> <xs:element minOccurs="0" name="intersectTime" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="setIds" nillable="true" xmlns:q3="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q3:ArrayOfint" /> <xs:element minOccurs="0" name="setNames" nillable="true" xmlns:q4="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q4:ArrayOfstring" /> <xs:element minOccurs="0" name="setTags" nillable="true" xmlns:q5="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q5:ArrayOfstring" /> </xs:sequence> </xs:complexType> <xs:element name="GeofenceIntersectRequestBody" nillable="true" type="tns:GeofenceIntersectRequestBody" /> </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>
<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:complexType name="ArrayOfstring"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="string" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfstring" nillable="true" type="tns:ArrayOfstring" /> <xs:complexType name="ArrayOfint"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="int" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfint" nillable="true" type="tns:ArrayOfint" /> </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>
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:complexType name="ImportAFSetResponseBody"> <xs:sequence> <xs:element minOccurs="0" name="SetID" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="ImportAFSetResponseBody" nillable="true" type="tns:ImportAFSetResponseBody" /> </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>