DIGIT Specifications
PlatformUrbanHealthPublic FinanceSanitation
  • Specifications Overview
    • Standardisation Approach
  • Common Service Specs
    • Access Control
    • Analytics
    • Billing
    • Collection
    • Dashboard Analytics
    • Decision Support System Ingest
    • Document Controller
    • Employee
    • Encryption
    • Filestore
    • ID Generation
    • Inbox
    • Indexer
    • Master
    • Master Data Management
    • OTP
    • Payment Gateway
    • PDF Generation
    • URL Shortening
    • User
    • Workflow
  • Domain Service Specs
    • Attendance
    • Bank Account
    • Billing Calculator
    • Birth-Death
    • Building Plan Approval
    • Building Plan Calculator
    • Campaign
    • Campaign Delivery
    • Contracts
    • Estimates
    • eChallan
    • Facility
    • Faecal Sludge Management (FSM)
    • Fire NOC
    • Fire NOC Calculator
    • Household
    • Individual
    • Inventory
    • Land
    • Muster Roll
    • National Dashboard Ingest
    • No Objection Certificate
    • Organization
    • Planning
    • Product
    • Project
    • Property Registry
    • Property Tax Calculator
    • Public Grievance Redressal
    • Registration
    • Sewerage Connection
    • Stock
    • Supervision
    • Sync
    • Trade Licence
    • Trade Licence Calculator
    • User Events
    • Vehicle Registration
    • Vendor Registration
    • Water Connection
  • Archived-docs
    • DIGIT Urban Service Specs
      • Property Tax Service
        • Property Tax Taxonomy
        • Property Tax Data Model
        • Property Tax Service API
      • Public Grievance Redressal Service
        • Public Grievance Redressal Taxonomy
        • Public Grievance Redressal Data Model
        • Public Grievance Redressal Service API
      • Trade License Service
        • Trade License Taxonomy
        • Trade License Data Model
        • Trade License API
      • Fire NOC Service
        • Fire NOC Taxonomy
        • Fire NOC Data Model
        • Fire NOC API
      • Miscellaneous Collection Service
        • Miscellaneous Collections Taxonomy
        • Miscellaneous Collections Data Model
        • Miscellaneous Collection API
      • Online Building Plan Approval Service
        • Online Building Plan Approval Taxonomy
        • Online Building Plan Approval Data Model
        • Online Building Plan Approval Service API
      • Water & Sewerage Service
        • Water & Sewerage Taxonomy
        • Water Service Data Model
        • Sewerage Service Data Model
        • Water & Sewerage Service API
      • Birth & Death Service
        • Birth & Death Taxonomy
        • Birth & Death Data Model
        • Birth & Death Service API
    • DIGIT Public Finance Management Service Specs
      • iFIX Master Data Service API
      • Adapter Master Data Service API
      • mGramSeva iFIX Adapter Service API
      • iFIX Department Entity Service API
      • Fiscal Event API
    • DIGIT Health Service Specs
      • Health Service Data Model
      • Health Service API
    • DIGIT Sanitation Service Specs
      • Faecal Sludge Management Service
        • Faecal Sludge Management Data Model
        • Faecal Sludge Management Service API
Powered by GitBook

​All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.

On this page

Was this helpful?

Export as PDF
  1. Domain Service Specs

Vehicle Registration

PreviousUser EventsNextVendor Registration

Last updated 2 years ago

Was this helpful?

Vehicle Registry APIs

API specs to capture vehicle details, add new vehicles, and update and search existing vehicle details.

Get the Vehicle details

post

Gets the list of Vehicle for a particular ULB based on search criteria.

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

registrationNumberstring[]Optional

Allows search for service type - comma separated list

idsstring[]Optional

Search by list of UUID

mobileNumberstringOptional

Search by mobile number of service requester

ownerIdstring[]Optional

Search by uuid of service requester

typestring[]Optional

Search by type of the vehicle

modelstring[]Optional

Search by model of the vehicle

tankCapacitystringOptional

Search by tankCapacity of the vehicle

sortBystring · enumOptional

sort the search results by fields

Possible values:
sortOrderstringOptional

sorting order of the search resulsts

suctionTypestring[]Optional

Search by model of the vehicle

limitstringOptional

limit on the resulsts

offsetstringOptional

offset index of the overall search resulsts

Responses
202
Successful response sorted by reverse chrnological order of creation
*/*
400
Invalid input.
*/*
post
POST /WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
{
  "responseInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "ts": 1,
    "action": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "uuid": "text",
      "userName": "text",
      "password": "text",
      "idToken": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "code": "text",
          "tenantId": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "code": "text",
              "tenantId": "text",
              "description": "text"
            }
          ]
        }
      ]
    },
    "correlationId": "text",
    "signature": "text"
  },
  "vehicle": {
    "vehicleOwner": {
      "tenantId": "text",
      "uuid": "text",
      "userName": "text",
      "password": "text",
      "idToken": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "code": "text",
          "tenantId": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "code": "text",
              "tenantId": "text",
              "description": "text"
            }
          ]
        }
      ]
    },
    "id": "text",
    "tenantId": "text",
    "registrationNumber": "text",
    "model": "text",
    "type": "text",
    "tankCapicity": 1,
    "suctionType": "text",
    "pollutionCertiValidTill": 1,
    "InsuranceCertValidTill": 1,
    "fitnessValidTill": 1,
    "roadTaxPaidTill": 1,
    "gpsEnabled": true,
    "additionalDetail": {},
    "source": "whatsapp, ivr etc",
    "status": "ACTIVE",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  },
  "totalCount": "text"
}

Get the VehicleTrip details

post

Gets the list of VehicleLog for a particular ULB based on search criteria.

Query parameters
tenantIdstring · varcharRequired

Unique id for a tenant.

registrationNumberstring[]Optional

Allows search for service type - comma separated list

idsstring[]Optional

Search by list of UUID of vehicleLog

tripOwnerIdsstring[]Optional

Search by list of UUID of of the trip owners

driverIdsstring[]Optional

Search by list of UUID of of the drivers

vehicleIdsstring[]Optional

Search by list of UUID of vehicle(s)

referenceNosstring[]Optional

Search by the referenceNo(s)

applicationNosstring[]Optional

Search by the applicationNo(s)

businessServicestringOptional

search by the businessService of the vehicleLog

applicationStatusstring[]Optional

search by the list of applicationStatus of the vehicleLog

offsetintegerOptional

offset for the pagination results

limitintegerOptional

limit for the pagination results

sortOrderstring · enumOptional

sort the search results in Ascending or descending order

Possible values:
sortBystring · enumOptional

sort the search results by fields

Possible values:
Responses
202
Successful response sorted by reverse chrnological order of creation
*/*
400
Invalid input.
*/*
post
POST /WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
{
  "responseInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "ts": 1,
    "action": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "uuid": "text",
      "userName": "text",
      "password": "text",
      "idToken": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "code": "text",
          "tenantId": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "code": "text",
              "tenantId": "text",
              "description": "text"
            }
          ]
        }
      ]
    },
    "correlationId": "text",
    "signature": "text"
  },
  "VehicleTrip": [
    {
      "tripOwner": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "tenantId": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "tenantId": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "driver": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "tenantId": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "tenantId": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "id": "text",
      "tenantId": "text",
      "vehicle": {
        "vehicleOwner": {
          "tenantId": "text",
          "uuid": "text",
          "userName": "text",
          "password": "text",
          "idToken": "text",
          "mobile": "text",
          "email": "text",
          "primaryrole": [
            {
              "name": "text",
              "code": "text",
              "tenantId": "text",
              "description": "text"
            }
          ],
          "additionalroles": [
            {
              "tenantId": "text",
              "roles": [
                {
                  "name": "text",
                  "code": "text",
                  "tenantId": "text",
                  "description": "text"
                }
              ]
            }
          ]
        },
        "id": "text",
        "tenantId": "text",
        "registrationNumber": "text",
        "model": "text",
        "type": "text",
        "tankCapicity": 1,
        "suctionType": "text",
        "pollutionCertiValidTill": 1,
        "InsuranceCertValidTill": 1,
        "fitnessValidTill": 1,
        "roadTaxPaidTill": 1,
        "gpsEnabled": true,
        "additionalDetail": {},
        "source": "whatsapp, ivr etc",
        "status": "ACTIVE",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      },
      "applicationNo": "text",
      "additionalDetail": {},
      "status": "ACTIVE",
      "businessService": "text",
      "tripDetails": [
        {
          "id": "text",
          "tenantId": "text",
          "referenceNo": "text",
          "referenceStatus": "text",
          "additionalDetail": {},
          "status": "ACTIVE",
          "itemStartTime": 1,
          "itemEndTime": 1,
          "volume": 1,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "applicationStatus": "text",
      "tripStartTime": 1,
      "tripEndTime": 1,
      "fstpEntryTime": 1,
      "fstpExitTime": 1,
      "volumeCarried": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ],
  "totalCount": "text"
}
  • Vehicle Registry APIs
  • POSTGet the Vehicle details
  • POSTAdd new vehicle
  • POSTUpdate existing vehicle details
  • POSTplainsearch
  • POSTfetchApplicationCount
  • POSTfetchVehicleTripDetail
  • POSTGet the VehicleTrip details
  • POSTAdd new vehicleLog
  • POSTUpdate existing vehicleLog details
  • POSTplainsearch

Add new vehicle

post

Add the vehicle details into the system

Body

Request for vehicle details

Responses
202
Request submitted successfully
*/*
400
Failed to process the Request
*/*
post
POST /WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 538

{
  "requestInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "ts": 1,
    "action": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "signature": "text"
  },
  "vehicle": {
    "tenantId": "text",
    "registrationNumber": "text",
    "model": "text",
    "type": "text",
    "tankCapicity": 1,
    "suctionType": "text",
    "pollutionCertiValidTill": 1,
    "InsuranceCertValidTill": 1,
    "fitnessValidTill": 1,
    "roadTaxPaidTill": 1,
    "gpsEnabled": true,
    "additionalDetail": {},
    "source": "whatsapp, ivr etc",
    "status": "ACTIVE"
  }
}
{
  "responseInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "ts": 1,
    "action": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "uuid": "text",
      "userName": "text",
      "password": "text",
      "idToken": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "code": "text",
          "tenantId": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "code": "text",
              "tenantId": "text",
              "description": "text"
            }
          ]
        }
      ]
    },
    "correlationId": "text",
    "signature": "text"
  },
  "vehicle": {
    "vehicleOwner": {
      "tenantId": "text",
      "uuid": "text",
      "userName": "text",
      "password": "text",
      "idToken": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "code": "text",
          "tenantId": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "code": "text",
              "tenantId": "text",
              "description": "text"
            }
          ]
        }
      ]
    },
    "id": "text",
    "tenantId": "text",
    "registrationNumber": "text",
    "model": "text",
    "type": "text",
    "tankCapicity": 1,
    "suctionType": "text",
    "pollutionCertiValidTill": 1,
    "InsuranceCertValidTill": 1,
    "fitnessValidTill": 1,
    "roadTaxPaidTill": 1,
    "gpsEnabled": true,
    "additionalDetail": {},
    "source": "whatsapp, ivr etc",
    "status": "ACTIVE",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  },
  "totalCount": "text"
}

Update existing vehicle details

post

Updates the details of the vehicle

Body

Request for vehicle details

Responses
202
Request submitted successfully
*/*
400
Failed to process the application
*/*
post
POST /WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_update HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 538

{
  "requestInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "ts": 1,
    "action": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "signature": "text"
  },
  "vehicle": {
    "tenantId": "text",
    "registrationNumber": "text",
    "model": "text",
    "type": "text",
    "tankCapicity": 1,
    "suctionType": "text",
    "pollutionCertiValidTill": 1,
    "InsuranceCertValidTill": 1,
    "fitnessValidTill": 1,
    "roadTaxPaidTill": 1,
    "gpsEnabled": true,
    "additionalDetail": {},
    "source": "whatsapp, ivr etc",
    "status": "ACTIVE"
  }
}
{
  "responseInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "ts": 1,
    "action": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "uuid": "text",
      "userName": "text",
      "password": "text",
      "idToken": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "code": "text",
          "tenantId": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "code": "text",
              "tenantId": "text",
              "description": "text"
            }
          ]
        }
      ]
    },
    "correlationId": "text",
    "signature": "text"
  },
  "vehicle": {
    "vehicleOwner": {
      "tenantId": "text",
      "uuid": "text",
      "userName": "text",
      "password": "text",
      "idToken": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "code": "text",
          "tenantId": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "code": "text",
              "tenantId": "text",
              "description": "text"
            }
          ]
        }
      ]
    },
    "id": "text",
    "tenantId": "text",
    "registrationNumber": "text",
    "model": "text",
    "type": "text",
    "tankCapicity": 1,
    "suctionType": "text",
    "pollutionCertiValidTill": 1,
    "InsuranceCertValidTill": 1,
    "fitnessValidTill": 1,
    "roadTaxPaidTill": 1,
    "gpsEnabled": true,
    "additionalDetail": {},
    "source": "whatsapp, ivr etc",
    "status": "ACTIVE",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  },
  "totalCount": "text"
}

plainsearch

post
Query parameters
applicationStatusstring[]Optional
idsstring[]Optional
limitinteger · int32Optional
mobileNumberstringOptional
modelstring[]Optional
offsetinteger · int32Optional
ownerIdstring[]Optional
registrationNumberstring[]Optional
sortBystring · enumOptionalPossible values:
sortOrderstring · enumOptionalPossible values:
statusstring[]Optional
suctionTypestring[]Optional
tankCapacitynumber · doubleOptional
tenantIdstringOptional
typestring[]Optional
vehicleOwnerstring[]Optional
vehicleWithNoVendorbooleanOptional
vendorVehicleStatusstring[]Optional
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_plainsearch HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 353

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "ts": 1,
    "userInfo": {
      "emailId": "text",
      "id": 1,
      "mobileNumber": "text",
      "name": "text",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "name": "text",
          "tenantId": "text"
        }
      ],
      "tenantId": "text",
      "type": "text",
      "userName": "text",
      "uuid": "text"
    },
    "ver": "text"
  }
}
{
  "responseInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "ts": 1,
    "action": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "uuid": "text",
      "userName": "text",
      "password": "text",
      "idToken": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "code": "text",
          "tenantId": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "code": "text",
              "tenantId": "text",
              "description": "text"
            }
          ]
        }
      ]
    },
    "correlationId": "text",
    "signature": "text"
  },
  "vehicle": {
    "vehicleOwner": {
      "tenantId": "text",
      "uuid": "text",
      "userName": "text",
      "password": "text",
      "idToken": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "code": "text",
          "tenantId": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "code": "text",
              "tenantId": "text",
              "description": "text"
            }
          ]
        }
      ]
    },
    "id": "text",
    "tenantId": "text",
    "registrationNumber": "text",
    "model": "text",
    "type": "text",
    "tankCapicity": 1,
    "suctionType": "text",
    "pollutionCertiValidTill": 1,
    "InsuranceCertValidTill": 1,
    "fitnessValidTill": 1,
    "roadTaxPaidTill": 1,
    "gpsEnabled": true,
    "additionalDetail": {},
    "source": "whatsapp, ivr etc",
    "status": "ACTIVE",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  },
  "totalCount": "text"
}

fetchApplicationCount

post
Body
applicationStatusstring[]Optional
idsstring[]Optional
limitinteger · int32Optional
mobileNumberstringOptional
modelstring[]Optional
offsetinteger · int32Optional
ownerIdstring[]Optional
registrationNumberstring[]Optional
sortBystring · enumOptionalPossible values:
sortOrderstring · enumOptionalPossible values:
statusstring[]Optional
suctionTypestring[]Optional
tankCapacitynumber · doubleOptional
tenantIdstringOptional
typestring[]Optional
vehicleOwnerstring[]Optional
vehicleWithNoVendorbooleanOptional
vendorVehicleStatusstring[]Optional
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/fetchApplicationStatusCount HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 380

{
  "applicationStatus": [
    "text"
  ],
  "ids": [
    "text"
  ],
  "limit": 1,
  "mobileNumber": "text",
  "model": [
    "text"
  ],
  "offset": 1,
  "ownerId": [
    "text"
  ],
  "registrationNumber": [
    "text"
  ],
  "sortBy": "InsuranceCertValidTill",
  "sortOrder": "ASC",
  "status": [
    "text"
  ],
  "suctionType": [
    "text"
  ],
  "tankCapacity": 1,
  "tenantId": "text",
  "type": [
    "text"
  ],
  "vehicleOwner": [
    "text"
  ],
  "vehicleWithNoVendor": true,
  "vendorVehicleStatus": [
    "text"
  ]
}
{
  "applicationIds": [
    "text"
  ],
  "applicationStatusCount": [
    {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  ],
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  }
}

fetchVehicleTripDetail

post
Body
applicationNosstring[]Optional
applicationStatusstring[]Optional
businessServicestringOptional
driverIdsstring[]Optional
idsstring[]Optional
limitinteger · int32Optional
offsetinteger · int32Optional
refernceNosstring[]Optional
sortBystring · enumOptionalPossible values:
sortOrderstring · enumOptionalPossible values:
tenantIdstringOptional
tripOwnerIdsstring[]Optional
vehicleIdsstring[]Optional
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/searchTrip HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 272

{
  "applicationNos": [
    "text"
  ],
  "applicationStatus": [
    "text"
  ],
  "businessService": "text",
  "driverIds": [
    "text"
  ],
  "ids": [
    "text"
  ],
  "limit": 1,
  "offset": 1,
  "refernceNos": [
    "text"
  ],
  "sortBy": "applicationStatus",
  "sortOrder": "ASC",
  "tenantId": "text",
  "tripOwnerIds": [
    "text"
  ],
  "vehicleIds": [
    "text"
  ]
}
{
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "totalCount": 1,
  "vehicleTripDetail": [
    {
      "id": "text",
      "tenantId": "text",
      "referenceNo": "text",
      "referenceStatus": "text",
      "additionalDetail": {},
      "status": "ACTIVE",
      "itemStartTime": 1,
      "itemEndTime": 1,
      "volume": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Add new vehicleLog

post

Add the vehicleLog details into the system

Body

Request for vehicleTrip details

Responses
202
Request submitted successfully
*/*
400
Failed to process the Request
*/*
post
POST /WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 941

{
  "requestInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "ts": 1,
    "action": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "signature": "text"
  },
  "VehicleTrip": {
    "tenantId": "text",
    "vehicle": {
      "tenantId": "text",
      "registrationNumber": "text",
      "model": "text",
      "type": "text",
      "tankCapicity": 1,
      "suctionType": "text",
      "pollutionCertiValidTill": 1,
      "InsuranceCertValidTill": 1,
      "fitnessValidTill": 1,
      "roadTaxPaidTill": 1,
      "gpsEnabled": true,
      "additionalDetail": {},
      "source": "whatsapp, ivr etc",
      "status": "ACTIVE"
    },
    "applicationNo": "text",
    "additionalDetail": {},
    "status": "ACTIVE",
    "businessService": "text",
    "tripDetails": [
      {
        "tenantId": "text",
        "referenceNo": "text",
        "referenceStatus": "text",
        "additionalDetail": {},
        "status": "ACTIVE",
        "itemStartTime": 1,
        "itemEndTime": 1,
        "volume": 1
      }
    ],
    "applicationStatus": "text",
    "tripStartTime": 1,
    "tripEndTime": 1,
    "fstpEntryTime": 1,
    "fstpExitTime": 1,
    "volumeCarried": 1
  }
}
{
  "responseInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "ts": 1,
    "action": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "uuid": "text",
      "userName": "text",
      "password": "text",
      "idToken": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "code": "text",
          "tenantId": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "code": "text",
              "tenantId": "text",
              "description": "text"
            }
          ]
        }
      ]
    },
    "correlationId": "text",
    "signature": "text"
  },
  "VehicleTrip": [
    {
      "tripOwner": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "tenantId": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "tenantId": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "driver": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "tenantId": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "tenantId": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "id": "text",
      "tenantId": "text",
      "vehicle": {
        "vehicleOwner": {
          "tenantId": "text",
          "uuid": "text",
          "userName": "text",
          "password": "text",
          "idToken": "text",
          "mobile": "text",
          "email": "text",
          "primaryrole": [
            {
              "name": "text",
              "code": "text",
              "tenantId": "text",
              "description": "text"
            }
          ],
          "additionalroles": [
            {
              "tenantId": "text",
              "roles": [
                {
                  "name": "text",
                  "code": "text",
                  "tenantId": "text",
                  "description": "text"
                }
              ]
            }
          ]
        },
        "id": "text",
        "tenantId": "text",
        "registrationNumber": "text",
        "model": "text",
        "type": "text",
        "tankCapicity": 1,
        "suctionType": "text",
        "pollutionCertiValidTill": 1,
        "InsuranceCertValidTill": 1,
        "fitnessValidTill": 1,
        "roadTaxPaidTill": 1,
        "gpsEnabled": true,
        "additionalDetail": {},
        "source": "whatsapp, ivr etc",
        "status": "ACTIVE",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      },
      "applicationNo": "text",
      "additionalDetail": {},
      "status": "ACTIVE",
      "businessService": "text",
      "tripDetails": [
        {
          "id": "text",
          "tenantId": "text",
          "referenceNo": "text",
          "referenceStatus": "text",
          "additionalDetail": {},
          "status": "ACTIVE",
          "itemStartTime": 1,
          "itemEndTime": 1,
          "volume": 1,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "applicationStatus": "text",
      "tripStartTime": 1,
      "tripEndTime": 1,
      "fstpEntryTime": 1,
      "fstpExitTime": 1,
      "volumeCarried": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ],
  "totalCount": "text"
}

Update existing vehicleLog details

post

Updates the details of the vehicleLog

Body

Request for vehicleTrip details

Responses
202
Request submitted successfully
*/*
400
Failed to process the application
*/*
post
POST /WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_update HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 941

{
  "requestInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "ts": 1,
    "action": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "signature": "text"
  },
  "VehicleTrip": {
    "tenantId": "text",
    "vehicle": {
      "tenantId": "text",
      "registrationNumber": "text",
      "model": "text",
      "type": "text",
      "tankCapicity": 1,
      "suctionType": "text",
      "pollutionCertiValidTill": 1,
      "InsuranceCertValidTill": 1,
      "fitnessValidTill": 1,
      "roadTaxPaidTill": 1,
      "gpsEnabled": true,
      "additionalDetail": {},
      "source": "whatsapp, ivr etc",
      "status": "ACTIVE"
    },
    "applicationNo": "text",
    "additionalDetail": {},
    "status": "ACTIVE",
    "businessService": "text",
    "tripDetails": [
      {
        "tenantId": "text",
        "referenceNo": "text",
        "referenceStatus": "text",
        "additionalDetail": {},
        "status": "ACTIVE",
        "itemStartTime": 1,
        "itemEndTime": 1,
        "volume": 1
      }
    ],
    "applicationStatus": "text",
    "tripStartTime": 1,
    "tripEndTime": 1,
    "fstpEntryTime": 1,
    "fstpExitTime": 1,
    "volumeCarried": 1
  }
}
{
  "responseInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "ts": 1,
    "action": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "uuid": "text",
      "userName": "text",
      "password": "text",
      "idToken": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "code": "text",
          "tenantId": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "code": "text",
              "tenantId": "text",
              "description": "text"
            }
          ]
        }
      ]
    },
    "correlationId": "text",
    "signature": "text"
  },
  "VehicleTrip": [
    {
      "tripOwner": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "tenantId": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "tenantId": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "driver": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "tenantId": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "tenantId": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "id": "text",
      "tenantId": "text",
      "vehicle": {
        "vehicleOwner": {
          "tenantId": "text",
          "uuid": "text",
          "userName": "text",
          "password": "text",
          "idToken": "text",
          "mobile": "text",
          "email": "text",
          "primaryrole": [
            {
              "name": "text",
              "code": "text",
              "tenantId": "text",
              "description": "text"
            }
          ],
          "additionalroles": [
            {
              "tenantId": "text",
              "roles": [
                {
                  "name": "text",
                  "code": "text",
                  "tenantId": "text",
                  "description": "text"
                }
              ]
            }
          ]
        },
        "id": "text",
        "tenantId": "text",
        "registrationNumber": "text",
        "model": "text",
        "type": "text",
        "tankCapicity": 1,
        "suctionType": "text",
        "pollutionCertiValidTill": 1,
        "InsuranceCertValidTill": 1,
        "fitnessValidTill": 1,
        "roadTaxPaidTill": 1,
        "gpsEnabled": true,
        "additionalDetail": {},
        "source": "whatsapp, ivr etc",
        "status": "ACTIVE",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      },
      "applicationNo": "text",
      "additionalDetail": {},
      "status": "ACTIVE",
      "businessService": "text",
      "tripDetails": [
        {
          "id": "text",
          "tenantId": "text",
          "referenceNo": "text",
          "referenceStatus": "text",
          "additionalDetail": {},
          "status": "ACTIVE",
          "itemStartTime": 1,
          "itemEndTime": 1,
          "volume": 1,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "applicationStatus": "text",
      "tripStartTime": 1,
      "tripEndTime": 1,
      "fstpEntryTime": 1,
      "fstpExitTime": 1,
      "volumeCarried": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ],
  "totalCount": "text"
}

plainsearch

post
Query parameters
applicationNosstring[]Optional
applicationStatusstring[]Optional
businessServicestringOptional
driverIdsstring[]Optional
idsstring[]Optional
limitinteger · int32Optional
offsetinteger · int32Optional
refernceNosstring[]Optional
sortBystring · enumOptionalPossible values:
sortOrderstring · enumOptionalPossible values:
tenantIdstringOptional
tripOwnerIdsstring[]Optional
vehicleIdsstring[]Optional
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_plainsearch HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 353

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "ts": 1,
    "userInfo": {
      "emailId": "text",
      "id": 1,
      "mobileNumber": "text",
      "name": "text",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "name": "text",
          "tenantId": "text"
        }
      ],
      "tenantId": "text",
      "type": "text",
      "userName": "text",
      "uuid": "text"
    },
    "ver": "text"
  }
}
{
  "responseInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "ts": 1,
    "action": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "uuid": "text",
      "userName": "text",
      "password": "text",
      "idToken": "text",
      "mobile": "text",
      "email": "text",
      "primaryrole": [
        {
          "name": "text",
          "code": "text",
          "tenantId": "text",
          "description": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "code": "text",
              "tenantId": "text",
              "description": "text"
            }
          ]
        }
      ]
    },
    "correlationId": "text",
    "signature": "text"
  },
  "VehicleTrip": [
    {
      "tripOwner": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "tenantId": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "tenantId": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "driver": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "tenantId": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "tenantId": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "id": "text",
      "tenantId": "text",
      "vehicle": {
        "vehicleOwner": {
          "tenantId": "text",
          "uuid": "text",
          "userName": "text",
          "password": "text",
          "idToken": "text",
          "mobile": "text",
          "email": "text",
          "primaryrole": [
            {
              "name": "text",
              "code": "text",
              "tenantId": "text",
              "description": "text"
            }
          ],
          "additionalroles": [
            {
              "tenantId": "text",
              "roles": [
                {
                  "name": "text",
                  "code": "text",
                  "tenantId": "text",
                  "description": "text"
                }
              ]
            }
          ]
        },
        "id": "text",
        "tenantId": "text",
        "registrationNumber": "text",
        "model": "text",
        "type": "text",
        "tankCapicity": 1,
        "suctionType": "text",
        "pollutionCertiValidTill": 1,
        "InsuranceCertValidTill": 1,
        "fitnessValidTill": 1,
        "roadTaxPaidTill": 1,
        "gpsEnabled": true,
        "additionalDetail": {},
        "source": "whatsapp, ivr etc",
        "status": "ACTIVE",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      },
      "applicationNo": "text",
      "additionalDetail": {},
      "status": "ACTIVE",
      "businessService": "text",
      "tripDetails": [
        {
          "id": "text",
          "tenantId": "text",
          "referenceNo": "text",
          "referenceStatus": "text",
          "additionalDetail": {},
          "status": "ACTIVE",
          "itemStartTime": 1,
          "itemEndTime": 1,
          "volume": 1,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "applicationStatus": "text",
      "tripStartTime": 1,
      "tripEndTime": 1,
      "fstpEntryTime": 1,
      "fstpExitTime": 1,
      "volumeCarried": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ],
  "totalCount": "text"
}