@dvsa/cvs-type-definitions 2.0.12 → 2.0.16

package/lib/json-schemas/v3/tech-record/put/hgv/skeleton/index.json

@@ -0,0 +1,1082 @@
+{
+	"title": "PUT HGV Technical Record V3 Skeleton",
+	"type": "object",
+	"additionalProperties": false,
+	"required": [
+		"partialVin",
+		"techRecord_reasonForCreation",
+		"techRecord_statusCode",
+		"techRecord_vehicleType",
+		"primaryVrm",
+		"vin"
+	],
+	"properties": {
+		"partialVin": {
+			"type": "string"
+		},
+		"techRecord_adrDetails_vehicleDetails_type": {
+			"type": [
+				"string",
+				"null"
+			]
+		},
+		"techRecord_adrDetails_vehicleDetails_approvalDate": {
+			"type": [
+				"string",
+				"null"
+			]
+		},
+		"techRecord_adrDetails_permittedDangerousGoods": {
+			"type": [
+				"array",
+				"null"
+			],
+			"items": {
+				"type": "string"
+			}
+		},
+		"techRecord_adrDetails_compatibilityGroupJ": {
+			"type": [
+				"boolean",
+				"null"
+			]
+		},
+		"techRecord_adrDetails_additionalExaminerNotes": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 1024
+		},
+		"techRecord_adrDetails_applicantDetails_name": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 150
+		},
+		"techRecord_adrDetails_applicantDetails_street": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 150
+		},
+		"techRecord_adrDetails_applicantDetails_town": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 100
+		},
+		"techRecord_adrDetails_applicantDetails_city": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 100
+		},
+		"techRecord_adrDetails_applicantDetails_postcode": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 25
+		},
+		"techRecord_adrDetails_memosApply": {
+			"type": [
+				"array",
+				"null"
+			],
+			"items": {
+				"type": [
+					"string"
+				]
+			}
+		},
+		"techRecord_adrDetails_documents": {
+			"type": [
+				"array",
+				"null"
+			],
+			"items": {
+				"type": [
+					"string"
+				]
+			}
+		},
+		"techRecord_adrDetails_listStatementApplicable": {
+			"type": [
+				"boolean",
+				"null"
+			]
+		},
+		"techRecord_adrDetails_batteryListNumber": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 8
+		},
+		"techRecord_adrDetails_brakeDeclarationsSeen": {
+			"type": [
+				"boolean",
+				"null"
+			]
+		},
+		"techRecord_adrDetails_brakeDeclarationIssuer": {
+			"type": [
+				"string",
+				"null"
+			]
+		},
+		"techRecord_adrDetails_brakeEndurance": {
+			"type": [
+				"boolean",
+				"null"
+			]
+		},
+		"techRecord_adrDetails_weight": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 8
+		},
+		"techRecord_adrDetails_declarationsSeen": {
+			"type": [
+				"boolean",
+				"null"
+			]
+		},
+		"techRecord_adrDetails_additionalNotes_guidanceNotes": {
+			"type": [
+				"array",
+				"null"
+			],
+			"items": {
+				"type": "string"
+			}
+		},
+		"techRecord_adrDetails_additionalNotes_number": {
+			"type": [
+				"array",
+				"null"
+			],
+			"items": {
+				"type": "string"
+			}
+		},
+		"techRecord_adrDetails_adrTypeApprovalNo": {
+			"type": [
+				"string",
+				"null"
+			]
+		},
+		"techRecord_adrDetails_adrCertificateNotes": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 1500
+		},
+		"techRecord_adrDetails_tank_tankDetails_tankManufacturer": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 70
+		},
+		"techRecord_adrDetails_tank_tankDetails_yearOfManufacture": {
+			"type": [
+				"integer",
+				"null"
+			],
+			"maximum": 9999
+		},
+		"techRecord_adrDetails_tank_tankDetails_tankManufacturerSerialNo": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 50
+		},
+		"techRecord_adrDetails_tank_tankDetails_tankTypeAppNo": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 30
+		},
+		"techRecord_adrDetails_tank_tankDetails_tankCode": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 30
+		},
+		"techRecord_adrDetails_tank_tankDetails_specialProvisions": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 1024
+		},
+		"techRecord_adrDetails_tank_tankDetails_tc2Details_tc2Type": {
+			"anyOf": [
+				{
+					"type": "null"
+				},
+				{
+					"title": "TC2 Types",
+					"type": "string",
+					"enum": [
+						"initial"
+					]
+				}
+			]
+		},
+		"techRecord_adrDetails_tank_tankDetails_tc2Details_tc2IntermediateApprovalNo": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 70
+		},
+		"techRecord_adrDetails_tank_tankDetails_tc2Details_tc2IntermediateExpiryDate": {
+			"type": [
+				"string",
+				"null"
+			]
+		},
+		"techRecord_adrDetails_tank_tankDetails_tc3Details_tc3Type": {
+			"anyOf": [
+				{
+					"type": "null"
+				},
+				{
+					"title": "TC3 Types",
+					"type": "string",
+					"enum": [
+						"intermediate",
+						"periodic",
+						"exceptional"
+					]
+				}
+			]
+		},
+		"techRecord_adrDetails_tank_tankDetails_tc3Type_tc3PeriodicNumber": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 75
+		},
+		"techRecord_adrDetails_tank_tankDetails_tc3Type_tc3PeriodicExpiryDate": {
+			"type": [
+				"string",
+				"null"
+			]
+		},
+		"techRecord_adrDetails_tank_tankDetails_tankStatement_substancesPermitted": {
+			"type": [
+				"string",
+				"null"
+			]
+		},
+		"techRecord_adrDetails_tank_tankDetails_tankStatement_statement": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 1500
+		},
+		"techRecord_adrDetails_tank_tankDetails_tankStatement_productListRefNo": {
+			"type": [
+				"string",
+				"null"
+			]
+		},
+		"techRecord_adrDetails_tank_tankDetails_tankStatement_productListUnNo": {
+			"type": [
+				"array",
+				"null"
+			],
+			"items": {
+				"type": [
+					"string"
+				]
+			}
+		},
+		"techRecord_adrDetails_tank_tankDetails_tankStatement_productList": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 1500
+		},
+		"techRecord_alterationMarker": {
+			"type": [
+				"boolean",
+				"null"
+			]
+		},
+		"techRecord_applicantDetails_name": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 150
+		},
+		"techRecord_applicantDetails_address1": {
+			"type": [
+				"null",
+				"string"
+			],
+			"maxLength": 60
+		},
+		"techRecord_applicantDetails_address2": {
+			"type": [
+				"null",
+				"string"
+			],
+			"maxLength": 60
+		},
+		"techRecord_applicantDetails_postTown": {
+			"type": [
+				"null",
+				"string"
+			],
+			"maxLength": 60
+		},
+		"techRecord_applicantDetails_address3": {
+			"type": [
+				"null",
+				"string"
+			],
+			"maxLength": 60
+		},
+		"techRecord_applicantDetails_postCode": {
+			"type": [
+				"null",
+				"string"
+			],
+			"maxLength": 12
+		},
+		"techRecord_applicantDetails_telephoneNumber": {
+			"type": [
+				"null",
+				"string"
+			],
+			"maxLength": 25
+		},
+		"techRecord_applicantDetails_emailAddress": {
+			"type": [
+				"null",
+				"string"
+			],
+			"maxLength": 255
+		},
+		"techRecord_applicationId": {
+			"type": [
+				"string",
+				"null"
+			]
+		},
+		"axles": {
+			"type": "array",
+			"items": {
+				"type": "object",
+				"title": "HGV Axles",
+				"additionalProperties": false,
+				"properties": {
+					"techRecord_parkingBrakeMrk": {
+						"type": [
+							"boolean",
+							"null"
+						]
+					},
+					"techRecord_axleNumber": {
+						"type": [
+							"integer",
+							"null"
+						]
+					},
+					"techRecord_weights_gbWeight": {
+						"type": [
+							"integer",
+							"null"
+						],
+						"minimum": 0,
+						"maximum": 99999
+					},
+					"techRecord_weights_designWeight": {
+						"type": [
+							"integer",
+							"null"
+						],
+						"minimum": 0,
+						"maximum": 99999
+					},
+					"techRecord_weights_eecWeight": {
+						"type": [
+							"integer",
+							"null"
+						],
+						"minimum": 0,
+						"maximum": 99999
+					},
+					"techRecord_tyres_tyreCode": {
+						"type": [
+							"integer",
+							"null"
+						],
+						"minimum": 0,
+						"maximum": 99999
+					},
+					"techRecord_tyres_tyreSize": {
+						"type": [
+							"string",
+							"null"
+						],
+						"maxLength": 12
+					},
+					"techRecord_tyres_plyRating": {
+						"type": [
+							"string",
+							"null"
+						]
+					},
+					"techRecord_tyres_fitmentCode": {
+						"anyOf": [
+							{
+								"type": "null"
+							},
+							{
+								"title": "Fitment Code",
+								"type": "string",
+								"enum": [
+									"single",
+									"double"
+								]
+							}
+						]
+					},
+					"techRecord_tyres_dataTrAxles": {
+						"type": [
+							"null",
+							"integer"
+						],
+						"minimum": 0,
+						"maximum": 999
+					}
+				}
+			}
+		},
+		"techRecord_bodyType_code": {
+			"type": "string"
+		},
+		"techRecord_bodyType_description": {
+			"type": "string"
+		},
+		"techRecord_brakes_antilockBrakingSystem": {
+			"type": [
+				"string",
+				"null"
+			]
+		},
+		"techRecord_brakes_dtpNumber": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 6
+		},
+		"techRecord_brakes_loadSensingValve": {
+			"type": [
+				"boolean",
+				"null"
+			]
+		},
+		"techRecord_conversionRefNo": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 10
+		},
+		"techRecord_departmentalVehicleMarker": {
+			"type": [
+				"boolean",
+				"null"
+			]
+		},
+		"techRecord_dimensions_axleSpacing_axles": {
+			"type": "string"
+		},
+		"techRecord_dimensions_axleSpacing_value": {
+			"type": [
+				"integer",
+				"null"
+			],
+			"maximum": 99999,
+			"minimum": 0
+		},
+		"techRecord_dimensions_length": {
+			"type": [
+				"integer",
+				"null"
+			],
+			"maximum": 99999,
+			"minimum": 0
+		},
+		"techRecord_dimensions_width": {
+			"type": [
+				"integer",
+				"null"
+			],
+			"maximum": 99999,
+			"minimum": 0
+		},
+		"techRecord_drawbarCouplingFitted": {
+			"type": [
+				"boolean",
+				"null"
+			]
+		},
+		"techRecord_emissionsLimit": {
+			"type": [
+				"null",
+				"integer"
+			],
+			"minimum": 0,
+			"maximum": 99
+		},
+		"techRecord_euroStandard": {
+			"type": [
+				"string",
+				"null"
+			]
+		},
+		"techRecord_euVehicleCategory": {
+			"anyOf": [
+				{
+					"title": "EU vehicle category",
+					"type": "string",
+					"enum": [
+						"m1",
+						"m2",
+						"m3",
+						"n1",
+						"n2",
+						"n3",
+						"o1",
+						"o2",
+						"o3",
+						"o4",
+						"l1e-a",
+						"l1e",
+						"l2e",
+						"l3e",
+						"l4e",
+						"l5e",
+						"l6e",
+						"l7e"
+					]
+				},
+				{
+					"type": "null"
+				}
+			]
+		},
+		"techRecord_frontAxleToRearAxle": {
+			"type": [
+				"integer",
+				"null"
+			],
+			"maximum": 99999,
+			"minimum": 0
+		},
+		"techRecord_frontAxleTo5thWheelMin": {
+			"type": [
+				"integer",
+				"null"
+			],
+			"maximum": 99999,
+			"minimum": 0
+		},
+		"techRecord_frontAxleTo5thWheelMax": {
+			"type": [
+				"integer",
+				"null"
+			],
+			"maximum": 99999,
+			"minimum": 0
+		},
+		"techRecord_frontVehicleTo5thWheelCouplingMin": {
+			"type": [
+				"integer",
+				"null"
+			],
+			"maximum": 99999,
+			"minimum": 0
+		},
+		"techRecord_frontVehicleTo5thWheelCouplingMax": {
+			"type": [
+				"integer",
+				"null"
+			],
+			"maximum": 99999,
+			"minimum": 0
+		},
+		"techRecord_fuelPropulsionSystem": {
+			"anyOf": [
+				{
+					"title": "Fuel Propulsion System",
+					"type": "string",
+					"enum": [
+						"DieselPetrol",
+						"Diesel",
+						"Petrol",
+						"Hybrid",
+						"Electric",
+						"CNG",
+						"Fuel cell",
+						"LNG",
+						"Other"
+					]
+				},
+				{
+					"type": "null"
+				}
+			]
+		},
+		"techRecord_functionCode": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 1
+		},
+		"techRecord_grossDesignWeight": {
+			"type": [
+				"integer",
+				"null"
+			],
+			"maximum": 99999,
+			"minimum": 0
+		},
+		"techRecord_grossEecWeight": {
+			"type": [
+				"integer",
+				"null"
+			],
+			"maximum": 99999,
+			"minimum": 0
+		},
+		"techRecord_grossGbWeight": {
+			"type": [
+				"integer",
+				"null"
+			],
+			"maximum": 99999,
+			"minimum": 0
+		},
+		"techRecord_make": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 30
+		},
+		"techRecord_maxTrainGbWeight": {
+			"type": [
+				"number",
+				"null"
+			],
+			"maximum": 99999,
+			"minimum": 0
+		},
+		"techRecord_maxTrainEecWeight": {
+			"type": [
+				"number",
+				"null"
+			],
+			"maximum": 99999,
+			"minimum": 0
+		},
+		"techRecord_maxTrainDesignWeight": {
+			"type": [
+				"number",
+				"null"
+			],
+			"maximum": 99999,
+			"minimum": 0
+		},
+		"techRecord_manufactureYear": {
+			"anyOf": [
+				{
+					"type": "integer",
+					"minimum": 0,
+					"maximum": 9999
+				},
+				{
+					"type": "null"
+				}
+			]
+		},
+		"techRecord_microfilm_microfilmDocumentType": {
+			"anyOf": [
+				{
+					"type": "null"
+				},
+				{
+					"title": "Microfilm Document Types",
+					"type": "string",
+					"enum": [
+						"PSV Miscellaneous",
+						"AAT - Trailer Annual Test",
+						"AIV - HGV International App",
+						"COIF Modification",
+						"Trailer COC + Int Plate",
+						"RCT - Trailer Test Cert paid",
+						"HGV COC + Int Plate",
+						"PSV Carry/Auth",
+						"OMO Report",
+						"AIT - Trailer International App",
+						"IPV - HGV EEC Plate/Cert",
+						"XCV - HGV Test Cert free",
+						"AAV - HGV Annual Test",
+						"COIF Master",
+						"Tempo 100 Sp Ord",
+						"Deleted",
+						"PSV N/ALT",
+						"XPT - Tr Plating Cert paid",
+						"FFV - HGV First Test",
+						"Repl Vitesse 100",
+						"TCV - HGV Test Cert",
+						"ZZZ -  Miscellaneous",
+						"Test Certificate",
+						"XCT - Trailer Test Cert free",
+						"C52 - COC and VTG52A",
+						"Tempo 100 Report",
+						"Main File Amendment",
+						"PSV Doc",
+						"PSV COC",
+						"PSV Repl COC",
+						"TAV - COC",
+						"NPT - Trailer Alteration",
+						"OMO Certificate",
+						"PSV Repl COIF",
+						"PSV Repl COF",
+						"COIF Application",
+						"XPV - HGV Plating Cert Free",
+						"TCT  - Trailer Test Cert",
+						"Tempo 100 App",
+						"PSV Decision on N/ALT",
+						"Special Order PSV",
+						"NPV - HGV Alteration",
+						"No Description Found",
+						"Vitesse 100 Sp Ord",
+						"Brake Test Details",
+						"COIF Productional",
+						"RDT - Test Disc Paid",
+						"RCV -  HGV Test Cert",
+						"FFT -  Trailer First Test",
+						"IPT - Trailer EEC Plate/Cert",
+						"XDT - Test Disc Free",
+						"PRV - HGV Plating Cert paid",
+						"COF Cert",
+						"PRT - Tr Plating Cert paid",
+						"Tempo 100 Permit"
+					]
+				}
+			]
+		},
+		"techRecord_microfilm_microfilmRollNumber": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 5
+		},
+		"techRecord_microfilm_microfilmSerialNumber": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 4
+		},
+		"techRecord_model": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 30
+		},
+		"techRecord_numberOfWheelsDriven": {
+			"type": [
+				"integer",
+				"null"
+			]
+		},
+		"techRecord_noOfAxles": {
+			"anyOf": [
+				{
+					"type": "integer",
+					"minimum": 0,
+					"maximum": 99
+				},
+				{
+					"type": "null"
+				}
+			]
+		},
+		"techRecord_notes": {
+			"type": [
+				"string",
+				"null"
+			]
+		},
+		"techRecord_offRoad": {
+			"type": [
+				"boolean",
+				"null"
+			]
+		},
+		"plates": {
+			"type": "array",
+			"items": {
+				"type": "object",
+				"title": "HGV Plates",
+				"additionalProperties": false,
+				"properties": {
+					"techRecord_plateSerialNumber": {
+						"type": [
+							"string",
+							"null"
+						],
+						"maxLength": 12
+					},
+					"techRecord_plateIssueDate": {
+						"type": [
+							"string",
+							"null"
+						]
+					},
+					"techRecord_reasonForIssue": {
+						"anyOf": [
+							{
+								"type": "null"
+							},
+							{
+								"title": "Plate Reason For Issue",
+								"type": "string",
+								"enum": [
+									"Free replacement",
+									"Replacement",
+									"Destroyed",
+									"Provisional",
+									"Original",
+									"Manual"
+								]
+							}
+						]
+					},
+					"techRecord_plateIssuer": {
+						"type": [
+							"string",
+							"null"
+						],
+						"maxLength": 150
+					}
+				}
+			}
+		},
+		"techRecord_reasonForCreation": {
+			"type": "string"
+		},
+		"techRecord_regnDate": {
+			"anyOf": [
+				{
+					"type": "string",
+					"pattern": "^$"
+				},
+				{
+					"type": "string",
+					"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
+				},
+				{
+					"type": "null"
+				}
+			]
+		},
+		"techRecord_roadFriendly": {
+			"type": [
+				"boolean",
+				"null"
+			]
+		},
+		"techRecord_statusCode": {
+			"title": "Status Code",
+			"type": "string",
+			"enum": [
+				"provisional",
+				"current",
+				"archived"
+			]
+		},
+		"techRecord_speedLimiterMrk": {
+			"type": [
+				"boolean",
+				"null"
+			]
+		},
+		"techRecord_tachoExemptMrk": {
+			"type": [
+				"boolean",
+				"null"
+			]
+		},
+		"techRecord_trainDesignWeight": {
+			"type": [
+				"integer",
+				"null"
+			],
+			"minimum": 0,
+			"maximum": 99999
+		},
+		"techRecord_trainEecWeight": {
+			"type": [
+				"number",
+				"null"
+			],
+			"maximum": 99999,
+			"minimum": 0
+		},
+		"techRecord_trainGbWeight": {
+			"type": [
+				"number",
+				"null"
+			],
+			"maximum": 99999,
+			"minimum": 0
+		},
+		"techRecord_tyreUseCode": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 2
+		},
+		"techRecord_vehicleClass_code": {
+			"type": "string"
+		},
+		"techRecord_vehicleClass_description": {
+			"title": "Vehicle Class Description",
+			"type": "string",
+			"enum": [
+				"motorbikes over 200cc or with a sidecar",
+				"not applicable",
+				"small psv (ie: less than or equal to 22 seats)",
+				"motorbikes up to 200cc",
+				"trailer",
+				"large psv(ie: greater than 23 seats)",
+				"3 wheelers",
+				"heavy goods vehicle",
+				"MOT class 4",
+				"MOT class 7",
+				"MOT class 5"
+			]
+		},
+		"techRecord_vehicleConfiguration": {
+			"anyOf": [
+				{
+					"title": "Vehicle Configuration",
+					"type": "string",
+					"enum": [
+						"rigid",
+						"articulated",
+						"centre axle drawbar",
+						"semi-car transporter",
+						"semi-trailer",
+						"long semi-trailer",
+						"low loader",
+						"other",
+						"drawbar",
+						"four-in-line",
+						"dolly",
+						"full drawbar"
+					]
+				},
+				{
+					"type": "null"
+				}
+			]
+		},
+		"techRecord_approvalType": {
+			"anyOf": [
+				{
+					"title": "Approval Type",
+					"type": "string",
+					"enum": [
+						"NTA",
+						"ECTA",
+						"IVA",
+						"NSSTA",
+						"ECSSTA",
+						"GB WVTA",
+						"UKNI WVTA",
+						"EU WVTA Pre 23",
+						"EU WVTA 23 on",
+						"QNIG",
+						"Prov.GB WVTA",
+						"Small series",
+						"IVA - VCA",
+						"IVA - DVSA/NI"
+					]
+				},
+				{
+					"type": "null"
+				}
+			]
+		},
+		"techRecord_approvalTypeNumber": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 25
+		},
+		"techRecord_ntaNumber": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 40
+		},
+		"techRecord_variantNumber": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 25
+		},
+		"techRecord_variantVersionNumber": {
+			"type": [
+				"string",
+				"null"
+			],
+			"maxLength": 35
+		},
+		"techRecord_vehicleType": {
+			"const": "hgv"
+		},
+		"primaryVrm": {
+			"type": "string"
+		},
+		"vin": {
+			"type": "string"
+		}
+	}
+}