Case InformationWebservice

Case Information
Webservice /Data Exchange
Functional specification document
DuPage County
4/01/2013

INDEX

Introduction & Purpose

1.Business Process Overview

2.Process Detail

Case Information using case number

Cases on a party using name search

3.Error Codes and their description

Generic Errors

Case Number Request Errors

Name Search Request Errors

Introduction & Purpose

The purpose of this document is to describe the design of webservice that needs to be created by countiesfor making their case informationavailable through I2File.Each county will create a webservice for providing case data. I2File will consume the county webservice and display the case information in I2File.

Definitions, Acronyms and Abbreviations

Acronym / Meaning
CMS / Case Management System
Clerk / Clerk Circuit Court Clerk
I2F / I2File application

1.Business Process Overview

I2File will send requests to the webservices of different counties to get case information or the cases on a particular party and display the response received from counties in I2File.

2.Process Detail

  • I2File will send a request to county webservice, to get the case information or the cases on a party.
  • After the request from I2File is successfully validated,county webservice will send case information or the case list on a particular party.
  • Each county will provide credentials with which I2File can access their webservice.County needs to implement WS-securityforwebservice security. Refer <wsse:Security> with in <soapenv:Header> in sample request files for county webservice
  • I2File will retrieve case data every time user makes the request.Case data will not be stored in i2file.
  • There will be two methods in county webservicewhichI2File will call to get case information
  • Case information using case number
  • Cases on a party using name search
  • Method names, request and response parameters in the webservice to be exposed by counties are specified below.
  • Data exchange will be done using NIEM standards.
  • For simplicity we have used regular business names for request and response elements in this document. Click onNIEMMapping link on index page to check the NIEM compliant names for the request and response elements.

Case Informationusing case number

  • I2File will call getCaseInfoByCaseNumber method of county webservice to retrieve case information using case number
  • Following information should be sentby county webservice in response:
  • Case Title – Title of the case
  • CaseType – Countiesneed to pass Civil for civil cases and Criminalfor criminal cases
  • CaseFile Date – Case initiation date or file date
  • Case Activities- Counties need to pass the below mentioned information related to the activities on the case
  • Date – File date of the activity
  • Activity Description
  • Activity Reason
  • Image associated with the activity
  • Assigned Location
  • Attorney Information - Counties need to pass the below mentioned information related to the attorneys on case
  • FirstName
  • LastName
  • MiddleName
  • Filing For – Party for which attorney has filed an appearance on the case
  • Address Information – Address information should contain address type, Street name, city, state code and zip
  • Party Information – Counties need to pass the below mentioned information related to the parties on case
  • FirstName
  • LastName
  • MiddleName
  • Suffix
  • Company
  • PartyRole – Role of the party on the case. E.g. First Named defendant, Plaintiff, etc.
  • Race
  • Sex
  • DriverLicense Number
  • DriverLicense State
  • PhoneNumber
  • Address Information – Address information should contain address type, Street name, city, state code and zip
  • Court calendar Information – Counties need to pass the below listed informationrelated to the future schedules of the case
  • ScheduleType – Case schedule details like reason for the case schedule. E.g. Continued for hearing, Final Judgment, etc.
  • CourtLocation
  • CourtTime
  • CourtDate
  • Police Officer Information – Counties need to pass the below listed informationrelated to the police officers on the case
  • FirstName
  • LastName
  • MiddleName
  • BadgeNumber
  • Address Information – Address information should contain address type, Street name, city, state code and zip
  • Case Number
  • Case Status -Countiesneed to passany one of the below values in case status
  • Active if legal status of case in is active, reactive or inactive.
  • Reinstatedif case has been reinstated
  • Closedif case is closed
  • Violations– Counties need to pass the below listed information related to the violations on case
  • ComplaintNumber
  • ReferenceCode – Statue code for violation
  • Description – Description of the statue
  • Agency – Location of violation
  • NCIC Code
  • Click on schema design link on index page to view schema design of county webservice.
  • Sample request and response for getCaseInfoByCaseNumber method can be viewed by clicking Sample getCaseInfoByCaseNumber request and Sample getCaseInfoByCaseNumber response links on index page

Cases on a party using name search

  • I2File will call getPartyInfoByPartyName method of county webservice to get the list of cases on a party from county CMS
  • Below information will be sent by I2File in their request to county webservice:

Request Parameter Name / Mandatory in the request sent from I2File / Allowed Values
First Name / Will be optional in case of company else mandatory
Last Name / Any one of file date, last name or case categorywill be present in request from I2File
Middle Name / Optional
IsFirm / Optional (Default N) / Y or N
Case Category / Any one of file date, last name or case categorywill be present in request from I2File / Values in request will be civil or criminal
File Date / Any one of file date, last name or case categorywill be present in request from I2File
  • Following information should be sent by countywebservice in response:
  • FirstName
  • LastName
  • MiddleName
  • IsFirm (Party is an individual or company)
  • Case Number
  • Case Title – Title of case
  • Case File Date – Case initiation date or file date
  • Case Type–E.g. Adoption, Dissolution of marriage, etc.
  • Case Category - Counties need to pass Civil for civil cases and Criminal for criminal cases
  • Role (Party role such as First Name Defendant, Defendant or plaintiff)
  • Click on schema design link on index page to view schema design of county webservice.
  • Sample request and response for getPartyInfoByPartyName method can be viewed by clicking Sample getPartyInfoByPartyName request and Sample getPartyInfoByPartyName response links on index page

3.Error Codes and their description

Generic Errors

List below shows common error messages that could be thrown from the service.

CODE / DESCRIPTION
0010 / Client unauthorized to consume the web service
0020 / Server not available
0030 / Security violation
0040 / Invalid username or password
0050 / Invalid web service identifier in the request
0060 / Unknown parameter type in the request

Case Number Request Errors

List below shows the error messages for case number request.

CODE / DESCRIPTION
CI010 / Invalid case number format
CI020 / Court file does not exist
CI030 / Court Case should be Criminal or Civil
CI040 / Court Case is impounded
CI050 / Court Case is expunged

Name Search Request Errors

List below shows the error messages for Name Search request.

CODE / DESCRIPTION
NI010 / Last Name Or File Date or Case Type is required
NI020 / Last Name should be greater than 2 characters
NI030 / First Name should be greater than 2 characters
NI040 / IsFirm should contain Y or N
NI050 / StartingRecord Number is required
NI060 / TotalRecord Number is required
NI070 / TotalRecord Number should be greater then zero and less than or equal to 20
NI080 / Court Case should be Crimial or Civil

Page 1 of 8