Tcl

DVLA Vehicle Enquiry Service

See more _Miscellaneous_ Examples

Demonstrates how to make a call to the DVLA Vehicle Enquiry API to get vehicle details of a specified vehicle. It uses the vehicle registration number as input to search and provide details of the vehicle. Tcl

load ./chilkat.dll

set success 0

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

# Implements the following CURL command:

# curl -X POST https://driver-vehicle-licensing.api.gov.uk/vehicle-enquiry/v1/vehicles \
#   -H "x-api-key: supplied API key" \
#   -H "Accept: application/json" \
#   -d '{"registrationNumber": "ABC1234"}'

# Use the following online tool to generate HTTP code from a CURL command
# Convert a cURL Command to HTTP Source Code

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "registrationNumber": "ABC1234"
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "registrationNumber" "ABC1234"

CkHttp_SetRequestHeader $http "Accept" "application/json"
CkHttp_SetRequestHeader $http "x-api-key" "supplied API key"

set resp [new_CkHttpResponse]

set success [CkHttp_HttpJson $http "POST" "https://driver-vehicle-licensing.api.gov.uk/vehicle-enquiry/v1/vehicles" $json "application/json" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkHttpResponse $resp
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkHttpResponse $resp
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "artEndDate": "2025-02-28",
#   "co2Emissions": 135,
#   "colour": "BLUE",
#   "engineCapacity": 2494,
#   "fuelType": "PETROL",
#   "make": "ROVER",
#   "markedForExport": false,
#   "monthOfFirstRegistration": "2004-12",
#   "motStatus": "No details held by DVLA",
#   "registrationNumber": "ABC1234",
#   "revenueWeight": 1640,
#   "taxDueDate": "2007-01-01",
#   "taxStatus": "Untaxed",
#   "typeApproval": "N1",
#   "wheelplan": "NON STANDARD",
#   "yearOfManufacture": 2004,
#   "euroStatus": "EURO 6 AD",
#   "realDrivingEmissions": "1",
#   "dateOfLastV5CIssued": "2016-12-25"
# }

# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

set artEndDate [CkJsonObject_stringOf $jResp "artEndDate"]
set co2Emissions [CkJsonObject_IntOf $jResp "co2Emissions"]
set colour [CkJsonObject_stringOf $jResp "colour"]
set engineCapacity [CkJsonObject_IntOf $jResp "engineCapacity"]
set fuelType [CkJsonObject_stringOf $jResp "fuelType"]
set make [CkJsonObject_stringOf $jResp "make"]
set markedForExport [CkJsonObject_BoolOf $jResp "markedForExport"]
set monthOfFirstRegistration [CkJsonObject_stringOf $jResp "monthOfFirstRegistration"]
set motStatus [CkJsonObject_stringOf $jResp "motStatus"]
set registrationNumber [CkJsonObject_stringOf $jResp "registrationNumber"]
set revenueWeight [CkJsonObject_IntOf $jResp "revenueWeight"]
set taxDueDate [CkJsonObject_stringOf $jResp "taxDueDate"]
set taxStatus [CkJsonObject_stringOf $jResp "taxStatus"]
set typeApproval [CkJsonObject_stringOf $jResp "typeApproval"]
set wheelplan [CkJsonObject_stringOf $jResp "wheelplan"]
set yearOfManufacture [CkJsonObject_IntOf $jResp "yearOfManufacture"]
set euroStatus [CkJsonObject_stringOf $jResp "euroStatus"]
set realDrivingEmissions [CkJsonObject_stringOf $jResp "realDrivingEmissions"]
set dateOfLastV5CIssued [CkJsonObject_stringOf $jResp "dateOfLastV5CIssued"]

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp