(DataFlex) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vJson
    Handle hoJson
    Variant vResp
    Handle hoResp
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sArtEndDate
    Integer iCo2Emissions
    String sColour
    Integer iEngineCapacity
    String sFuelType
    String sMake
    Boolean iMarkedForExport
    String sMonthOfFirstRegistration
    String sMotStatus
    String sRegistrationNumber
    Integer iRevenueWeight
    String sTaxDueDate
    String sTaxStatus
    String sTypeApproval
    String sWheelplan
    Integer iYearOfManufacture
    String sEuroStatus
    String sRealDrivingEmissions
    String sDateOfLastV5CIssued
    String sTemp1
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

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

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "registrationNumber" "ABC1234" To iSuccess

    Send ComSetRequestHeader To hoHttp "Accept" "application/json"
    Send ComSetRequestHeader To hoHttp "x-api-key" "supplied API key"

    Get pvComObject of hoJson to vJson
    Get ComPostJson3 Of hoHttp "https://driver-vehicle-licensing.api.gov.uk/vehicle-enquiry/v1/vehicles" "application/json" vJson To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComStatusCode Of hoResp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComHeader Of hoResp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Send Destroy of hoResp
        Procedure_Return
    End

    Send Destroy of hoResp

    // 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

    Get ComStringOf Of hoJResp "artEndDate" To sArtEndDate
    Get ComIntOf Of hoJResp "co2Emissions" To iCo2Emissions
    Get ComStringOf Of hoJResp "colour" To sColour
    Get ComIntOf Of hoJResp "engineCapacity" To iEngineCapacity
    Get ComStringOf Of hoJResp "fuelType" To sFuelType
    Get ComStringOf Of hoJResp "make" To sMake
    Get ComBoolOf Of hoJResp "markedForExport" To iMarkedForExport
    Get ComStringOf Of hoJResp "monthOfFirstRegistration" To sMonthOfFirstRegistration
    Get ComStringOf Of hoJResp "motStatus" To sMotStatus
    Get ComStringOf Of hoJResp "registrationNumber" To sRegistrationNumber
    Get ComIntOf Of hoJResp "revenueWeight" To iRevenueWeight
    Get ComStringOf Of hoJResp "taxDueDate" To sTaxDueDate
    Get ComStringOf Of hoJResp "taxStatus" To sTaxStatus
    Get ComStringOf Of hoJResp "typeApproval" To sTypeApproval
    Get ComStringOf Of hoJResp "wheelplan" To sWheelplan
    Get ComIntOf Of hoJResp "yearOfManufacture" To iYearOfManufacture
    Get ComStringOf Of hoJResp "euroStatus" To sEuroStatus
    Get ComStringOf Of hoJResp "realDrivingEmissions" To sRealDrivingEmissions
    Get ComStringOf Of hoJResp "dateOfLastV5CIssued" To sDateOfLastV5CIssued


End_Procedure