Reference for https://pcmiler.alk.com/APIs/REST/v1.0/Service.svc/About
Url: https://pcmiler.alk.com/APIs/REST/v1.0/Service.svc/About
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:
<Request xmlns="http://pcmiler.alk.com/APIs/v1.0">
<!--Valid elements of type: ServiceRequestHeader-->
<Header i:type="ServiceRequestHeader" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<DataSet>String content</DataSet>
<DataVersion>String content</DataVersion>
<IsSoap>true</IsSoap>
<RequestType>String content</RequestType>
<APIKey>String content</APIKey>
<Account>String content</Account>
<AccountId>9223372036854775807</AccountId>
<FeatureLevel>2147483647</FeatureLevel>
<IsAdmin>true</IsAdmin>
<UserId>9223372036854775807</UserId>
<IsMapSureEnterprise>true</IsMapSureEnterprise>
<EncryptedOwnerId>String content</EncryptedOwnerId>
<TransactionId>String content</TransactionId>
<AuthToken>String content</AuthToken>
<LinkedAccountId>9223372036854775807</LinkedAccountId>
</Header>
</Request>
The following is an example request Json body:
{
"Header":{
"DataSet":"String content",
"DataVersion":"String content",
"IsSoap":true,
"RequestType":"String content",
"APIKey":"String content",
"Account":"String content",
"AccountId":9223372036854775807,
"FeatureLevel":2147483647,
"IsAdmin":true,
"UserId":9223372036854775807,
"IsMapSureEnterprise":true,
"EncryptedOwnerId":"String content",
"TransactionId":"String content",
"AuthToken":"String content",
"LinkedAccountId":9223372036854775807
}
}
The following is an example response Xml body:
<Response xmlns="http://pcmiler.alk.com/APIs/v1.0">
<Header>
<Type>String content</Type>
<Success>true</Success>
<DataVersion>String content</DataVersion>
<Errors>
<Error>
<Type>Warning</Type>
<Code>SUCCESS</Code>
<LegacyErrorCode>2147483647</LegacyErrorCode>
<Description>String content</Description>
<Index>2147483647</Index>
</Error>
<Error>
<Type>Warning</Type>
<Code>SUCCESS</Code>
<LegacyErrorCode>2147483647</LegacyErrorCode>
<Description>String content</Description>
<Index>2147483647</Index>
</Error>
</Errors>
<DebugLogs>
<KeyValueOfstringstring xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<Key>String content</Key>
<Value>String content</Value>
</KeyValueOfstringstring>
<KeyValueOfstringstring xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<Key>String content</Key>
<Value>String content</Value>
</KeyValueOfstringstring>
</DebugLogs>
<GridDataVersion>String content</GridDataVersion>
</Header>
</Response>
The following is an example response Json body:
{
"Header":{
"Type":"String content",
"Success":true,
"DataVersion":"String content",
"Errors":[{
"Type":0,
"Code":0,
"LegacyErrorCode":2147483647,
"Description":"String content",
"Index":2147483647
}],
"DebugLogs":[{
"Key":"String content",
"Value":"String content"
}],
"GridDataVersion":"String content"
}
}
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:complexType name="Request">
<xs:sequence>
<xs:element minOccurs="0" name="Header" nillable="true" type="tns:RequestHeader" />
</xs:sequence>
</xs:complexType>
<xs:element name="Request" nillable="true" type="tns:Request" />
<xs:complexType name="RequestHeader">
<xs:sequence>
<xs:element minOccurs="0" name="DataSet" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="DataVersion" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="IsSoap" type="xs:boolean" />
<xs:element minOccurs="0" name="RequestType" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="RequestHeader" nillable="true" type="tns:RequestHeader" />
<xs:complexType name="ServiceRequestHeader">
<xs:complexContent mixed="false">
<xs:extension base="tns:RequestHeader">
<xs:sequence>
<xs:element minOccurs="0" name="APIKey" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Account" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="AccountId" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="FeatureLevel" type="xs:int" />
<xs:element minOccurs="0" name="IsAdmin" type="xs:boolean" />
<xs:element minOccurs="0" name="UserId" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="IsMapSureEnterprise" type="xs:boolean" />
<xs:element minOccurs="0" name="EncryptedOwnerId" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="TransactionId" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="AuthToken" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="LinkedAccountId" nillable="true" type="xs:long" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="ServiceRequestHeader" nillable="true" type="tns:ServiceRequestHeader" />
</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>
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="Response">
<xs:sequence>
<xs:element minOccurs="0" name="Header" nillable="true" type="tns:ResponseHeader" />
</xs:sequence>
</xs:complexType>
<xs:element name="Response" nillable="true" type="tns:Response" />
<xs:complexType name="ResponseHeader">
<xs:sequence>
<xs:element minOccurs="0" name="Type" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Success" type="xs:boolean" />
<xs:element minOccurs="0" name="DataVersion" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Errors" nillable="true" type="tns:ArrayOfError" />
<xs:element minOccurs="0" name="DebugLogs" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfKeyValueOfstringstring">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="GridDataVersion" 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="ResponseHeader" nillable="true" type="tns:ResponseHeader" />
<xs:complexType name="ArrayOfError">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Error" nillable="true" type="tns:Error" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfError" nillable="true" type="tns:ArrayOfError" />
<xs:complexType name="Error">
<xs:sequence>
<xs:element minOccurs="0" name="Type" type="tns:ErrorType" />
<xs:element minOccurs="0" name="Code" type="tns:PcmwsExceptionCode" />
<xs:element minOccurs="0" name="LegacyErrorCode" type="xs:int" />
<xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Index" nillable="true" type="xs:int">
<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="Error" nillable="true" type="tns:Error" />
<xs:simpleType name="ErrorType">
<xs:restriction base="xs:string">
<xs:enumeration value="Warning" />
<xs:enumeration value="Exception" />
</xs:restriction>
</xs:simpleType>
<xs:element name="ErrorType" nillable="true" type="tns:ErrorType" />
<xs:simpleType name="PcmwsExceptionCode">
<xs:restriction base="xs:string">
<xs:enumeration value="SUCCESS" />
<xs:enumeration value="LEGACY_ERROR" />
<xs:enumeration value="INTRNL_FAIL" />
<xs:enumeration value="INVLD_PROFILE_VER" />
<xs:enumeration value="TRIP_LIMIT_EXCEEDED" />
<xs:enumeration value="INVLD_LOGIN" />
<xs:enumeration value="LOGIN_DISABLED" />
<xs:enumeration value="INVLD_PROFILE" />
<xs:enumeration value="INVLD_PROFILE_ARRAY" />
<xs:enumeration value="INVLD_PROFILE_CANADIAN" />
<xs:enumeration value="INVLD_PROFILE_DETAIL" />
<xs:enumeration value="INVLD_PROFILE_COND" />
<xs:enumeration value="INVLD_PROFILE_DIRECTIONS" />
<xs:enumeration value="INVLD_PROFILE_ROAD" />
<xs:enumeration value="INVLD_PROFILE_STATE" />
<xs:enumeration value="INVLD_PROFILE_FUEL" />
<xs:enumeration value="INVLD_PROFILE_HUB" />
<xs:enumeration value="INVLD_PROFILE_SPLC" />
<xs:enumeration value="INVLD_PROFILE_PLACE_NAME" />
<xs:enumeration value="INVLD_PROFILE_STREETS" />
<xs:enumeration value="INVLD_PROFILE_STREETS_GEO" />
<xs:enumeration value="INVLD_PROFILE_FASTEST" />
<xs:enumeration value="INVLD_PROFILE_TRK_CFG" />
<xs:enumeration value="INVLD_PROFILE_TOLLDATA" />
<xs:enumeration value="INVLD_PROFILE_VEHICLE_TYPE" />
<xs:enumeration value="INVLD_ADDR" />
<xs:enumeration value="CITY_STATE_ZIP_MISMATCH" />
<xs:enumeration value="INVLD_ZIP" />
<xs:enumeration value="INVLD_STATE" />
<xs:enumeration value="INVLD_CITY_JURIS" />
<xs:enumeration value="INVLD_PLACE_NAME" />
<xs:enumeration value="NO_CITY_ZIP" />
<xs:enumeration value="INVLD_CITY" />
<xs:enumeration value="INVLD_STATE_ABBR" />
<xs:enumeration value="PO_BOX_NO_ALLOWED" />
<xs:enumeration value="FIND_MTCH_FAILED" />
<xs:enumeration value="MISSING_TRIP_ORIGIN" />
<xs:enumeration value="MISSING_TRIP_DEST" />
<xs:enumeration value="MISSING_VARIABLE" />
<xs:enumeration value="INVLD_AF_TYPE" />
<xs:enumeration value="INVLD_ROUTE_NAME" />
<xs:enumeration value="INVLD_CITE_INT" />
<xs:enumeration value="INVLD_FUEL_OPT_COND" />
<xs:enumeration value="INVLD_DEPART_TIME" />
<xs:enumeration value="INVLD_INT" />
<xs:enumeration value="INVLD_DBL" />
<xs:enumeration value="INVLD_INPUT_PLACE" />
<xs:enumeration value="INVLD_METRIC_VAL" />
<xs:enumeration value="INVLD_MET_LGTH" />
<xs:enumeration value="INVLD_MET_HEIGHT" />
<xs:enumeration value="INVLD_MET_WEIGHT" />
<xs:enumeration value="INVLD_MET_WIDTH" />
<xs:enumeration value="INVLD_ENG_HEIGHT" />
<xs:enumeration value="INVLD_ENG_WEIGHT" />
<xs:enumeration value="INVLD_ENG_WIDTH" />
<xs:enumeration value="INVLD_ENG_LENGTH" />
<xs:enumeration value="INVLD_TOLL_DISCOUNT" />
<xs:enumeration value="INVLD_STOP_INFO" />
<xs:enumeration value="INVLD_DATE" />
<xs:enumeration value="INVLD_TIME" />
<xs:enumeration value="INVLD_RADIUS" />
<xs:enumeration value="MISSING_FUEL_OPTIONS" />
<xs:enumeration value="MISSING_FUEL_INFO" />
<xs:enumeration value="MISSING_STOP_INFO" />
<xs:enumeration value="MISSING_DATE_TIME" />
<xs:enumeration value="MISSING_DAY_OF_WEEK" />
<xs:enumeration value="INVLD_LAT" />
<xs:enumeration value="INVLD_LNG" />
<xs:enumeration value="INVLD_COORDS" />
<xs:enumeration value="FUEL_OPT_ERR" />
<xs:enumeration value="INVLD_TRIP" />
<xs:enumeration value="PARITY_MISMATCH" />
<xs:enumeration value="NO_STREET_NUMBER" />
<xs:enumeration value="DIRECTIONAL_MISMATCH" />
<xs:enumeration value="STREET_TYPE_MISMATCH" />
<xs:enumeration value="STREET_NAME_MISSPELL" />
<xs:enumeration value="MULTIPLE_MATCHES" />
<xs:enumeration value="NO_STREET_NAME" />
<xs:enumeration value="ADDR_OUT_OF_RANGE" />
<xs:enumeration value="STREET_NOT_IN_ZIP" />
<xs:enumeration value="COORDS_ZIPCENTROID" />
<xs:enumeration value="EXTRA_FUEL_OPTIONS" />
<xs:enumeration value="EXTRA_TRUCK_CONFIG" />
<xs:enumeration value="EXTRA_DATE" />
<xs:enumeration value="EXTRA_REPORT" />
<xs:enumeration value="INVLD_DATA_VER" />
<xs:enumeration value="DEPCREATED_TOLL_TAG" />
<xs:enumeration value="INVLD_GEO_LIST_CNT" />
<xs:enumeration value="GEOCODE_ERROR" />
<xs:enumeration value="GEOCODE_WARN" />
<xs:enumeration value="INVLD_TILE_INDEX" />
<xs:enumeration value="EXTRA_ROUTE" />
<xs:enumeration value="EXTRA_DATA" />
<xs:enumeration value="INVLD_ROUTE_OPTIONS" />
<xs:enumeration value="INVLD_VAL" />
<xs:enumeration value="DEPRECATED" />
<xs:enumeration value="GEOCODE_LIMIT_EXCEEDED" />
<xs:enumeration value="UNAVAILABLE_FEATURE" />
<xs:enumeration value="STOP_LIMIT_EXCEEDED" />
<xs:enumeration value="NO_ALLOWED_INTERPS" />
<xs:enumeration value="INVALID_INTERP" />
<xs:enumeration value="INVALID_FUEL_CONSUMPTION" />
<xs:enumeration value="INVLD_COUNTRY_ABBR" />
<xs:enumeration value="HOS_SERVICE_ERR" />
<xs:enumeration value="CONTENT_SERVICE_ERR" />
<xs:enumeration value="RATE_LIMITED" />
<xs:enumeration value="INVALID_PARAMETER" />
</xs:restriction>
</xs:simpleType>
<xs:element name="PcmwsExceptionCode" nillable="true" type="tns:PcmwsExceptionCode" />
</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="ArrayOfKeyValueOfstringstring">
<xs:annotation>
<xs:appinfo>
<IsDictionary xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</IsDictionary>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="KeyValueOfstringstring">
<xs:complexType>
<xs:sequence>
<xs:element name="Key" nillable="true" type="xs:string" />
<xs:element name="Value" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfKeyValueOfstringstring" nillable="true" type="tns:ArrayOfKeyValueOfstringstring" />
</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>