(PureBasic) DVLA Vehicle Enquiry Service

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.

For more information, see https://developer-portal.driver-vehicle-licensing.api.gov.uk/apis/vehicle-enquiry-service/vehicle-enquiry-service-description.html

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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"
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"registrationNumber","ABC1234")

    CkHttp::ckSetRequestHeader(http,"Accept","application/json")
    CkHttp::ckSetRequestHeader(http,"x-api-key","supplied API key")

    resp.i = CkHttp::ckPostJson3(http,"https://driver-vehicle-licensing.api.gov.uk/vehicle-enquiry/v1/vehicles","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    ; 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

    artEndDate.s = CkJsonObject::ckStringOf(jResp,"artEndDate")
    co2Emissions.i = CkJsonObject::ckIntOf(jResp,"co2Emissions")
    colour.s = CkJsonObject::ckStringOf(jResp,"colour")
    engineCapacity.i = CkJsonObject::ckIntOf(jResp,"engineCapacity")
    fuelType.s = CkJsonObject::ckStringOf(jResp,"fuelType")
    make.s = CkJsonObject::ckStringOf(jResp,"make")
    markedForExport.i = CkJsonObject::ckBoolOf(jResp,"markedForExport")
    monthOfFirstRegistration.s = CkJsonObject::ckStringOf(jResp,"monthOfFirstRegistration")
    motStatus.s = CkJsonObject::ckStringOf(jResp,"motStatus")
    registrationNumber.s = CkJsonObject::ckStringOf(jResp,"registrationNumber")
    revenueWeight.i = CkJsonObject::ckIntOf(jResp,"revenueWeight")
    taxDueDate.s = CkJsonObject::ckStringOf(jResp,"taxDueDate")
    taxStatus.s = CkJsonObject::ckStringOf(jResp,"taxStatus")
    typeApproval.s = CkJsonObject::ckStringOf(jResp,"typeApproval")
    wheelplan.s = CkJsonObject::ckStringOf(jResp,"wheelplan")
    yearOfManufacture.i = CkJsonObject::ckIntOf(jResp,"yearOfManufacture")
    euroStatus.s = CkJsonObject::ckStringOf(jResp,"euroStatus")
    realDrivingEmissions.s = CkJsonObject::ckStringOf(jResp,"realDrivingEmissions")
    dateOfLastV5CIssued.s = CkJsonObject::ckStringOf(jResp,"dateOfLastV5CIssued")


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure