Reference for https://pcmiler.alk.com/APIs/REST/v1.0/Service.svc/CustomPlaceSets/{SETID}?tag={TAG}&includePlaces={INCLUDEPLACES}&placeName={PLACENAME}&catId={CATID}&catName={CATNAME}&corner1={CORNER1}&corner2={CORNER2}
Url: https://pcmiler.alk.com/APIs/REST/v1.0/Service.svc/CustomPlaceSets/{SETID}?tag={TAG}&includePlaces={INCLUDEPLACES}&placeName={PLACENAME}&catId={CATID}&catName={CATNAME}&corner1={CORNER1}&corner2={CORNER2}
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:
<ArrayOfPlaceSet xmlns="http://schemas.datacontract.org/2004/07/ALK.Common.Model">
<PlaceSet>
<Name>String content</Name>
<Tag>String content</Tag>
<Id>2147483647</Id>
<Places>
<Place>
<Address xmlns="http://pcmiler.alk.com/APIs/v1.0">
<StreetAddress>String content</StreetAddress>
<City>String content</City>
<State>String content</State>
<Zip>String content</Zip>
<County>String content</County>
<Country>String content</Country>
<SPLC>String content</SPLC>
<CountryPostalFilter>US</CountryPostalFilter>
<AbbreviationFormat>FIPS</AbbreviationFormat>
<StateName>String content</StateName>
<StateAbbreviation>String content</StateAbbreviation>
<CountryAbbreviation>String content</CountryAbbreviation>
</Address>
<!--Valid elements of type: GPSPoint-->
<Coords i:type="GPSPoint" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://pcmiler.alk.com/APIs/v1.0">
<Lat>String content</Lat>
<Lon>String content</Lon>
<Speed>1.26743233E+15</Speed>
<Heading>1.26743233E+15</Heading>
<Timestamp>2147483647</Timestamp>
</Coords>
<Region xmlns="http://pcmiler.alk.com/APIs/v1.0">Unknown</Region>
<Label xmlns="http://pcmiler.alk.com/APIs/v1.0">String content</Label>
<PlaceName xmlns="http://pcmiler.alk.com/APIs/v1.0">String content</PlaceName>
<PlaceId xmlns="http://pcmiler.alk.com/APIs/v1.0">String content</PlaceId>
<CategoryId>2147483647</CategoryId>
<CompanyId>String content</CompanyId>
<Heading>32767</Heading>
<Info>String content</Info>
<PersistentId>2147483647</PersistentId>
<Phone>String content</Phone>
<PlaceType>String content</PlaceType>
<Promotable>true</Promotable>
<SetId>2147483647</SetId>
<SiteId>2147483647</SiteId>
<Speed>32767</Speed>
<Deleted>true</Deleted>
<Guid>1627aea5-8e0a-4371-9022-9b504344e724</Guid>
<Id>2147483647</Id>
<ModifiedOn>9223372036854775807</ModifiedOn>
</Place>
<Place>
<Address xmlns="http://pcmiler.alk.com/APIs/v1.0">
<StreetAddress>String content</StreetAddress>
<City>String content</City>
<State>String content</State>
<Zip>String content</Zip>
<County>String content</County>
<Country>String content</Country>
<SPLC>String content</SPLC>
<CountryPostalFilter>US</CountryPostalFilter>
<AbbreviationFormat>FIPS</AbbreviationFormat>
<StateName>String content</StateName>
<StateAbbreviation>String content</StateAbbreviation>
<CountryAbbreviation>String content</CountryAbbreviation>
</Address>
<!--Valid elements of type: GPSPoint-->
<Coords i:type="GPSPoint" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://pcmiler.alk.com/APIs/v1.0">
<Lat>String content</Lat>
<Lon>String content</Lon>
<Speed>1.26743233E+15</Speed>
<Heading>1.26743233E+15</Heading>
<Timestamp>2147483647</Timestamp>
</Coords>
<Region xmlns="http://pcmiler.alk.com/APIs/v1.0">Unknown</Region>
<Label xmlns="http://pcmiler.alk.com/APIs/v1.0">String content</Label>
<PlaceName xmlns="http://pcmiler.alk.com/APIs/v1.0">String content</PlaceName>
<PlaceId xmlns="http://pcmiler.alk.com/APIs/v1.0">String content</PlaceId>
<CategoryId>2147483647</CategoryId>
<CompanyId>String content</CompanyId>
<Heading>32767</Heading>
<Info>String content</Info>
<PersistentId>2147483647</PersistentId>
<Phone>String content</Phone>
<PlaceType>String content</PlaceType>
<Promotable>true</Promotable>
<SetId>2147483647</SetId>
<SiteId>2147483647</SiteId>
<Speed>32767</Speed>
<Deleted>true</Deleted>
<Guid>1627aea5-8e0a-4371-9022-9b504344e724</Guid>
<Id>2147483647</Id>
<ModifiedOn>9223372036854775807</ModifiedOn>
</Place>
</Places>
</PlaceSet>
<PlaceSet>
<Name>String content</Name>
<Tag>String content</Tag>
<Id>2147483647</Id>
<Places>
<Place>
<Address xmlns="http://pcmiler.alk.com/APIs/v1.0">
<StreetAddress>String content</StreetAddress>
<City>String content</City>
<State>String content</State>
<Zip>String content</Zip>
<County>String content</County>
<Country>String content</Country>
<SPLC>String content</SPLC>
<CountryPostalFilter>US</CountryPostalFilter>
<AbbreviationFormat>FIPS</AbbreviationFormat>
<StateName>String content</StateName>
<StateAbbreviation>String content</StateAbbreviation>
<CountryAbbreviation>String content</CountryAbbreviation>
</Address>
<!--Valid elements of type: GPSPoint-->
<Coords i:type="GPSPoint" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://pcmiler.alk.com/APIs/v1.0">
<Lat>String content</Lat>
<Lon>String content</Lon>
<Speed>1.26743233E+15</Speed>
<Heading>1.26743233E+15</Heading>
<Timestamp>2147483647</Timestamp>
</Coords>
<Region xmlns="http://pcmiler.alk.com/APIs/v1.0">Unknown</Region>
<Label xmlns="http://pcmiler.alk.com/APIs/v1.0">String content</Label>
<PlaceName xmlns="http://pcmiler.alk.com/APIs/v1.0">String content</PlaceName>
<PlaceId xmlns="http://pcmiler.alk.com/APIs/v1.0">String content</PlaceId>
<CategoryId>2147483647</CategoryId>
<CompanyId>String content</CompanyId>
<Heading>32767</Heading>
<Info>String content</Info>
<PersistentId>2147483647</PersistentId>
<Phone>String content</Phone>
<PlaceType>String content</PlaceType>
<Promotable>true</Promotable>
<SetId>2147483647</SetId>
<SiteId>2147483647</SiteId>
<Speed>32767</Speed>
<Deleted>true</Deleted>
<Guid>1627aea5-8e0a-4371-9022-9b504344e724</Guid>
<Id>2147483647</Id>
<ModifiedOn>9223372036854775807</ModifiedOn>
</Place>
<Place>
<Address xmlns="http://pcmiler.alk.com/APIs/v1.0">
<StreetAddress>String content</StreetAddress>
<City>String content</City>
<State>String content</State>
<Zip>String content</Zip>
<County>String content</County>
<Country>String content</Country>
<SPLC>String content</SPLC>
<CountryPostalFilter>US</CountryPostalFilter>
<AbbreviationFormat>FIPS</AbbreviationFormat>
<StateName>String content</StateName>
<StateAbbreviation>String content</StateAbbreviation>
<CountryAbbreviation>String content</CountryAbbreviation>
</Address>
<!--Valid elements of type: GPSPoint-->
<Coords i:type="GPSPoint" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://pcmiler.alk.com/APIs/v1.0">
<Lat>String content</Lat>
<Lon>String content</Lon>
<Speed>1.26743233E+15</Speed>
<Heading>1.26743233E+15</Heading>
<Timestamp>2147483647</Timestamp>
</Coords>
<Region xmlns="http://pcmiler.alk.com/APIs/v1.0">Unknown</Region>
<Label xmlns="http://pcmiler.alk.com/APIs/v1.0">String content</Label>
<PlaceName xmlns="http://pcmiler.alk.com/APIs/v1.0">String content</PlaceName>
<PlaceId xmlns="http://pcmiler.alk.com/APIs/v1.0">String content</PlaceId>
<CategoryId>2147483647</CategoryId>
<CompanyId>String content</CompanyId>
<Heading>32767</Heading>
<Info>String content</Info>
<PersistentId>2147483647</PersistentId>
<Phone>String content</Phone>
<PlaceType>String content</PlaceType>
<Promotable>true</Promotable>
<SetId>2147483647</SetId>
<SiteId>2147483647</SiteId>
<Speed>32767</Speed>
<Deleted>true</Deleted>
<Guid>1627aea5-8e0a-4371-9022-9b504344e724</Guid>
<Id>2147483647</Id>
<ModifiedOn>9223372036854775807</ModifiedOn>
</Place>
</Places>
</PlaceSet>
</ArrayOfPlaceSet>
The following is an example response Json body:
[{
"Name":"String content",
"Tag":"String content",
"Id":2147483647,
"Places":[{
"Address":{
"StreetAddress":"String content",
"City":"String content",
"State":"String content",
"Zip":"String content",
"County":"String content",
"Country":"String content",
"SPLC":"String content",
"CountryPostalFilter":0,
"AbbreviationFormat":0,
"StateName":"String content",
"StateAbbreviation":"String content",
"CountryAbbreviation":"String content"
},
"Coords":{
"Lat":"String content",
"Lon":"String content",
"Speed":1.26743233E+15,
"Heading":1.26743233E+15,
"Timestamp":2147483647
},
"Region":0,
"Label":"String content",
"PlaceName":"String content",
"PlaceId":"String content",
"CategoryId":2147483647,
"CompanyId":"String content",
"Heading":32767,
"Info":"String content",
"PersistentId":2147483647,
"Phone":"String content",
"PlaceType":"String content",
"Promotable":true,
"SetId":2147483647,
"SiteId":2147483647,
"Speed":32767,
"Deleted":true,
"Guid":"1627aea5-8e0a-4371-9022-9b504344e724",
"Id":2147483647,
"ModifiedOn":9223372036854775807
}]
}]
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/ALK.Common.Model" xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/ALK.Common.Model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
<xs:import namespace="http://pcmiler.alk.com/APIs/v1.0" />
<xs:complexType name="ArrayOfPlaceSet">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="PlaceSet" nillable="true" type="tns:PlaceSet" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfPlaceSet" nillable="true" type="tns:ArrayOfPlaceSet" />
<xs:complexType name="PlaceSet">
<xs:complexContent mixed="false">
<xs:extension base="tns:AddPlaceSet">
<xs:sequence>
<xs:element minOccurs="0" name="Id" type="xs:int" />
<xs:element minOccurs="0" name="Places" nillable="true" type="tns:ArrayOfPlace" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="PlaceSet" nillable="true" type="tns:PlaceSet" />
<xs:complexType name="AddPlaceSet">
<xs:sequence>
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Tag" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="AddPlaceSet" nillable="true" type="tns:AddPlaceSet" />
<xs:complexType name="ArrayOfPlace">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Place" nillable="true" type="tns:Place" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfPlace" nillable="true" type="tns:ArrayOfPlace" />
<xs:complexType name="Place">
<xs:complexContent mixed="false">
<xs:extension base="tns:AddPlace">
<xs:sequence>
<xs:element minOccurs="0" name="Deleted" type="xs:boolean" />
<xs:element minOccurs="0" name="Guid" type="ser:guid" />
<xs:element minOccurs="0" name="Id" type="xs:int" />
<xs:element minOccurs="0" name="ModifiedOn" nillable="true" type="xs:long" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="Place" nillable="true" type="tns:Place" />
<xs:complexType name="AddPlace">
<xs:complexContent mixed="false">
<xs:extension xmlns:q1="http://pcmiler.alk.com/APIs/v1.0" base="q1:Location">
<xs:sequence>
<xs:element minOccurs="0" name="CategoryId" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="CompanyId" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Heading" nillable="true" type="xs:short" />
<xs:element minOccurs="0" name="Info" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="PersistentId" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="Phone" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="PlaceType" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Promotable" type="xs:boolean" />
<xs:element minOccurs="0" name="SetId" type="xs:int" />
<xs:element minOccurs="0" name="SiteId" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="Speed" nillable="true" type="xs:short" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="AddPlace" nillable="true" type="tns:AddPlace" />
</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://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="Location">
<xs:sequence>
<xs:element minOccurs="0" name="Address" nillable="true" type="tns:Address" />
<xs:element minOccurs="0" name="Coords" nillable="true" type="tns:Coordinates" />
<xs:element minOccurs="0" name="Region" type="tns:DataRegion" />
<xs:element minOccurs="0" name="Label" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="PlaceName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="PlaceId" nillable="true" type="xs:string">
<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="Location" nillable="true" type="tns:Location" />
<xs:complexType name="Address">
<xs:sequence>
<xs:element minOccurs="0" name="StreetAddress" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="City" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="State" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Zip" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="County" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Country" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="SPLC" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CountryPostalFilter" type="tns:PostCodeType" />
<xs:element minOccurs="0" name="AbbreviationFormat" type="tns:CountryAbbreviationType" />
<xs:element minOccurs="0" name="StateName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="StateAbbreviation" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CountryAbbreviation" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="Address" nillable="true" type="tns:Address" />
<xs:simpleType name="PostCodeType">
<xs:restriction base="xs:string">
<xs:enumeration value="US" />
<xs:enumeration value="Mexico" />
<xs:enumeration value="Both" />
</xs:restriction>
</xs:simpleType>
<xs:element name="PostCodeType" nillable="true" type="tns:PostCodeType" />
<xs:simpleType name="CountryAbbreviationType">
<xs:restriction base="xs:string">
<xs:enumeration value="FIPS" />
<xs:enumeration value="ISO2" />
<xs:enumeration value="ISO3" />
<xs:enumeration value="GENC2" />
<xs:enumeration value="GENC3" />
</xs:restriction>
</xs:simpleType>
<xs:element name="CountryAbbreviationType" nillable="true" type="tns:CountryAbbreviationType" />
<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:simpleType name="DataRegion">
<xs:restriction base="xs:string">
<xs:enumeration value="Unknown" />
<xs:enumeration value="AF" />
<xs:enumeration value="AS" />
<xs:enumeration value="EU" />
<xs:enumeration value="NA" />
<xs:enumeration value="OC" />
<xs:enumeration value="SA" />
<xs:enumeration value="ME" />
<xs:enumeration value="MX" />
</xs:restriction>
</xs:simpleType>
<xs:element name="DataRegion" nillable="true" type="tns:DataRegion" />
</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>