Reference for https://pcmiler.alk.com/APIs/REST/v1.0/Service.svc/AvoidFavorSets/{SETID}/Groups?detail={DETAILFORALL}&corner1={CORNER1}&corner2={CORNER2}&filter={FILTER}&dataset={DATASET}
Url: https://pcmiler.alk.com/APIs/REST/v1.0/Service.svc/AvoidFavorSets/{SETID}/Groups?detail={DETAILFORALL}&corner1={CORNER1}&corner2={CORNER2}&filter={FILTER}&dataset={DATASET}
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:
<ArrayOfAFGroup xmlns="http://pcmiler.alk.com/APIs/v1.0"> <AFGroup> <AvoidFavorType>Avoid</AvoidFavorType> <GroupComments>String content</GroupComments> <GroupName>String content</GroupName> <GroupID>2147483647</GroupID> <GroupLinks> <AFLink> <AFGroupID>2147483647</AFGroupID> <AvoidFavorID>2147483647</AvoidFavorID> <AvoidFavorType>Avoid</AvoidFavorType> <Comment>String content</Comment> <ExtraInfo> <IsBorder>true</IsBorder> <MaxAddress>4294967295</MaxAddress> <MinAddress>4294967295</MinAddress> <RoadClass>255</RoadClass> <RouteNum1>4294967295</RouteNum1> <RouteNum2>4294967295</RouteNum2> <RouteNum3>4294967295</RouteNum3> <StreetName>String content</StreetName> </ExtraInfo> <Geometries> <ArrayOfArrayOfdouble xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <ArrayOfdouble> <double>1.26743233E+15</double> <double>1.26743233E+15</double> </ArrayOfdouble> <ArrayOfdouble> <double>1.26743233E+15</double> <double>1.26743233E+15</double> </ArrayOfdouble> </ArrayOfArrayOfdouble> <ArrayOfArrayOfdouble xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <ArrayOfdouble> <double>1.26743233E+15</double> <double>1.26743233E+15</double> </ArrayOfdouble> <ArrayOfdouble> <double>1.26743233E+15</double> <double>1.26743233E+15</double> </ArrayOfdouble> </ArrayOfArrayOfdouble> </Geometries> <GridID>4294967295</GridID> <GridLevel>32767</GridLevel> <LinkID>65535</LinkID> <LinkPoints> <ArrayOfint xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <int>2147483647</int> <int>2147483647</int> </ArrayOfint> <ArrayOfint xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <int>2147483647</int> <int>2147483647</int> </ArrayOfint> </LinkPoints> <ModifiedOn>9223372036854775807</ModifiedOn> <PLIDs> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int> </PLIDs> </AFLink> <AFLink> <AFGroupID>2147483647</AFGroupID> <AvoidFavorID>2147483647</AvoidFavorID> <AvoidFavorType>Avoid</AvoidFavorType> <Comment>String content</Comment> <ExtraInfo> <IsBorder>true</IsBorder> <MaxAddress>4294967295</MaxAddress> <MinAddress>4294967295</MinAddress> <RoadClass>255</RoadClass> <RouteNum1>4294967295</RouteNum1> <RouteNum2>4294967295</RouteNum2> <RouteNum3>4294967295</RouteNum3> <StreetName>String content</StreetName> </ExtraInfo> <Geometries> <ArrayOfArrayOfdouble xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <ArrayOfdouble> <double>1.26743233E+15</double> <double>1.26743233E+15</double> </ArrayOfdouble> <ArrayOfdouble> <double>1.26743233E+15</double> <double>1.26743233E+15</double> </ArrayOfdouble> </ArrayOfArrayOfdouble> <ArrayOfArrayOfdouble xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <ArrayOfdouble> <double>1.26743233E+15</double> <double>1.26743233E+15</double> </ArrayOfdouble> <ArrayOfdouble> <double>1.26743233E+15</double> <double>1.26743233E+15</double> </ArrayOfdouble> </ArrayOfArrayOfdouble> </Geometries> <GridID>4294967295</GridID> <GridLevel>32767</GridLevel> <LinkID>65535</LinkID> <LinkPoints> <ArrayOfint xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <int>2147483647</int> <int>2147483647</int> </ArrayOfint> <ArrayOfint xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <int>2147483647</int> <int>2147483647</int> </ArrayOfint> </LinkPoints> <ModifiedOn>9223372036854775807</ModifiedOn> <PLIDs> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int> </PLIDs> </AFLink> </GroupLinks> <ModifiedOn>9223372036854775807</ModifiedOn> <SetID>2147483647</SetID> </AFGroup> <AFGroup> <AvoidFavorType>Avoid</AvoidFavorType> <GroupComments>String content</GroupComments> <GroupName>String content</GroupName> <GroupID>2147483647</GroupID> <GroupLinks> <AFLink> <AFGroupID>2147483647</AFGroupID> <AvoidFavorID>2147483647</AvoidFavorID> <AvoidFavorType>Avoid</AvoidFavorType> <Comment>String content</Comment> <ExtraInfo> <IsBorder>true</IsBorder> <MaxAddress>4294967295</MaxAddress> <MinAddress>4294967295</MinAddress> <RoadClass>255</RoadClass> <RouteNum1>4294967295</RouteNum1> <RouteNum2>4294967295</RouteNum2> <RouteNum3>4294967295</RouteNum3> <StreetName>String content</StreetName> </ExtraInfo> <Geometries> <ArrayOfArrayOfdouble xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <ArrayOfdouble> <double>1.26743233E+15</double> <double>1.26743233E+15</double> </ArrayOfdouble> <ArrayOfdouble> <double>1.26743233E+15</double> <double>1.26743233E+15</double> </ArrayOfdouble> </ArrayOfArrayOfdouble> <ArrayOfArrayOfdouble xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <ArrayOfdouble> <double>1.26743233E+15</double> <double>1.26743233E+15</double> </ArrayOfdouble> <ArrayOfdouble> <double>1.26743233E+15</double> <double>1.26743233E+15</double> </ArrayOfdouble> </ArrayOfArrayOfdouble> </Geometries> <GridID>4294967295</GridID> <GridLevel>32767</GridLevel> <LinkID>65535</LinkID> <LinkPoints> <ArrayOfint xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <int>2147483647</int> <int>2147483647</int> </ArrayOfint> <ArrayOfint xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <int>2147483647</int> <int>2147483647</int> </ArrayOfint> </LinkPoints> <ModifiedOn>9223372036854775807</ModifiedOn> <PLIDs> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int> </PLIDs> </AFLink> <AFLink> <AFGroupID>2147483647</AFGroupID> <AvoidFavorID>2147483647</AvoidFavorID> <AvoidFavorType>Avoid</AvoidFavorType> <Comment>String content</Comment> <ExtraInfo> <IsBorder>true</IsBorder> <MaxAddress>4294967295</MaxAddress> <MinAddress>4294967295</MinAddress> <RoadClass>255</RoadClass> <RouteNum1>4294967295</RouteNum1> <RouteNum2>4294967295</RouteNum2> <RouteNum3>4294967295</RouteNum3> <StreetName>String content</StreetName> </ExtraInfo> <Geometries> <ArrayOfArrayOfdouble xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <ArrayOfdouble> <double>1.26743233E+15</double> <double>1.26743233E+15</double> </ArrayOfdouble> <ArrayOfdouble> <double>1.26743233E+15</double> <double>1.26743233E+15</double> </ArrayOfdouble> </ArrayOfArrayOfdouble> <ArrayOfArrayOfdouble xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <ArrayOfdouble> <double>1.26743233E+15</double> <double>1.26743233E+15</double> </ArrayOfdouble> <ArrayOfdouble> <double>1.26743233E+15</double> <double>1.26743233E+15</double> </ArrayOfdouble> </ArrayOfArrayOfdouble> </Geometries> <GridID>4294967295</GridID> <GridLevel>32767</GridLevel> <LinkID>65535</LinkID> <LinkPoints> <ArrayOfint xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <int>2147483647</int> <int>2147483647</int> </ArrayOfint> <ArrayOfint xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <int>2147483647</int> <int>2147483647</int> </ArrayOfint> </LinkPoints> <ModifiedOn>9223372036854775807</ModifiedOn> <PLIDs> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int> </PLIDs> </AFLink> </GroupLinks> <ModifiedOn>9223372036854775807</ModifiedOn> <SetID>2147483647</SetID> </AFGroup> </ArrayOfAFGroup>
The following is an example response Json body:
[{ "AvoidFavorType":0, "GroupComments":"String content", "GroupName":"String content", "GroupID":2147483647, "GroupLinks":[{ "AFGroupID":2147483647, "AvoidFavorID":2147483647, "AvoidFavorType":0, "Comment":"String content", "ExtraInfo":{ "IsBorder":true, "MaxAddress":4294967295, "MinAddress":4294967295, "RoadClass":255, "RouteNum1":4294967295, "RouteNum2":4294967295, "RouteNum3":4294967295, "StreetName":"String content" }, "Geometries":[[[1.26743233E+15]]], "GridID":4294967295, "GridLevel":32767, "LinkID":65535, "LinkPoints":[[2147483647]], "ModifiedOn":9223372036854775807, "PLIDs":[2147483647] }], "ModifiedOn":9223372036854775807, "SetID":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:complexType name="ArrayOfAFGroup"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="AFGroup" nillable="true" type="tns:AFGroup" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfAFGroup" nillable="true" type="tns:ArrayOfAFGroup" /> <xs:complexType name="AFGroup"> <xs:complexContent mixed="false"> <xs:extension base="tns:AFGroupBase"> <xs:sequence> <xs:element minOccurs="0" name="GroupID" nillable="true" type="xs:int" /> <xs:element minOccurs="0" name="GroupLinks" nillable="true" type="tns:ArrayOfAFLink" /> <xs:element minOccurs="0" name="ModifiedOn" type="xs:long" /> <xs:element minOccurs="0" name="SetID" type="xs:int" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="AFGroup" nillable="true" type="tns:AFGroup" /> <xs:complexType name="AFGroupBase"> <xs:sequence> <xs:element minOccurs="0" name="AvoidFavorType" type="tns:AFType" /> <xs:element minOccurs="0" name="GroupComments" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="GroupName" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="AFGroupBase" nillable="true" type="tns:AFGroupBase" /> <xs:simpleType name="AFType"> <xs:list> <xs:simpleType> <xs:restriction base="xs:string"> <xs:enumeration value="Avoid" /> <xs:enumeration value="Favor" /> </xs:restriction> </xs:simpleType> </xs:list> </xs:simpleType> <xs:element name="AFType" nillable="true" type="tns:AFType" /> <xs:complexType name="ArrayOfAFLink"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="AFLink" nillable="true" type="tns:AFLink" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfAFLink" nillable="true" type="tns:ArrayOfAFLink" /> <xs:complexType name="AFLink"> <xs:sequence> <xs:element minOccurs="0" name="AFGroupID" nillable="true" type="xs:int" /> <xs:element minOccurs="0" name="AvoidFavorID" type="xs:int" /> <xs:element minOccurs="0" name="AvoidFavorType" type="tns:AFType" /> <xs:element minOccurs="0" name="Comment" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ExtraInfo" nillable="true" type="tns:AFExtraInfo" /> <xs:element minOccurs="0" name="Geometries" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfArrayOfArrayOfdouble" /> <xs:element minOccurs="0" name="GridID" type="xs:unsignedInt" /> <xs:element minOccurs="0" name="GridLevel" type="xs:short" /> <xs:element minOccurs="0" name="LinkID" type="xs:unsignedShort" /> <xs:element minOccurs="0" name="LinkPoints" nillable="true" xmlns:q2="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q2:ArrayOfArrayOfint" /> <xs:element minOccurs="0" name="ModifiedOn" nillable="true" type="xs:long" /> <xs:element minOccurs="0" name="PLIDs" nillable="true" xmlns:q3="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q3:ArrayOfint" /> </xs:sequence> </xs:complexType> <xs:element name="AFLink" nillable="true" type="tns:AFLink" /> <xs:complexType name="AFExtraInfo"> <xs:sequence> <xs:element minOccurs="0" name="IsBorder" type="xs:boolean" /> <xs:element minOccurs="0" name="MaxAddress" type="xs:unsignedInt" /> <xs:element minOccurs="0" name="MinAddress" type="xs:unsignedInt" /> <xs:element minOccurs="0" name="RoadClass" type="xs:unsignedByte" /> <xs:element minOccurs="0" name="RouteNum1" type="xs:unsignedInt" /> <xs:element minOccurs="0" name="RouteNum2" type="xs:unsignedInt" /> <xs:element minOccurs="0" name="RouteNum3" type="xs:unsignedInt" /> <xs:element minOccurs="0" name="StreetName" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="AFExtraInfo" nillable="true" type="tns:AFExtraInfo" /> </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="ArrayOfArrayOfArrayOfdouble"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="ArrayOfArrayOfdouble" nillable="true" type="tns:ArrayOfArrayOfdouble" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfArrayOfArrayOfdouble" nillable="true" type="tns:ArrayOfArrayOfArrayOfdouble" /> <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="ArrayOfArrayOfint"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="ArrayOfint" nillable="true" type="tns:ArrayOfint" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfArrayOfint" nillable="true" type="tns:ArrayOfArrayOfint" /> <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>