MVR Submit request Help
Revision History
|
Date |
Description |
|
Live Date March 6, 2016 |
1.
Driver Date of Birth updated with province code PE. 2. The MVRAbstract.xsd has been modified from <xs:element name="StartDate" type="xs:date" /> to < xs:element name="StartDate" type="xs:date" minOccurs="0"/>. The StartDate may be blank for some cases in New Brunswick. 3. PEI MVR_Immediate now available_note that overnights no longer supported.
4. MessageDT
– added comments about the various messages 5. Alberta: when the FirstLicenceComment is populated than the Status of the driver has to be treated as "Restricted". ConvictionDT ‘Status’ element document updated |
|
Live Date May 15, 2016 |
No changes to XML |
|
Live Date Sept 25, 2016 |
-CGI has introduced Cross Carrier duplicate checking for Ontario MVRs. Please contact CGI if you wish to subscribe this feature. -Historied MVRs are being discontinued as of Sept 26, 2016. |
|
Live Date Dec 2, 2016 |
Documentation change for Alberta LicenceIssueDate |
|
Client test March 27 Live April 23, 2017 |
PEI has introduced
legislation to report short term suspensions. The suspensions
will stay on file for 3 years.
Statute =
HTA 277.1(3.2) and Statute Description = 7 Day Suspension
Statute =
HTA 277.1(3.3) and Statute Description = 30 Day Suspension (2nd Offence)
Statute =
HTA 277.1(3.5) and Statute Description = 90 Day Suspension (3rd Offence)
Changes to the XML
in SuspensionDT |
|
Client test Aug21- Sept 8, 2017
Live Date: Sept
17, 2017 |
-Change
MVRAbstract.xsd
-the Merit section
order has changed.(AB)
Meritcode
is in the XML as the first element – Change effective July
2017 due to ministry change. -Graduated licence expiry date update (AB) -Reinstatement Dates changes (AB)
-Complex type documentation only – no change
Documentation update about Licence Endorsement
Documentation: SponsorSubscriberId in SOAP header |
|
Client test July
31 Live August 3, 2017 |
Hotfix.
CGI has just
now learned that, effective July 1, 2017, the Ontario Ministry of
Transportation (MTO) now requires drivers to successfully complete the MTO
entry-level Commercial Class-A training course, prior to attempting their
Commercial Ontario Class-A road test.
This new MTO
data is currently being displayed on the abstract as a conviction between
July 1, 2017 and August 3, 2017
On August 3
CGI will be promoting live a MVR system change to correctly display this new
data as a “Condition”.
Refer to
Condition section
|
|
Live Date Nov 26,
2017 |
Documentation update: Gender X: CGI has been actively talking with the IBC and MTO. There are no system changes known at this point to include X as a new value. There are also no changes to licence validation rules in for Ontario Licence. |
|
Live Date June 3,
2018
|
Documentation update: Added more documentation regarding MessageDT code 200291402
Gender X: Alberta registry
has indicated that Gender X is expected to be included on MVRs Late May –
early June 2018 Timeframe.
Please contact
CGI for test case No technical changes are expected by MTO. CGI has created test cases if a carrier wants to test a potential change Added values in DriverInfoDT – Gender
There are no changes to XSD or Stylesheet.
|
|
Live Date Aug 18,
2018 |
No changes |
|
Live Date Nov 25,
2018 |
Documentation changes |
|
Live Date Feb 24,
2019 |
No changes |
|
Live Date July 27,
2019 |
Introduction of optional field in the request <xs:element name=" ReferencePurpose " minOccurs="0"type="xs:string"/> </ xs:sequence ></xs:complexType> Documentation update on DOB Documentation update ProviderMessageDT reads ProviderMessage and ProviderErrorDT reads ProviderError |
|
Live Date August
24, 2019 |
No changes |
|
Live Date October
19, 2019 |
No changes |
|
Live Date December
7, 2019 |
No changes |
|
Live Date May 24,
2020 |
ConditionID– New ON Condition for 2020 VALID FOR REHAB EVAL ONLY
In
response to COVID-19, the Ontario Ministry of Transportation (MTO) has moved
all expired licence dates to March 1, 2021.
For these cases MTO has set the status has been set to EXTENDED, which is a
newly created in status. |
|
Live Date June 28,
2020 |
No changes |
|
Live Date July 19,
2020 |
No changes |
|
Live Date Aug 23,
2020 |
No changes |
|
Documentation
update |
Documentation
update for Abstract and address
Details
regarding ON, AB and PE address format
NS,
NB, NL and QC does not provide address |
|
Documentation
update Apr 23, 2024 |
Documentation
update for Description and Comments for MVRResponseDT |
|
Documentation
update May 10, 2025 |
Documentation
update in Driver Info Name and Surname and FirstName |
|
Documentation
update November 16, 2025 |
New Ontario condition |
|
Documentation
update March 2026 |
New Ontario service is added related to the Driver training data. |
Web Service Request
SOAP
header:
The Web Service Client must pass the following as custom SOAP headers:
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
CredentialsContext |
String |
|
Username |
|
|
SponsorSubscriberID |
String |
|
Sponsoring Subscriber ID |
The subscriber id of the Insurance company paying for the service. |
|
Credentials |
String |
|
|
|
|
UserName |
String |
|
Userid assigned by CGI. The format is e-mail address |
Required This can be an application’s id. |
|
Password |
String |
|
Password |
Required. Valid password provided by CGI. |
|
FederatedContext |
|
|
|
Optional |
|
SponsorSubscriberID
=>SponsorSubscriberId |
|
|
Sponsoring Subscriber ID |
The subscriber id of the Insurance company paying for the
service. Consult with CGI. [may3/2017] the spelling of the field is changed to SponsorSubscriberId to match the WDSL. |
|
FederatedCredentials |
|
|
|
|
|
UserName |
String |
|
Userid assigned by CGI. The format is e-mail address |
Optional If used this is typically the final user’s id. Consult with CGI. |
|
Password |
String |
|
Password |
Required. Valid password provided by CGI. |
|
Requestmode |
|
|
|
|
|
Mode |
String |
|
|
Not used for single webservice calls |
|
Origin |
String |
|
Origin of the webservice call |
Example CLIENT, COMPQ. See CGI for instructions which origin code to use. This may impact pricing of the transaction. |
|
RequestVersion |
|
|
|
|
|
Version |
String |
|
Version of the schema used |
Default to 1.00 or the version you are using. |
SOAP Body User Inputs:
The Web Service Client must pass in user inputs wrapped in an XML document.
SOAP Sample:
<soap:Body>
<SubmitRequest xmlns="https://RapidWebServices.cgi.com/WebServices">
<MVRRequestDS xmlns="http://localhost/IISDOTNETAPP/XMLSchemas/MVRRequestDS.xsd">
<MVRRequestDT>
<DriverLicenceProvinceCode>ON</DriverLicenceProvinceCode>
<DriverLicenceNumber>B50094077600101</DriverLicenceNumber>
<OrderImmediateInd>Y</OrderImmediateInd>
<DriverDateOfBirth>1/1/1960 12:00:00 AM</DriverDateOfBirth>
<DriverGender>M</DriverGender>
<DriverLastName>BLACK</DriverLastName>
<DriverFirstName>JOHN</DriverFirstName>
<PredictorCheckOverrideInd>N</PredictorCheckOverrideInd>
<DuplicateCheckOrderOverrideInd>Y</DuplicateCheckOrderOverrideInd>
<AbstractFormat>B</AbstractFormat>
<SuspendAbstractResponseInd>N</SuspendAbstractResponseInd>
<ExplicitRequestResponsePoolInd>N</ExplicitRequestResponsePoolInd>
< ReferencePurpose>NEW BUSINESS</ ReferencePurpose>
</MVRRequestDT>
</MVRRequestDS>
</SubmitRequest>
</soap:Body>
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
RequestParametersDT |
String |
|
|
|
|
DriverLicenceProvinceCode |
String |
2 |
Province code |
ON, AB, NS, NB, NL, QC, PE |
|
DriverLicenceNumber |
String |
50 |
Driver license requested |
|
|
OrderImmediateInd |
String |
1 |
ON: Y or N AB: N (Response available with 3 hours). No processing on last business day of month NS: Y NB: Y (from ACOL) or N (from NB registry). Next day NL: N Next day PE: Y Immediate |
Y – for immediate N – for overnight |
|
DriverDateOfBirth |
Text |
30 |
Mandatory for NB, AB, PE, NL Validated in ON |
yyyy/mm/dd Alberta
and New Brunswick Ministries will not release the MVR unless the submitted
DriverDateOfBirth matches to the
ministries records. Once
you correct the data of birth, a new request must be submitted with the DuplicateCheckOrderOverrideInd set to Y PEI - send a warning of the two
date birth do not match. NL - there are no messages If you submit the DriverDateOfBirth, it will be validated against the licence format. NOTE: contact CGI for testing Alberta and NB cases |
|
DriverGender |
String |
|
Validated in ON |
F or M [Sept26/17] Gender X is not available yet until CGI receives specifications from the MTO |
|
DriverLastName |
String |
50 |
Last name of requested driver |
|
|
DriverFirstName |
String |
50 |
First name of requested driver |
|
|
DriverMiddleName |
String |
50 |
Middle initial of requested driver |
|
|
RequestReference |
String |
100 |
Memo field, free form. This is displayed back on the Print format (if applicable) of the MVR. This is also echoed back on billing backup file |
Mandatory for QC MVR, the first 3 letters of this element are predefined at account setup. Please contact CGI Montreal. |
|
RequestComment |
String |
100 |
Comment field, free form. This is displayed back on the Print format (if applicable) of the MVR. |
|
|
PredictorCheckOverrideInd |
String |
1 |
Y or N |
If the MVR Predictor feature is applicable. Y – the call bypasses Predictor N – the call results on ordering an MVR |
|
DuplicateCheckOrderOverrideInd |
String |
1 |
Y or N |
First webservice call must be N to determine if a duplicate exists or not. Consult CGI for more details. Second webservice call can be N [Cross Carrier duplicate checking] If you have
signed up for this feature – the value must be N |
|
AbstractFormat |
String |
1 |
The response can be returned in various formats: Data only, formatted print or both. D, B, P |
D – Data only B – Both data and print P – Print only Note: different pricing applies based on the option you choose. |
|
SuspendAbstractResponseInd |
|
|
For internal CGI use. |
|
|
ExplicitRequestResponsePoolInd |
|
|
For internal CGI use. |
|
|
ConsentType |
String |
1 |
For QC use only |
M or E or V |
|
Language |
String |
1 |
For QC use only |
E or F |
|
SignatureCode |
String |
9 |
For QC use only |
9 characters all filled. |
|
ReferencePurpose |
String |
30 |
Optional field |
[June82019live] This is an optional field for Webservice users. The value shows in Billing Backup Suggested Values for Insurance requests New Business Renewal New driver added to policy Claims adjudication Policy transfer <xs:element
name="ReferencePurpose" minOccurs="0"type="xs:string"/></xs:sequence></xs:complexType> |
Web Service Response
The web service returns an XML document.
The XML represents a dataset with the following tables:
Tables:
Notes:
1. Unpopulated tables are not returned in the XML.
2. RequestParametersDT is an echo-back of user inputs.
MVRRequestDT
Echo
back of the original request with confirmation of receipt if the request.
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
RequestReceipt |
Integer |
A token returned. - Unique id of the transaction in Rapidweb |
For overnight request, only the RequestReceipt is returned. For immediate request, if the response is not returned by the Provincial Ministry within a specific timeout period. |
|
|
DriverLicenceProvinceCode |
String |
2 |
Repeated from RequestParametersDT |
|
|
DriverLicenceNumber |
Integer |
50 |
Repeated from RequestParametersDT |
|
|
OrderImmediateInd |
String |
1 |
Repeated from RequestParametersDT |
|
|
DriverDateOfBirth |
Text |
30 |
Repeated from RequestParametersDT |
|
|
DriverGender |
String |
|
Repeated from RequestParametersDT |
|
|
DriverLastName |
String |
50 |
Repeated from RequestParametersDT |
|
|
DriverFirstName |
String |
50 |
Repeated from RequestParametersDT |
|
|
DriverMiddleName |
String |
50 |
Repeated from RequestParametersDT |
|
|
RequestReference |
String |
100 |
Repeated from RequestParametersDT |
|
|
RequestComment |
String |
100 |
Repeated from RequestParametersDT |
|
|
PredictorCheckOverrideInd |
String |
1 |
Repeated from RequestParametersDT |
|
|
DuplicateCheckOrderOverrideInd |
String |
1 |
Repeated from RequestParametersDT |
|
|
AbstractFormat |
String |
1 |
Repeated from RequestParametersDT |
|
|
SuspendAbstractResponseInd |
|
|
Internal CGI Use |
|
|
Username |
|
|
Internal CGI Use |
|
|
ExplicitRequesteResponsePoolInd |
|
|
Internal CGI Use |
|
|
ConsentType |
String |
1 |
For QC use only |
M or E or V |
|
Language |
String |
1 |
For QC use only |
E or F |
|
SignatureCode |
String |
9 |
For QC use only |
9 characters all filled |
MVRResponseDT
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
RequestReceipt |
Integer |
1 |
A token returned. |
[April23/2024 documentation update]
If only a RequestReceipt is returned it means, that the client
needs to return with GetResponse method to get the
response. The RequetsReceipt is returned of the request is an overnight request, or an immediate data provider does not respond to the request immediately. The receipt is -1 is the request pulled a duplicate previously ordered response |
|
RequestErrorInd |
indicator |
1 |
|
[April23/2024 documentation update]
N – abstract returned with no errors Y – there was a problem with the transaction [June6/2022] the Value Y is returned of the MVR is a duplicate or cross carrier duplicate. |
|
RequestOrderInd |
indicator |
1 |
Indicates that the MVR request was submitted to the Ministry |
[June6/2022] ‘Y’ – the request was submitted to Ministry ‘N’ For requests not sent to the ministry i.e.; CGI error or duplicate found , the value will be ‘N’, |
|
DuplicateRequestInd |
indicator |
0 |
Repeated from RequestParametersDT |
[April23/2024 documentation update]
Y indicates that the MVR order included returned a duplicate. [Nov16/2025 documentation update]N indicates that the MVR included in the response is not a duplicate. |
|
PredictorInvokedInd |
indicator |
1 |
Repeated from RequestParametersDT |
[April23/2024 documentation update]
Y indicates that the MVR order included a MVR Predictor call. |
|
PredictorUnavailableInd |
indicator |
0 |
MVR Predictor was ordered, however the CGI system could not the module. MVR is ordered |
[April23/2024 documentation update]
Y indicates that the MVR order included MVR Predictor call however the Predictor module was not invoked by the CGI system due to no sufficient data available. |
|
PredictorOrderInd |
indicator |
0 |
MVR Predictor was invoked |
[April23/2024 documentation update]
Y indicates that the MVR order included MVR Predictor call |
|
PredictorScore |
integer |
0 |
The Predictor Score value |
[April23/2024 documentation update]
The Predictor Score value from the MVR Predictor call from 0 to 999 |
|
AbstractInd |
indicator |
1 |
|
[April23/2024 documentation update]
|
|
AbstractHasConvictionCodesInd |
indicator |
0 |
MVR with no conviction (Clean) or MVR without Conviction (dirty) abstract |
[April23/2024 documentation update]
Y – Contains conviction (Dirty) N - Does not contain conviction (Clean) N - Is returned when the drivers licence is not in the ministry database. |
|
AbstractFormat |
abstractFormat |
0 |
|
B – both, P – Print, D - Data |
|
Username |
string |
0 |
Based on credentials |
|
|
UserFirstName |
string |
0 |
Based on credentials |
|
|
UserLastName |
string |
0 |
Based on credentials |
|
|
ProviderResponseDateTime |
dateTime |
0 |
Date time the response was received from the provider – Ministry |
[Cross Carrier duplicate checking] The date and time of the original request. |
|
ResponseSentDateTime |
dateTime |
0 |
Date time the response was sent out |
[Cross Carrier duplicate checking] The date and time of the original request. |
|
ReceivedDateTime |
dateTime |
0 |
Date time when the Request was requested |
[Cross Carrier duplicate checking] The date and time of the original request. |
|
ReprintDateTime |
dateTime |
0 |
Date time the response was reprinted |
|
|
RequestResponsePoolInvokedInd |
indicator |
0 |
|
|
|
SubscriberName |
string |
0 |
The name of the subscriber who ordered the transaction. |
|
|
SponsoringSubscriberID |
string |
|
ID of the Sponsoring Subscriber |
SponsoringSubscriberID is an Optional Element. It is not an input field. It either returns a value, or is not returned. |
|
SponsoringSubscriberName |
string |
|
Name of the Sponsoring Subscriber |
SponsoringSubscriberName is an Optional Element. It is not an input field. It either returns a value, or is not returned. |
MVRDuplicateRequestDT
This
section is returned if the response returns a duplicate. This information refers to the originally
returned transaction.
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
RequestReceipt |
String |
Unique id of the original transaction in Rapidweb |
[Cross Carrier duplicate checking] The value is -1 if Cross carrier duplicate found. |
|
|
DriverLicenceProvinceCode |
String |
|
Province code |
|
|
DriverLicenceNumber |
Integer |
|
Licence number |
|
|
OrderImmediateInd |
String |
|
From the Original request |
|
|
DriverDateOfBirth |
String |
|
From the Original request |
|
|
DriverGender |
String |
|
From the Original request |
|
|
DriverLastName |
String |
|
From the Original request |
|
|
DriverFirstName |
|
|
From the Original request |
|
|
DriverMiddleName |
|
|
From the Original request |
|
|
RequestReference |
|
|
From the Original request |
[Cross Carrier duplicate checking] The RequestReference submitted by this request (not of the original request) |
|
RequestComment |
|
|
From the Original request |
[Cross Carrier duplicate checking] The RequestComment submitted by this request (not of the original request) |
|
PredictorCheckOverrideInd |
|
|
From the Original request |
|
|
DuplicateCheckOrderOverrideInd |
|
|
From the Original request |
|
|
AbstractFormat |
|
|
From the Original request |
|
|
SuspendAbstractResponseInd |
|
|
From the Original request |
|
|
Username |
|
|
From the Original request |
[Cross Carrier duplicate checking] Left blank if cross carrier duplicate found |
|
UserFirstName |
|
|
From the Original request |
[Cross Carrier duplicate checking] Left blank if cross carrier duplicate found |
|
UserLastName |
|
|
From the Original request |
[Cross Carrier duplicate checking] Left blank if cross carrier duplicate found |
|
ConsentType |
String |
1 |
For QC use only |
M or E or V |
|
Language |
String |
1 |
For QC use only |
E or F |
|
SignatureCode |
String |
9 |
For QC use only |
9 characters all filled |
DataFormatAbstractDT
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
RequestReceipt |
string |
|
|
|
RequestInfoDT
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
RequestId |
integer |
|
|
|
|
AccountNumber |
string |
|
|
|
|
IBCRequestId |
integer |
|
|
|
ABSTRACT
DriverInfo
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
LicenceNumber
|
string |
25 |
Repeated from RequestParametersDT |
AB,ON,NB,NS,NL,PE,QC |
|
Name
|
string |
See comments |
Name of driver |
May10 2025 – documentation update
Ontario
Examples
Note: There may be cases where last name is two names and the
Alberta
Examples
Nova Scotia and New Brunswick Immediate
Examples
Note: Nova Scotia and New Brunswick Immediate Driver Info also
New Brunswick Overnight
Examples
PEI
Examples
Newfoundland
Examples
Note: Newfoundland Driver Info also has additional fields for |
|
BirthDate
|
date |
|
Date of birth as per ministry |
AB,ON,NB,NS,NL,PE |
|
LicenceStatus
|
string |
120 |
License Status |
AB,ON,NB(ACOL),NS,NL ON: LICENCED, PE Note: some ministries supply multiple statuses
Please contact CGI for information relating to specific
values for provinces
COVID-19
related
In response to COVID-19, the Ontario Ministry of Transportation (MTO) has moved all expired licence dates to March 1, 2021. For these cases MTO has set the status has been set to EXTENDED, which is a newly created in status. [June6/2022] as of Feb28/2022, the EXTENDED status is used only for G2 drivers.
Alberta, NS, NB have not modified the actual expiry dates
and no new status values. |
|
LicenceClass
|
string |
30 |
License Class |
AB,ON,NB,NS,NL,PE Example ON : G***
Please contact CGI for information relating to specific
values for provinces |
|
LicenceStatusExpanded
|
|
0 |
Multiple value of License status |
NS – the MVR can have up to 4 status values, but most cases have one value, sometimes 2. For Example <LicenceStatusExpanded> <Code>A</Code>
<Description>ACTIVE</Description>
</LicenceStatusExpanded>
<LicenceStatusExpanded>
<Code>B</Code>
<Description>SUSPENDED</Description>
<Code>D</Code>
<Description>INACTIVE</Description> </LicenceStatusExpanded> Possible values are: ACTIVE A SUSPENDED B EXPIRED C INACTIVE D CANCELLED E SURRENDER F DECEASED G NEVER LICENSED H DENIED I PROHIBITED K Please note: Nova Scotia can add new values or discontinue values |
|
Code |
string |
|
Status Code |
NS – Status Code of the licence |
|
Description |
string |
|
Status code description |
NS – Description of the Status code |
|
Surname |
string |
30 |
Name as per ministry |
NS,NL, NB immediate Surname format:<SURNAME>LASTNAME</SURNAME>
Examples |
|
FirstName |
string |
30 |
Name as per ministry |
NS,NL, NB immediate FirstName format: <FIRSTNAME>FIRSTNAME</FIRSTNAME>
or
Examples
For a given name, |
|
MiddleName
|
string |
30 |
Name as per ministry |
This field is not populated |
|
OldLicenceNumber
|
string |
|
If the license number has been cross reference to an old previous license number. |
AB,ON,NL |
|
Gender |
integer |
1 |
Gender as per ministry |
AB,ON
[Sept26/17]
Gender X
is not available yet until CGI receives specifications from the MTO and
Alberta
[Apr13/18]
Gender X
may be included in Alberta MVRs late May early
June 2018, date to be confirmed by Alberta Registry. Please
contact CGI for test case. No technical changes are expected by MTO. CGI has created Ontario test cases if a carrier wants to test a potential change |
|
Height |
integer |
3 |
Height as per ministry |
AB,ON |
|
Weight |
integer |
3 |
Weight as per ministry |
AB |
|
LicenceCondition
|
string |
20 |
Many occurrences are possible: Details are in the Condition. ON This fields contains: X/N */N X/Y */Y NB: A - Valid for all Motorcycles B - Valid for School Bus C - Valid for Motorcycle and School Bus D - Valid for Motorcycle (up to 550 cc) E – Valid for Airbrake
The endorsement "E" is the only endorsement which may be used in combination with endorsements "A" through "C". No other combinations are allowed.
Alberta [documentation update May/2022]
A - Adequate Lenses
B – Special Conditions
C - Periodic
Medical *
D - Periodic Vision Report *
E - Periodic Driver Examination *
F - Valid Temporary Licence
H - Daylight Driving Only
J - Outside Mirrors
K - Automatic Transmission
L - Hand Controls
M - Under Alberta Transportation Review *
N - Excludes Class 2 and 4
P - Testing to be conducted by Provincial
Examiner only *
T - Special Medical *
Endorsements
Q - Air Brakes S - School Bus
U - Completed Driver Education Course *
V - Extended Length Vehicle Combinations
* Do not appear on the driver's licence |
AB,ON,NB,NS
ON (refer to
Condition for condition description in ON only). Position 1X Corrective lenses required *: No corrective lenses required ON Position 2/ slash (always present) ON Position 3 Y additional conditions and/or endorsements exist N: no additional conditions and/or endorsements ON There are only 4 possible string for the conditions provided by the ministry: ON X/N Requires corrective lenses, no other conditions X/Y Requires corrective lenses, and other conditions */N no conditions */Y Other conditions NB Endorsements: Licence can have up to 3 endorsements |
|
LicenceRestriction
|
string |
10 |
01: corrective lenses / verres correcteurs
02: side mirrors / rétroviseurs
latéraux
03: hand controls / commandes manuelles
04: auto
transmission / transmission automatique
05: steering knob / guide-volant
06: daylight driving / valide le
jour seulement
07: lenses & side mirrors /verres corr. et rétrov.
lat. 08: hand controls & auto /commandes man. + transm. auto 09: steering knob & auto / guide-volant + transm. auto 10: call head office / contacter le bureau central 11: periodic medical / examen médical périodique 12: valid in NB only / valide au N.-B. seulement
15: for work only / pour le travail
seulement
16: requires ignition interlock / exige antidémarreur
21: valid: Moped & tractor / cyclomoteurs et tracteurs
22: medical purposes only / raisons médicales seulement
23: zero alcohol expires dd/mm/yyyy
/ alcoolémie=0 expirée dd/mm/yyyy
1: 5
KM RES
2: 10 KM RES 3: 15 KM RES 4: 20 KM RES 5: 25 KM RES
6: 30 KM RES
7: EXCL MONTAGUE
8: EXCL CH’TOWN
9: EXCL S’SIDE 10: EXC DTOWN CTOWN 11: EXC DTOWN SSIDE 12: IMMED FAM ONLY 13: NO TCH 14: QUEENS CO ONLY 15: KINGS CO ONLY 16: PRINCE CO ONLY 17: PEI ONLY 18: RURAL DRI ONLY 19: RESTRICTED 20: LEFT FOOT ACCEL 21: PASS VEH ONLY 22: HEAR AID – CL 2 23: NO WINTER DRI 24: EYE PATCH 25: PEDDLE EXTENT 26: INTERLOCK 27: 40 KMS RES 28: CH’TOWN ONLY 29: 12 KMS RES 30: S’SIDE ONLY 31: MONTAGUE ONLY 32: SOURIS ONLY 33: CH’TOWN ONLY 34: S’SIDE ONLY 35: MONTAGUE ONLY 36: SOURIS ONLY 37: 35 KMS RES 38: EXCL RTE1 39: EXCL RTE2 40: FERN171,112,119 41: CL 3 -25 KM RES 42: COM VEH-DAY-PEI 43: 50000 KM RES 53: OXYGEN 55: NO BUSES 56: NIGHT:WORK-HOME 58: 11PM-6AM NO DRI 60: NO ROAD > 60KMS 62: CL1 -20 KMS RES 64: HEAR AID – CL 4 66: SEE SPE PERMIT 68: Drive only with driver ed inst 70: CLASS 3 ONLY 72: CDL 1,2,3,4 CANADA Only 74: GOOSENECK ONLY 75: 3 WHEEL MC ONLY 81: CL1 Auto Transm 82: CL2 Auto Transm 83: CL3 Auto Transm 87: TAXI ONLY 88: CL4 Ambulance 93: 12AM-6AM NO DRI 99: CLASS 3 – PEI ONLY 105: HEAR AID – TDG 111: NO SNOW REMOVAL 117: Zero Blood Alcohol Content 118: Zero Blood Alcohol Content 123: Drive only with DRI Ed Inst 124: Be With Driver 129: Class 1 PEI Only 130: Class 2 PEI Only 131: Class 4 PEI Only 132: Class 4 PEI Only 138: Class 1 PEI – NB – NS Only 144: Daytime Dri Only 150: 11PM-8AM NO DRI 156: 50 KM RES |
NB overnight MVR only can contain up to five restrictions (2 characters per restriction - up to a maximum of 10 characters per restriction Example: “02”, “0104092223” etc.) PE |
|
LicenceEndorsement
|
byte |
0 |
|
PE
Endorsement is related to driving condition and added to the Driver licence. Endorsement names are like AIRBRAKES, ATV,
SNOWMOBILE, DIRT BIKE & COMMERCIAL LEARNER
. |
|
LicenceIssueDate
|
date |
0 |
Earliest Licence issue date for ON Earliest Licence issue date for NS Earliest Licence issue date for PE (NB**) the lincence issue date is available in the “FirstLicenceComment” field |
(AB),ON,NS,PE, (NB**) Data is available from 1987 and onwards
Alberta – the issue date is issue date of the current
driver’s licence and not the earliest licence date. For example if the Driver first
got a licence on January 31, 1980 and the current licence was renewed (issued) on September 30, 2016 to
September 30 2020. The MVR will have the LicenceIssueDate
as September 30, 2016 |
|
LicenceExpiryDate
|
date |
0 |
Expiry date of license |
AB,ON,NB,NS,PE |
|
IsLicenceSuspended
|
boolean |
|
True or false |
AB,ON,NB,NS,NL,PE |
|
DemeritPoints
|
integer |
0 |
Number of current demerit points |
AB,ON,NL,PE,NS |
|
GraduatedDriverLicence
|
0 |
|
AB |
|
|
Type |
string |
|
Example ‘DRIVER’ ‘LEARNER’ |
AB |
|
ExpiryDate
|
date |
|
The expiry date is populated in most cases, expect when
the exist date is Indefinite Example <Type>DRIVER</Type> <Description>GDL DRIVER ELIGIBLE EXIT DATE INDEFINITE</Description> </GraduatedDriverLicence>
|
AB The XSD will change to Minoccurs 0
|
|
Description |
string |
|
Examples GDL LEARNER ELIGIBLE EXIT DATE 2017/05/08 GDL DRIVER ELIGIBLE EXIT DATE INDEFINITE |
|
|
Address
|
mixedAddress |
|
Ontario Address is returned if the requesting userid has been configured so. Contact CGI to find out your settings. Address is returned in the following format:
Or Address line Postal code Alberta, PEI address is available (not based on userid) |
Examples Ontario ON - address is an option based on MTO contract <Address> <Street>100 JOHN BLVD</Street> <Municipality>ANYCITY</Municipality> <Province>ON</Province> <PostalCode>K7L5A3</PostalCode> </Address> Alberta <Address> <AddressLine>xxxx</AddressLine> <AddressLine>XXX AB</AddressLine> <PostalCode>TNT 9C9</PostalCode> </Address> PEI <Address> <AddressLine>Box 10</AddressLine> <AddressLine>CITY</AddressLine> <AddressLine>100 ANY ST</AddressLine> <PostalCode>C0B 1T0</PostalCode> </Address> Nova Scotia – Address not provided New Brunswick - Address not provided Newfoundland - Address not provided Quebec – Address not provided |
|
FirstLicenceComment
|
string |
0 |
The first licence comment is returned by Ministry in free form text The first licence comment is returned by Ministry to show the GDL (Graduated Driver Licence) as Y/N Indicator This field is populated if the Alberta Driver is Restricted. In these cases the Status field has to be treated based in the business process to deal with Restricted licences. The Abstract also includes details on the restrictions. NB Immediate [Dec2016] Free form text which contains First licence date for various classes. This data is free form |
NS PE AB NB immediate |
Condition
Effective
July 1, 2017 MVR Ontario MVR will include condition data related to MELT
(Mandatory Entry Level Training). Effective September 2025 MVR Ontario MVR includes condition data related to RECREATIONAL VEHICLE LEARNING MODULE completion. Starting November 16, 2025, the data is in condition section.
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
Date |
date |
|
Medical Due date Mandatory Level Training for Class A Commercial Truck Drivers RECREATIONAL VEHICLE ENDORSEMENT |
ON |
|
ConditionId |
string |
|
|
|
|
Description |
string |
120 |
Description as per Ministry |
|
|
|
|
|
List of known
conditions (MTO reserves the right to add more
conditions): IGNITION INTERLOCK APPLICABLE ON REINSTATEMENT REQUIRES CORRECTIVE LENSES MANDATORY IGNITION INTERLOCK REQUIRED CAN OPERATE A COMMERCIAL VEHICLE IN CANADA ONLY REQUIRES SPECIAL CONTROLS FOR THE HAND REQUIRES SPECIAL CONTROLS FOR THE FOOT REQUIRES SPECIAL HAND AND FOOT CONTROLS REQUIRES HEARING DEVICE REQUIRES VISUAL DEVICE RESTRICTION FOR GIVING DRIVER INSTRUCTION EXISTS COMMERCIAL VEHICLE OPERATION RESTRICTION IN EFFECT SPECIAL NAME & ADDRESS REQUIREMENTS EXIST SPECIAL VEHICLE CONTROLS REQUIRED BY DRIVER MOTORCYCLE RESTRICTION(S) IN EFFECT CLASS A VEHICLE RESTRICTION IN EFFECT CATEGORY S IS FOR INTERNAL TEST USE ONLY AIR BRAKE ENDORSEMENT DRIVER MAY ONLY OPERATE VEHICLE WITH HAND CONTROLS MORE CONDITIONS EXIST VALID FOR REHAB EVAL ONLY MANDATORY ENTRY-LEVEL
TRAINING CLASS A COMPLETED TRANSMISSON: MANUAL COMPLETION DATE: yyyy/mm/dd ROAD TEST PASSED: CLASS A TRANSMISSION: MANUAL COMPLETION DATE: yyyy/mm/dd New November 16, 2025 RECREATIONAL VEHICLE ENDORSEMENT COMPLETION DATE: 2025/08/30 |
ON NEW starting Aug 3, 2017 ON – Mandatory Training for Class A Commercial will be displayed. Example MANDATORY ENTRY-LEVEL
TRAINING CLASS A COMPLETED TRANSMISSON: MANUAL COMPLETION DATE: 2017/07/05 ROAD TEST PASSED: CLASS A TRANSMISSION: MANUAL COMPLETION DATE: 2017/07/20 New in 2020 VALID FOR REHAB EVAL ONLY This means: Valid for Rehab Eval Only - under category V - is placed on the applicant's driving record by the Medical Review Section. This restricts the licence holder to driving with an Occupational Therapist from an approved Functional Assessment Centre and only for the purpose of the functional assessment and/or lessons. NEW November 16 2025 RECREATIONAL VEHICLE ENDORSEMENT |
|
|
|
|
List of known
conditions (MTO reserves the right to add more conditions): 01 - must wear glasses or contact lenses 02 - may only drive during the day 03 - must use a hearing aid 04 - must undergo periodic medical examinations 05 - must have annual visual examination 06 - must have two side mirrors on vehicle 07 - must not exceed designated speed 08 - must only drive vehicle with a total loaded mass not exceeding 5500 kg 09 - may only drive vehicle equipped with an automatic transmission 10 - may only drive vehicle equipped with a device for easier handling of steering wheel 11 - may only drive vehicle equipped with power brakes 12 - may not drive a public commercial vehicle, bus, minibus or taxi 13 - must wear a seat belt when driving any type of vehicle 14 - may not drive an emergency vehicle 15 - may only drive vehicle equipped with hand-operated controls 16 - may only drive vehicle equipped with a manual dimmer switch or magic eye 17 - may only drive vehicle equipped with an accelerator on the left 18 - may only drive vehicle equipped with controls adapted to the handicap 19 - may operate vehicle with air-brakes 20 - moped only 21 - may only drive vehicle equipped with power steering 22 - may only drive vehicle equipped with an alcohol sensing ignition interlock device 99 – other |
NB, NS - License Condition 1 to 10 (X2 occurs 10 times) |
|
|
|
|
List of known
conditions (MTO reserves the right to add more
conditions): 1 – COR LENSES 2 – DAY DRI ONLY 3 – HAND CONTROL 4 – SIDE MIRRORS 5 – P.STEERING 6 – AUTOMATIC 7 – P.BRAKES 8 – SP KNOB 9 – MAX 60 KM 10 – RESTRICTED 11 – OTHER 12 – TEST 16 – CDL 1,2,3,4 20 – Hearing Aid for Class 2 |
PE |
Conviction
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
Code |
string |
0 |
CGI code for conviction: used to classify convictions. |
AB,ON,NB,NS,NL,PE Contact CGI to obtain a current list of Conviction Codes |
|
MinistryCode |
string |
0 |
Unique Ministry code for the conviction |
AB,NB,NS,NL,PE ON: not supplied |
|
OffenceDate |
date |
0 |
Date of offence (sometimes the offence date is in the description) |
AB,ON,NB,NS |
|
ConvictionDate |
date |
|
Date of conviction |
AB,ON,NB,NS,NL,PE |
|
StartDate |
date |
0 |
|
AB |
|
ExpiryDate |
date |
0 |
|
AB |
|
Description |
|
Description as per MTO (can be free form) |
AB,ON,NB,NS,NL,PE |
|
|
ReferenceNumber |
string |
0 |
|
AB |
|
CaseNumber |
string |
0 |
|
AB |
|
Jurisdiction |
string |
0 |
|
NB,NS,PE |
|
LocationCode |
string |
0 |
|
AB |
|
Status |
string |
0 |
Status of the conviction |
PE – Values: Active, Under Appeal, Pardoned, Whitespace(Active) |
|
RSPEICode |
string |
0 |
|
PE |
|
IsOutOfProvince |
boolean |
0 |
|
AB |
|
DemeritPoints |
integer |
0 |
|
AB,NS,PE |
|
CumulativeDemeritPoints |
integer |
0 |
|
NS |
|
PrintLine |
string |
|
|
AB |
|
Type |
offenseType |
0 |
|
AB |
|
SpeedLimit |
|
|
|
|
|
ActualSpeed |
|
|
|
|
|
DuplicateIndicator |
|
|
|
|
|
ProvinceCode |
|
|
|
|
|
LegalReference |
|
|
|
|
|
Type |
offenceType |
|
|
Optional |
|
QuebecConvictionType |
|
|
|
Optional |
Suspension
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
StartDate |
date |
|
Start date of suspension |
AB,ON,NB,NS,NL. PE The StartDate may be blank for some cases in New Brunswick. The MVRAbstract.xsd defines the element as <xs:element name="StartDate" type="xs:date" minOccurs="0"/>. PEI
starts reporting from April 23, 2017 – reporting back to 3 years. |
|
ExpiryDate |
date |
0 |
Expiry date of suspension |
AB,ON,NB,NS,NL |
|
SuspendDate |
date |
0 |
|
NB |
|
Description |
(description) |
0 |
Description of Suspension (may be multiple) |
AB,ON,NB,NS,NL |
|
ConvictionCode |
string |
0 |
|
AB,NB,ON, PE (values are SUS007, SUS030,
SUS090) |
|
ReferenceNumber |
string |
0 |
Reference number from Ministry |
AB,ON |
|
CaseNumber |
string |
0 |
|
AB |
|
AppealEndDate |
date |
0 |
|
AB |
|
ReinstateDate |
date |
0 |
|
AB |
|
TermLength |
string |
0 |
|
AB |
|
SuspendedMonthsCount |
integer |
0 |
|
NL |
|
SuspendedDaysCount |
integer |
0 |
|
NL |
|
PrintLine |
string |
|
|
AB |
|
AffectedDocument |
string |
|
|
|
|
Status |
string |
|
|
|
|
Description |
string |
|
|
Conviction Description |
|
OffenceDate |
string |
|
|
|
|
ConvictionDate |
string |
|
|
|
|
Type |
offenceType |
|
|
AB |
ReinstatementDT
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
EligibleDate |
date |
0 |
|
AB |
|
Condition |
|
0 |
|
AB |
|
Date |
date |
0 |
|
NB,NS |
|
Description |
string |
0 |
|
NB,NS |
|
Type |
offenceType |
|
|
AB |
Prohibition
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
ReferenceNumber |
string |
|
|
AB |
|
ProhibitionCode |
string |
|
|
|
|
CaseNumber |
string |
0 |
|
AB |
|
StartDate |
date |
|
|
AB |
|
ExpiryDate |
date |
|
|
AB |
|
TermLength |
string |
|
|
AB |
|
AppealEndDate |
date |
0 |
|
AB |
|
ReinstateDate |
string |
0 |
|
AB |
|
Description |
string |
|
|
AB |
|
PrintLine |
string |
|
|
AB |
|
Type |
offenceType |
|
|
AB |
RestrictionDT
Restrictions
can continue to be populated for Alberta and also for PEI starting March 6,
2016
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
ReferenceNumber |
string |
|
|
AB, PE |
|
RestrictionCode |
string |
|
|
|
|
CaseNumber |
string |
|
|
AB |
|
StartDate |
date |
|
|
AB |
|
ExpiryDate |
date |
|
|
AB |
|
Description |
string |
|
|
AB, PE |
|
PrintLine |
string |
|
|
AB |
|
Type |
offenceType |
|
|
AB |
Merit
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
MeritCode |
|
|
<MeritCode/> |
AB – Optional field |
|
ReferenceNumber |
string |
|
AB – the Ministry reference to the Merit course |
AB, PE – Optional field |
|
Date |
date |
|
Date of the course |
AB, PE |
|
Description |
string |
|
Course Description |
AB, PE |
|
DemeritPoints |
integer |
0 |
Demerit point reduction – example <DemeritPoints>-03</DemeritPoints> |
AB |
|
PrintLine |
string |
|
Multiple rows for the description |
AB |
Example:
<Merit type="appeal">
<MeritCode/>
<ReferenceNumber>MVD001911234</ReferenceNumber>
<Date>2015-10-05</Date>
<Description>MERIT COURSE Attitude People Inc. - DDC</Description>
<DemeritPoints>-03</DemeritPoints>
<PrintLine> MVD001911234 MERIT -3 </PrintLine>
<PrintLine> MERIT COURSE </PrintLine>
<PrintLine> Attitude People Inc. - DDC </PrintLine>
<PrintLine> START DATE: 2015/10/05 </PrintLine>
</Merit>
Accident
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
Date |
date |
|
|
NB,NS,NL,PE |
|
Description |
string |
0 |
|
NB,NS |
|
ReportRetrievalNum |
string |
0 |
|
NS |
|
Code |
string |
0 |
|
NL |
|
Type |
string |
0 |
|
NL |
|
DamageAmount |
integer |
0 |
|
NL |
|
Province |
province |
0 |
|
PE |
|
PropertyDamage |
string |
0 |
|
PE |
|
Fatalities |
string |
0 |
|
PE |
|
Injury |
string |
0 |
|
PE |
|
ShareOfLiability |
string |
|
|
QC |
|
Severity |
string |
|
|
QC |
ReportDT
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
PrintLineWidth |
integer |
|
|
QC |
|
PrintLine |
string |
|
|
QC |
ProviderMessage
These messages are provided by
the Ministry. CGI does not alter these
messages just a pass through. The list
of complete messages is not available.
We encourage that clients
display the provider messages in their user interface.
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
Code |
string |
|
Code of message returned by Ministry |
Example: I1002 (MVR ON) |
|
Text |
text |
|
Message returned by Ministry |
Example: SEARCH SUCCESSFUL - ABSTRACT FOUND |
ProviderError
These error messages are
provided by the Ministry. CGI does not
alter these error messages just a pass through.
The list of complete messages is not available.
We encourage that clients
display the provider messages in their user interface.
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
Code |
string |
0 |
|
Example: I1005 (MVR ON) |
|
Type |
integer |
0 |
|
|
|
Text |
string |
|
|
Example: DRIVER LICENSE NUMBER NOT FOUND ON DATABASE (for I1005 (MVR ON) Special mention
for MVR Ontario S1999 Description is MTO SYSTEM ERROR This error means that MTO has encountered and no actual MVR will be returned at this time. Client must reorder (with duplicate override if it is always set to N) |
MessageDT
|
ELEMENT NAME |
DATA TYPE |
DATA LENGTH |
DESCRIPTION |
COMMENTS |
|
Code |
string |
10 |
A code field. |
See below. |
|
Text |
string |
200 |
A description field corresponding to the above code field. Added the possible maximum size |
|
CGI Internal code |
CGI Internal code |
Code |
Description |
Comment |
|
|
|
200230100 |
Request Completed Successfully |
Confirmation |
|
M |
02 |
200230102 |
This request is a duplicate. A request is pending. |
Information – duplicate checking related |
|
M |
03 |
200230103 |
This request is a duplicate. A historied abstract exists. |
Information – duplicate checking related Historied MVRs are being discontinued as of Sept
26, 2016. |
|
M |
04 |
200230104 |
Duplicate request. Abstract found. |
Information – duplicate checking related |
|
M |
05 |
200230105 |
This request is a duplicate. The existing request is an error. |
Information – duplicate checking related |
|
M |
12 |
200230112 |
CGI Error - Unable to process request at this time. |
System error |
|
E |
21 |
200230121 |
Invalid MVR Submit Request CBO, object is null. |
System error |
|
E |
22 |
200230122 |
Invalid Requestor, object is null. |
System error |
|
E |
23 |
200230123 |
Unauthorized access not authorized for requested service. |
The id does not have access to the service |
|
M |
24 |
200230124 |
Invalid request. Driver Licence Province Code was not supplied. |
Validation errors not for webservice |
|
M |
25 |
200230125 |
Invalid request. Driver Licence Number was not supplied. |
Validation errors not for webservice |
|
M |
26 |
200230126 |
Invalid request. Order Immediate Indicator was not supplied. |
Validation errors not for webservice |
|
M |
27 |
200230127 |
Invalid request. Predictor Check Override Indicator was not supplied. |
Validation errors not for webservice |
|
M |
28 |
200230128 |
Invalid request. Duplicate Check Order Override Indicator was not supplied. |
Validation errors not for webservice |
|
M |
29 |
200230129 |
Invalid request. AbstractFormat was not supplied. |
Validation errors not for webservice |
|
M |
30 |
200230130 |
Invalid request. Suspend Abstract Response Indicator was not supplied. |
Validation errors not for webservice |
|
M |
31 |
200230131 |
Invalid Driver Date of Birth. |
Validation errors not for webservice |
|
M |
32 |
200230132 |
Date of Birth is required. |
Validation errors not for webservice |
|
M |
33 |
200230133 |
First Name is missing. First Name is required. |
Validation errors not for webservice |
|
M |
34 |
200230134 |
Last Name is missing. Last Name is required. |
Validation errors not for webservice |
|
E |
35 |
200230135 |
Invalid MVR Provincial Service Code. |
Validation errors not for webservice |
|
M |
36 |
200230136 |
MVR Predictor returned an order MVR result. |
Information – MVR Predictor related |
|
M |
37 |
200230137 |
MVR Predictor returned a do NOT order result. |
Information – MVR Predictor related |
|
M |
38 |
200230138 |
MVR Predictor component is currently unavailable. |
Information – MVR Predictor related |
|
E |
01 |
200231001 |
Request Receipt cannot be null |
Getresponse related error
– trying to submit with no receipt number |
|
E |
02 |
200231002 |
Request Receipt must contain at least one value. |
Getresponse related error
– trying to submit with no receipt number |
|
E |
03 |
200231003 |
Invalid Requestor, object is null. |
System error |
|
M |
04 |
200231004 |
Request Receipt cannot be null |
Getresponse related error –
trying to submit with no receipt number |
|
M |
|
200231010 |
Invalid Request Receipt. |
Getresponse related error – the receipt number is likely more than 30 days old. It cannot be picked up anymore. |
|
M |
|
200231020 |
Response Pickup is not allowed. |
Getresponse related error – the MVR report is not ready. You get this message, when the ministry as slower response
times or a prolonged outage or maintenance. You need to
keep trying the pickups. |
|
M |
|
200231021 |
Response Pickup is not authorized. |
Getresponse related error
– the MVR receipt is not of the userid |
|
M |
|
200231022 |
Not authorized to pickup response in this province. |
System error not applicable to webservice |
|
M |
|
200231023 |
Pending Request |
|
|
M |
|
200231030 |
Invalid Service Code. |
System error not applicable to webservice |
|
M |
|
200231031 |
Invalid Response. |
System error not applicable to webservice |
|
M |
|
200231032 |
Invalid Province Code. |
System error not applicable to webservice |
|
M |
|
200231033 |
Record is locked by someone else |
System error not applicable to webservice |
|
M |
|
200231034 |
Response Pickup Error |
System error not applicable to webservice |
|
M |
|
200231035 |
Response Pickup Error - Print table is empty. |
System error not applicable to webservice |
|
|
|
200291402 |
Provider returned error |
This message is displayed when the Abstract picked up is an error. Webservice returns this code only for the getresponse method </DataFormatAbstractDT>
<MessageDT>
<RequestReceipt>9999999</RequestReceipt>
<Code>200291402</Code> <Text>Provider returned error</Text> </MessageDT> </MVRRequestResponseDS> Sequence: Webservice user requests a MVR
and get a receipt <MessageDT>
<RequestReceipt>9999999</RequestReceipt>
<Code>200230100</Code>
<Text>Request Completed
Successfully.</Text> </MessageDT> Webservice user uses Getresponse to pick up the response, and the Provider
(Ministry) is error <MessageDT>
<RequestReceipt>9999999</RequestReceipt>
<Code>200291402</Code> <Text>Provider returned error</Text> </MessageDT> </MVRRequestResponseDS> Webservice user uses Getresponse to pick up the response, and the Provider
(Ministry) is not error
<MessageDT>
<RequestReceipt>9999999</RequestReceipt>
<Code>200291400</Code>
<Text>Request Completed
Successfully.</Text>
</MessageDT> |
LV
Front End Messages
LV – Licence Validation messages are displayed if the
province Licence number is supplied and there is validation error. The
Transactions are not processed.
Example: Submitted ON
12345-123 and got the following in the MessageDT.
The transaction will not be processed further. Not all messages
apply to all provinces.
<MessageDT>
<RequestReceipt>-1</RequestReceipt>
<Code>LV01</Code>
<Text>The Licence Number
format is invalid.</Text>
</MessageDT>
|
Code |
Text |
Example |
|
LV01 |
The Licence
Number format is invalid. |
ON – and 12345-123 |
|
LV02 |
The Licence
Number Check Digit is incorrect. |
NS BOND 040760009 Date of
birth 13/01/1999 |
|
LV03 |
The Licence
Number Birthdate is invalid. |
Example ON B50094077600101 F (Female) and Date of birth
13/01/1999 |
|
LV04 |
The Last name initial does not
match. |
Not applicable for
Webservices |
|
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
Not applicable for
Webservices - this scenario is a SOAP error |
|
Prov |
Code |
Text |
|
ValidateMVRLicence(?,?,?) |
Lv03 |
The Licence
Number Birthdate is invalid. |
|
|
|
|
|
ValidateLicense(?,?,?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV10 |
Invalid ProvinceCode
parameter, Province code is empty, or not supported. |
|
|
|
|
|
ValidateABLicense(?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV01 |
The Licence
Number format is invalid. |
|
|
LV02 |
The Licence
Number Check Digit is incorrect. |
|
|
LV00 |
Valid. |
|
|
|
|
|
ValidateNBLicense(?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV01 |
The Licence
Number format is invalid. |
|
|
|
|
|
ValidateNLLicense(?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV01 |
The Licence
Number format is invalid. |
|
|
LV02 |
The Licence
Number Check Digit is incorrect. |
|
|
LV03 |
The Licence
Number Birthdate is invalid. |
|
|
|
|
|
ValidateNSLicense(?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV01 |
The Licence
Number format is invalid. |
|
|
LV02 |
The Licence
Number Check Digit is incorrect. |
|
|
LV03 |
The Licence
Number Birthdate is invalid. |
|
|
LV00 |
Valid. |
|
|
|
|
|
ValidateONLicense(?,?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV01 |
The Licence
Number format is invalid. |
|
|
LV03 |
The Licence
Number Birthdate is invalid. |
|
|
|
|
|
ValidatePELicense(?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV01 |
The Licence
Number format is invalid. |
|
|
|
|
|
ValidateLastNameInitial(?,?,?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV10 |
Invalid ProvinceCode
parameter, ProvinceCode is empty, or not supported. |
|
|
LV13 |
Invalid Last Name parameter,
Last Name is null or empty. |
|
|
|
|
|
ValidateNLLastNameInitial(?,?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV04 |
The Last name initial does not
match. |
|
|
LV13 |
Invalid Last Name parameter,
Last Name is null or empty. |
|
|
|
|
|
ValidateNSLastNameInital(?,?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV04 |
The Last name initial does not
match. |
|
|
LV13 |
Invalid Last Name parameter,
Last Name is null or empty. |
|
|
|
|
|
ValidateONLastNameInitial(?,?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV04 |
The Last name initial does not
match. |
|
|
LV13 |
Invalid Last Name parameter,
Last Name is null or empty. |
|
|
|
|
|
ValidateLastName(?,?,?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV10 |
Invalid ProvinceCode
parameter, ProvinceCode is empty, or not supported. |
|
|
LV13 |
Invalid Last Name parameter,
Last Name is null or empty. |
|
|
|
|
|
ValidateONLastName(?,?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV05 |
The Licence
number does not match the Driver's Last Name. |
|
|
LV13 |
Invalid Last Name parameter,
Last Name is null or empty. |
|
|
|
|
|
ValidateNSLastName(?,?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV05 |
The Licence
number does not match the Driver's Last Name. |
|
|
LV13 |
Invalid Last Name parameter,
Last Name is null or empty. |
|
|
|
|
|
ValidateFirstName(?,?,?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV10 |
Invalid ProvinceCode
parameter, ProvinceCode is empty, or not supported. |
|
|
LV14 |
Invalid First Name parameter,
First Name is null or empty. |
|
|
|
|
|
ValidateONFirstName(?,?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV06 |
The Licence
Number Birthdate is invalid. |
|
|
LV14 |
Invalid First Name parameter,
First Name is null or empty. |
|
|
|
|
|
ValidateMiddleName(?,?,?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV10 |
Invalid ProvinceCode
parameter, ProvinceCode is empty, or not supported. |
|
|
LV15 |
Invalid Middle Name parameter,
Middle Name is null or empty. |
|
|
|
|
|
ValidateONMiddleName(?,?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV06 |
The Licence
Number Birthdate is invalid. |
|
|
LV07 |
The Licence
Number does not match the Driver’s Middle Name. |
|
|
LV15 |
Invalid Middle Name parameter,
Middle Name is null or empty. |
|
|
|
|
|
ValidateBirthDate(?,?,?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV10 |
Invalid ProvinceCode
parameter, ProvinceCode is empty, or not supported. |
|
|
LV16 |
Invalid Birthdate parameter,
Birthdate is null or empty. |
|
|
|
|
|
ValidateNLBirthDate(?,?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV01 |
The Licence
Number format is invalid. |
|
|
LV08 |
The Driver's Birthdate does not
match the Licence Number Birthdate. |
|
|
LV16 |
Invalid Birthdate parameter,
Birthdate is null or empty. |
|
|
|
|
|
ValidateNSBirthDate(?,?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV08 |
The Driver's Birthdate does not
match the Licence Number Birthdate. |
|
|
LV16 |
Invalid Birthdate parameter,
Birthdate is null or empty. |
|
|
|
|
|
ValidateONBirthDate(?,?) |
LV11 |
Invalid Licence
parameter, Licence is empty or nothing. |
|
|
LV01 |
The Licence
Number format is invalid. |
|
|
LV08 |
The Driver's Birthdate does not
match the Licence Number Birthdate. |
|
|
LV16 |
Invalid Birthdate parameter,
Birthdate is null or empty. |