STATE OF MINNESOTA DEPARTMENT OF PUBLIC SAFETY

Transcription

1 STATE OF MINNESOTA DEPARTMENT OF PUBLIC SAFETY BUREAU OF CRIMINAL APPREHENSION Minnesota Criminal Justice Statute Service Web Service Published On: January 7, 2013 Last Updated: Nov 13, 2018 Service Release Version#: 7.0 Prepared By: Bureau of Criminal Apprehension Criminal Justice Information Systems 1430 Maryland Avenue East St. Paul, Minnesota This document is to be provided only after an agency is approved for access to this Service

2 Document Revision History Date Version Description Author 12/07/ Initial Document Dave Kurth and Kari Schuch 2/19/ Added revision for the Statute Service Dave Kurth and Kari Schuch work under the CRS project that added UCR Offense Codes to the Statute Function. 03/07/ Added revision for the Statute Service Dave Anderson and Kent Verrill Enhancements 11/13/ Added new flags Wildlife Restitution & Nonviolent Controlled Substance Offender Review under section 2.n Sureshkannan Srinivasan & Dave Anderson Page 2 of 10

3 Table of Contents SERVICE ACCESS AND REQUIREMENTS... 4 BUSINESS RULES... 4 TECHNICAL DETAILS... 8 SUPPORTING DOCUMENTS... 8 APPENDIX A: GLOSSARY... 9 APPENDIX B: STATUTE SERVICE ERROR MESSAGE... 9 Page 3 of 10

4 Service Access and Requirements Environment Access Test Environment End Point Production Environment End Point This service does not require the client to submit UserId and Password on each request Supported Version(s) BCAHeader Schema N/A Business Rules 1. SEARCH CRITERIA Statute Service Version 7.0 The following is a list of possible search criteria: a. BasicSearchQuery i. Chapter ii. Section iii. Subdivision iv. Keyword v. Keyword Location (keywordqueryscope) vi. Effective Date (AsOfDate) vii. Effective Date Definition (AsOfDateQueryScope) viii. Function ix. Offense Level x. Flag xi. Statute ID b. GetLegislativeText i. Statute ID c. GetStatuteQuery i. Statute ID d. RetrieveUpdateQuery Page 4 of 10

5 i. StateDate ii. EndDate e. AllStatuteCountQuery f. AllStatuteQuery i. (firststatutesreturned) ii. maxstatutesreturned 2. VALIDATION OF SEARCH CRITERIA The supplied information in a search request must pass the following validations: a. Only one value can be supplied for each search criteria. b. When Chapter is supplied, it must be an alphanumeric value that does not exceed 16 characters in length. c. When Section is supplied, Chapter is required. d. When Section is supplied, it must be an alphanumeric value that does not exceed 16 characters in length. e. When Subdivision is supplied, Chapter and Section are required. f. When Subdivision is supplied, it must be an alphanumeric value that does not exceed 16 characters in length. g. When OffenseLevel is supplied, it must be one of the following values: i. Felony when requesting only felony statutes. ii. Gross Misdemeanor when requesting only gross misdemeanor statutes. iii. Misdemeanor when requesting only misdemeanor statutes. iv. Petty Misdemeanor when requesting only petty misdemeanor statutes. h. When Function is supplied, it must be one of the following values: i. Charge when requesting only this specific function type. ii. Criminal Rule when requesting only this specific function type. iii. Definition when requesting only this specific function type. iv. Enhancement when requesting only this specific function type. v. Incomplete when requesting only this specific function type. vi. Modifier when requesting only this specific function type. vii. Penalty when requesting only this specific function type. viii. Penalty (Other) when requesting only this specific function type. i. When Effective Date Definition is supplied, it must be one of the following values: i. 0 when requesting only statutes currently in effect. ii. 1 when requesting only statutes in effect on a specific date iii. 2 when requesting only statutes that went into effect on a specific date. j. When the Effective Date Definition is 1, AsOfDate must be supplied in the MM/DD/YYYY format to find statutes in effect on that date. i. Effective Date must be on or after 01/01/1859. k. When the Effective Date Definition is 2, AsOfDate must be supplied in the MM/DD/YYYY format to find statutes that went into effect on that date. Page 5 of 10

6 i. Effective Date must be on or after 01/01/1859. l. When a Keyword is supplied, it must not exceed 50 characters. m. When Keyword is supplied, one of the following KeywordQueryScope values must also be supplied: i. Summary when requesting only the statutes where the summary text contains the keyword(s) supplied. ii. Fulltext when requesting only the statutes where the legislative text contains the keyword(s) supplied. iii. Only one of the above values can be supplied for Keyword per request. n. When a Flag is supplied, it must be one of the following values: i. Crime of Violence when requesting only statutes with this specific flag. ii. Targeted Misdemeanor when requesting only statutes with this specific flag. iii. Predatory Offender Registration Review when requesting only statutes with this specific flag. iv. Enhanceable when requesting only statutes with this specific flag. v. Certify to DPS when requesting only statutes with this specific flag. vi. Report to DNR when requesting only statutes with this specific flag. vii. DPS Group when requesting only statutes with this specific flag. viii. Conditional Release when requesting only statutes with this specific flag. ix. Payable when requesting only statutes with this specific flag. x. Petty Misd Only if Prosecutor Certifies when requesting only statutes with this specific flag. xi. Third Violation Indicator when requesting only statutes with this specific flag. xii. Qualified Domestic Violence Related when requesting only statutes with this specific flag. xiii. Wildlife Restitution when requesting only statutes with this specific flag xiv. Nonviolent Controlled Substance Offender Review when requesting only statutes with this specific flag o. When StatuteID is supplied, it must not exceed 16 characters in length. 3. FIND MATCHING STATUTES Statutes that match all of the supplied criteria are found. 4. RETURN MATCHING STATUTES a. An empty or null result is returned when no matching statutes are found. b. BasicSearchQuery i. Statute ID ii. Chapter iii. Section Page 6 of 10

7 iv. Subdivision v. Year vi. Legislative Session Code vii. Session Text Indicator viii. Head Note Indicator ix. Effective Date x. Expiration Date xi. Enactment Date xii. Repealed Indicator xiii. Document Location URI xiv. Summary Description Text xv. Active Indicator xvi. Statute Function c. GetLegislativeText i. legislativetext d. GetStatuteQuery i. StatuteID ii. Chapter iii. Section iv. Subdivision v. Year vi. LegislativeSessionCode vii. SessionTextIndicator viii. HeadNoteIndicator ix. EffectiveDate x. EnactmentDate xi. ExpirationDate xii. ModifiedDate xiii. RepealedIndicator xiv. DocumentLocationURI xv. SummaryDescriptionText xvi. ActiveIndicator xvii. StatuteFunction e. RetrieveUpdateQuery i. Statute ID ii. Chapter iii. Section iv. Subdivision f. AllStatuteCountQuery i. Count of All Statutes (allstatutecount) Page 7 of 10

8 g. AllStatuteQuery i. StatuteID ii. Chapter iii. Section iv. Subdivision v. Year vi. LegislativeSessionCode vii. SessionTextIndicator viii. HeadNoteIndicator ix. EffectiveDate x. EnactmentDate xi. ModifiedDate xii. RepealedIndicator xiii. DocumentLocationURI xiv. SummaryDescriptionText xv. ActiveIndicator xvi. StatuteFunction Technical Details The following is the list of errors which could occur and when an action is required by the Service Consumers: o If the Statute web service returns an error for any reason, a response that includes the reason for the error is returned. It is the responsibly of the Service Consumers to take corrective actions to update and resubmit the request. Supporting Documents WSDL StatuteService.wsdl Page 8 of 10

9 Schemas Statute Service V7.zip Samples Attached is the SOAP-UI project XML file that can be imported to the SOAP-UI testing tool to submit version 7 Statute Service requests and view the responses. StatuteServiceV7-so apui-project.xml Appendix A: Glossary Term Public Service Restricted Service Private 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. A service that is only available internal to the BCA. That is, can only be consumed by other BCA services. Appendix B: Statute Service Error Message When the input properties are wrong, the system issues an error just like the following: <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <soap:body> Page 9 of 10

10 <soap:fault> <faultcode>userexception</faultcode> <faultstring>invalid Parameter(s): Chapter and Section: When searching by Subdivision, both Chapter and Section parameters are required.</faultstring> <detail/> </soap:fault> </soap:body> </soap:envelope> Page 10 of 10