@dvsa/cvs-type-definitions 2.0.14 → 2.0.16

package/lib/json-schemas/v3/tech-record/put/lgv/complete/request/index.json

@@ -0,0 +1,97 @@
+{
+	"title": "Tech Record Complete Car Schema",
+	"type": "object",
+	"additionalProperties": false,
+	"required": [
+		"vehicleSubclass"
+	],
+	"allOf": [
+		{
+			"title": "Tech Record PUT Request Complete Car Schema",
+			"type": "object",
+			"additionalProperties": true,
+			"required": [
+				"vehicleSubclass"
+			],
+			"properties": {
+				"vin": {
+					"type": "string"
+				},
+				"primaryVrm": {
+					"type": "string"
+				},
+				"trailerId": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_reasonForCreation": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_vehicleType": {
+					"title": "Vehicle Type",
+					"type": "string",
+					"enum": [
+						"psv",
+						"trl",
+						"hgv",
+						"car",
+						"lgv",
+						"motorcycle"
+					]
+				},
+				"techRecord_statusCode": {
+					"title": "Status Code",
+					"type": "string",
+					"enum": [
+						"provisional",
+						"current",
+						"archived"
+					]
+				},
+				"techRecord_regnDate": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_manufactureYear": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_noOfAxles": {
+					"type": [
+						"integer",
+						"null"
+					]
+				},
+				"vehicleSubclass": {
+					"title": "Vehicle Subclass",
+					"type": "array",
+					"items": {
+						"type": "string",
+						"enum": [
+							"n",
+							"p",
+							"a",
+							"s",
+							"c",
+							"l",
+							"t",
+							"e",
+							"m",
+							"r",
+							"w"
+						]
+					}
+				}
+			}
+		}
+	]
+}

package/lib/json-schemas/v3/tech-record/put/lgv/complete/response/index.json

@@ -0,0 +1,247 @@
+{
+	"title": "Tech Record Complete Car Schema",
+	"type": "object",
+	"additionalProperties": false,
+	"required": [
+		"vehicleSubclass"
+	],
+	"allOf": [
+		{
+			"title": "Tech Record PUT Response Complete Car Schema",
+			"type": "object",
+			"additionalProperties": true,
+			"required": [
+				"vehicleSubclass",
+				"createdTimestamp",
+				"systemNumber"
+			],
+			"properties": {
+				"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
+				},
+				"vin": {
+					"type": "string"
+				},
+				"systemNumber": {
+					"type": "string"
+				},
+				"createdTimestamp": {
+					"type": "string"
+				},
+				"partialVin": {
+					"type": "string"
+				},
+				"primaryVrm": {
+					"type": "string"
+				},
+				"techRecord_createdAt": {
+					"type": "string"
+				},
+				"techRecord_createdByName": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_createdById": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_euVehicleCategory": {
+					"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"
+					]
+				},
+				"techRecord_lastUpdatedAt": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_lastUpdatedByName": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_lastUpdatedById": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_recordCompleteness": {
+					"type": "string",
+					"enum": [
+						"complete",
+						"testable",
+						"skeleton"
+					]
+				},
+				"techRecord_vehicleConfiguration": {
+					"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"
+					]
+				},
+				"techRecord_noOfAxles": {
+					"type": [
+						"integer",
+						"null"
+					]
+				},
+				"techRecord_manufactureYear": {
+					"type": [
+						"integer",
+						"null"
+					]
+				},
+				"techRecord_regnDate": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_statusCode": {
+					"title": "Status Code",
+					"type": "string",
+					"enum": [
+						"provisional",
+						"current",
+						"archived"
+					]
+				},
+				"techRecord_vehicleType": {
+					"title": "Vehicle Type",
+					"type": "string",
+					"enum": [
+						"psv",
+						"trl",
+						"hgv",
+						"car",
+						"lgv",
+						"motorcycle"
+					]
+				},
+				"techRecord_reasonForCreation": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_bodyType_code": {
+					"type": "string"
+				},
+				"techRecord_bodyType_description": {
+					"type": "string"
+				}
+			},
+			"vehicleSubclass": {
+				"title": "Vehicle Subclass",
+				"type": "array",
+				"items": {
+					"type": "string",
+					"enum": [
+						"n",
+						"p",
+						"a",
+						"s",
+						"c",
+						"l",
+						"t",
+						"e",
+						"m",
+						"r",
+						"w"
+					]
+				}
+			}
+		}
+	]
+}

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

@@ -0,0 +1,71 @@
+{
+	"title": "Tech Record Complete Car Schema",
+	"type": "object",
+	"additionalProperties": false,
+	"allOf": [
+		{
+			"title": "Tech Record PUT Request Skeleton Car Schema",
+			"type": "object",
+			"additionalProperties": true,
+			"properties": {
+				"vin": {
+					"type": "string"
+				},
+				"primaryVrm": {
+					"type": "string"
+				},
+				"trailerId": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_reasonForCreation": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_vehicleType": {
+					"title": "Vehicle Type",
+					"type": "string",
+					"enum": [
+						"psv",
+						"trl",
+						"hgv",
+						"car",
+						"lgv",
+						"motorcycle"
+					]
+				},
+				"techRecord_statusCode": {
+					"title": "Status Code",
+					"type": "string",
+					"enum": [
+						"provisional",
+						"current",
+						"archived"
+					]
+				},
+				"techRecord_regnDate": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_manufactureYear": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_noOfAxles": {
+					"type": [
+						"integer",
+						"null"
+					]
+				}
+			}
+		}
+	]
+}

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

@@ -0,0 +1,223 @@
+{
+	"title": "Tech Record Complete Car Schema",
+	"type": "object",
+	"additionalProperties": false,
+	"allOf": [
+		{
+			"title": "Tech Record PUT Response Skeleton Car Schema",
+			"type": "object",
+			"additionalProperties": true,
+			"required": [
+				"createdTimestamp",
+				"systemNumber"
+			],
+			"properties": {
+				"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
+				},
+				"vin": {
+					"type": "string"
+				},
+				"systemNumber": {
+					"type": "string"
+				},
+				"createdTimestamp": {
+					"type": "string"
+				},
+				"partialVin": {
+					"type": "string"
+				},
+				"primaryVrm": {
+					"type": "string"
+				},
+				"techRecord_createdAt": {
+					"type": "string"
+				},
+				"techRecord_createdByName": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_createdById": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_euVehicleCategory": {
+					"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"
+					]
+				},
+				"techRecord_lastUpdatedAt": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_lastUpdatedByName": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_lastUpdatedById": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_recordCompleteness": {
+					"type": "string",
+					"enum": [
+						"complete",
+						"testable",
+						"skeleton"
+					]
+				},
+				"techRecord_vehicleConfiguration": {
+					"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"
+					]
+				},
+				"techRecord_noOfAxles": {
+					"type": [
+						"integer",
+						"null"
+					]
+				},
+				"techRecord_manufactureYear": {
+					"type": [
+						"integer",
+						"null"
+					]
+				},
+				"techRecord_regnDate": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_statusCode": {
+					"title": "Status Code",
+					"type": "string",
+					"enum": [
+						"provisional",
+						"current",
+						"archived"
+					]
+				},
+				"techRecord_vehicleType": {
+					"title": "Vehicle Type",
+					"type": "string",
+					"enum": [
+						"psv",
+						"trl",
+						"hgv",
+						"car",
+						"lgv",
+						"motorcycle"
+					]
+				},
+				"techRecord_reasonForCreation": {
+					"type": [
+						"string",
+						"null"
+					]
+				},
+				"techRecord_bodyType_code": {
+					"type": "string"
+				},
+				"techRecord_bodyType_description": {
+					"type": "string"
+				}
+			}
+		}
+	]
+}