JNET Messages Volume II V1.0.0 - Legal XML · 2019-11-22 · JNET Messages Volume II 6/5/01 organization unit name, followed by individual topic names. This optional organization

JNET Messages Volume II

Version 1.0.0


6/5/01

Table of Contents

1. INTRODUCTION......................................................................................................................... 2

1.1 DOCUMENT SECTIONS ............................................................................................................. 2 2. TOPIC NAMING STANDARD.................................................................................................... 3

2.1 EVENT MESSAGE TOPICS ........................................................................................................ 3 2.2 REQUEST /REPLY TOPICS ........................................................................................................ 3 2.3 HIERARCHICAL TOPIC STRUCTURE .......................................................................................... 3

3. MESSAGE STRUCTURE AND ELEMENT NAMING STANDARD ........................................ 6 3.1 DOCUMENT ROOT ELEMENT.................................................................................................... 6 3.2 ELEMENT NAMING CONVENTION............................................................................................. 6

4. COMMON ELEMENTS............................................................................................................... 7 4.1 NAME..................................................................................................................................... 7 4.2 ADDRESS................................................................................................................................ 8 4.3 PHONE.................................................................................................................................... 9 4.4 SIMPLE ELEMENTS: SSN, EMAIL, SEX, DOB, … ................................................................... 11 4.5 REPLYHEADER ..................................................................................................................... 11 4.6 TRANSACTION STATUS.......................................................................................................... 13

5. EVENT MESSAGE TYPES........................................................................................................ 15 5.1 CONTACT ............................................................................................................................. 15 5.2 INMATE MOVEMENT ............................................................................................................. 23 5.3 DETAINER ............................................................................................................................ 29 5.4 STATE PAROLE VIOLATION ................................................................................................... 35 5.5 OUT STATE MOTOR VEHICLE VIOLATION .............................................................................. 44 5.6 INMATE CLASSIFICATION ...................................................................................................... 52

6. REQUEST AND REPLY MESSAGE TYPES............................................................................ 58 6.1 RECIPIENT ADDRESS REQUEST .............................................................................................. 58 6.2 RECIPIENT ADDRESS REPLY .................................................................................................. 63 6.3 GENERIC REQUEST................................................................................................................ 71


6/5/01

1. INTRODUCTION There are two volumes of the JNET Messages document, this is Volume II of JNET Messages. This document was created during FY 00/01, it provides JNET Messaging Infrastructure (JNET MI), Message Distributor, based naming standards and it is a central reference for all newly implemented FY 00/01 event messages. Volume I of this document provides naming standards and a central reference for all pre-FY00/01 JNET MI implemented messages. The naming standards provide naming conventions for Topics and Event Message formats. For messages implemented during FY 00/01, this document provides a class model, an element list with their corresponding descriptions, an XML (eXtensible Markup Language) sample file, a DTD (Document Type Definition) file and an XML Schema. JNET agency, system maintenance and enhancement personnel should use this document as a reference to help achieve uniformity in event message naming.

1.1 DOCUMENT SECTIONS

The major document sections are: Topic naming standard:

JNET Event Message Topics, Request/Reply Topics and Hierarchical Topic Structure naming standards are described here.

Message structure and element naming standard:

JNET Event Message Document Root Element and Element Naming Convention standards are described here.

Common elements:

Common elements, that occur across multiple event messages, are identified and described here.


6/5/01

2. TOPIC NAMING STANDARD The JNET MI is a publish/subscribe based messaging environment. Event messages are published to JMS topics. Request applications publish request messages to request topics and/or receive reply messages from reply topics. Reply applications subscribe to request topics and publish reply messages to reply topics. With this topic-naming standard, JNET MI users can easily identify topics in which they are interested. NOTE: This Topic Naming Standard will be implemented into production JNET by 8/1/01.

2.1 EVENT MESSAGE TOPICS

In general, a particular topic delivers a particular message type, for example, the Arrest topic only handles the arrest message. Different message types are usually handled by different topics. Topic names should reflect event message types. For text messages, XML schemas and DTDs are defined. The root element names also reflect event types. Currently JNET only supports text messages. For text based XML messages, our topic-naming standard is as follows: Topic name = Event type name = XML document root tag name. In the future, if JNET agency requirements define the need to deliver non-text based messages, such as scanned documents, PDF documents, or binary messages (voice, video, images), the topic naming standard for non-text based messages is as follows: Topic name = Event type name

2.2 REQUEST /REPLY TOPICS

Request/reply topics are regular paired topics. Topic names will reflect the message types and whether they are request or reply. Our topic naming standard for request/reply message types are: Request topic name should have a message type name followed by suffix “Request”. Reply topic name should have a message type name followed by suffix “Reply”.


6/5/01

organization unit name, followed by individual topic names. This optional organization unit can keep hierarchical structure expandable, especially for large organizations which may have many departments, each owning their own topics.. Our hierarchical topic naming standard is : PAJNET/Organization name[/Organization unit name] … /Topic name The attached diagram describes all available topics and their hierarchical structures to be delivered to production JNET by the end of July 2001. Here is examples how applications can leverage hierarchical topic structure features:

1. Assuming DOC has three event message topics: Detainer, InmateMovement, and InmateClassification. Their hierarchical topic names are: PAJNET/DOC/Detainer, PAJNET/DOC/InmateMovement, and PAJNET/DOC/InmateClassification.

2. If the PSP publishes Arrests, and FBI publishes Arrests, their hierarchical topic names are: PAJNET/PSP/Arrest and FEDS/FBI/Arrest.

Application A is interested in all of the messages from DOC. It’ll subscribe to PAJNET/DOC/* even application A does not know how many and what topics are available from DOC. Application B is interested in all arrest messages. It’ll subscribe to */*/Arrest, even though application B does not know what organization and how many organizations publish Arrest messages through JNET.


6/5/01

Page 5 of 6

PAJNET

Contact

Disposition

PCCDJTS PBPPDPWDOTDOCAOPC PSP

GreenSheet

Want

JuvenileInfo

RecipientAddressReply

RecipientAddressRequest

OutStateMotorVehicleViolation

Misconduct

InmateMovement

InmateClassification

Detainer

Warrant

PFA

ContactRequest

ReleaseOrder

Arrest

Contact

JuvenileArrest

JNETService

WebDelivery

EmailDelivery

StateParoleViolation

ContactReply

Figure 1. JNET Topic Hierarchical Structure Diagram


6/5/01

3. MESSAGE STRUCTURE AND ELEMENT NAMING STANDARD

3.1 DOCUMENT ROOT ELEMENT

A message document root element is an element at the top of the XML hierarchical tree. The element has a message ID attribute and a timestamp attribute. These two attributes are JNET standards and are mandated by the JNET Office via the Architectural Governance and Oversight team. An agency can define any other attributes at the message root level based on their own business needs. The root element usually contains some common elements.

3.2 ELEMENT NAMING CONVENTION

One of the goals of naming convention is to make element names self-descriptive and specific. This naming convention uses the following rules:

1. A name always starts with capital letter, for example: Address. 2. A word always starts with capital letter in multi-word names, for example:

FirstName, PhiladelphiaPhotoNumber. 3. Acronyms and abbreviations are all capital and only well-known acronyms or

abbreviations are included, for example: SID, OTN, DOB. 4. No space or any other separator in between words. 5. Duplicate element names representing different things are not allowed. Identical

names under different namespaces are not duplicates. 6. Unnecessary abbreviation should be avoided, for example CD for Code, DT for

Date. 7. If abbreviation is necessary, the abbreviation should be consistent, i.e. you don’t

use different abbreviations for the same thing in your document (Nmbr, No, #, Nbr for Number).


6/5/01

4. COMMON ELEMENTS In the first design iteration, the following common elements were identified. Additional common elements are expected in the future as more JNET event message types are designed.

4.1 NAME

The Name element consists of one attribute, Type, and five elements. With the attribute Type, the Name element can support multiple different kinds of names when referenced by a parent element, for example a criminal may have multiple names. Type may have a default value such as “official”. The enumeration list of Type attribute can be expanded when new name types are defined.

4.1.1 Name Class Model

Name

TypeLastNameFirstNameMiddleNameSuffixTitle

4.1.2 Name Element/Attribute Descriptions Element/Attribute Name Description Type Name type i.e. official, alias, … LastName Person’s last name FirstName Person’s first name MiddleName Person’s middle name, optional Suffix Person’s name suffix, optional Title Person’s title, optional


6/5/01

<!ELEMENT Suffix (#PCDATA)> <!ELEMENT Title (#PCDATA)>

4.2 ADDRESS

The Address element consists of one attribute, Type, and eight elements. With the attribute Type, the Address element can support multiple kinds of addresses when referenced by a parent element, for example a person or an organization may have multiple addresses for different purposes. This attribute is implied (optional). The enumeration list of Type attribute can be expanded when new address types are defined.

4.2.1 Address Class Model

AddressTypeAddressLine1AddressLine2CityStateZipCodeZipExtensionCountyDistrict

4.2.2 Address Element/Attribute Descriptions Element/Attribute Name Description Type Address type i.e. business, home, … AddressLine1 Address line 1 AddressLine2 Address line 2 (optional) City City State State in abbreviation ZipCode 5 digit zip code


6/5/01

4.2.3 Address XML DTD <!ELEMENT Address (AddressLine1,AddressLine2?,City,State,ZipCode,ZipExtension?,County?, District?)> <!ATTLIST Address Type (mailing | billing | business | home) #IMPLIED > <!ELEMENT AddressLine1 (#PCDATA)> <!ELEMENT AddressLine2 (#PCDATA)> <!ELEMENT City (#PCDATA)> <!ELEMENT State (#PCDATA)> <!ELEMENT ZipCode (#PCDATA)> <!ELEMENT ZipExtension (#PCDATA)> <!ELEMENT County (#PCDATA)> <!ELEMENT District (#PCDATA)> <!ELEMENT Title (#PCDATA)>

4.3 PHONE

The Phone element consists of one attribute, Type, and two elements. With the attribute Type, the Phone element can support multiple kinds of phones when referenced by a parent element. For example a person or an organization may have multiple phones for different purposes such as a cell or business phone number. This attribute is implied (optional). The enumeration list of Type attribute can be expanded when new phone types are defined.

4.3.1 Phone Class Model

PhoneTypePhoneNumberPhoneExtension

4.3.2 Phone Element/Attribute Descriptions


6/5/01

4.3.3 Phone XML DTD <!ELEMENT Phone (PhoneNumber,PhoneExtension)> <!ATTLIST Phone Type (business | home | cell | pager | fax | others) #IMPLIED > <!ELEMENT PhoneNumber (#PCDATA)> <!ELEMENT PhoneExtension (#PCDATA)>


6/5/01

4.4 SIMPLE ELEMENTS: SSN, EMAIL, SEX, DOB, …

Simple elements don’t have child elements. The following simple elements are commonly used. As the number of JNET message types grows, more simple elements will be developed.

4.4.1 Simple Element Class Model

DOBEmail

EyeColorHeight

SexSSN

WeightRace

4.4.2 Simple Element Element/Attribute Descriptions Element/Attribute Name Description SSN Social security number Email Email address Sex Sex DOB Date of birth Race Race Height Height Weight Weight EyeColor Eye color

4.4.3 Simple Element XML DTD <!ELEMENT SSN (#PCDATA)> <!ELEMENT Email (#PCDATA)> <!ELEMENT Sex (#PCDATA)> <!ELEMENT DOB (#PCDATA)> <!ELEMENT Race (#PCDATA)> <!ELEMENT Height (#PCDATA)>


6/5/01

the replier’s information and some of the original request information. ReplyHeader element has an Error element and an OriginalRequest element. A reply message could contain a requested message or an empty message if no match was found. A reply message also can return zero to many errors. OriginalRequest element has name ANY. ANY is a key word in XML DTD. It is a space holder for any element definition. Here, ANY is reserved for original request element. The actual element could be a JNET provided generic Request element or an agency designed request element. The reason to have this option is to maximize the flexibility that agencies may want to design a specific request document to best fit their reply application needs.

4.5.1 ReplyHeader Class Model

ErrorErrorCodeErrorDescript ion

Reply HeaderReplyApplicationIDReplyAgencyIDMatchIndicator

0..*

OriginalRequest

11

0..*

4.5.2 ReplyHeader Element/Attribute Descriptions Element/Attribute Name Description ReplyApplicationID Reply application id ReplyAgencyID Reply agency id MatchIndicator If the reply has a match or not for the request Error Return error from replier


6/5/01

<!ELEMENT ReplyHeader (MatchIndicator,Error*,OriginalRequest)> <!ATTLIST ReplyHeader ReplyApplicationID CDATA #REQUIRED ReplyAgencyID CDATA #IMPLIED > <!ELEMENT MatchIndicator (#PCDATA)> <!ELEMENT Error (ErrorCode,ErrorDescription)> <!ELEMENT ErrorCode (#PCDATA)> <!ELEMENT ErrorDescription (#PCDATA)> <!ELEMENT OriginalRequest ANY>

4.6 TRANSACTION STATUS

If a message document is transactional and could have one of multiple transaction status types, a message provider may want to include transaction status in a message document. For example, add, update, delete or any other status type may be useful. The attribute Type is required (mandated). The enumeration list of Type attribute can be expanded when new status types are defined. If a message provider only publishes single type of transactions, TransactionStatus element may not be required. For example, PSP always publish new arrests, so the TransactionStatus of ‘new’ isn’t required.

4.6.1 TransactionStatus Class Model

TransactionStatusTypeTransactionDateEffectiveDate

4.6.2 TransactionStatus Element/Attribute Descriptions Element/Attribute Name Description Type Transaction status type such as add, delete, update TransactionDate Transaction date EffectiveDate Effective date of the transaction


6/5/01


6/5/01

5. EVENT MESSAGE TYPES Event message types are published by publishers on topics when event occur. The interesting parties can subscribe to corresponding topics to obtain event messages when these messages are available.

5.1 CONTACT

Contact message type is designed for agencies to publish contact information such as trooper, judge, constable or deputy sheriff. It consists of some common elements and some optional agency specific elements so that it can be used across multiple agencies.

5.1.1 Contact Class Model

0..1

CertificationTypeCertificationNumberExpirationDate

PoliceOrganizationStateLocalCodeBadgeNumberORIStationLocationCode


NameTy peLastNameFirstNameMiddleNameSuffixTit le



AssignmentLocationType

EmailSSN

ContactTypeMessageIDTimestampIdentificationNumberIdentificationType

0..10..1

0..10..1

0..1

11

1..*1..*

0..*0..*

0..*0..*

0..*0..*0..10..1


6/5/01

IdentificationType Identification type, i.e. employee number, bar number,

… required. Type (in Contact) Contact person’s type, i.e. Judge, trooper, constable, … ,

required SSN See common element section, optional Name See common element section for detail Address See common element section for detail Email See common element section for detail Phone See common element section for detail, optional PhoneNumber See common element section for detail, optional AssignmentLocation District name or county name a judge assigned to Type (in AssignmentLocation)

Assignment type such as justice district, magisterial district, primary or secondary county, …

Certification Any certification CertificationNumber Certification number Type (in Certification) Certification type such as constable, deputy sheriff ExpirationDate Expiration date of the certification PoliceOrganization This element is only for trooper BadgeNumber Police badge number ORI ORI number StationLocationCode PSP station location code StateLocalCode State local code such as PS, MP TransactionStatus See common element section for detail, optional

5.1.3 Contact XML DTD <!ELEMENT Contact (Name,Address+,Phone*,Email*,SSN?,AssignmentLocation*,Certification?,PoliceOrganization?,TransactionStatus?)> <!ATTLIST Contact MessageID ID #REQUIRED Timestamp CDATA #IMPLIED IdentificationNumber CDATA #REQUIRED IdentificationType (employee-number | bar-number | certification-number) #REQUIRED


6/5/01

<!ELEMENT Title (#PCDATA)> <!ELEMENT Address (AddressLine1,AddressLine2?,City,State,ZipCode,ZipExt ension?,County?,District?)> <!ATTLIST Address Type (mailing | billing | business | home) #IMPLIED > <!ELEMENT AddressLine1 (#PCDATA)> <!ELEMENT AddressLine2 (#PCDATA)> <!ELEMENT City (#PCDATA)> <!ELEMENT State (#PCDATA)> <!ELEMENT ZipCode (#PCDATA)> <!ELEMENT ZipExtension (#PCDATA)> <!ELEMENT County (#PCDATA)> <!ELEMENT District (#PCDATA)> <!ELEMENT Phone (PhoneNumber,PhoneExtension?)> <!ATTLIST Phone Type (business | home | cell | pager | fax | others) #IMPLIED > <!ELEMENT PhoneNumber (#PCDATA)> <!ELEMENT PhoneExtension (#PCDATA)> <!ELEMENT Email (#PCDATA)> <!ELEMENT SSN (#PCDATA)> <!ELEMENT AssignmentLocation (#PCDATA)> <!ATTLIST AssignmentLocation Type (judicial-district | county-1 | county-2 | magisterial-district) #REQUIRED > <!ELEMENT Certification (CertificationNumber,ExpirationDate)> <!ATTLIST Certification Type (PA-Constable | PA-Deputy-Sheriff | other) "other" > <!ELEMENT CertificationNumber (#PCDATA)> <!ELEMENT ExpirationDate (#PCDATA)> <!ELEMENT PoliceOrganization (BadgeNumber,ORI,StationLocat ionCode)> <!ATTLIST PoliceOrganization StateLocalCode (SP | MP) #IMPLIED > <!ELEMENT BadgeNumber (#PCDATA)> <!ELEMENT ORI (#PCDATA)> <!ELEMENT StationLocationCode (#PCDATA)> <!ELEMENT TransactionStatus (TransactionDate?,EffectiveDate?)> <!ATTLIST TransactionStatus


6/5/01

<schema> <element name="Contact" content="elementOnly"> <group order="sequence"> <element name="Name" /> <element name="Address" minOccurs='1' maxOccurs='*'/> <element name="Phone" minOccurs='0' maxOccurs='*'/> <element name="Email" minOccurs='0' maxOccurs='*'/> <element name="SSN" minOccurs='0' maxOccurs='1'/> <element name="AssignmentLocation" minOccurs='0' maxOccurs='*'/> <element name="Certification" minOccurs='0' maxOccurs='1'/> <element name="PoliceOrganization" minOccurs='0' maxOccurs='1'/> <element name="TransactionStatus" minOccurs='0' maxOccurs='1'/> </group> <attribute name="MessageID" type="string" minOccurs="1"/> <attribute name="Timestamp" type="timeInstance"/> <attribute name="IdentificationNumber" type="string" minOccurs="1"/> <attribute name="IdentificationType" type="string" minOccurs="1"> <datatype source = "NMTOKEN"> <enumeration value = "employee -number"/> <enumeration value = "bar-number"/> <enumeration value = "certification -number"/> </datatype> </attribute> <attribute name="Type" type="string" minOccurs="1"> <datatype source = "NMTOKEN"> <enumeration value = "judge"/> <enumeration value = "trooper"/> <enumeration value = "constable"/> <enumeration value = "deputy -sheriff"/> <enumeration value = "clerk"/> </datatype> </attribute> </element> <element name="Name" content="elementOnly"> <group order="sequence"> <element name="LastName" /> <element name="FirstName" />


6/5/01

</element> <element name="LastName" type="string" content="textOnly"> </element> <element name="FirstName" type="string" content="textOnly"> </element> <element name="MiddleName" type="string" content="textOnly"> </element> <element name="Suffix" type="string" content="textOnly"> </element> <element name="Title" type="string" content="textOnly"> </element> <element name="Address" content="elementOnly"> <group order="sequence"> <element name="AddressLine1" /> <element name="AddressLine2" minOccurs='0' maxOccu rs='1'/> <element name="City" /> <element name="State" /> <element name="ZipCode" /> <element name="ZipExtension" minOccurs='0' maxOccurs='1'/> <element name="County" minOccurs='0' maxOccurs='1'/> <element name="District" minOccurs='0' maxOccurs='1'/> </group> <attribute name="Type" type="" default="business"> <datatype source = "NMTOKEN"> <enumeration value = "mailing"/> <enumeration value = "billing"/> <enumeration value = "business"/> <enumeration value = "home"/> </datatype> </attribute> </element> <element name="AddressLine1" type="string" content="textOnly"> </element> <element name="AddressLine2" type="string" content="textOnly"> </element>


6/5/01

</element> <element name="County" type="string" content="textOnly"> </element> <element name="District" type="string" content="textOnly"> </element> <element name="Phone" content="elementOnly"> <group order="sequence"> <element name="PhoneNumber" /> <element name="PhoneExtension" minOccurs='0' maxOccurs='1'/> </group> <attribute name="Type" type=""> <datatype source = "NMTOKEN"> <enumeration value = "business"/> <enumeration value = "home"/> <enumeration value = "cell"/> <enumeration value = "pager"/> <enumeration value = "fax"/> <enumeration value = "others"/> </datatype> </attribute> </element> <element name="PhoneNumber" content="textOnly"> </element> <element name="PhoneExtension" content="textOnly"> </element> <element name="Email" type="string" content="textOnly"> </element> <element name="SSN" type="string" content="textOnly"> </element> <element name="AssignmentLocation" conte nt="textOnly"> <attribute name="Type" type="" minOccurs="1"> <datatype source = "NMTOKEN"> <enumeration value = "judicial -district"/> <enumeration value = "county -1"/>


6/5/01

<attribute name="Type" type="string" default="other"> <datatype source = "NMTOKEN"> <enumeration value = "PA -Constable"/> <enumeration value = "PA-Deputy-Sheriff"/> <enumeration value = "other"/> </datatype> </attribute> </element> <element name="CertificationNumber" content="textOnly"> </element> <element name="ExpirationDate" type="date" content="textOnly"> </element> <element name="PoliceOrganization" content="elementOnly"> <group order="sequence"> <element name="BadgeNumber" /> <element name="ORI" /> <element name="StationLocationCode" /> </group> <attribute name="StateLocalCode" type=""> <datatype source = "NMTOKEN"> <enumeration value = "SP"/> <enumeration value = "MP"/> </datatype> </attribute> </element> <element name="BadgeNumber" type="string" content="textOnly"> </element> <element name="ORI" type="string" content="textOnly"> </element> <element name="StationLocationCode" type="string" content="textOnly"> </element> <element name="TransactionStatus" content="elementOnly"> <group order="sequence"> <element name="TransactionDate" minOccurs='0' maxOccurs='1'/>


6/5/01

<element name="TransactionDate" type="date" content="textOnly"> </element> <element name="EffectiveDate" type="date" content="textOnly"> </element> </schema>


6/5/01

5.1.5 Contact XML Sample <?xml version='1.0'?> <!DOCTYPE Contact SYSTEM "http://www.jnet.state.pa.us/metadatarepository/dtds/Contact.dtd" > <Contact MessageID=”91282736” Timestamp=”4/18/2001 10:32” IdentificationType="bar-number" PersonType="judge" IdentificationNumber="A1231245"> <Name Type=”official”> <LastName>Smith</LastName> <FirstName>John</FirstName> <MiddleName>T.</MiddleName> <Suffix>Jr.</Suffix> <Title>Mr.</Title> </Name> <Address Type="mailing"> <AddressLine1>John Smith Office</Addre ssLine1> <AddressLine2>300 Judge Plaza</AddressLine2> <City>Johnstown</City> <State>PA</State> <ZipCode>17654</ZipCode> <ZipExtension>7788</ZipExtension> </Address> <Address Type="home"> <AddressLine1>800 Follower Drive</Address Line1> <City>Garden City</City> <State>PA</State> <ZipCode>17123</ZipCode> </Address> <Phone Type="business"/> <PhoneNumber>7177301234</PhoneNumber> </Phone> <SSN>781236453</SSN> <AssignmentLocation Type="magisterial -district"> Cumberland</AssignmentLocation> <TransactionStatus Type="update"> <TransactionDate>12/2/2000</TransactionDate> <EffectiveDate>4/20/2001</EffectiveDate> </TransactionStatus> </Contact>


6/5/01

5.2.1 Inmate Movement Class Model

InmateMovementMessageIDTimestampOTNInmateNumber

NameTypeLastNameFirstNameMiddleNameSuffixTitle

SSNDOB

OutStateSIDState

Sex

MovementTypeMovementDateArrivalTimeDepartureLocationDestinationLocation


11

0..10..1

PhiladelphiaPhotoNumber

SubjectSID

1..*1..*

1..*1..*1..*1..*

0..*0..*

11

11

0..1

FBINumber

0..1

0..1

0..1

5.2.2 Inmate Movement Element/Attribute Description Element/Attribute Name Description MessageID Unique number for a message Timestamp Timestamp when a message issued OTN Offense tracking number issued by AOPC InmateNumber Inmate number issued by DOC Subject Person’s demographic information SID State ID issued by State Police Philadelphia PhotoNumber Philadelphia photo number FBINumber FBI number


6/5/01

MovementDate Movement date ArrivalTime Movement arrival time DepartureLocation Location moved from DestinationLocation New or current location TransactionStatus See common element section for detail, optional

5.2.3 Inmate Movement XML DTD <!ELEMENT InmateMovement (Subject,OTN,InmateNumber,Movement,TransactionStatus?)> <!ATTLIST InmateMovement MessageID ID #REQUIRED Timestamp CDATA #IMPLIED > <!ELEMENT Subject (PhiladelphiaPhotoNumber?,FBINumber?,OutStateSID*,Name+,DOB+,Sex,SSN+)> <!ATTLIST Subject SID CDATA #IMPLIED > <!ELEMENT OTN (#PCDATA)> <!ELEMENT InmateNumber (#PCDATA)> <!ELEMENT Movement (MovementDate,ArrivalTime,DepartureLocation,DestinationLocation)> <!ATTLIST Movement Type CDATA #IMPLIED > <!ELEMENT TransactionStatus (TransactionDate,EffectiveDate?)> <!ATTLIST TransactionStatus Type (add | delete | update | other) #REQUIRED > <!ELEMENT PhiladelphiaPhotoNumber (#PCDATA)> <!ELEMENT FBINumber (#PCDATA)> <!ELEMENT Name (LastName,FirstName,MiddleName?,Suffix?,Title?)> <!ATTLIST Name Type (Official | Alias | Street | nickname) "Official" > <!ELEMENT DOB (#PCDATA)> <!ELEMENT Sex (#PCDATA)>


6/5/01

<!ELEMENT MovementDate (#PCDATA)> <!ELEMENT ArrivalTime (#PCDATA)> <!ELEMENT DepartureLocation (#PCDATA)> <!ELEMENT DestinationLocation (#PCDATA)> <!ELEMENT TransactionDate (#PCDATA)> <!ELEMENT EffectiveDate (#PCDATA)>

5.2.4 Inmate Movement XML Schema <?xml version="1.0"?> <schema> <element name="InmateMovement" content="elementOnly"> <group order="sequence"> <element name="Subject" /> <element name="OTN" /> <element name="InmateNumber" /> <element name="Movement" /> <element name="TransactionStatus" minOccurs='0' maxOccurs='1'/> </group> <attribute name="MessageID" type="ID" minOccurs="1"/> <attribute name="Timestamp" type="string"/> </element> <element name="Subject" content="elementOnly"> <group order="sequence"> <element name="PhiladelphiaPhotoNumber" minOccurs='0' maxOccurs='1'/> <element name="FBINumber" minOccurs='0' maxOccurs='1'/> <element name="OutStateSID" minOccurs='0' maxOccurs='*'/> <element name="Name" minOccurs='1' maxOccurs='*'/> <element name="DOB" minOccurs='1' maxOccurs='*'/> <element name="Sex" /> <element name="SSN" minOccurs='1' maxOccurs='*'/> </group> <attribute name="SID" type="string"/> </element> <element name="OTN" type="string" content="textOnly"> </element>


6/5/01

<attribute name="Type" type="string"/> </element> <element name="TransactionStatus" content="elementOnly"> <group order="sequence"> <element name="TransactionDate" /> <element name="EffectiveDate" minOccurs='0' maxOccurs='1'/> </group> <attribute name="Type" type="" minOccurs="1"> <datatype source = "NMTOKEN"> <enumeration value = "a dd"/> <enumeration value = "delete"/> <enumeration value = "update"/> <enumeration value = "other"/> </datatype> </attribute> </element> <element name="PhiladelphiaPhotoNumber" ty pe="string" content="textOnly"> </element> <element name="FBINumber" type="string" content="textOnly"> </element> <element name="Name" content="elementOnly"> <group order="sequence"> <element name="LastName" /> <element name="FirstName" /> <element name="MiddleName" minOccurs='0' maxOccurs='1'/> <element name="Suffix" minOccurs='0' maxOccurs='1'/> <element name="Title" minOccurs='0' maxOccurs='1'/> </group> <attribute name="Type" type="" default="Official"> <datatype source = "NMTOKEN"> <enumeration value = "Official"/> <enumeration value = "Alias"/> <enumeration value = "Street"/> <enumeration value = "nickname"/> </datatype> </attribute> </element>


6/5/01

</element> <element name="LastName" type="string" content="te xtOnly"> </element> <element name="FirstName" type="string" content="textOnly"> </element> <element name="MiddleName" type="string" content="textOnly"> </element> <element name="Suffix" type="string" content="textOnly"> </element> <element name="Title" type="string" content="textOnly"> </element> <element name="MovementDate" type="date" content="textOnly"> </element> <element name="ArrivalTime" type="timeInstance" content="textOnly"> </element> <element name="DepartureLocation" type="string" content="textOnly"> </element> <element name="DestinationLocation" type="string" content="textOnly"> </element> <element name="TransactionDate" type="date" content="textOnly"> </element> <element name="EffectiveDate" type="date" content="textOnly"> </element> </schema>


6/5/01

5.2.5 Inmate Movement XML Sample <?xml version='1.0'?> <!DOCTYPE InmateMovement SYSTEM "http://www.jnet.state.pa.us/metadatarepository/dtds/InmateMovement.dtd" > <InmateMovement Timestamp="4/23/2001 10:30" MessageID="12313543"> <Subject SID="12312233"> <PhiladelphiaPhotoNumber>438487429832</PhiladelphiaPhotoNumber> <FBINumber>43543453</FBINumber> <OutStateSID State=”FL”>98989898</OutStateSID> <Name Type="Official"> <LastName>Smith</LastName> <FirstName>John</FirstName> <MiddleName>H.</MiddleName> <Suffix>Jr.</Suffix> </Name> <DOB>03/21/1960</DOB> <DOB>04/05/1970</DOB> <Sex>M</Sex> <SSN>123456789</SSN> <SSN>987654321</SSN> </Subject> <InmateNumber>4574574576</InmateNumber> <OTN>A12897663</OTN> <Movement Type="new"> <MovementDate>2/1/2000</MovementDate> <MovementArrivalTime>2/1/2000 11:32</MovementArrivalTime> <DepartureLocation>Philadelphia</DepartureLocation> <DestinationLocation>Cumberland</DestinationLocation> </Movement> </InmateMovement>

5.3 DETAINER

A Detainer is part of the overall criminal justice process whereby a particular jurisdiction wants an individual to answer to a charge or charges that have been filed against that


6/5/01


SentenceChargeChargeDescriptionMinSentenceDateMaxSentenceDate


SubjectSID

1..*1..*

DetainerMessageIDTimestampOTNInmateNumberDetainerStatusDetainerTypeDetainerNumberSubmittingAgencyAgencyDetainerNumberRemarksDetainerLiftedDate

1..*1..*

0..10..1

11

5.3.2 Detainer Element/Attribute Descriptions Element/Attribute Name Description MessageID Unique number for a message Timestamp Timestamp when a message issued Subject Person’s demographic information SID State ID issued by PSP Name See common element section for detail OTN Offense tracking number issued by AOPC InmateNumber Inmate number issued by DOC DetainerStatus Detainer status


6/5/01

MinSentenceDate Minimum sentence date MaxSentenceDate Maximum sentence date TransactionStatus See common element section for detail, optional

5.3.3 Detainer XML DTD <!ELEMENT Detainer (Subject,OTN,InmateNumber,DetainerStatus, DetainerType,DetainerNumber,SubmittingAgency,AgencyDetainerNumber, Remarks,DetainerLiftedDate,SentenceCharge+,TransactionStatus?)> <!ATTLIST Detainer MessageID ID #REQUIRED Timestamp CDATA #IMPLIED DetainerStatus (new | changed | removed | other) #REQU IRED DetainerType CDATA #IMPLIED DetainerNumber CDATA #IMPLIED > <!ELEMENT Subject (Name+,PhiladelphiaPhotoNumber?,FBINumber?)> <!ATTLIST Subject SID CDATA #IMPLIED > <!ELEMENT Name (LastName,FirstName,MiddleName?,Suffix?,Title?)> <!ATTLIST Name Type (Official | Alias | Street | nickname) "Official" > <!ELEMENT LastName (#PCDATA)> <!ELEMENT FirstName (#PCDATA)> <!ELEMENT MiddleName (#PCDATA)> <!ELEMENT Suffix (#PCDATA)> <!ELEMENT Title (#PCDATA)> <!ELEMENT PhiladelphiaPhotoNumber (#PCDATA)> <!ELEMENT FBINumber (#PCDATA)> <!ELEMENT OTN (#PCDATA)> <!ELEMENT InmateNumber (#PCDATA)> <!ELEMENT DetainerStatus (#PCDATA)> <!ELEMENT DetainerType (#PCDATA)> <!ELEMENT DetainerNumber (#PCDATA)> <!ELEMENT SubmittingAgency (#PCDATA)> <!ELEMENT AgencyDetainerNumber (#PCDATA)> <!ELEMENT Remarks (#PCDATA)> <!ELEMENT DetainerLiftedDate (#PCDATA)> <!ELEMENT SentenceCharge


6/5/01

5.3.4 Detainer XML Schema <?xml version="1.0"?> <schema> <element name="Detainer" content="elementOnly"> <group order="sequence"> <element name="Subject" /> <element name="OTN" /> <element name="InmateNumber" /> <element name="DetainerStatus" /> <element name="DetainerType" /> <element name="DetainerNumber" /> <element name="SubmittingAgency" /> <element name="AgencyDetainerNumber" /> <element name="Remarks" /> <element name="DetainerLiftedDate" /> <element name="SentenceCharge" minOccurs='1' maxOccurs='*'/> <element name="TransactionStatus" minOccurs='0' maxOccurs='1'/> </group> <attribute name="MessageID" type="ID" minOcc urs="1"/> <attribute name="Timestamp" type="string"/> <attribute name="DetainerStatus" type="" minOccurs="1"> <datatype source = "NMTOKEN"> <enumeration value = "new"/> <enumeration value = "chang ed"/> <enumeration value = "removed"/> <enumeration value = "other"/> </datatype> </attribute> <attribute name="DetainerType" type="string"/> <attribute name="DetainerNumber" type="string" /> </element> <element name="Subject" content="elementOnly"> <group order="sequence"> <element name="Name" minOccurs='1' maxOccurs='*'/> <element name="PhiladelphiaPhotoNumber" minOccurs='0' maxOccurs='1'/> <element name="FBINumber" minOccurs='0' maxOccurs='1'/>


6/5/01

<element name="Title" minOccurs='0' maxOccurs='1'/> </group> <attribute name="Type" type="" default="Official"> <datatype source = "NMTOKEN"> <enumeration value = "Official"/> <enumeration value = "Alias"/> <enumeration value = "Street"/> <enumeration value = "nickname"/> </datatype> </attribute> </element> <element name="LastName" type="string" content="textOnly"> </element> <element name="FirstName" type="string" content="textOnly"> </element> <element name="MiddleName" type="string" content="textOnly"> </element> <element name="Suffix" type="string" content="textOnly"> </element> <element name="Title" type="string" content="textOnly"> </element> <element name="PhiladelphiaPhotoNumber" type="string" content="textOnly"> </element> <element name="FBINumber" type="string" content="textOnly"> </element> <element name="OTN" type="string" content="textOnly"> </element> <element name="InmateNumber" type="string" content="textOnly"> </element> <element name="DetainerStatus" type="string" content="textOnly"> </element>


6/5/01

</element> <element name="Remarks" type="string" content="textOnly"> </element> <element name="DetainerLiftedDate" type="date" content="textOnly"> </element> <element name="SentenceCharge" content="elementOnly"> <group order="sequence"> <element name="ChargeDescription" /> <element name="MinSentenceDate" /> <element name="MaxSentenceDate" /> </group> </element> <element name="ChargeDescription" type="string" content="textOnly"> </element> <element name="MinSentenceDate" type="string" content="textOnly"> </element> <element name="MaxSentenceDate" type="string" content="textOnly"> </element> <element name="TransactionStatus" content="elementOnly"> <group order="sequence"> <element name="TransactionDate" /> <element name="EffectiveDate" minOccurs='0' maxOccurs='1'/> </group> <attribute name="Type" type="" minOccurs="1"> <datatype source = "NMTOKEN"> <enumeration value = "add"/> <enumeration value = "delete"/> <enumeration value = "update"/> <enumeration value = "other"/> </datatype> </attribute> </element> <element name="TransactionDate" type="date" content="textOnly">


6/5/01

5.3.5 Detainer XML Sample <?xml version='1.0'?> <!DOCTYPE Detainer SYSTEM "http://www.jnet.state.pa.us/metadatare pository/dtds/Detainer.dtd" > <Detainer Timestamp="2/11/2001" MessageID="12131314"> <Subject SID=”12345678”> <Name Type="official"> <LastName>Doe</LastName> <FirstName>John</FirstName> </Name> </Subject> <OTN>45645623</OTN> <InmateNumber>7657467456</InmateNumber> <DetainerStatus>AAAA</DetainerStatus> <DetainerType>new</DetainerType> <DetainerNumber>2313131</DetainerNumber> <SubmittingAgency>Cumberland PD</SubmittingAgency> <AgencyDetainerNumber>452124141</AgencyDetain erNumber> <Remarks>This person is wanted by LA PD</Remarks> <DetainerLiftedDate>12/10/2000h</DetainerLiftedDate> <SentenceCharge> <ChargeDescription>BB</ChargeDescription> <MinSentenceDate>123</MinSentenceDate> <MaxSentenceDate>2134</MaxSentenceDate> </SentenceCharge> <SentenceCharge> <ChargeDescription>ZZ</ChargeDescription> <MinSentenceDate>23</MinSentenceDate> <MaxSentenceDate>123</MaxSentenceDate> </SentenceCharge> </Detainer>

5.4 STATE PAROLE VIOLATION

A State Parole Violation involves the offender who has been released on state parole and


6/5/01

ParoleOfficer


OfficeAssignment




SSN

DOB

SentenceChargeChargeDescriptionMinSentenceDateMaxSentenceDate


11

11

SubjectSID

1..*1..*

1..*1..*

1..*1..*

1..*1..*

1..*1..*

StateParoleViolationMessageIDTimestampInmateNumberParoleNumberParoleStatusCodeParoleStatusDescriptionParoleStartDateParoleStatusChangeDate

1..*1..*

0..10..1

11

11

5.4.2 State Parole Violation Element/Attribute Descriptions MessageID Unique number for a message Timestamp Timestamp when a message issued InmateNumber Inmate number issued by DOC ParoleNumber Parolee number issued by PBPP Subject Person’s demographic information SID State ID issued by State Police Name See common element section for detail Address See common element section for detail Phone See common element section for detail


6/5/01

SentenceCharge Sentence charge ChargeDescription Charge description MaxSentenceDate Maximum sentence date MinSentenceDate Minimum sentence date ParoleOfficer Parole officer information OfficeAssignment Office assigned for the parole officer Name (in ParoleOfficer) Parole officer’s name TransactionStatus See common element section for detail

5.4.3 State Parole Violation XML DTD <!ELEMENT StateParoleViolation (Subject,InmateNumber,ParoleNumber, ParoleStatusCode,ParoleStatusDescription,ParoleStartDate, ParoleStatusChangeDate,ParoleOfficer,SentenceCharge+, TransactionStatus?)> <!ATTLIST StateParoleViolation MessageID ID #REQUIRED Timestamp CDATA #REQUIRED > <!ELEMENT Subject (Name,DOB*,Sex,SSN*,Address+,Phone+)> <!ATTLIST Subject SID CDATA #REQUIRED > <!ELEMENT Name (LastName,FirstName,MiddleName?,Suffix?,Title?)> <!ATTLIST Name Type (official | alias | street) #IMPLIED > <!ELEMENT LastName (#PCDATA)> <!ELEMENT FirstName (#PCDATA)> <!ELEMENT MiddleName (#PCDATA)> <!ELEMENT Suffix (#PCDATA)> <!ELEMENT Title (#PCDATA)> <!ELEMENT DOB (#PCDATA)> <!ELEMENT Sex (#PCDATA)> <!ELEMENT SSN (#PCDATA)> <!ELEMENT Address (AddressLine1,AddressLine2?,City,State,ZipCode,ZipExtension?,County?, District?)> <!ATTLIST Address Type (home | business) #IMPLIED


6/5/01

Type (home | business | cell | fax) #IMPLIED > <!ELEMENT PhoneNumber (#PCDATA)> <!ELEMENT PhoneExtension (#PCDATA)> <!ELEMENT InmateNumber (#PCDATA)> <!ELEMENT ParoleNumber (#PCDATA)> <!ELEMENT ParoleStatusCode (#PCDATA)> <!ELEMENT ParoleStatusDescription (#PCDATA)> <!ELEMENT ParoleStartDate (#PCDATA)> <!ELEMENT ParoleStatusChangeDate (#PCDATA)> <!ELEMENT ParoleOfficer (Name,OfficeAssignment)> <!ELEMENT OfficeAssignment (#PCDATA)> <!ELEMENT SentenceCharge (ChargeDescription,MaxSentenceDate,MinSentenceDate)> <!ELEMENT ChargeDescription (#PCDATA)> <!ELEMENT MinSentenceDate (#PCDATA)> <!ELEMENT MaxSentenceDate (#PCDATA)> <!ELEMENT TransactionStatus (TransactionDate,EffectiveDate)> <!ATTLIST TransactionStatus Type (add | delete | update) #IMPLIED > <!ELEMENT TransactionDate (#PCDATA)> <!ELEMENT EffectiveDate (#PCDATA)>

5.4.4 State Parole Violation XML Schema <?xml version="1.0"?> <schema> <element name="StateParoleViolation" content="elementOnly"> <group order="sequence"> <element name="Subject" /> <element name="InmateNumber" /> <element name="ParoleNumber" /> <element name="ParoleStatusCode" /> <element name="ParoleStatusDescription " /> <element name="ParoleStartDate" /> <element name="ParoleStatusChangeDate" /> <element name="ParoleOfficer" /> <element name="SentenceCharge" minOccurs='1' maxOccurs='*'/> <element name="TransactionStatus" minOccurs='0' maxOccurs='1'/> </group>


6/5/01

<element name="SSN" minOccurs='0' maxOccurs='*'/> <element name="Address" minOccurs='1' maxOccurs='*'/> <element name="Phone" minOccurs='1' maxOccurs='*'/> </group> <attribute name="SID" type="string" minOccurs="1"/> </element> <element name="Name" content="elementOnly"> <group order="sequence"> <element name="LastName" /> <element name="FirstName" /> <element name="MiddleName" minOccurs='0' maxOccurs='1'/> <element name="Suffix" minOccurs='0' maxOccurs='1'/> <element name="Title" minOccurs='0' maxOccurs='1'/> </group> <attribute name="Type" type="string"> <datatype source = "NMTOKEN"> <enumeration value = "official"/> <enumeration value = "alias"/> <enumeration value = "street"/> </datatype> </attribute> </element> <element name="LastName" type="string" content="textOnly"> </element> <element name="FirstName" type="string" content="textOnly"> </element> <element name="MiddleName" type="string" content="textOnly"> </element> <element name="Suffix" type="string" content="textOnly"> </element> <element name="Title" type="string" content="textOnly"> </element> <element name="DOB" type="date" content="textOnly"> </element> <element name="Sex" type="string" content="textOnly">


6/5/01

<element name="ZipCode" /> <element name="ZipExtension" minOccurs='0' maxOccurs='1'/> <element name="County" minOccurs='0' maxOccurs='1'/> <element name="District" minOccurs='0' maxOccurs='1'/> </group> <attribute name="Type" type="string"> <datatype source = "NMTOKEN"> <enumeration value = "home"/> <enumeration value = "business"/> </datatype> </attribute> </element> <element name="AddressLine1" type=" string" content="textOnly"> </element> <element name="AddressLine2" type="string" content="textOnly"> </element> <element name="City" type="string" content="textOnly"> </element> <element name="State" type="string" content="textO nly"> </element> <element name="ZipCode" type="string" content="textOnly"> </element> <element name="ZipExtension" type="string" content="textOnly"> </element> <element name="County" type="string" content="textOnly"> </element> <element name="District" type="string" content="textOnly"> </element> <element name="Phone" content="elementOnly"> <group order="sequence"> <element name="PhoneNumber" /> <element name="PhoneExtension" minOc curs='0' maxOccurs='1'/> </group>


6/5/01

</element> <element name="PhoneExtension" type="string" con tent="textOnly"> </element> <element name="InmateNumber" type="string" content="textOnly"> </element> <element name="ParoleNumber" type="string" content="textOnly"> </element> <element name="ParoleStatusCode" type="string" conten t="textOnly"> </element> <element name="ParoleStatusDescription" type="string" content="textOnly"> </element> <element name="ParoleStartDate" type="date" content="textOnly"> </element> <element name="ParoleStatusChangeDate" type= "date" content="textOnly"> </element> <element name="ParoleOfficer" type="date" content="elementOnly"> <group order="sequence"> <element name="Name" /> <element name="OfficeAssignment" /> </group> </element> <element name="OfficeAssignment" type="string" content="textOnly"> </element> <element name="SentenceCharge" content="elementOnly"> <group order="sequence"> <element name="ChargeDescription" /> <element name="MaxSentenceDate" /> <element name="MinSentenceDate" /> </group> </element>


6/5/01

<group order="sequence"> <element name="TransactionDate" /> <element name="EffectiveDate" /> </group> <attribute name="Type" type="string"> <datatype source = "NMTOKEN"> <enumeration value = "add"/> <enumeration value = "delete"/> <enumeration value = "update"/> </datatype> </attribute> </element> <element name="TransactionDate" content="textOnly"> </element> <element name="EffectiveDate" type="date" content="textOnly"> </element> </schema>


6/5/01

5.4.5 State Parole Violation XML <?xml version='1.0'?> <!DOCTYPE StateParoleViolation SYSTEM "http://www.jnet.state.pa.us/metadatarepository/dtds/StateParoleViolation.dtd" > <StateParoleViolation Timestamp="12/1/2000 10:23" MessageID="1232424234"> <Subject SID="12345678"> <Name> <LastName>Smith</LastName> <FirstName>John</FirstName> <MiddleName>T.</MiddleName> </Name> <DOB>2/12/1970</DOB> <Sex>M</Sex> <SSN>123123123</SSN> <SSN>543543543</SSN> <Address Type="home"> <AddressLine1>Apartment 3A</AddressLine1> <AddressLine2>123 Main Street</AddressLine2> <City>SmallTown</City> <State>PA</State> <ZipCode>17123</ZipCode> <ZipExtension>4567</ZipExtension> </Address> <Phone Type="cell"> <PhoneNumber>7171231234</PhoneNumber> <PhoneExtension></PhoneExtension> </Phone> <Phone Type="fax"> <PhoneNumber>7175432543</PhoneNumber> </Phone> </Subject> <InmateNumber>768967895</InmateNumber <ParoleNumber>567463</ParoleNumber> <ParoleStatusCode>aaaa</ParoleStatusCode> <ParoleStatusDescription>xxxxxxxxxx</ParoleStatusDescription> <ParoleStartDate>1/1/2000</ParoleStartDate> <ParoleStatusChangeDate>12/12/2000</ParoleStatusChangeDate>


6/5/01

</SentenceCharge> <SentenceCharge> <ChargeDescription>ssssss</ChargeDescription> <MinSentenceDate>13</MinSentenceDate> <MaxSentenceDate>1212</MaxSentenceDate> </SentenceCharge> </StateParoleViolation>

5.5 OUT STATE MOTOR VEHICLE VIOLATION

Out of State Motor Vehicle Violations involves a specific motor vehicle violation of an individual possessing a Pennsylvania Drivers License or an individual with a Pennsylvania address. PennDOT captures the following Out of State Motor Vehicle Violations; Driving Under the Influence (DUI), Homicide by Vehicle, Felonies and Drugs.

5.5.1 Out State Motor Vehicle Violation Class Model


6/5/01




DOB

Height

Sex

EyeColor

SSN

ViolationConvictionConvictionDateStateViolationOccurred

JurisdictionCourt

11

VehicleDriver

11

11

11

11

11

11

11

VehicleViolationSectionViolatedViolationDate

0..10..1

0..10..1


OutStateMotorVehicleViolationMessageIDTimestampConvictionIndicator

11

11

0..10..1

5.5.2 Out State Motor Vehicle Violation Element Descriptions Element/Attribute Name Description MessageID Unique number for a message Timestamp Timestamp when a message issued ConvictionIndicator The violation is convicted or not


6/5/01

SSN Driver’s social security number Vehicle Violation SectionViolated This element is for a reply to a request. ViolationDate Reply id ViolationConviction Vehicle violation conviction information ConvictionDate ConvictionDate StateViolationOccured State violation occurred JurisdictionCourt Jurisdiction court information if violation not convicted Address Jurisdiction court address. See common element section

for detail. TransactionStatus See common element section for detail. optional

5.5.3 Out State Motor Vehicle Violation XML DTD <!ELEMENT OutStateMotorVehicleViolation (VehicleDriver,VehicleViolation,TransactionStatus?)> <!ATTLIST OutStateMotorVehicleViolation MessageID ID #REQUIRED Timestamp CDATA #IMPLIED ConvictionIndicator CDATA #REQUIRED > <!ELEMENT VehicleDriver (Name,DOB,Address,SSN,Height,Sex,EyeColor)> <!ELEMENT VehicleViolation (ViolationConviction|JurisdictionCourt)> <!ELEMENT Name (LastName,FirstName,MiddleName?,Suffix?,Title?)> <!ATTLIST Name Type (official | alias | street) #IMPLIED > <!ELEMENT LastName (#PCDATA)> <!ELEMENT FirstName (#PCDATA)> <!ELEMENT MiddleName (#PCDATA)> <!ELEMENT Suffix (#PCDATA)> <!ELEMENT Title (#PCDATA)> <!ELEMENT Address (AddressLine1,AddressLine2?,City,State,ZipCode,ZipExtension?,County?,District?)> <!ATTLIST Address Type (mailing | billing | business | home) #IMPLIED >


6/5/01

Type (add | update | delete) #REQUIRED > <!ELEMENT TransactionDate (#PCDATA)> <!ELEMENT EffectiveDate (#PCDATA)> <!ELEMENT DOB (#PCDATA)> <!ELEMENT Height (#PCDATA)> <!ELEMENT Sex (#PCDATA)> <!ELEMENT EyeColor (#PCDATA)> <!ELEMENT ViolationConviction (ConvictionDate,StateViolationOccured)> <!ELEMENT JurisdictionCourt (Address)> <!ELEMENT ConvictionDate (#PCDATA)> <!ELEMENT StateViolationOccured (#PCDATA)>

5.5.4 Out State Motor Vehicle Violation XML Schema <?xml version="1.0"?> <schema> <element name="OutStateMotorVehicleViolation" content="elementOnly"> <group order="sequence"> <element name="VehicleDriver" /> <element name="VehicleViolation" /> <element name="TransactionStatus" minOccurs='0' maxOccurs='1'/> </group> <attribute name="MessageID" type="string" minOccurs="1"/> <attribute name="Timestamp" ty pe="timeInstance"/> <attribute name="ConvictionIndicator" type="boolean" minOccurs="1"/> </element> <element name="VehicleDriver" content="elementOnly"> <group order="sequence"> <element name="Name" /> <element name="DOB" /> <element name="Address" /> <element name="SSN" /> <element name="Height" /> <element name="Sex" /> <element name="EyeColor" /> </group> </element>


6/5/01

<element name="LastName" /> <element name="FirstName" /> <element name="MiddleName" minOccurs='0' maxOccurs='1'/> <element name="Suffix" minOccurs='0' maxOccurs='1'/> <element name="Title" minOccurs='0' maxOccurs='1'/> </group> <attribute name="Type" type="string"> <datatype source = "NMTOKEN"> <enumeration value = "official"/> <enumeration value = "alias"/> <enumeration value = "street"/> </datatype> </attribute> </element> <element name="LastName" type="string" content="textOnly"> </element> <element name="FirstName" type="string" content="textOnly"> </element> <element name="MiddleName" type="string" content="textOnly"> </element> <element name="Suffix" type="string" content="textOnly"> </element> <element name="Title" type="string" content="textOnly"> </element> <element name="Address" content="elementOnly"> <group order="sequence"> <element name="AddressLine1" /> <element name="AddressLine2" minOccurs='0' maxOccurs='1'/> <element name="City" /> <element name="State" /> <element name="ZipCode" /> <element name="ZipExtension" minOccurs='0' maxOccurs='1'/> <element name="County" minOccurs='0' maxOccurs='1'/> <element name="District" minOccurs='0' maxOccurs='1'/> </group> <attribute name="Type" type="" default="business"> <datatype source = "NMTOKEN">


6/5/01

<element name="AddressLine2" type="string" content="textOnly "> </element> <element name="City" type="string" content="textOnly"> </element> <element name="State" type="string" content="textOnly"> </element> <element name="ZipCode" type="string" content="textOnly"> </element> <element name="ZipExtension" type="string" content="textOnly"> </element> <element name="County" type="string" content="textOnly"> </element> <element name="District" type="string" content="textOnly"> </element> <element name="SSN" type="string" content="textOnly"> </element> <element name="TransactionStatus" content="elementOnly"> <group order="sequence"> <element name="TransactionDate" minOccurs='0' maxOccurs='1'/> <element name="EffectiveDat e" minOccurs='0' maxOccurs='1'/> </group> <attribute name="Type" type="string" minOccurs="1"> <datatype source = "NMTOKEN"> <enumeration value = "add"/> <enumeration value = "update"/> <enumeration value = "delete"/> </datatype> </attribute> </element> <element name="TransactionDate" type="date" content="textOnly"> </element>


6/5/01

<element name="EyeColor" type="string" content="textOnly"> </element> <element name="ViolationConviction" content="elementOnly"> <group order="sequence"> <element name="ConvictionDate" /> <element name="StateViolationOccured" /> </group> </element> <element name="JurisdictionCourt" content="elementOnly"> <group order="sequence"> <element name="Address" /> </group> </element> <element name="ConvictionDate" type="date" content="textOnly "> </element> <element name="StateViolationOccured" type="string" content="textOnly"> </element> </schema>

5.5.5 Out State Motor Vehicle Violation XML Sample <?xml version='1.0'?> <!DOCTYPE OutStateMotorVehicleViolation SYSTEM "http://www.jnet.state.pa.us/metadatarepository/dtds/OutStateMotor VehicleViolation.dtd" > <OutStateMotorVehicleViolation MessageID="123123213" ConvictionIndicator="YES"> <VehicleDriver> <Name Type="official"> <LastName>Smith</LastName> <FirstName>John</FirstName>


6/5/01

</Address> <SSN>123456789</SSN> <Height>6’2”</Height> <Sex>M</Sex> <EyeColor>Blue</EyeColor> </VehicleDriver> <VehicleViolation> <ViolationConviction> <ConvictionDate>4/21/2001</ConvictionDate> <StateViolationOccured>FL</StateViolationOccured> </ViolationConviction> </VehicleViolation> </OutStateMotorVehicleViolation>


6/5/01

5.6 INMATE CLASSIFICATION

The Inmate Classification event is a part of the corrections diagnosis and classification process. During the diagnosis and classification process, DOC administers assessments including psychological tests and collects demographic, education, current offense, prior offense, medical and mental health information.

5.6.1 Inmate Classification Class Model

SubjectSID


1

RequiredAssessmentType

ReclassificationSummaryInst itutionalViolenceDisciplinaryReportMostSevereReportEscapeHistoryProgramComplianceWorkComplianceHousingCompliance

1

InmateClassificationMessageIDTimestampInmateNumberCustodyLvel

11

0..*0..*

11


0..10..1

5.6.2 Inmate Classification Element Description


6/5/01

RequiredAssessment) educational, sexual problems, remarks/other needs CustodyLevel Custody level ReclassificationSummary Reclassification summary InstitutionalViolence Institutional violence DisciplinaryReport Disciplinary report MostSevereReport Most severe report / 18 months EscapeHistory Escape history ProgramCompliance Program compliance WorkCompliance Work compliance HousingCompliance Housing compliance TransactionStatus See common element section for detail

5.6.3 Inmate Classification XML DTD <!ELEMENT InmateClassification (Subject,InmateNumber,RequiredAssessment*,CustodyLevel, ReclassificationSummary,TransactionStatus?)> <!ATTLIST InmateClassification MessageID CDATA #REQUIRED Timestamp CDATA #REQUIRED > <!ELEMENT Subject (Name)> <!ATTLIST Subject SID CDATA #REQUIRED > <!ELEMENT RequiredAssessment (#PCDATA)> <!ATTLIST RequiredAssessment Type (emotional | drug-alcohol | educational | sexual-problem | remarks | other) #REQUIRED > <!ELEMENT CustodyLevel (#PCDATA)> <!ELEMENT ReclassificationSummary (InstitutionalViolence,DisciplinaryReport,MostSevereReport,EscapeHistory,ProgramCompliance,WorkCompliance,HousingCompliance)> <!ELEMENT DisciplinaryReport (#PCDATA)> <!ELEMENT MostSevereReport (#PCDATA)> <!ELEMENT InmateNumber (#PCDATA)> <!ELEMENT Name (LastName,FirstName,MiddleName?,Suffix?,Title?)> <!ATTLIST Name Type (official | alias | street | nickname) #IMPLIED


6/5/01

<!ELEMENT HousingCompliance (#PCDATA)> <!ELEMENT TransactionStatus (TransactionDate,EffectiveDate)> <!ATTLIST TransactionStatus Type (add | update | delete | other) #IMPLIED > <!ELEMENT TransactionDate (#PCDATA)> <!ELEMENT EffectiveDate (#PCDATA)>

5.6.4 Inmate Classification XML Schema <?xml version="1.0"?> <schema> <element name="InmateClassification" content="elementOnly"> <group order="sequence"> <element name="Subject" /> <element name="InmateNumber" /> <element name="RequiredAssessment" minOccurs='0' maxOccurs='*'/> <element name="CustodyLevel" /> <element name="ReclassificationSummary" /> <element name="TransactionStatus" minOccurs='0' maxOccurs='1'/> </group> <attribute name="MessageID" type="string" minOccurs="1"/> <attribute name="Timestamp" type="timeInstance" minOccurs="1"/> </element> <element name="Subject" content="elementOnly"> <group order="sequence"> <element name="Name" /> </group> <attribute name="SID" type="string" minOccurs="1"/> </element> <element name="RequiredAssessment" type="string" content="textOnly"> <attribute name="Type" type="string" minOccurs="1"> <datatype source = "NMTOKEN"> <enumeration value = "emotional"/> <enumeration value = "drug -alcohol"/>


6/5/01

<element name="ReclassificationSummary" content="elementOnly"> <group order="sequence"> <element name="InstitutionalViolence" /> <element name="DisciplinaryReport" /> <element name="MostSevereReport" /> <element name="EscapeHistory" /> <element name="ProgramCompliance" /> <element name="WorkCompliance" /> <element name="HousingCompliance" /> </group> </element> <element name="DisciplinaryReport" type="string" content="textOnly"> </element> <element name="MostSevereReport" type="string" content="textOnly"> </element> <element name="InmateNumber" type="string" content="textOnly"> </element> <element name="Name" content="elementOnly"> <group order="sequence"> <element name="LastName" /> <element name="FirstName" /> <element name="MiddleName" minOccurs='0' maxOccurs='1'/> <element name="Suffix" minOccurs='0' maxOccurs='1'/> <element name="Title" minOccurs='0' maxOccurs='1'/> </group> <attribute name="Type" type=""> <datatype source = "NMTOKEN"> <enumeration value = "o fficial"/> <enumeration value = "alias"/> <enumeration value = "street"/> <enumeration value = "nickname"/> </datatype> </attribute> </element> <element name="LastName" type="stri ng" content="textOnly"> </element>


6/5/01

</element> <element name="InstitutionalViolence" type="string" content="textOnly"> </element> <element name="EscapeHistory" type="string" content="textOnly" > </element> <element name="ProgramCompliance" type="string" content="textOnly"> </element> <element name="WorkCompliance" type="string" content="textOnly"> </element> <element name="HousingCompliance" type="string" content="textOnly"> </element> <element name="TransactionStatus" content="elementOnly"> <group order="sequence"> <element name="TransactionDate" /> <element name="EffectiveDate" /> </group> <attribute name="Type" type="string"> <datatype source = "NMTOKEN"> <enumeration value = "add"/> <enumeration value = "update"/> <enumeration value = "delete"/> <enumeration value = "other"/> </datatype> </attribute> </element> <element name="TransactionDate" type="date" content="textOnly"> </element> <element name="EffectiveDate" type="date" content="textOnly"> </element>


6/5/01

<Subject SID="12312312"> <Name Type="official"> <LastName>Doe</LastName> <FirstName>John</FirstName> <MiddleName>D</MiddleName> </Name> </Subject> <InmateNumber>121313131</InmateNumber> <CustodyLevel>AAA</CustodyLevel> <ReclassificationSummary> <InstitutionalViolence>level 2</InstitutionalViolence> <DisciplinaryReport>level 2</DisciplinaryReport> <MostSevereReport>level 2</MostSevereReport> <EscapeHistory>level 2</EscapeHistory> <ProgramCompliance>level 2</ProgramCompliance> <WorkCompliance>level 2</WorkCompliance> <HousingCompliance>level 2</HousingCompliance> </ReclassificationSummary> <TransactionStatus Type="add"> <TransactionDate>level 2</TransactionDate> <EffectiveDate>level 2</EffectiveDate> </TransactionStatus> </InmateClassification>


6/5/01

6. REQUEST AND REPLY MESSAGE TYPES Request/Reply message types are usually paired. A requester application publishes a request message on a request topic and expects to receive a reply message from a reply topic, a corresponding party subscribes to the request topic and then publishes a reply message on the reply topic.

6.1 RECIPIENT ADDRESS REQUEST

A Recipient Address is the physical location of the individual receiving benefits from the Department of Public Welfare and it is the most current address used to mail benefits to that individual.

6.1.1 Recipient Address Request Class Model

RecipientAddressRequestCriteriaLastNameFirstNameDOBSexSSN

RecipientAddressRequestMessageIDTimestampUserDefinedTrackingNumber

ReplyDescriptorType

RequestHeaderRequestUIDRequestGroupIDRequestAgencyID

11

0..*

11

0..*


6/5/01

MessageID Unique number for a message Timestamp Timestamp when a message issued RequestHeader Request header RequestUID Requester’s User id RequestGroupID Requester’s group id RequestAgencyID Requester’s agency id UserDefinedTrackingNumber User defined tracking number, optional RecipientAddressRequestCriteria Recipient address request criteria LastName LastName in criteria FirstName FirstName in criteria DOB Date of birth in criteria Sex Sex in criteria SSN Social security number in criteria, optional ReplyDescriptor Reply descriptor Type (in ReplyDescriptor) Type of reply, such as EmailDelivery, WebDelivery DescriptorName Descriptor name DescriptorOperator Descriptor operator DescriptorValue Descriptor value

6.1.3 Recipient Address Request DTD <!ELEMENT RecipientAddressRequest (RequestHeader,RecipientAddressCriteria,UserDefinedTrackingNumber?)> <!ATTLIST RecipientAddressRequest MessageID ID #REQUIRED Timestamp CDATA #REQUIRED > <!ELEMENT RequestHeader (RequestUID,RequestGroupID,RequestAgencyID,ReplyDescriptor*)> <!ELEMENT RequestUID (#PCDATA)> <!ELEMENT RequestGroupID (#PCDATA)> <!ELEMENT RequestAgencyID (#PCDATA)> <!ELEMENT ReplyAgencyID (#PCDATA)> <!ELEMENT RecipientAddressCriteria (LastName,FirstName,DOB,Sex,SSN?)> <!ELEMENT LastName (#PCDATA)> <!ELEMENT FirstName (#PCDATA)> <!ELEMENT DOB (#PCDATA)> <!ELEMENT Sex (#PCDATA)>


6/5/01

6.1.4 Recipient Address Request Schema <?xml version="1.0"?> <schema> <element name="RecipientAddressRequest" content="elementOnly"> <group order="sequence"> <element name="RequestHeader" /> <element name="RecipientAddressCriteria" /> <element name="UserDefinedTrackingNumber" minOccurs='0' maxOccurs='1'/> </group> <attribute name="MessageID" type="string" minOccurs="1"/> <attribute name="Timestamp" type="timeInstance" minOccurs="1"/> </element> <element name="RequestHeader" content="elementOnly"> <group order="sequence"> <element name="RequestUID" /> <element name="RequestGroupID" /> <element name="RequestAgencyID" /> <element name="ReplyDescriptor" minOccurs='0' maxOccurs='*'/> </group> </element> <element name="RequestUID" type="string" content="textOnly"> </element> <element name="RequestGroupID" type="string" content="textOnly"> </element> <element name="RequestAgencyID" type="string" content="textOnly"> </element> <element name="ReplyAgencyID" type="string" content="textOnly"> </element> <element name="RecipientAddressCriteria" content="elementOnly">


6/5/01

</element> <element name="FirstName" type="string" content="textOnly"> </element> <element name="DOB" type="string" content="textOnly"> </element> <element name="Sex" type="string" content="textOnly"> </element> <element name="SSN" type="string" content="textOnly"> </element> <element name="ReplyDescriptor" content="elementOnly"> <group order="sequence"> <element name="DescriptorName" /> <element name="DescriptorOperator" /> <element name="DescriptorValue" /> </group> <attribute name="Type" type="string"> <datatype source = "NMTOKEN"> <enumeration value = "EmailDelivery"/> <enumeration value = "WebDelivery"/> <enumeration value = "other"/> </datatype> </attribute> </element> <element name="DescriptorName" type="string" content="textOnly"> </element> <element name="DescriptorOperator" type="string" content="textOnly"> </element> <element name="DescriptorValue" type="string" content="textOnly"> </element> <element name="UserDefinedTrackingNumber" type="string" content="textOnly"> </element>


6/5/01

6.1.5 Recipient Address Request XML Sample <?xml version='1.0'?> <!DOCTYPE RecipientAddressRequest SYSTEM "http://www.jnet.state.pa.us/metadatarepository/dtds/Recipi entAddressRequest.dtd" > <RecipientAddressRequest Timestamp="11/30/2000 10:30" MessageID="34532452"> <RequestHeader> <RequestUID>john.smith</RequestUID> <RequestGroupID>cj</RequestGroupID> <RequestAgencyID>AOPC</RequestAgencyID> <ReplyDescriptor Type=”EmailDelivery”> <DescriptorName>Email address</DescriptorName> <DescriptorOperator>=</DescriptorOperator> <DescriptorValue>[email protected]</DescriptorValue> </ReplyDescriptor> <ReplyDescriptor Type=”WebDelivery”> <DescriptorName>JNET UID</DescriptorName> <DescriptorOperator>=</DescriptorOperator> <DescriptorValue>john.smith</DescriptorValue> </ReplyDescriptor> </RequestHeader> <RecipientAddressRequestCriteria> <LastName>Doe</LastName> <FirstName>John</FirstName> <DOB>10/20/1960</DOB> <Sex>M</Sex> <SSN>123123123</SSN> </RecipientAddressRequestCriteria> <UserDefinedTrackingNumber>XYZ</UserDefinedTrackingNumber> </RecipientAddressRequest>


6/5/01

6.2 RECIPIENT ADDRESS REPLY

6.2.1 Recipient Address Reply Class Model



SSN



ReplyDescriptorTypeDescriptorNameDescriptorOperatorDescriptorValue

ErrorErrorCodeErrorDescription

RecipientAddressReplyMessageIDTimestampAddressLastChangeDate

11

11 11

11

0..10..1RecipientAddressRequestCriteria

Las tNameFirstNameDOBSexSSN

RequestHeaderRequestUIDRequestGroupIDRequestAgencyID

0..*0..*

RecipientAddressRequestMessageIDTimestampUserDefinedTrackingNumber

1111

ReplyHeaderReplyApplicationIDReplyAgencyIDMatchIndicator

0..*0..*

11

11

6.2.2 Recipient Address Reply Element Description MessageID Unique number for a message Timestamp Timestamp when a message issued AddressLastChangeDate Address last change date Name See common element section for detail Address See common element section for detail SSN See common element section for detail ReplyHeader See common element section for detail ReplyApplicationID Reply application id, optional


6/5/01

6.2.3 Recipient Address Reply XML DTD <!ELEMENT RecipientAddressReply (ReplyHeader,Name,Address,SSN,AddressLastChangeDate)> <!ATTLIST RecipientAddressReply MessageID ID #REQUIRED Timestamp CDATA #REQUIRED > <!ELEMENT ReplyHeader (RecipientAddressRequestRequest,Error*,MatchIndicator,ReplyApplicationID?,ReplyAgencyID?)> <!ELEMENT RecipientAddressRequestRequest (RequestHeader,RecipientAddressRequestCriteria,UserDefinedT rackingNumber?)> <!ATTLIST RecipientAddressRequestRequest MessageID ID #REQUIRED Timestamp CDATA #IMPLIED > <!ELEMENT Name (LastName,FirstName,MiddleName?,Suffix?,Title?)> <!ATTLIST Name Type (official | alias | street | other) #IMPLIED > <!ELEMENT Address (AddressLine1,AddressLine2?,City,State,ZipCode,ZipExtension?,County?,District?)> <!ATTLIST Address Type (home | business | case | other) #IMPLIED > <!ELEMENT SSN (#PCDATA)> <!ELEMENT LastName (#PCDATA)> <!ELEMENT FirstName (#PCDATA)> <!ELEMENT MiddleName (#PCDATA)> <!ELEMENT Suffix (#PCDATA)> <!ELEMENT Title (#PCDATA)> <!ELEMENT AddressLine1 (#PCDATA)> <!ELEMENT AddressLine2 (#PCDATA)> <!ELEMENT City (#PCDATA)> <!ELEMENT State (#PCDATA)> <!ELEMENT ZipCode (#PCDATA)> <!ELEMENT ZipExtension (#PCDATA)> <!ELEMENT County (#PCDATA)> <!ELEMENT District (#PCDATA)> <!ELEMENT MatchIndicator (#PCDATA)> <!ELEMENT Error (ErrorCode,ErrorDescription)>


6/5/01

<!ELEMENT ReplyDescriptor (DescriptorName,DescriptorOperator,DescriptorValue)> <!ATTLIST ReplyDescriptor Type (EmailDelivery | WebDelivery | other) #REQUIRED > <!ELEMENT DOB (#PCDATA)> <!ELEMENT Sex (#PCDATA)> <!ELEMENT DescriptorName (#PCDATA)> <!ELEMENT DescriptorOperator (#PCDATA)> <!ELEMENT DescriptorValue (#PCDATA)> <!ELEMENT ReplyApplicationID (#PCDATA)> <!ELEMENT RequestHeader (RequestUID,RequestGroupID,RequestAgencyID,ReplyDescriptor*)>

6.2.4 Recipient Address Reply XML Schema <?xml version="1.0"?> <schema> <element name="RecipientAddressReply" content="elementOnly"> <group order="sequence"> <element name="ReplyHeader" /> <element name="Name" /> <element name="Address" /> <element name="SSN" /> <element name="AddressLastChangeDate" /> </group> <attribute name="MessageID" type="string" minOccurs="1"/> <attribute name="Timestamp" type="timeInstance" minOccurs="1"/> </element> <element name="ReplyHeader" content="elementOnly"> <group order="sequence"> <element name="RecipientAddressRequestRequest" /> <element name="Error" minOccurs='0' maxOccurs='*'/> <element name="MatchIndicator" /> <element name="ReplyApplicationID" minOccurs='0' maxOccurs='1'/>


6/5/01

<element name="UserDefinedTrackingNumber" minOccurs='0' maxOccurs='1'/> </group> <attribute name="MessageID" type="string" minOccurs="1"/> <attribute name="Timestamp" type="timeInstance"/> </element> <element name="Name" content="elementOnly"> <group order="sequence"> <element name="LastName" /> <element name="FirstName" /> <element name="MiddleName" minOccurs='0' maxOccurs='1'/> <element name="Suffix" minOccurs='0' maxOccurs='1'/> <element name="Title" minOccurs='0' maxOccurs='1'/> </group> <attribute name="Type" type="string"> <datatype source = "NMTOKEN"> <enumeration value = "official"/> <enumeration value = "alias"/> <enumeration value = "street"/> <enumeration value = "other"/> </datatype> </attribute> </element> <element name="Address" content="elementOnly"> <group order="sequence"> <element name="AddressLine1" /> <element name="AddressLine2" minOccurs='0' maxOccurs='1'/> <element name="City" /> <element name="State" /> <element name="ZipCode" /> <element name="ZipExtension" minOccurs='0' maxOccurs='1'/> <element name="County" minOccurs='0' maxOccurs='1'/> <element name="District" minOccurs='0' maxOccurs='1'/> </group> <attribute name="Type" type="string"> <datatype source = "NMTOKEN"> <enumeration value = "home"/> <enumeration value = "business"/ > <enumeration value = "case"/> <enumeration value = "other"/> </datatype>


6/5/01

<element name="MiddleName" type="string" content="textOnly"> </element> <element name="Suffix" type="string" c ontent="textOnly"> </element> <element name="Title" type="string" content="textOnly"> </element> <element name="AddressLine1" type="string" content="textOnly"> </element> <element name="AddressLine2" type="string" content="textOn ly"> </element> <element name="City" type="string" content="textOnly"> </element> <element name="State" type="string" content="textOnly"> </element> <element name="ZipCode" type="string" content="textOnly"> </element> <element name="ZipExtension" type="string" content="textOnly"> </element> <element name="County" type="string" content="textOnly"> </element> <element name="District" type="string" content="textOnly"> </element> <element name="MatchIndicator" type="string" content="textOnly"> </element> <element name="Error" content="elementOnly"> <group order="sequence"> <element name="ErrorCode" /> <element name="ErrorDescription" /> </group> </element>


6/5/01

<element name="RequestUID" type="string" content="textOnly"> </element> <element name="RequestGroupID" type="string" content="textOnly"> </element> <element name="RequestAgencyID" type="string" content="textOnly"> </element> <element name="ReplyAgencyID" type="string" content="textOnly"> </element> <element name="UserDefinedTrackingNumber" type="string" content="textOnly"> </element> <element name="RecipientAddressRequestCriteria" content="elementOnly"> <group order="sequence"> <element name="LastName" /> <element name="FirstName" /> <element name="DOB" /> <element name="Sex" /> <element name="SSN" /> </group> </element> <element name="ReplyDescriptor" content="elementOnly"> <group order="sequence"> <element name="DescriptorName" /> <element name="DescriptorOperator" /> <element name="DescriptorValue" /> </group> <attribute name="Type" type="string" minOccurs="1"> <datatype source = "NMTOKEN"> <enumeration value = "EmailDelivery"/> <enumeration value = "WebDelivery"/> <enumeration value = "other"/> </datatype> </attribute> </element> <element name="DOB" type="string" content="textOnly">


6/5/01

<element name="DescriptorValue" type="string" content="textOnly"> </element> <element name="ReplyApplicationID" type= "string" content="textOnly"> </element> <element name="RequestHeader" content="elementOnly"> <group order="sequence"> <element name="RequestUID" /> <element name="RequestGroupID" /> <element name="RequestAgencyID" /> <element name="ReplyDescriptor" minOccurs='0' maxOccurs='*'/> </group> </element> </schema>


6/5/01

6.2.5 Recipient Address Reply XML Sample <?xml version='1.0'?> <!DOCTYPE RecipientAddressReply SYSTEM "http://www.jnet.state.pa.us/metadatarepository/dtds/RecipientAddressReply.dtd" > <RecipientAddressReply Timestamp="2/13/2001 10:31” MessageID="122141123"> <ReplyHeader> <RecipientAddressRequest Timestamp="11/30/2000 10:30" MessageID="34532452"> <RequestHeader> <RequestUID>john.smith</RequestUID> <RequestGroupID>cj</RequestGroupID> <RequestAgencyID>AOPC</RequestAgencyID> <ReplyDescriptor Type=”EmailDelivery”> <DescriptorName>Email address</DescriptorName> <DescriptorOperator>=</DescriptorOperator> <DescriptorValue>[email protected]</DescriptorValue> </ReplyDescriptor> <ReplyDescriptor Type=”WebDelivery”> <DescriptorName>JNET UID</DescriptorName> <DescriptorOperator>=</DescriptorOperator> <DescriptorValue>john.smith</DescriptorValue> </ReplyDescriptor> </RequestHeader> <RecipientAddressRequestCriteria> <LastName>Doe</LastName> <FirstName>John</FirstName> <DOB>10/20/1960</DOB> <Sex>M</Sex> <SSN>123123123</SSN> </RecipientAddressRequestCriteria> <UserDefinedTrackingNumber>XYZ</UserDefinedTrackingNumber> </RecipientAddressRequest> <MatchIndicator>Y</MatchIndicator> <ReplyAgencyID>DPW</ReplyAgencyID> </ReplyHeader> <Name Type=”official”> <LastName>Doe</LastName> <FirstName>John</FirstName> </Name> <Address Type="case"> <AddressLine1>Apartment A</AddressLine1>


6/5/01

6.3 GENERIC REQUEST

This message type plays a template role. If an agency wish to use it, the root element tag should be renamed to match a request topic name and DTD or schema files also need to be renamed (refer to our topic-naming standard).

6.3.1 Generic Request Class Model

RequestCriteriaCriteriaNameCriteriaOperatorCriteriaValue

ReplyDescriptorTypeDescriptorNameDescriptorOperatorDescriptorValue

GenericRequestMessageIDTimestamp

1..*1..*RequestHeaderRequestUIDRequestGroupIDRequestAgencyID

0..*0..*

11

6.3.2 Generic Request Element Description MessageID Unique number for a message Timestamp Timestamp when a message issued


6/5/01

DescriptorValue Descriptor value RequestCriteria Request criteria CriteriaName Criteria name CriteriaOperator Criteria operator CriteriaValue Criteria value

6.3.3 Generic Request XML DTD <!ELEMENT GenericRequest (RequestHeader,RequestCriteria+)> <!ATTLIST GenericRequest MessageID ID #REQUIRED Timestamp CDATA #REQUIRED > <!ELEMENT RequestHeader (RequestUID,RequestGroupID,RequestAgencyID,ReplyDescriptor*)> <!ELEMENT RequestUID (#PCDATA)> <!ELEMENT RequestGroupID (#PCDATA)> <!ELEMENT RequestAgencyID (#PCDATA)> <!ELEMENT RequestName (#PCDATA)> <!ELEMENT RequestCriteria (CriteriaName,CriteriaOperator,CriteriaValue)> <!ELEMENT CriteriaName (#PCDATA)> <!ELEMENT CriteriaOperator (#PCDATA)> <!ELEMENT CriteriaValue (#PCDATA)> <!ELEMENT ReplyDescriptor (DescriptorName,DescriptorOperator,DescriptorValue)> <!ATTLIST ReplyDescriptor Type (EmailDelivery | WebDelivery | other) #IMP LIED > <!ELEMENT DescriptorName (#PCDATA)> <!ELEMENT DescriptorOperator (#PCDATA)> <!ELEMENT DescriptorValue (#PCDATA)>

6.3.4 Generic Request XML Schema <?xml version="1.0"?> <schema> <element name="GenericRequest" content="elementOnly"> <group order="sequence">


6/5/01

<group order="sequence"> <element name="RequestUID" /> <element name="RequestGroupID" /> <element name="RequestAgencyID" /> <element name="ReplyDescriptor" minOccurs='0' maxOccurs='*'/> </group> </element> <element name="RequestUID" type="string" content="textOnly"> </element> <element name="RequestGroupID" type="string" content="textOnly"> </element> <element name="RequestAgencyID" type="string" content="textOnly"> </element> <element name="RequestCriteria" content="elementOnly"> <group order="sequence"> <element name="CriteriaName" / > <element name="CriteriaOperator" /> <element name="CriteriaValue" /> </group> </element> <element name="CriteriaName" type="string" content="textOnly"> </element> <element name="CriteriaOperator" type="st ring" content="textOnly"> </element> <element name="CriteriaValue" type="string" content="textOnly"> </element> <element name="ReplyDescriptor" content="elementOnly"> <group order="sequence"> <element name="DescriptorN ame" /> <element name="DescriptorOperator" /> <element name="DescriptorValue" /> </group>


6/5/01

<element name="DescriptorOperator" type="string" content="textOnly"> </element> <element name="DescriptorValue" type="string" content="textOnly"> </element> </schema>

6.3.5 Generic Request XML Sample <?xml version='1.0'?> <!DOCTYPE GenericRequest SYSTEM "http://www.jnet.state.pa.us/metadatarepository/dtds/GenericRequest.dtd" > <GenericRequest Timestamp="2/13/2001 10:31” MessageID="122141123"> <RequestHeader> <RequestUID/> <RequestGroupID/> <RequestAgencyID>AOPC</RequestAgencyID> </RequestHeader> <RequestCriteria> <CriteriaName>BadgeNumber</CriteriaName> <CriteriaOperator>=</CriteriaOperator> <CriteriaValue>12345678</CriteriaValue> </RequestCriteria> </GenericRequest>

Documents

JNET Messages Volume II V1.0.0 - Legal XML · 2019-11-22 · JNET Messages Volume II 6/5/01 organization unit name, followed by individual topic names. This optional organization