STATE OF MINNESOTA DEPARTMENT OF PUBLIC SAFETY

Transcription

1 STATE OF MINNESOTA DEPARTMENT OF PUBLIC SAFETY BUREAU OF CRIMINAL APPREHENSION Query Minnesota Motor Registration Information Service (QMV) Published On: Feb 09, 2012 Service Release Version#: 1.0 Prepared By: Bureau of Criminal Apprehension Criminal Justice Information Systems 1430 Maryland Avenue East St. Paul, Minnesota Service Visibility Service Description Accessibility Service Inputs Service Outputs SERVICE SUMMARY Public Restricted See Glossary for definitions This service provides users with the capability of retrieving information on vehicle registration BCA Criminal Justice Partners Vehicle Identification Number (VIN) and related information Vehicle License Plate Number (LIC) and related information MN DVS Motor Vehicle Registration

2 Document Revision History Date Version Description Author 02/09/ Initial Document BCA MNJIS 2/10/ :14:49 AM Page 2

3 Table of Contents SERVICE SUMMARY... 1 BUSINESS SERVICE DEFINITION... 4 QUERY MINNESOTA MOTOR REGISTRATION SERVICE... 4 SERVICE OVERVIEW... 4 REAL WORLD EFFECTS... 4 SUMMARY... 4 BUSINESS SCENARIOS... 5 INPUT DETAIL AND BUSINESS VALIDATION RULES... 5 SERVICE CONSUMERS AND ACCESS RIGHTS... 5 SERVICE-LEVEL EXPECTATIONS... 5 SERVICE LOGGING AND AUDITING REQUIREMENTS... 6 TRAINING AND CERTIFICATION... 6 POLICIES... 6 STATUTES AND RULES... 6 RULES... 6 STATUTES... 6 BUSINESS USE-CASE... 7 TECHNICAL SERVICE DEFINITION ACCESSING THE SERVICE PRE-CONDITIONS (TECHNICAL) POST-CONDITIONS (TECHNICAL) SERVICE INTERFACE MESSAGE FORMAT EXCEPTION CONDITIONS AND ERROR HANDLING SECURITY PROFILE APPENDIX A: GLOSSARY /10/ :14:49 AM Page 3

4 Business Service Definition Query Minnesota Motor Registration Service Service Overview The Query Minnesota Motor Registration (QMV) information service is a message key in the Law Enforcement Message Switch (LEMS) system that retrieves information on motor vehicle registration. QMV enables criminal justice personnel to identify the registered owner(s) of a vehicle along with specific information about the vehicle. Specific data retrieved includes MN motor vehicle registration. See the following example: Service Inputs: Vehicle License Number (LIC) with optional Vehicle License Year (LIY) or Vehicle Identification Number (VIN) Consumer of Service: BCA Criminal Justice Partner Provider of Service: DVS Service Outputs: MN Vehicle Registration Real World Effects The following is a list of effects of using this service: Summary A BCA criminal justice partner obtains vehicle s Minnesota vehicle registration. A User s application hub submits a service call to the BCA Enterprise Service Bus (ESB), which authorizes, authenticates, and validates the request. A valid request is then routed through the Law Enforcement Message Switch (LEMS) as a query to the required data source, the MN Driver and Vehicle Services Division (DVS) database. Either a vehicle registration or No Hit 2/10/ :14:49 AM Page 4

5 responses are returned to the BCA via the LEMS, is validated, and stored in the SQL Server database until the User Application Hub requests the response. The BCA ESB sends the vehicle registration response (if any) or No Hit response to the User Application Hub. Business Scenarios This service s resulting vehicle registration information will be used by law enforcement and other BCA criminal justice partners to verify compliance with motor vehicle laws, confirm vehicle and personal information during traffic incidents, conduct other types of investigations where a vehicle is involved, provide assistance and carry out enforcement actions. Input Detail and Business Validation Rules Mandatory QMV input includes the following criteria: Vehicle Identification Number (VIN) or Vehicle License Number (LIC) Optional criteria for QMV include: Vehicle License Year (LIY) The following validation rules apply to QMV service calls: Data inputs must be submitted in upper case alphanumeric characters with special characters as required or permitted for each input field. See Appendix A: Glossary for definitions and business rules. Service Consumers and Access Rights The authorized users of the QMV service are select BCA personnel and BCA criminal justice partners including but not limited to law enforcement officials, courts, probation officers, and parole officers. The QMV service is query-only. No updates occur with this service. Service-Level Expectations Support Availability Telephone and support for this service is available Monday through Friday, 7:00 a.m. to 4:30 p.m., except state holidays, through the BCA Service Desk at telephone number: , or bca.servicedesk@state.mn.us. Service Availability This service is designed to operate 24 hours a day, 7 days a week, 365 days a year. In addition to the support listed in the Support section above, BCA provides on-call 24/7/365 support for this service. After-hours support for high priority incidents can be obtained by calling the BCA Service Desk at or and choosing Option 1. External Service Dependencies The vehicle registration is provided through an interface with MN Driver and Vehicle Services Division (DVS); this service must be available to the BCA ESB via LEMS in order for the service to complete successfully. If DVS services are not available, the call will be repeated until the DVS service is available. 2/10/ :14:49 AM Page 5

6 The Law Enforcement Message Switch (LEMS) must be available in order for the service to complete successfully. Service Maintenance Window The LEMS and the ESB are designed to function 24 hour per day, seven days per week. When LEMS is down, it is for patches or upgrades, usually occurring on Tuesdays or Wednesdays at 11:00 AM and lasting five to ten minutes or longer, depending on the activity. These downtimes are announced and occur on an as-needed basis. Service Downtime Notification The message returned during system downtime and/or unavailability will depend on the source system and the destination system. Messages returned will either indicate the host system is unavailable or the request timed out. Expected Response Times Responses from each system queried are delivered separately to ensure the return of information as it becomes available. Average response times vary depending on the responding system as described below. DVS Responses: Service Logging and Auditing Requirements within one second For this computer-to-computer service, the consuming agency must keep a transaction record that is sufficient to satisfy FBI-CJIS requirements and to permit an audit or investigation of misuse to occur. FBI-CJIS audits occur on a three-year cycle and so the transaction record must be kept for three (3) years. At a minimum, the transaction record must contain the identifier for the individual who entered the query and received the results, when the transaction was done and why it was done. Training and Certification There is no separate training or certification requirement for this service. Individual users must meet FBI and/or MNJIS training and certification requirements for the underlying transaction. Policies There is no specific policy applicable to this service. Statutes and Rules Rules Statutes Minn. Stat classifies datas about motor vehicle registration. Driver s Privacy Protection Act, 18 U.S.C also controls access to and use of driver s license and motor vehicle information. 2/10/ :14:49 AM Page 6

7 Business Use-Case Main Flow Query The Main Flow for this use case is described below. Pre-Conditions The following must occur before the flow begins: 1. The following inputs are known and provided: Vehicle License Number (LIC) with optional Vehicle License Year (LYR), or Vehicle Identification Number (VIN) for a motor vehicle is known. Post-Conditions Success End-Conditions The following have occurred as a result of the successful completion of the main flow: 1. The query results in a hit or NOT ON FILE for MN DVS. 2. Hits collectively reveal the current registered owner(s) of the vehicle and information regarding the vehicle (make, model, VIN, sticker number). 3. Non-hits reveal that the data sources queried have no information on the vehicle in question. Failed End-Conditions The following have occurred as a result of the main flow failing: 1. One or more of the databases queried return an error message indicating information submitted was in some way erroneous. This may be due to a syntax error, missing data, a system failure, or a system being down. 2. The ESB security or archive service returns an error message to the agency hub reporting an error with authentication, authorization, or validation. 2/10/ :14:49 AM Page 7

8 QUERY MOTOR REGISTRATION (QMV) REQUEST INSTANCE Consumer Application HUB ESB LEMS Request Service LEMS, Data Source Data Server M1. Submit Request M2. Authorize, Authenticate, Validate M2.A. Receive Error Message N Pass? Y M3. Translate M4. Place hold in data store M6. Receive Message Receipt M5. Archive Req. Msg. Receipt M7. LEMS Queue M8. Query Data Sources M11. Hold in data store M10. Translate M9. LEMS Queue Request Response M1. Submit Request A law enforcement agent (user) initiates a query from the Consumer Application Hub, or hub. His or her system puts the request in XML format encased in a SOAP envelope, which is sent to the BCA. M2. Authorize, Authenticate, Validate The security service performs an authentication and authorization of the hub s ID and password to confirm whether the consumer application hub may request a QMV query. The message SOAP format is validated against the schema. Pass? If the authentication, authorization, and validation are successful, then the flow continues to M3. Translate. If the authentication, authorization, or validation is unsuccessful, then the flow continues to M2.A. Receive Error Message. M2.A. Receive Error Message The ESB sends an error message to the user, indicating either a failure to authenticate, pass authorization, or validate the schema. 2/10/ :14:49 AM Page 8

9 The user s hub receives the response message including the correlation ID. M3. Translate The XML message is translated to SIF format. M4. Place hold in data store A placeholder is placed in the data store. In this way, the data store is prepared to receive responses. M5. Archive Request Message Receipt The archive service archives the response message with correlation ID being sent to the hub. The full response to the client is archived, including the correlation ID for the request. M6. Receive Message Receipt The Consumer Application Hub receives a message confirming the query has been received, which includes a correlation ID. M7. LEMS Queue The query is placed in the LEMS Queue, where it waits until LEMS is able to process it. LEMS removes the query from its queue and directs it the required data sources. M8. Query Data Source DVS Database. The inquiry is received by Minnesota Drivers and Vehicle Services (DVS) data source. This data source returns vehicle registration information including the identity of its owner(s), past and present. A hit produces the desired information; a no hit produces a NOT ON FILE response. The response NO HIT D.L.REG. BUT M.V.REG ON FILE reveals a person owns a registered motor vehicle but does not have a driver s license. M9. LEMS Queue The query is placed in the LEMS Queue, where it waits until LEMS is able to process it. ESB removes the query result from its queue and directs them to SQL Database. M10. Translate The SIF message is translated into XML. M11. Hold in data store The separate responses received through LEMS from the data sources are held separately, until the user hub retrieves them by correlation ID. Main Flow Request Response The Main Flow for this use case is described below. 2/10/ :14:49 AM Page 9

10 Pre-Conditions The following must occur before the flow begins: 1. The response from the data source is received, translated to XML, validated, and stored in the data store. Post-Conditions Success End-Conditions The following have occurred as a result of the successful completion of the main flow: 1. Parsed XML is returned to the client. 2. The consumer of the service has a drivers license image for the person in question. Failed End-Conditions The following have occurred as a result of the main flow failing: 1. The database queried returns an error message indicating information submitted was in some way erroneous. This may be due to a syntax error, missing data, a system failure, or a system being down. 2. The ESB security or archive service returns an error message to the consumer application hub reporting an error with authentication, authorization, or validation. 2/10/ :14:49 AM Page 10

11 QUERY MOTOR REGISTRATION (QMV) RESPONSE INSTANCE Consumer Application HUB ESB LEMS Request Service Data Server Query Request M12. Request Response M13. Authorize, Authenticate, Validate M13.A. Receive Error Message N Pass? Y M14. Retrieve from data store M16. Validate M15. Create Response Y N All anticipated responses in? M18. Receive Response Message M17. Archive Request and Response M12. Request Response The consumer application hub requests responses for the query, sending the correlation ID as the transaction identifier. M13. Authorize, Authenticate, Validate The ESB authenticates the hub s identity and whether the hub is authorized to request the query results. Pass? If the authentication and authorization is successful, then the flow continues to M14. Retrieve from data store. If the authentication and authorization are not successful, then the results of the inquiry are withheld and an error message is sent to the hub; the flow continues to M13.A. Receive Error Message. M13.A. Receive Error Message The hub receives an error message indicating the ESB rejected the request due to a problem with authorization, authentication, or validation. M14. Retrieve from data store The query results are identified by correlation ID, copied from the data store, and brought into the ESB. M15. Create Response The various responses from the SQL database are formatted into a Response Message instance document. 2/10/ :14:49 AM Page 11

12 M16. Validate The Response Message instance is validated. Pass? If the response message is valid, then the flow continues to M17. Archive Request and Response. If the message is invalid, the results of the inquiry are withheld and an error response message is generated; the flow continues to M17. Archive Request and Response. M17. Archive Request and Response The valid response or error message response is sent to Archive Services. Either response is sent to the hub. M18. Receive Response Message The consumer application hub receives the response from the ESB in XML, in a SOAP envelope. All anticipated responses in? If one or more responses have not been received, the hub will repeat its request. This will continue until each of the message keys and their three data sources have given a valid response. The following fault conditions could exist: 1. One or more systems involved in this service is unavailable. 2. The service query request is unauthorized, fails to authenticate, or is invalid. 3. The data source returns an invalid response. 4. The service results request is unauthorized, fails to authenticate, or is invalid. Alternative Flows No alternative flows exist for this service. 2/10/ :14:49 AM Page 12

13 Technical Service Definition Accessing the Service Accessing the Query Minnesota Motor Registration Information service is restricted to systems on the CJDN network that have access to the BCA s ESB. The Query Minnesota Motor Registration Information Service interface is not discoverable. Once an agency is approved for access to this service, BCA will provide the Detailed Service Description document that includes access details. Pre-Conditions (Technical) MCJE compliant request Request is valid Request contains a valid instance of the BCA Header Access to this service is secured. The agency must have a valid MNJIS System user ID and password Post-Conditions (Technical) This is a read only service; therefore this service will not change the state or data All requests to and responses from this service will be archived Service Interface Provide Justice Partners the ability to submit Query Minnesota Motor Registration requests. Responses from this service are retrieved using the BCA Asynchronous Messaging pattern as follows: 1. Upon submitting a Query Minnesota Motor Registration request operation, the service returns a MessageReceipt that contains a unique correlation ID synchronously. 2. The service consumer will then make a RequestMessage request operation passing in the correlation ID obtained from the initial request. If the responses are available, an MCJE compliant ResponseMessage will be returned. If the responses are not available, an empty response will be returned by the service and the service consumer needs to make another RequestMessage request at a later time. Once an agency is approved for access to this service, BCA will provide the Detailed Service Description document that includes the WSDL. Message Format Communication to and from this service is handled using Simple Object Access Protocol (SOAP). Request and Response messages are XML instances that are embedded in the header and body of the SOAP envelope. Both the Request and Response XML messages conform to the BCA s Schema standards. There are multiple Schema files that define the request and response formats. The sample exchanges 2/10/ :14:49 AM Page 13

14 are meant to demonstrate several but not all possible query/response scenarios and can be used as a basis for understanding how to use this service. Once an agency is approved for access to this service, BCA will provide the Detailed Service Description document that includes the schemas and sample messages. Submission Request/Response Messages The following is a list of the supported request operations (refer to the request message schemas): o QueryMNMotorVehicleRegistrationRequest The response to the above requests is a MessageReceipt (refer to the MessageReceipt schema) that contains a unique correlation ID Retrieve Request/Response Messages The request for retrieving the responses is a RequestMessage (refer to the RequestMessage schema) The following is a list of the responses (refer to the response message schemas) that are wrapped in a ResponseMessage (refer to the ResponseMessage schema): o QueryMNMotorVehicleRegistrationResponse Exception Conditions and Error Handling This service will return a SOAP Fault if there is an error with the Service Consumer initiated calls If the consumer s request contains improper data in the BCA Header or service request, the XML response will contain a FailureReason that describes the error During processing unhandled exceptions happen for unknown and unpredicted reasons. When an unhandled exception occurs, a Fault is returned to the consumer of this service. The Fault element will contain any known information about the unhandled exception. Security Profile Access to this service is limited to criminal justice agencies that are connected to the State of Minnesota Criminal Justice Data Network (CJDN). Workstations and servers that access the services must be granted access by IP address through the BCA s firewall in order to reach the servers where the service is running. The IP addresses of all computers directly accessing the services must be provided to the BCA so that firewall rules can be created. This service operates over HTTPS on TCP/IP port 443. An SSL certificate is required to be installed on any workstation or server consuming this service. SSL certificates can be obtained from the BCA. When configuring the endpoint in a consuming client or service, make sure that https is specified. 2/10/ :14:49 AM Page 14

15 Appendix A: Glossary LIC (License Plate Number) license plate number of vehicle that is the subject of the query FORMAT: Format: alphanumeric, maximum 10 characters. BUSINESS RULES: If the license plate number exceeds ten characters, only the first ten characters should be entered in the LIC Field. LIY (License Year) License plate year of expiration; the highest year for which the license plate is valid FORMAT: numeric or NX for Non-Expiring, two or four characters. BUSINESS RULES: Must be a valid four-character year (YYYY) or the alphabetic NX to represent a nonexpiring registration. Must be greater than equal to the current year minus one and less than For stolen plates the value can be current year, current year minus one, or later than current year. VIN (Vehicle Identification Number) - a unique serial number used by the automotive industry to identify individual motor vehicles. FORMAT: alphanumeric, A-Z excluding the letters I, O, and Q; 0-9, 20 characters maximum. BUSINESS RULES: A single zero only, run of zeros only, single alphabetic only, all alphabetic characters only, or spaces, are prohibited. Vehicles manufactured prior to 1981 may have an alternate format. If the vehicle identification number exceeds 20 characters, only the last 20 characters should be entered in the VIN Field. The following terms are used in this document: Term Public Service Restricted Service Definition A service that it is available for anyone to consume. This includes anyone with access to a computer and the world wide web. A service that can only be consumed after authorization and configuration by the BCA. 2/10/ :14:49 AM Page 15