ࡱ > M R bjbj== C W W oJ G n l , , ,
6 t " > $ b - - - P . l z. b kc "/ N p3 ( 3 3 @ 3 5 ; = b b b b b b b $ ie g c B 2 > B 5 5 > , ? c ^B B B 3 3 4 %c ^B ^B ^B $? : B 3 B 3 b ^B > b ^B ^B NK _ L B B ~a 3 / Ncyb \! - ^B :a " ~a l ;c 0 kc \a " yh ^B yh ~a ^B b b B B B B XML Standards Development Project Proposal for Query and Response Policy
Document Number
Current Version
October 22, 2002
Previous Version(s)
August 20, 2002
August 5, 2002
July 1, 2002
February 10, 2002
December 10, 2001
November 30, 2001
Workgroup Information
Workgroup Name: OASIS LegalXML Court Filing Technical Committee
Workgroup Co-Chairs: John Greacen, Mary Campbell McQueen
Sub-Workgroup Name: LegalXML CMS API Subgroup
Sub-Workgroup Chair: Moira Rowley
Workgroup Mailing List: legalxml-courtfiling-cms-api@lists.oasis-open.org
Workgroup Mailing List Archive:
Document Author(s)
Shane Durham ( HYPERLINK "mailto:shane.durham@lexisnexis.com" shane.durham@lexisnexis.com)
Previous Author(s)
Dwight R. Daniels ( HYPERLINK "mailto:drdaniels@kpmg.com" drdaniels@kpmg.com)
Marty Halvorson ( HYPERLINK "mailto:martyh@nmcourts.com" martyh@nmcourts.com)
Document Editor(s)
Roger Winters ( HYPERLINK "mailto:Roger.Winters@metrokc.gov" Roger.Winters@metrokc.gov)
Short Statement of Status
Proposal for consideration by Technical Committee workgroup.
Abstract
This document describes a proposal to express Query and Response Policy, the court policy for LegalXML Query and Response system.
Status of Document
This is a Court Filing Technical Committee Proposal for consideration.
TOC \o "1-3" \h \z HYPERLINK \l "_Toc22999046" Abstract PAGEREF _Toc22999046 \h 1
HYPERLINK \l "_Toc22999047" Status of Document PAGEREF _Toc22999047 \h 1
HYPERLINK \l "_Toc22999048" 1 Introduction PAGEREF _Toc22999048 \h 3
HYPERLINK \l "_Toc22999049" 1.1 Conventions PAGEREF _Toc22999049 \h 3
HYPERLINK \l "_Toc22999050" 1.2 Document Description PAGEREF _Toc22999050 \h 3
HYPERLINK \l "_Toc22999051" 1.3 Assumptions and Requirements PAGEREF _Toc22999051 \h 4
HYPERLINK \l "_Toc22999052" 1.4 Terminology PAGEREF _Toc22999052 \h 4
HYPERLINK \l "_Toc22999053" 1.5 Date and Time Format PAGEREF _Toc22999053 \h 4
HYPERLINK \l "_Toc22999054" 1.6 White Space Treatment PAGEREF _Toc22999054 \h 4
HYPERLINK \l "_Toc22999055" 1.7 Extensions PAGEREF _Toc22999055 \h 4
HYPERLINK \l "_Toc22999056" 2 The Document Type Definitions PAGEREF _Toc22999056 \h 5
HYPERLINK \l "_Toc22999057" 3 Element Specification PAGEREF _Toc22999057 \h 6
HYPERLINK \l "_Toc22999058" 3.1 supportedQueries PAGEREF _Toc22999058 \h 6
HYPERLINK \l "_Toc22999059" 3.2 query PAGEREF _Toc22999059 \h 6
HYPERLINK \l "_Toc22999060" 3.2.1 queryName PAGEREF _Toc22999060 \h 6
HYPERLINK \l "_Toc22999061" 3.2.2 queryDescription PAGEREF _Toc22999061 \h 6
HYPERLINK \l "_Toc22999062" 3.2.3 queryParameters PAGEREF _Toc22999062 \h 6
HYPERLINK \l "_Toc22999063" 3.3 responseRecord PAGEREF _Toc22999063 \h 8
HYPERLINK \l "_Toc22999064" 3.3.1 responseElement PAGEREF _Toc22999064 \h 8
HYPERLINK \l "_Toc22999065" 4 Examples PAGEREF _Toc22999065 \h 9
HYPERLINK \l "_Toc22999066" 4.1 getCaseActorList PAGEREF _Toc22999066 \h 9
HYPERLINK \l "_Toc22999067" 4.2 getCaseList PAGEREF _Toc22999067 \h 10
HYPERLINK \l "_Toc22999068" 4.3 getCaseCalendar PAGEREF _Toc22999068 \h 11
HYPERLINK \l "_Toc22999069" 4.4 getCaseDocument PAGEREF _Toc22999069 \h 12
HYPERLINK \l "_Toc22999070" 4.5 getCaseHistory PAGEREF _Toc22999070 \h 12
HYPERLINK \l "_Toc22999071" 4.6 getCaseInformation PAGEREF _Toc22999071 \h 13
HYPERLINK \l "_Toc22999072" 5 Revision History PAGEREF _Toc22999072 \h 15
Introduction
This Query and Response Policy proposal enables an organization to define the queries it wishes to support.
It describes an XML solution for expressing extensions and restrictions to the LegalXML Query and Response standard. It enables a court to publish its supported query set in a manner that may be interpreted by remote systems, such that they can automatically present users with the courts query options.
This specification is the product of a consensus process. The workgroup received valuable input on many items, from participants representing multiple viewpoints. The positions and views were often not identical. When discussed items needed to be closed, this was usually done when the question Is there anyone who cannot live with this? met with silence. On some occasions, decisions were made based on an overwhelming majority.
Finally, this proposal represents work almost entirely extracted from previous drafts of LegalXML Query and Response.
Conventions
Within this document the terms shall and must are used to describe mandatory items. The term may is used to describe optional items.
This proposal conforms to the XML 1.0 Specification ( HYPERLINK "http://www.w3.org/TR/REC-xml.html" http://www.w3.org/TR/REC-xml.html).
Courier New font is used for the Document Type Definition or portions thereof.
Ariel font is used for elements or attributes from a DTD when referred to in the body of the text.
Times New Roman font set in quotation marks and italicized is used to indicate a non-literal textual representation, e.g. of a transmitted file.
Document Description
This document includes a DTD that is to be used to validate the syntax of XML documents describing query and response policy. Any annotations appearing inside a DTD, which add further definition and specification, shall be binding.
The examples provided in this document are non-normative. Where there is a conflict between an example and the DTDs or the body of this document, or between the body of this document and the underlying DTD, the DTD shall be considered normative and ruling.
Assumptions and Requirements
All assumptions and requirements from Court Filing apply.
Terminology
All terms defined in Court Filing apply.
Date and Time Format
All date and time formats from Court Filing apply.
White Space Treatment
It is often convenient to use white space (spaces, tabs, and blank lines) to set apart the markup for greater readability.
Court Filing Query and Response Policy XML processors may:
Discard leading and trailing white space contained within any element content returned to the sender in a response message.
Convert strings of white space characters into a single space character (#x20) contained within any element or attribute content returned to the sender in a response message.
It is expected that Court Filing XML processors shall discard leading and trailing white space contained within any element or attribute content returned to the sender in a response message.
Extensions
Extension rules from Court Filing apply.
The Document Type Definitions
Element Specification
supportedQueries
The supportedQueries and supportedQuery element express a list of query definitions supported by a court.
query
query provides a mechanism for describing a request for court information. Within the elements a court may specify the queries it will accept, and the required and optional input parameters.
queryName
The queryName element identifies a supported query. A submitted queryName must provide an exact match of one of the supported queries described by this Policy XML. If an exact match is not found, an errorMessage shall be returned (see REF _Ref13035925 \r \h 3.3 below).
queryDescription
The queryDescription is used to provide an explanation of the purpose of the query and what information it provides to the user. The queryDescription is intended to assist with human readablity and does not affect theacceptability of a submitted query.
queryParameters
The queryParameters element contains the parameters needed to fulfill a query.
parameter
In a query, the parameter element is used to convey the individual data parameters, if any, that may be submitted with the query. Named parameters are supported by the parameterName element, and each parameter shall have a unique name in the query. Wherever possible, the parameterName should coincide with the established elements and attributes of the LegalXML data dictionary and contain the same information.
The parameterName element contains the name by which each parameter is known. All parameters within a query shall have unique names. The required attribute indicates if a parameter must be provided in a submitted query. The label attribute contains an alternate designation, e.g., the local vernacular, for the parameter to be used as a label for the input field. The label is intended to assist with human readablity and does not effect the acceptability of a submitted query.
The parameterDescription element contains provides an explanation of the nature and purpose of the parameter for presentation to the user, e.g., as a mouse over help feature. The parameterDescription is intended to assist with human readablity and does not effect the acceptability of a submitted query.
The parameterDatatype element specifies the data type of the parameter. Valid parameterDatatype values are the built-in datatypes of the XML Schema Part 2: Datatypes recommendation.
responseRecord
The responseRecord element describes the information that will be returned when a system processes a given valid query.
responseElement
The responseElement describes the individual pieces (ie columns, cells, objects) of the responseRecord.
The elementName element contains the name by which each responseElement is known. All responseElements within a query shall have unique names. The label is intended to assist with human readablity.
The elementName should coincide with the established elements and attributes of the LegalXML data dictionary and contain the same information. If the elementName does not coorespond with established LegalXML elements, then the following elementDataType and elementAttribute should be used to describe the new responseElement.
The elementDatatype and elementAttribute elements optionally express the XML definition of a previously undefined responseElement. It should not be included in the policy set if the cooresponding responseElement represents data defined elsewhere in the LegalXML dictionary (ie. CourtFiling 1.x, Query and Response 1.x, Document 1.x). These policy elements are to be used when the court needs to define result data not previously described by the LegalXML dictionary. Valid elementDatatype values are the built-in datatypes of the XML Schema Part 2: Datatypes recommendation.
Examples
In this section, an example of how Query and Response Policy can be used to describe the standard queries defined by the LegalXML Query and Response standard.
By adjusting these sample policies, an organization can express restrictions or extensions to the standard query set. To avoid confusion, query extensions or restrictions should be given new names that do not coincide with the standard set defined by LegalXML Query and Response.
getCaseActorList
getCaseActorList
Use this query to find the list of case participantsand their roles.
fullCaseNumber
string
lastName
string
firstName
string
caseActorStatus
actor
getCaseList
getCaseList
Use this query to get a listing of all currently active cases in which the person is involved.
lastName
string
firstName
string
middleName
string
caseInformation
getCaseCalendar
getCaseCalendar
This query will give you a list of all hearings currently scheduled for the case.
fullCaseNumber
string
courtEvent
getCaseDocument
getCaseDocument
courtDocumentReference
integer
documentContent
getCaseHistory
getCaseHistory
View the Case Registry of Actions
fullCaseNumber
string
lastName
string
firstName
string
docketEntry
getCaseInformation
getCaseInformation
Provides information about the case.
fullCaseNumber
string
caseInformation
Revision History
DateEditorMajor Change(s)1/7/02Dwight R. DanielsMajor revision of entire document. Change of author to Dwight R. Daniels.1/24/02Roger Winters, Marty HalvorsonEditing of revised document.1/28/02Dwight R. DanielsIncorporation of comments from 1/24/02 editing; further corrections and restructuring of document; addition of Query and Response Summary Table.2/10/02Dwight R. DanielsChange of eventType to courtEventType; modification of dateFilter content model. Other minor revisions and release for comment.7/1/02Dwight R. DanielsFundamental change in approach and major revision of entire document.8/5/02Dwight R. DanielsNormalized the standard queries and placed them within their own section of the document.8/20/02Dwight R. DanielsAdded authentication, queryIdentification and respondsTo elements. Added label attribute to parameterName element. Renamed getActorRole query to getCaseActorRole and revised input parameters and response elements to support getting a list of actors on a case. Added actorIdentifier element to standard queries with name parameters. Eliminated getCourtPolicy from list of standard queries.10/22/02Shane DurhamExtracted policy work from prior draft of Query and Response. Renamed and re-titled document to indicate the documents policy focus. Remove references to authentication and privilege levels to be consistent with current draft of Query and Response specification. Enabled responseElementDataType to be optional so that courts need not express the data types of compound elements referenced from existing LegalXML standards. Indicated where prior portions of policy DTD had not been defined; took a stab at providing some draft language for some of those undefined elements. Updated example policy set related to standard query set to reflect recent changes to current draft of Query and Response specification.
The concept of Case Management System Data Configuration XML, or CDC XML, has also been introduced into the discussion and suggested as the location where a court would define its supported queries. The relationship between CDC XML and Court Policy XML has not been finalized, but it seems likely that CDC XML will be one segment within the larger Court Policy XML. For this reason, this specification refers to Court Policy XML without thereby intending to indicate a specific, or even preferred, resolution to the issue. On CDC XML see EFM-CMS Interface Requirements, v. 7, 1.
Query and Response Policy [Proposal]
FILENAME QueryAndResponsePolicyProposal2002_10_22.doc PAGE 15
PAGE \# "'Page: '#''" Previously undefined
PAGE \# "'Page: '#''" Previously undefined.
PAGE \# "'Page: '#''" Previously undefined.
PAGE \# "'Page: '#''" Previously undefined.
PAGE \# "'Page: '#''" Previously undefined.
I |
> Q _ ` & ' O P Q d e . 7 - . / 0 K L M N V 栮 j >*B*Uph
j 0J UOJ QJ hOJ QJ KH B* OJ QJ ph j Uhj Uj U0J j U j U B*ph 5CJ0 > I Y [ k |
J > Q g z
d d d d oN P $Q R - . 7 w
i
# s & u -
1$
&