OnlineAVL Published Interface
Click here for a complete list of operations.
DoLogin
This method is used to authenticate a client application with the Published Interface web service. This method returns a session id/ token which must be supplied with all subsequent API calls.
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /onlineavl/api/V1.3/service.asmx HTTP/1.1
Host: onlineavl2api-mx.navmanwireless.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://onlineavl2.navmanwireless.com/0907/DoLogin"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<DoLogin xmlns="http://onlineavl2.navmanwireless.com/0907/">
<request>
<Session>
<SessionId>guid</SessionId>
</Session>
<UserCredential>
<UserName>string</UserName>
<Password>string</Password>
<ApplicationID>guid</ApplicationID>
<ClientID>guid</ClientID>
<ClientVersion>string</ClientVersion>
</UserCredential>
<IPAddress>string</IPAddress>
<ClockVerificationUtc>dateTime</ClockVerificationUtc>
</request>
</DoLogin>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<DoLoginResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
<DoLoginResult>
<OperationStatus>boolean</OperationStatus>
<StatusMessage>
<SystemMessage>
<MessageCode>int</MessageCode>
<ExceptionMessage>string</ExceptionMessage>
<ExceptionStackTrace>string</ExceptionStackTrace>
<ExceptionType>string</ExceptionType>
</SystemMessage>
<SystemMessage>
<MessageCode>int</MessageCode>
<ExceptionMessage>string</ExceptionMessage>
<ExceptionStackTrace>string</ExceptionStackTrace>
<ExceptionType>string</ExceptionType>
</SystemMessage>
</StatusMessage>
<SecurityProfile>
<User>
<UserID>guid</UserID>
<OwnerID>guid</OwnerID>
<UserName>string</UserName>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Email>string</Email>
<AlertEmail>string</AlertEmail>
<PasswordExpiryDate>dateTime</PasswordExpiryDate>
<PasswordExpiryDays>int</PasswordExpiryDays>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<AddressLine3>string</AddressLine3>
<AddressLine4>string</AddressLine4>
<MobilePhone>string</MobilePhone>
<AfterHoursPhone>string</AfterHoursPhone>
<SystemUser>boolean</SystemUser>
<SystemOwner>boolean</SystemOwner>
<Active>boolean</Active>
<JobTitle>string</JobTitle>
<DaysToPasswordExpiryDate>int</DaysToPasswordExpiryDate>
<CountryCode>string</CountryCode>
<EVGSuperUser>boolean</EVGSuperUser>
<RestrictedVehicleAccess>boolean</RestrictedVehicleAccess>
<ApplicationId>guid</ApplicationId>
<Password>string</Password>
<IsFirstLogon>boolean</IsFirstLogon>
</User>
<Session>
<SessionId>guid</SessionId>
</Session>
<IsFirstLogon>boolean</IsFirstLogon>
<IsSystemOwner>boolean</IsSystemOwner>
</SecurityProfile>
<Authenticated>boolean</Authenticated>
<UpgradeRecommended>boolean</UpgradeRecommended>
<UpgradeEssential>boolean</UpgradeEssential>
<MinimumVersionRecommended>string</MinimumVersionRecommended>
<MinimumVersionEssential>string</MinimumVersionEssential>
<DynamicClientConfiguration>
<PollIntervalMilliseconds>int</PollIntervalMilliseconds>
<EnableDecompression>boolean</EnableDecompression>
<KeepAliveIntervalMinutes>int</KeepAliveIntervalMinutes>
<GMapSettings>
<VersionNumber>string</VersionNumber>
<IsRealTimeDrawingAllowed>boolean</IsRealTimeDrawingAllowed>
<HtmlUrl>string</HtmlUrl>
</GMapSettings>
<KVPS>
<KVP>
<K>string</K>
<V>string</V>
</KVP>
<KVP>
<K>string</K>
<V>string</V>
</KVP>
</KVPS>
<RetentionDays>int</RetentionDays>
<IsDWEnabled>boolean</IsDWEnabled>
<ReportCriteriaVehicleAndDriverSoftThrottleLimit>int</ReportCriteriaVehicleAndDriverSoftThrottleLimit>
<ReportCriteriaVehicleAndDriverHardThrottleLimit>int</ReportCriteriaVehicleAndDriverHardThrottleLimit>
<ReportCriteriaDurationSoftThrottleLimitInDays>int</ReportCriteriaDurationSoftThrottleLimitInDays>
<ReportCriteriaDurationHardThrottleLimitInDays>int</ReportCriteriaDurationHardThrottleLimitInDays>
<ReportSchedulingMaxDateRangeDays>int</ReportSchedulingMaxDateRangeDays>
</DynamicClientConfiguration>
<ServerUTCTime>dateTime</ServerUTCTime>
<EntityVersions>
<EntityVersion>
<EntityName>string</EntityName>
<OwnerId>guid</OwnerId>
<Version>long</Version>
</EntityVersion>
<EntityVersion>
<EntityName>string</EntityName>
<OwnerId>guid</OwnerId>
<Version>long</Version>
</EntityVersion>
</EntityVersions>
</DoLoginResult>
</DoLoginResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /onlineavl/api/V1.3/service.asmx HTTP/1.1
Host: onlineavl2api-mx.navmanwireless.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<DoLogin xmlns="http://onlineavl2.navmanwireless.com/0907/">
<request>
<Session>
<SessionId>guid</SessionId>
</Session>
<UserCredential>
<UserName>string</UserName>
<Password>string</Password>
<ApplicationID>guid</ApplicationID>
<ClientID>guid</ClientID>
<ClientVersion>string</ClientVersion>
</UserCredential>
<IPAddress>string</IPAddress>
<ClockVerificationUtc>dateTime</ClockVerificationUtc>
</request>
</DoLogin>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<DoLoginResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
<DoLoginResult>
<OperationStatus>boolean</OperationStatus>
<StatusMessage>
<SystemMessage>
<MessageCode>int</MessageCode>
<ExceptionMessage>string</ExceptionMessage>
<ExceptionStackTrace>string</ExceptionStackTrace>
<ExceptionType>string</ExceptionType>
</SystemMessage>
<SystemMessage>
<MessageCode>int</MessageCode>
<ExceptionMessage>string</ExceptionMessage>
<ExceptionStackTrace>string</ExceptionStackTrace>
<ExceptionType>string</ExceptionType>
</SystemMessage>
</StatusMessage>
<SecurityProfile>
<User>
<UserID>guid</UserID>
<OwnerID>guid</OwnerID>
<UserName>string</UserName>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Email>string</Email>
<AlertEmail>string</AlertEmail>
<PasswordExpiryDate>dateTime</PasswordExpiryDate>
<PasswordExpiryDays>int</PasswordExpiryDays>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<AddressLine3>string</AddressLine3>
<AddressLine4>string</AddressLine4>
<MobilePhone>string</MobilePhone>
<AfterHoursPhone>string</AfterHoursPhone>
<SystemUser>boolean</SystemUser>
<SystemOwner>boolean</SystemOwner>
<Active>boolean</Active>
<JobTitle>string</JobTitle>
<DaysToPasswordExpiryDate>int</DaysToPasswordExpiryDate>
<CountryCode>string</CountryCode>
<EVGSuperUser>boolean</EVGSuperUser>
<RestrictedVehicleAccess>boolean</RestrictedVehicleAccess>
<ApplicationId>guid</ApplicationId>
<Password>string</Password>
<IsFirstLogon>boolean</IsFirstLogon>
</User>
<Session>
<SessionId>guid</SessionId>
</Session>
<IsFirstLogon>boolean</IsFirstLogon>
<IsSystemOwner>boolean</IsSystemOwner>
</SecurityProfile>
<Authenticated>boolean</Authenticated>
<UpgradeRecommended>boolean</UpgradeRecommended>
<UpgradeEssential>boolean</UpgradeEssential>
<MinimumVersionRecommended>string</MinimumVersionRecommended>
<MinimumVersionEssential>string</MinimumVersionEssential>
<DynamicClientConfiguration>
<PollIntervalMilliseconds>int</PollIntervalMilliseconds>
<EnableDecompression>boolean</EnableDecompression>
<KeepAliveIntervalMinutes>int</KeepAliveIntervalMinutes>
<GMapSettings>
<VersionNumber>string</VersionNumber>
<IsRealTimeDrawingAllowed>boolean</IsRealTimeDrawingAllowed>
<HtmlUrl>string</HtmlUrl>
</GMapSettings>
<KVPS>
<KVP>
<K>string</K>
<V>string</V>
</KVP>
<KVP>
<K>string</K>
<V>string</V>
</KVP>
</KVPS>
<RetentionDays>int</RetentionDays>
<IsDWEnabled>boolean</IsDWEnabled>
<ReportCriteriaVehicleAndDriverSoftThrottleLimit>int</ReportCriteriaVehicleAndDriverSoftThrottleLimit>
<ReportCriteriaVehicleAndDriverHardThrottleLimit>int</ReportCriteriaVehicleAndDriverHardThrottleLimit>
<ReportCriteriaDurationSoftThrottleLimitInDays>int</ReportCriteriaDurationSoftThrottleLimitInDays>
<ReportCriteriaDurationHardThrottleLimitInDays>int</ReportCriteriaDurationHardThrottleLimitInDays>
<ReportSchedulingMaxDateRangeDays>int</ReportSchedulingMaxDateRangeDays>
</DynamicClientConfiguration>
<ServerUTCTime>dateTime</ServerUTCTime>
<EntityVersions>
<EntityVersion>
<EntityName>string</EntityName>
<OwnerId>guid</OwnerId>
<Version>long</Version>
</EntityVersion>
<EntityVersion>
<EntityName>string</EntityName>
<OwnerId>guid</OwnerId>
<Version>long</Version>
</EntityVersion>
</EntityVersions>
</DoLoginResult>
</DoLoginResponse>
</soap12:Body>
</soap12:Envelope>