Adjudication Electronic Ticket Submission ... - New York DMV



New York State Department of Motor Vehicles

Adjudication Batch Electronic Ticket Submission

User Guide

For New York City Police Department

January 2016

New York State Department of Motor Vehicles

XML File Specifications for Batch Transactions

File Naming Convention

This section describes the file naming convention for the several XML files used in Batch FTP transactions.

The name of the batch input file must consist of the DMV application id, followed by a batch date, then a batch time and then the submitter’s user id, all separated by underscores and followed by the extension “.in.xml” as in:

EBAA_ccyymmdd_hhmmss_NYPDB.in.xml

where

“EBAA” is the official DMV application identifier for the adjudication batch electronic ticket transactions in the file;

“ccyymmdd” represents the submitter’s input batch date in “year, month, day” format—e.g., “20090601” for June 1, 2009;

“hhmmss” represents the submitter’s input batch time in “hours, minutes, seconds” based on a 24 hour clock—e.g., “133105” for 1:31:05 pm;

“NYPDB” represents the submitter id for “NYPD” for this application, assigned by DMV; and

“.in.xml” is the standard file extension for all input batch XML files.

Input batch filenames need to be unique. If the submitter needs to resubmit or completely recreate a file, the date/time that is embedded in the filename needs to be changed. Failure to do so will result in a duplicate file error being returned.

The batch input acknowledgement file, which is merely a receipt of the input file, will have the same name as its corresponding input file, except that it ends with “.in.ack.xml” as in:

EBAA_ccyymmdd_hhmmss_NYPDB.in.ack.xml

The batch input error file, which indicates the file level error (wrong user password, etc.), will also have the same name as the input file, except that it ends with “.in.err.xml” as in:

EBAA_ccyymmdd_hhmmss_NYPDB.in.err.xml

The batch output file is named using the same format as the input file, except that the server date and time are from the DMV server, and the file name ends with “.out.xml” as in:

EBAA_ccyymmdd_hhmmss_NYPDB.out.xml

The .out.xml file contains only the errors that cannot be fixed, such as missing ticket number, etc. The remaining sections of the user guide describe the data elements of the Adjudication batch electronic ticket XML files.

Adjudication Data Elements

The following sets forth the requirements and descriptions for each data element as it is used in the Adjudication System. The order of this document follows the order of schema file provided to the user. Please refer the schema for the construction of XML file. nodes should be compiled and wrapped by a node which is preceded by the ADMIN nodes, as explained below.

_____________________________________________________________________________________

Description: Ticket File root node.

The element is followed by the ADMIN nodes, the so-called “ADMIN wrapper”, and then a node that contains individual nodes.

* this node is included only in the error file.

______________________________________________________________________________

Description: Information of the batch user who submits the file. The ticket file may contain only one “ADMIN_USER” element, which contains the following child elements.

Description: The User ID provided to the user by DMV. It should be included both in the input file and the returned file. *** Required ***

Value: NYPDB

Description: The password associated with the User ID, provided to the user by DMV. *** Required *** It must be included in the input file but not included in the output file.

Value: to be assigned.

NYC PD E-ticket

New York City Police Dept

1 Police Plaza Path

New York

NY

10007

123

5185555555

xxx@

XXX

???

NYC

B##

B

ETICKET

22.231.113.64

???

______________________________________________________________________________

Description: Information that indicates the type of transaction. The ticket file may contain only one “ADMIN_TRANSACTION” element, which contains the following child elements. *** Required ***

Description: Indicates the date the file was processed. Not required in the input file. Only included in the returned .ack file and .err file.

Sample data: 20090828

Description: Indicates the time the file was processed. Not required in the input file. Only included in the returned .ack file and .err file.

Sample value: 120010705

Description: Application ID in the DMV system. *** Required ***

Value: EBAA

Description: System Code in the DMV system. *** Required ***

Value: XADJ

Description: Transaction Code in the DMV system. *** Required ***

Value: ATAD

Description: The combination of and . Not required in the input file, but included in the returned file.

Value: EBAAATAD

Description: This element indicates the disposition status of the transaction. “P” if the file was accepted successfully, “E” if there was some sort of error. Not required in the input file, but included in the returned file.

Value: “P” or “E”

______________________________________________________________________________

Description: Information regarding the batch transaction. The ticket file may contain only one “ADMIN_BTCH_TRANS” element, which contains the following child elements.

Description: The parent element of the nodes. The ticket file may contain only one “IN_BTCHS” element. This element may contain only one “IN_BTCH” node or none in the input file but it may contain multiple “IN_BTCH” nodes in the returned file.

Description: The parent element of the “BTCH_ID” and “CUST_REF_NUM” nodes. The input file may or may not contain this element, but returned file will contain this element.

Description: The batch id logged by the DMV’s server. A unique value per input file when the file is successfully logged in DMV. Not to be included in the input file.

Description: The file reference number that user can specify for the convenience of the user. The input file may contain only one “CUST_REF_NUM” element, if the user chooses to use this element. This element will be included in the returned file, if the input data contains this data.

Description: Total number of tickets in the file. This number must match the number of “Ticket” nodes in the file. *** Required ***

Sample value: 43

Description: The name of the node that contains the ticket data. *** Required ***

Value: Ticket

______________________________________________________________________________

Description: The parent element of the “MESSAGE_TEXT” nodes. The “SYSTEM_MESSAGES” element may contain multiple “MESSAGE_TEXT” nodes. It should not be included in the input file and it is only included in the returned .out or .err file.

Description: This element contains the error code (6-7 in length) and error message separated by a “: “.

______________________________________________________________________________

Description: This element follows after DMV’s ADMIN nodes and it is a parent element to the “Ticket” elements. The ticket file may contain only one “TRANSACTIONS” element. *** Required ***

Description: This element contains ticket record information. Multiple “Ticket” nodes may be contained in the “TRANSACTIONS” element. The number of “Ticket” nodes must match the value of the “TRANS_COUNT” element. *** Required ***

Each element contains the following elements as containers.

___________________________________________________________________________________

Description: Ticket Header. This is a container for the ticket number and the officer’s information, etc. *** Required ***

This element contains the following elements.

Description: Ticket type and ticket version creation date

Sample data: UT-60(4/13)

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 11

• xsd:maxLength: 11

• The date of the ticket version must be noted at the end of the data field

____________________________________________________________________________________

***Required***

Description: Ticket number

Sample data: 1B110001NY

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 10

• xsd:maxLength: 10

The Universal Ticket Number must be a unique 10-character value while adhering to the following rules:

• 10 alphanumeric characters

• Position 1 cannot be zero “O”

• Only letters and numbers are allowed, no special characters

• All letters must be UPPER CASE

• Create by using the letters of the alphabet B-Z plus 0-9 characters minus vowels (A,E,I,O,U,Y)

o Insures that the ticket will not spell or imply anything offensive

______________________________________________________________________________

*** Required ***

Description: National Crime Information Center Code.

Sample data: 03030

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 5

• xsd:maxLength: 5

The 5 position numeric National Crime Information Center Code designating the enforcement agency that issued the traffic ticket.

(Note: The NCIC that is used is the middle 5 characters of the full 9 character value. For instance, NY0303000 would then be 03030. The NY and 00 are removed.)

______________________________________________________________________________

*** Required ***

Description: Officer Tax ID Number

Sample data: 172762

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 6

• xsd:maxLength: 6

If the tax id number is less than 6 characters, pad the number with preceding zeros.

Ex. 005493

The Police officer Tax ID number is required and must already be on file with DMV for all Adjudication tickets.

_____________________________________________________________________________

*** Required ***

Description: Officer initials.

First initial of first name, first initial of last name.

Sample data: AS

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 2

• xsd:maxLength: 2

The first initial of the officer’s first name and the first initial of the officer’s last name.

_____________________________________________________________________________

*** Required ***

Description: Rank (Rank is optional), First Initial of the Officer’s first name and complete last name.

Sample data: PO A SMITH

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 3

• xsd:maxLength: 20

_____________________________________________________________________________

***Required***

Description: Officer Signature.

Format TBD

_____________________________________________________________________________

***Only required for speeding violations where radar is used***

Description: Radar officer signature – must appear for ticket involving radar, otherwise can be omitted or left blank.

Format TBD

_____________________________________________________________________________

***Required***

Description: TVB (Traffic Violations Bureau) This element should always be set to “Y” for tickets returnable to a Traffic Violations Bureau)

Sample Data: Y

• xsd:minLength: 1

• xsd:maxLength: 1

___________________________________________________________________________________

Description: A container element for the motorist’s data. *** Required ***

This element contains following other elements.

*** Required when Gender code is M or F ***

***Not a required field when Gender code is C (corporation) ***

Description: Motorist’s First Name.

Sample data: SALLY

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 0

• xsd:maxLength: 20

Alpha characters and '-' (dash) are valid. The dash cannot be the first or last character.

_____________________________________________________________________________

***Not a required field***

Description: Motorist’s Middle Initial, or Middle Name.

Sample data: D

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 0

• xsd:maxLength: 20

Must be alpha-only

_____________________________________________________________________________

*** Required ***

Description: Motorist’s Last Name; or the name of the corporation a ticket was issued to.

Sample data for motorist: SMITH

Sample data for corporation: CHOICE ONE AUTO CARE

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 2

• xsd:maxLength: 20

Last Name can only contain alpha characters, and '-' (dash). The dash cannot be the first or last position. No special characters allowed other than a dash.

Corporation names must be put into the last name field.

No numbers can be used so any company names that include them must be spelled out alphabetically.

Do not enter the suffix in the last name field. There is a separate field for Suffix.

_____________________________________________________________________________

***Not Required***

Description: Motorist’s Suffix name. If supplied, must be one of the DMV acceptable suffixes. Select an option from the list below.

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 0

• xsd:maxLength: 4

Suffix table:

| |

|Acceptable SUFFIX[pic] |

| |

|I |

| |

|II |

| |

|III |

| |

|IV |

| |

|IX |

| |

|JR |

| |

|SR |

| |

|V |

| |

|VI |

| |

|VII |

| |

|VIII |

| |

|X |

| |

| |

| |

_____________________________________________________________________________

*** Required ***

Description: Motorist's Residence Street Address.

Sample data: 1010 ANYPLACE ST

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 5

• xsd:maxLength: 20

Alpha numeric or '&' or '/' or '-' or spaces are the only valid entries

_____________________________________________________________________________

*** Required ***

Description: Motorist’s Residence City.

Sample data: YOURCITY

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 2

• xsd:maxLength: 20

Alpha or '-' or spaces are the only valid characters

_____________________________________________________________________________

*** Required ***

Description: Motorist’s Residence State or Province.

Sample data: NY

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 2

• xsd:maxLength: 2

* See U.S. States, Territories, and Canadian Provinces Table in Appendix A.

_____________________________________________________________________________

*** Required ***

Description: Motorist’s Residence Zip-Code.

Sample data: 121210000

Data must adhere to the following:

• base: xsd:string

• xsd:pattern: [0-9]{5}([0-9]{4})

• xsd:minLength: 5

• xsd:maxLength: 9

No space or hyphen between the zip code and the +4

_____________________________________________________________________________

***Required if the gender code is M or F ***

***Not required if the gender code is C***

Description: Motorist’s Birth Date

Sample data: 07/18/1993

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 0

• xsd:maxLength: 10

MM/DD/YYYY: format. Month and day must be padded with leading zeros.

If Gender code is C field should not be populated

_____________________________________________________________________________

***Not required***

Description: Motorist Age

Sample data: 46

Data must adhere to the following:

Restrictions: base:xsd:string

_____________________________________________________________________________

***Not required ***

Description: License Expiration Date

Sample data: 07/18/2013

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 0 (if no license)

• xsd:maxLength: 10

MM/DD/YYYY: format. Month and day must be padded with leading zeros.

_____________________________________________________________________________

*** Required ***

Description: Motorist’s gender code. Select an option from the list.

Sample data: F

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 1

• xsd:maxLength: 1

List of acceptable values:

|Code |Description |

|M |Male |

|F |Female |

|C |Corporation |

_____________________________________________________________________________

Description: A container element for the motorist’s license data.

***Required if the motorist is licensed/a permit holder/NDID holder***

***Not required if the motorist is unlicensed***

***Not required if the motorist’s license status is unknown***

***Not required if the Gender code is C (company) ***

This element contains the following additional elements.

***Not Required***

Description: State or province license issued in.

Sample data: NY

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 2

• xsd:maxLength: 2

* See U.S. States, Territories, and Canadian Provinces Table in Appendix A.

*** Not Required***

Description: Out of State License Number or NYS Drivers License Number (Client ID).

Sample data For NY Licensees: 123456789

Sample data for other state licensees: G158497521538963257451853

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 0

• xsd:maxLength: 25

If the accused is not a corporation, and the motorist's license/permit/NDID is from NY, entry is strongly recommended and must be the NYS Client-ID.

This is always a nine digit numeric value, and (000000000) or (555555555) or (999999999) is not allowed. A null value is also allowed if the < State> is NY and the Client ID is not known.

If the accused is not a corporation, and the motorist is licensed in a state other than NY, the field may be left blank. However, if entered, this would be the motorist's license number from the issuing state.

Format: Alphanumeric only, 25 character maximum. A minimum length of zero allows the element to be left blank.

Special Characters (including a space) are not allowed.

______________________________________________________________________

***Required***

Description: License Class. If the accused is a licensed motorist from another state, then the class of the motorist’s license is required. If the motorist is not licensed or the class of the motorist’s license cannot be determined, the default should be "UNKNOWN".

Sample data: B

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 1

• xsd:maxLength: 9

Note: For out-of-state licenses, enter the class from the license up to a maximum of

nine characters.

NYS Driver License Class Description

|License Class (Minimum Age) |Code |Vehicle Type Examples |Vehicle Descriptions |

|A |A |Combination – such as |Gross combination weight rating (GCWR) of more than 26,000 |

|(21) | |tractor-trailer or truck |lbs., provided the gross vehicle weight rating (GVWR) or |

| | |trailer |GCWR of vehicle(s) being towed is more than 10,000 lbs. |

|B |B |Single – Such as heavy single |GVWR of more than 26,000 lbs. Class B may tow vehicles with|

|(21) | |unit truck |a GVWR of 10,000 lbs. or less, or may tow a vehicle of more |

|(18 – No interstate commerce.| | |than 10,000 lbs. providing the GCWR is not more than 26,000 |

|Cannot transport hazardous | | |lbs. |

|materials or | | | |

|operate a school bus) | | | |

|CDL C |C |Single – Such as heavy single |GVWR of 26,000 lbs. or less that: |

|(21) | |unit truck or bus |Transports 15 or more passengers OR |

|(18 – No interstate commerce.| | |Transports passengers under Article 19-A of the V&T Law OR |

|Cannot transport hazardous | | |Carries Hazardous Materials (Class C may tow vehicles with a|

|materials or | | |GVWR of 10,000 lbs. or less, or may tow a vehicle of more |

|operate a school bus) | | |than 10,000 lbs. providing the GCWR is not more than |

| | | |26,000lbs.) |

|Non – CDL C *** |N |Single – Such as farm vehicles|GVWR of 26,000 lbs. or less that does not require a CDL |

|(18) | | |endorsement. |

| | | |May tow a vehicle with a GVWR of 10,000 lbs. or less, or may|

| | | |tow a vehicle of more than 10,000 lbs. providing the GCWR is|

| | | |not more than 26,000 lbs. |

|D *** |D |Single – such as passenger |GVWR of 26,000 lbs. or less. |

|(18; | |cars and light trucks |May tow a vehicle with a GVWR of 10,000 lbs. or less; or may|

|17 with Student Certificate | | |tow a vehicle of more than 10,000 lbs. providing the GCWR is|

|of Completion) | | |not over 26,000 lbs. |

| | | |Limited use automobiles |

| | | |Class B and/or Class C limited use motorcycles |

| | | |Recreational vehicles with a GVWR of 26,000 lbs. or less |

|DJ |DJ |Single |GVWR of 10,000 lbs. or less |

|(16) | | |May tow a vehicle of 3,000 lbs. or less. |

| | | |Limited use automobiles |

| | | |Class B and/or Class C limited use motorcycles |

|E |E |Single – such as taxi and |GVWR of 26,000 lbs. or less used to transport 14 or fewer |

|(18) | |livery |passengers for hire and does not fall under 19-A |

| | | |May tow a vehicle with a GVWR of 10,000 lbs. or less, and |

| | | |may tow a vehicle of more than 10,000 lbs. providing the |

| | | |GCWR is not over 26,000 lbs. |

| | | |RV GVWR 26,000 lbs. or less |

|M |M |Motorcycle | |

|(18; 17 with Student |or | | |

|Certificate of Completion); |MJ | | |

|MJ (16) | | | |

|UNKNOWN |UNKNOWN | |Unknown: If the motorist is not licensed or the class of the|

| | | |motorist’s license cannot be determined. |

___________________________________________________________________________________

Description: A container element for the vehicle data.

This element contains the following additional elements.

*** Required ***

Description: Type of vehicle the motorist was driving or occupying at the time of the offense.

Sample data: 1

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 1

• xsd:maxLength: 1

Vehicle Type table:

|Code |Description |

|0 |No vehicle |

|1 |Passenger |

|2 |Bus |

|3 |Motorcycle |

|4 |Moped |

|5 |Truck |

|6 |Truck/Tractor |

|7 |Recreation vehicle |

|8 |Farm vehicle |

|9 |All others |

|A |All terrain vehicle |

|B |Bicycle |

|P |Pickup truck |

|V |Van |

|Y |Yellow Taxi |

|G |Green Taxi |

|S |Black Car Svc |

|T |Tow Truck |

|M |Ambulance |

|F |Fire Truck |

|C |Pedi-cab |

|K |Scooter (for motorized bicycles) |

*** Required if a vehicle is involved in the stop***

*** Not required for 0, 9, B, C ***

Description: Plate Number. Alphanumeric plate number with no embedded spaces or special characters.

(Not required if there is not a vehicle involved, i.e. bicycle violations)

Sample data: 123ABC

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 1

• xsd:maxLength: 8

______________________________________________________________________

*** Required if a vehicle is involved in the stop***

*** Not required for 0, 9, B, C ***

Description: State vehicle is registered in.

(Not required if there is not a vehicle involved, i.e. bicycle violations)

Sample data: NY

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 0

• xsd:maxLength: 2

* See U.S. States, Territories, and Canadian Provinces Table in Appendix A.

______________________________________________________________________

*** Required if a vehicle is involved in the stop***

*** Not required for 0, 9, B, C ***

(Not required if there is not a vehicle involved, i.e. bicycle violations)

Description: Vehicle Registration Type, required with certain Registration violations.

Data must adhere to the following:

• base: xsd:string

Xsd:minLength: 0

• xsd:maxLength: 3

*See Vehicle Registration Type table in Appendix B.

______________________________________________________________________

______________________________________________________________________

*** Required if a vehicle is involved in the stop***

*** Not required for 0, 9, B, C ***

Description: Vehicle Make, maximum of 5-character Vehicle Make.

Sample data: CHEV

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 1

• xsd:maxLength: 5

* Use the NCIC Vehicle Make Code Table found at the link below



______________________________________________________________________

*** Required if a vehicle is involved in the stop***

*** Not required for 0, 9, B, C ***

Description: Vehicle Year.

Sample data: 1997

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 0

• xsd:maxLength: 4

______________________________________________________________________

***Not Required***

Description: Vehicle Model

Sample data: MALIBU

• base: xsd:string

• xsd:minLength: 0

• xsd:maxLength: 25

______________________________________________________________________

*** Required if a vehicle is involved in the stop***

*** Not required for 0, 9, B, C ***

Description: Registration Expiration Date.

(Not required if there is not a vehicle involved, i.e. bicycle violations)

Sample data: 06/30/2006

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 0

• xsd:maxLength: 10

MM/DD/YYYY: format. Month and day must be padded with leading zeros.

______________________________________________________________________

*** Required if a vehicle is involved in the stop***

*** Not required for 0, 9, B, C ***

Description: Vehicle Color

(Not required if there is not a vehicle involved, i.e. bicycle violations)

Sample data: GY

If a vehicle is two colors the colors should be represented with the first color code a backslash and then the 2nd color code. Example: Green & Black would be transmitted as GR/BK.

To designate light vs dark shades of color use LT for light and DK for dark, a backslash, and then the color of the vehicle. Example: Light Green would be transmitted as LT/GR.

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 0

• xsd:maxLength: 5

* See Vehicle Color Code table in Appendix C.

______________________________________________________________________

***Not Required***

Description: Vehicle Identification Number

Alphanumeric no special characters or spaces

Sample data: JH4TB2H26CC000000

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 0

• Xsd::maxLenght: 17

There are 17 numbers and letters (17 positions) in a VIN and you can divide them into three groups: World Manufacturer Identifier, Vehicle Descriptor Section, and Vehicle Identifier Section.

If a value is captured, display it in the description field by appending it to the end of the description in the field.

______________________________________________________________________

***Required for all weight violations***

Description: Registered vehicle Weight

Sample data: 80000

Data must adhere to the following:

• base: xsd:string

• Xsd:minLength: 0

• xsd:maxLength: 6

When captured, the values of // must be appended to the end of the description in the field

______________________________________________________________________

***Required for all weight violations***

Description: Actual vehicle Weight

Sample data: 80200

Data must adhere to the following:

• base: xsd:string

• Xsd:minLength: 0

• xsd:maxLength: 6

When captured, the values of // must be appended to the end of the description in the field

______________________________________________________________________

***Required for all weight & length violations***

Description: Number of Axles

Sample data: 5

Data must adhere to the following:

Restrictions: • base: xsd:string

• Xsd:minLength: 0

• xsd:maxLength: 2

When captured, the values of // must be appended to the end of the description in the field

______________________________________________________________________

*** Not Required ***

Description: Commercial vehicle indicator.

Values: "C" if the Vehicle is Commercial, a null value if not Commercial.

Sample data: C

Commercial Motor Vehicle – A motor vehicle or combination of vehicles designed or used to transport passengers or property:

• Which has a GVWR (gross vehicle weight rating) of more than twenty-six thousand pounds; or

• Which has a GCWR (gross combination weight rating) of more than twenty-six thousand pounds, including any towed unit with a GVWR of more than ten thousand pounds;

or

• Designed or used to transport fifteen or more passengers, in addition to the driver

*** A pickup truck with commercial plate is not a commercial vehicle for these purposes.

Data must adhere to the following:

• base: xsd:string

• Xsd:minLength: 0

• xsd:maxLength: 1

______________________________________________________________________

*** Not Required ***

Description: Bus Indicator.

Values: "B" if the Vehicle is a Commercial Bus, a null value if not a bus.

Sample data: B

Data must adhere to the following:

• base: xsd:string

• Xsd:minLength: 0

• xsd:maxLength: 1

______________________________________________________________________

*** Not Required ***

Description: HazMat Indicator.

Values: "H" If the Vehicle is carrying Hazardous Materials or Placarded as such, a null value if not.

Sample data: H

Data must adhere to the following:

• base: xsd:string

• Xsd:minLength: 0

• xsd:maxLength: 1

______________________________________________________________________

*** Required if a vehicle is involved in the stop***

*** Not required for 0, 9, B, C ***

Description: Owner Owned. Must be “Y” or “N”.

Sample data: Y

Data must adhere to the following:

• base: xsd:string

• xsd:maxLength: 1

______________________________________________________________________

***Not required***

Description: DOT Number assigned to commercial vehicles.

Sample data: 123456

Data must adhere to the following:

• base: xsd:string

• Xsd:minLength: 0

• xsd:maxLength:8

The US DOT number is used by enforcement to determine who is legally responsible for the operation and safety of the vehicle.

______________________________________________________________________

***Not required***

Description: Out of Service indicator. Must be “Y” or “N” or Null

Sample Data: N

• base: xsd:string

• Xsd:minLength: 0

• xsd:maxLength: 1

An imminent hazard and which, when discovered, render the driver, vehicle and/or cargo “out of service” until such time that the condition(s) or defect(s) can be corrected or fixed.  

___________________________________________________________________________________

*** Required ***

Description: A container element for the court data that the ticket is answerable to.

This element contains the following additional elements.

*** Required ***

Description: Adjudication court code that the ticket is answerable to. Court code must be on the list for valid adjudication courts.

Sample data: TVB1499

Data must adhere to the following:

• base: xsd:string

• xsd:pattern: [T][V][B][0-9]{4}

• xsd:minLength: 7

• xsd:maxLength: 7

Court code table:

|Court Code |Court Name |

|TVB2799 |Rochester TVB |

|TVB7050 |Bronx TVB |

|TVB7111 |Brooklyn South TVB |

|TVB7150 |Brooklyn North TVB |

|TVB7211 |Manhattan North TVB |

|TVB7250 |Manhattan South TVB |

|TVB7311 |Queens South TVB |

|TVB7350 |Queens North TVB |

|TVB7550 |Richmond (Staten Island) TVB |

______________________________________________________________________

*** Required ***

Description: The name of the TVB that the ticket is answerable to.

Sample data: Bronx TVB

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 9

• xsd:maxLength: 28

|Court Code |Court Name |

|TVB2799 |Rochester TVB |

|TVB7050 |Bronx TVB |

|TVB7111 |Brooklyn South TVB |

|TVB7150 |Brooklyn North TVB |

|TVB7211 |Manhattan North TVB |

|TVB7250 |Manhattan South TVB |

|TVB7311 |Queens South TVB |

|TVB7350 |Queens North TVB |

|TVB7550 |Richmond (Staten Island) TVB |

___________________________________________________________________________________

*** Required ***

Description: A container element for the violation data.

This element contains the following additional elements.

*** Required ***

Description: Date and time of the occurrence of the violation.

Sample data: 09/25/201520:26:00.0000

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 18

• xsd:maxLength: 23

MM/DD/YYYYHH:MM:SS OR MM/DD/YYYY HH:MM:SS. The Violation date cannot be in the future and cannot be more than 2 years old. Month and day must be padded with leading zeros and there should be no spaces between date and time.

______________________________________________________________________

*** Required ***

Description: The type of law on which the violation is based, as printed on the motorists’ copy of the ticket

Sample data: VTL

Data must adhere to the following:

▪ base: xsd:string

▪ Xsd:minLength: 2

▪ Xsd:MaxLenght: 9

Law Type table:

|Law Type Code |Type of Law |

|PL |Penal Law |

|TAX |Tax Law |

|TL |Transportation Law |

|VTL |Vehicle/Traffic Law |

|NYCRR |New York Rules and Regulations |

|PKWY |Parkway Rules and Regulations |

|PORT AUTH |Port Authority |

|TBTA |Tri-borough Bridge and Tunnel Authority |

|TWY |Thruway Rules and Regulations |

Use the Law Type for each violation is listed the ‘law type’ column from the Traffic Violation Charge Code Table found at the link below.



______________________________________________________________________

***Required for violations of sections 1180B, 1180C, 1180D, 1180D2, 1180F and 1180G.***

Description: Actual Speed Must be a numeric value between 5 and 200.

Must be greater than speed zone ().

Sample data: 87

Data must adhere to the following:

• base: xsd:string

• xsd:minExclusive: 5

• xsd:maxExclusive: 200

______________________________________________________________________

***Required for violations of sections 1180B, 1180C, 1180D, 1180D2, 1180F and 1180G***

Description: Zone Speed - Posted Limit. Must be greater or equal to 5 and less than or equal to 65 (both inclusive) in multiples of 5. Must be less than actual speed.

Sample data: 65

Data must adhere to the following:

• base: xsd:string

• xsd:minExclusive: 5

• xsd:maxExclusive: 200

______________________________________________________________________

*** Not Required ***

Description: Type of Highway.

Sample data: 9

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 0

• xsd:maxLength: 1

* See Highway Type Code table in Appendix D and Parkway Code table in Appendix E.

______________________________________________________________________

***Not Required***

Description: Highway Number or Type of Parkway. If the highway type (HighwayTypeCode) is ‘9’ – Parkway, then the Route Code identifies the name of the Parkway.

Sample data: BRPK

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 0

• xsd:maxLength: 4

* See Route Code table in Appendix D and Parkway Code table in Appendix E.

______________________________________________________________________

***Not Required***

Description: Municipality Code: 4-digit numeric municipality code where the violation occurred.

Sample data: 3452

• xsd:minLength: 4

• xsd:maxLength: 4

______________________________________________________________________

***Required***

Description: municipality code where the violation occurred. This element should always be set to “TVB” for tickets returnable to a Traffic Violations Bureau

Sample Data: TVB

• xsd:minLength: 3

• xsd:maxLength: 3

______________________________________________________________________

***Required***

Description: Type of Arrest.

Sample data: 6

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 1

• xsd:maxLength: 1

* See Arrest Type Code table in Appendix F.

______________________________________________________________________

*** Required ***

Description: The Date and time the violation was affirmed.

Sample data: 09/25/201500:00:00.0000

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 18

• xsd:maxLength: 23

______________________________________________________________________

*** Required ***

Description: Command Code the officer is assigned to.

Sample data: 11LA

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 1

• xsd:maxLength: 4

______________________________________________________________________

***Required***

Description: NCIC Description

Sample data: NYC POLICE DEPT

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 7

• xsd:maxLength: 30

***Required***

Description: The Court Code the ticket is returnable to.

Sample data: 7050

|Court Code |Court Name |

|TVB2799 |Rochester TVB |

|TVB7050 |Bronx TVB |

|TVB7111 |Brooklyn South TVB |

|TVB7150 |Brooklyn North TVB |

|TVB7211 |Manhattan North TVB |

|TVB7250 |Manhattan South TVB |

|TVB7311 |Queens South TVB |

|TVB7350 |Queens North TVB |

|TVB7550 |Richmond (Staten Island) TVB |

______________________________________________________________________

***Required***

Description: Description of place the violation occurred

Sample data: 200 N. Clinton Ave. S/B

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 5

• xsd:maxLength: 50

______________________________________________________________________

***Required***

Description: Indicates whether the driver’s license was displayed to the arresting officer. Entry must be 1 for yes or 2 for No.

Sample data: 1

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 1

• xsd:maxLength: 1

______________________________________________________________________

*** Required ***

Description: Violation Description.

Use Violation Description from the Traffic Violation Charge Code Table found at the link below.



Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 5

• xsd:maxLength: 60

______________________________________________________________________

*** Required ***

Description: Vehicle and Traffic Code: Violation Charged.

Transmit the ‘Law Code applied to DMV’ from the Traffic Violation Charge Code Table found at the link below.



Print the ‘Law code Printed on Ticket’ on the ticket.

Sample data: 3752A1

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 3

• xsd:maxLength: 7

In some cases the Adjudication System utilizes administrative codes to accommodate special requirements such as Unregistered vs Unregistered > 60 days.

______________________________________________________________________

**Required**

Sample data: N

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 1

• xsd:maxLength: 6

If the value of = S.P.I. append “S.P.I.” to the end of the description in the field. Section 603-b of the VTL states this must be printed in the Violation description on the traffic ticket

If the value of = D append “D” to the end of the description in the field. Section 603-b of the VTL state this must be printed in the Violation description on the traffic ticket

|N |NO ACCIDENT REPORTED |

|I |INJURY ACCIDENT - NOT SERIOUS |

|S.P.I. |RESULTING IN SERIOUS PHYSICAL INJURY |

|D |RESULTING IN DEATH |

______________________________________________________________________

*** Required ***

Description: The Police precinct numeric code.

Sample data: 442

Data must adhere to the following:

• base: xsd:string

• xsd:minLength: 1

• xsd:maxLength: 10

___________________________________________________________________________________

APPENENDICIES / EXIBITS

Appendix A: U.S. States, Territories, and Canadian Provinces Table

|Code |U.S. States, Territories, and Canadian Provinces |

|AB |ALBERTA, CANADA |

|AF |ARMED FORCES (Not used in Accident Reporting) |

|AK |ALASKA |

|AL |ALABAMA |

|AR |ARKANSAS |

|AS |AMERICAN SAMOA |

|AZ |ARIZONA |

|BC |BRITISH COLUMBIA, CANADA |

|CA |CALIFORNIA |

|CO |COLORADO |

|CT |CONNECTICUT |

|DC |DISTRICT OF COLUMBIA |

|DE |DELAWARE |

|FL |FLORIDA |

|FO |FOREIGN LICENSE |

|GA |GEORGIA |

|GL |US GOVERNMENT LICENSE |

|GU |GUAM (Tickets) |

|GM |GUAM (Accidents) |

|HI |HAWAII |

|IA |IOWA |

|ID |IDAHO |

|IL |ILLINOIS |

|IN |INDIANA |

|IT |INTERNATIONAL LICENSE |

|KS |KANSAS |

|KY |KENTUCKY |

|LA |LOUISIANA |

|MA |MASSACHUSETTS |

|MB |MANITOBA, CANADA |

|MD |MARYLAND |

|ME |MAINE |

|MI |MICHIGAN |

|MN |MINNESOTA |

|MO |MISSOURI |

|MS |MISSISSIPPI |

|MT |MONTANA |

|MX |MEXICO |

|NB |NEW BRUNSWICK, CANADA (Tickets) |

|NK |NEW BRUNSWICK, CANADA (Accidents) |

|NC |NORTH CAROLINA |

|ND |NORTH DAKOTA |

|NE |NEBRASKA |

|NF |NEWFOUNDLAND, CANADA |

|NH |NEW HAMPSHIRE |

|NJ |NEW JERSEY |

|NM |NEW MEXICO |

|NS |NOVA SCOTIA, CANADA |

|NT |NORTHWEST TERRITORIES, CANADA (Tickets) |

|NW |NORTHWEST TERRITORIES, CANADA (Accidents) |

|NU |NUNAVUT, CANADA |

|NV |NEVADA |

|NY |NEW YORK |

|OH |OHIO |

|OK |OKLAHOMA |

|ON |ONTARIO, CANADA |

|OR |OREGON |

|OT |OTHER |

|PA |PENNSYLVANIA |

|PE |PRINCE EDWARD ISLAND, CANADA |

|PN |PANAMA (Tickets only) |

|PR |PUERTO RICO |

|QC |QUEBEC, CANADA (Tickets) |

|PQ |QUEBEC, CANADA (Accidents) |

|RI |RHODE ISLAND |

|SC |SOUTH CAROLINA |

|SD |SOUTH DAKOTA |

|SK |SASKATCHEWAN, CANADA (Tickets) |

|SN |SASKATCHEWAN, CANADA (Accidents) |

|TN |TENNESSEE |

|TX |TEXAS |

|US |US GOVERNMENT/ FOREIGN DIPLOMATS |

|UT |UTAH |

|VA |VIRGINIA |

|VI |VIRGIN ISLANDS |

|VT |VERMONT |

|WA |WASHINGTON |

|WI |WISCONSIN |

|WK |WAKE ISLAND |

|WV |WEST VIRGINIA |

|WY |WYOMING |

|YT |YUKON TERRITORY, CANADA |

Appendix B: Vehicle Registration Type table

|Vehicle Registration Type Code |Description |

|AGC |Agricultural Commercial |

|AGR |Agricultural |

|AMB |Ambulance |

|ARG |Air National Guard |

|ATD |All Terrain Dealer |

|ATV |All Terrain Vehicle |

|AYG |Army National Guard |

|BOB |Birthplace of Baseball |

|BOT |Boats |

|CBS |County Board of Supervisors |

|CCK |County Clerk |

|CHC |Household Carrier Commercial |

|CLG |County Legislators |

|CME |Coroner/Medical Examiner |

|CMH |Congressional Medal of Honor |

|COM |Commercial |

|CSP |Sports Commercial |

|DLR |Dealer |

|FAR |Farm |

|FPW |Former Prisoner of War |

|GSM |Gold Star Mothers |

|HAC |Ham Operator Commercial |

|HAM |Ham Operator |

|HIF |Special Reg Hearse |

|HIR |Hearse Coach (Hearse/Invalid Regular) |

|HIS |Historical |

|HOU |House or Coach Trailer |

|HSM |Historical Motorcycle |

|IRP |International Registration Plan |

|ITP |In Transit Permit |

|JCA |Court of Appeals |

|JCL |Court of Claims |

|JSC |Supreme Court (ADJ) |

|JWV |Jewish War Veterans |

|LMA |Limited Use Motorcycle - Type A |

|LMB |Limited Use Motorcycle - Type B |

|LMC |Limited Use Motorcycle - Type C |

|LOC |Locomotive |

|LTR |Light Trailer |

|LUA |Limited Use Automobile |

|MCD |Motorcycle dealer |

|MCL |Marine Corp League |

|MED |Medical Doctor |

|MOT |Motorcycle |

|NLM |Naval Militia |

|NYA |New York State Assembly |

|NYC |New York Council |

|NYS |New York State Senate |

|OMF |(Public Service) Omnibus |

|OML |(Livery) Omnibus |

|OMO |Omnibus Out-of-State |

|OMR |(Regular) Omnibus |

|OMS |(Special) Omnibus (Rentals) |

|OMT |(Taxi) Omnibus |

|OMV |(Vanity) Omnibus (Rentals) |

|ORC |Organizational Commercial |

|ORG |Organizational |

|ORM |Organizational Motorcycle |

|PAS |Passenger (Passenger) |

|PHS |Pearl Harbor Survivors |

|PPH |Purple Heart |

|PSD |Political Subdivision (municipal/thruway) |

|RGC |Regional Commercial |

|RGL |Regional |

|SCL |School Car |

|SEM |Commercial Semi-Trailer |

|SNO |Snowmobiles |

|SOS |Survivors of the shield |

|SPC |Special Purpose Commercial |

|SPO |Sports (Passenger) |

|SRF |Special Passenger |

|SRN |Special Passenger (Judges/Officials) |

|STA |State Agencies |

|STG |State National Guard |

|SUP |Supreme Court Justice |

|THC |Household Carrier Tractor |

|TOW |Tow Truck |

|TRA |Transporter |

|TRC |(Regular) Tractor |

|TRL |(Regular) Trailer |

|USC |U.S. Congress |

|USS |U.S. Senate |

|VAS |Volunteer Ambulance Services |

|VPL |Van Pool |

|WUG |World University Games |

Appendix C: Vehicle Color Code Table

|Standard Color  |Code |

|Black  |BK |

|Blue |BL |

|Brown |BR |

|Gold  |GL |

|Gray   |GY |

|Green   |GR |

|Maroon  |MR |

|Orange   |OR |

|Pink  |PK |

|Purple |PR |

|Red   |RD |

|Tan  |TN |

|White  |WH |

|Yellow |YW |

Appendix D: Highway Type Code Table

|Code |Type of Highway |

| |(Highway Type Code) |

|1 |INTERSTATE |

|2 |STATE |

|3 |COUNTY |

|4 |TOWN |

|5 |VILLAGE |

|6 |CITY |

|7 |OFF ROAD |

|8 |PARKING LOT |

|9 |PARKWAY |

Appendix E: Parkway Code Table

If the highway type (HighwayTypeCode) is ‘9’ –Parkway—then the Parkway must be identified in the . The following table lists the parkway names and their valid codes.

|Code |Parkway Description |

| |(RouteCode if HighwayTypeCode = ‘9’) |

|BDPK |BAY DRIVE |

|BRPK |BRONX RIVER PARKWAY |

|BSPK |BETHPAGE STATE PARKWAY |

|CCPK |CROSS COUNTRY PARKWAY |

|HRPK |HUTCHINSON RIVER PARKWAY |

|HSPK |HECKSCHER SPUR |

|LMPK |LONG MOUNTAIN PARKWAY |

|LOPK |LAKE ONTARIO STATE PARKWAY |

|LPKY |LOOP PARKWAY |

|MCPK |ROBERT MOSES CAUSEWAY |

|MSPK |MEADOWBROOK PARKWAY |

|NSPK |NORTHERN STATE PARKWAY |

|OCPK |OCEAN PARKWAY |

|PIPK |PALISADES INTERSTATE PARKWAY |

|RMPK |ROBERT MOSES PARKWAY |

|SAPK |SAGTIKOS STATE PARKWAY |

|SBPK |SPRAIN BROOK PARKWAY |

|SMPK |SAW MILL RIVER PARKWAY |

|SOPK |SOUTH STATE PARKWAY |

|SSPK |SOUTHERN STATE PARKWAY |

|SUPK |SUNKEN MEADOW SPUR |

|TSPK |TACONIC STATE PARKWAY |

|UNKN |UNKNOWN |

|WRPK |W RIVER ST PARKWAY |

|WSPK |WANTAGH STATE PARKWAY |

Appendix F: Arrest Type Code Table

The following table lists the valid ‘Arrest type’

|Code |Type of Arrest (ArrestTypeCode) |

|1 |PATROL |

|2 |RADAR |

|3 |ROAD CHECK |

|4 |SCALES |

|5 |PROPERTY DAMAGE ACCIDENT |

|6 |PERSONAL INJURY ACCIDENT |

|7 |FATAL ACCIDENT |

|8 |AIRCRAFT |

|9 |OTHER |

|L |LASER |

|V |VASCAR |

|W |WORK ZONE |

Example of XML:

VM014TGD9J

02701

2497

BW

B WILSON

R0lGODlhMgFAAPEAAAAAAP///wAAAAAAACH/C05FVF ** (truncated)**

Y

EDWARD

F

KARUTH

JR ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download