Vehicle Registration

Vehicle Registry APIs

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

Get the Vehicle details

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

post

/vehicle/v1/_search

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

registrationNumberstring[]

Allows search for service type - comma separated list

idsstring[]

Search by list of UUID

mobileNumberstring

Search by mobile number of service requester

ownerIdstring[]

Search by uuid of service requester

typestring[]

Search by type of the vehicle

modelstring[]

Search by model of the vehicle

tankCapacitystring

Search by tankCapacity of the vehicle

sortBystring · enum

sort the search results by fields

Options: type, model, suctionType, pollutionCertiValidTill, InsuranceCertValidTill, fitnessValidTill, roadTaxPaidTill, tankCapicity, createdTime

sortOrderstring

sorting order of the search resulsts

suctionTypestring[]

Search by model of the vehicle

limitstring

limit on the resulsts

offsetstring

offset index of the overall search resulsts

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_search?tenantId=text'

202

400

202

{
  "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",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "status": "ACTIVE"
  },
  "totalCount": "text"
}

Successful response sorted by reverse chrnological order of creation

Add new vehicle

Add the vehicle details into the system

post

/vehicle/v1/_create

Body

requestInfoobject

RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseHeader in the response body to ensure correlation.

vehicleobject

Instance of Service request raised for a particular service. As per extension propsed in the Service definition "attributes" carry the input values requried by metadata definition in the structure as described by the corresponding schema.

• Any one of 'address' or '(lat and lang)' or 'addressid' is mandatory

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiInfo":{"id":"text","version":"text","path":"text"},"deviceDetail":{"id":"text","signature":"text"},"ts":1,"action":"text","msgId":"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"}]}]}},"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"}]}]},"tenantId":"text","registrationNumber":"text","model":"text","type":"text","additionalDetail":{},"source":"whatsapp, ivr etc","auditDetails":{"createdBy":"text","lastModifiedBy":"text","createdTime":1,"lastModifiedTime":1},"status":"ACTIVE"}}'

202

400

202

{
  "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",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "status": "ACTIVE"
  },
  "totalCount": "text"
}

Request submitted successfully

Update existing vehicle details

Updates the details of the vehicle

post

/vehicle/v1/_update

Body

requestInfoobject

RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseHeader in the response body to ensure correlation.

vehicleobject

Instance of Service request raised for a particular service. As per extension propsed in the Service definition "attributes" carry the input values requried by metadata definition in the structure as described by the corresponding schema.

• Any one of 'address' or '(lat and lang)' or 'addressid' is mandatory

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiInfo":{"id":"text","version":"text","path":"text"},"deviceDetail":{"id":"text","signature":"text"},"ts":1,"action":"text","msgId":"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"}]}]}},"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"}]}]},"tenantId":"text","registrationNumber":"text","model":"text","type":"text","additionalDetail":{},"source":"whatsapp, ivr etc","auditDetails":{"createdBy":"text","lastModifiedBy":"text","createdTime":1,"lastModifiedTime":1},"status":"ACTIVE"}}'

202

400

202

{
  "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",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "status": "ACTIVE"
  },
  "totalCount": "text"
}

Request submitted successfully

plainsearch

post

/vehicle/v1/_plainsearch

Query parameters

applicationStatusstring[]

idsstring[]

limitinteger · int32

mobileNumberstring

modelstring[]

offsetinteger · int32

ownerIdstring[]

registrationNumberstring[]

sortBystring · enum

Options: InsuranceCertValidTill, createdTime, fitnessValidTill, model, pollutionCertiValidTill, roadTaxPaidTill, suctionType, tankCapicity, type, vehicleOwner

sortOrderstring · enum

Options: ASC, DESC

statusstring[]

suctionTypestring[]

tankCapacitynumber · double

tenantIdstring

typestring[]

vehicleOwnerstring[]

vehicleWithNoVendorboolean

vendorVehicleStatusstring[]

Body

RequestInfoRequestInfo

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_plainsearch' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"userInfo":{"roles":[{}]}}}'

200

201

401

403

404

200

{
  "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",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "status": "ACTIVE"
  },
  "totalCount": "text"
}

OK

fetchApplicationCount

post

/vehicle/v1/fetchApplicationStatusCount

Body

limitinteger · int32

mobileNumberstring

offsetinteger · int32

tankCapacitynumber · double

tenantIdstring

vehicleWithNoVendorboolean

sortBystring · enum

Options: InsuranceCertValidTill, createdTime, fitnessValidTill, model, pollutionCertiValidTill, roadTaxPaidTill, suctionType, tankCapicity, type, vehicleOwner

sortOrderstring · enum

Options: ASC, DESC

applicationStatusstring[]

idsstring[]

modelstring[]

ownerIdstring[]

registrationNumberstring[]

statusstring[]

suctionTypestring[]

typestring[]

vehicleOwnerstring[]

vendorVehicleStatusstring[]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/fetchApplicationStatusCount' \
  --header 'Content-Type: application/json' \
  --data '{"sortBy":"InsuranceCertValidTill","sortOrder":"ASC","applicationStatus":[null],"ids":[null],"model":[null],"ownerId":[null],"registrationNumber":[null],"status":[null],"suctionType":[null],"type":[null],"vehicleOwner":[null],"vendorVehicleStatus":[null]}'

200

201

401

403

404

200

{
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "applicationIds": [
    "text"
  ],
  "applicationStatusCount": [
    {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  ]
}

OK

fetchVehicleTripDetail

post

/vehicle/v1/searchTrip

Body

businessServicestring

limitinteger · int32

offsetinteger · int32

tenantIdstring

sortBystring · enum

Options: applicationStatus, applicationiNo, createdTime, referenceNo, tripEndTime, tripStartTime, vehicle

sortOrderstring · enum

Options: ASC, DESC

applicationNosstring[]

applicationStatusstring[]

driverIdsstring[]

idsstring[]

refernceNosstring[]

tripOwnerIdsstring[]

vehicleIdsstring[]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/searchTrip' \
  --header 'Content-Type: application/json' \
  --data '{"sortBy":"applicationStatus","sortOrder":"ASC","applicationNos":[null],"applicationStatus":[null],"driverIds":[null],"ids":[null],"refernceNos":[null],"tripOwnerIds":[null],"vehicleIds":[null]}'

200

201

401

403

404

200

{
  "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": {},
      "itemStartTime": 1,
      "itemEndTime": 1,
      "volume": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "status": "ACTIVE"
    }
  ]
}

OK

Get the VehicleTrip details

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

post

/vehicle/trip/v1/_search

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

registrationNumberstring[]

Allows search for service type - comma separated list

idsstring[]

Search by list of UUID of vehicleLog

tripOwnerIdsstring[]

Search by list of UUID of of the trip owners

driverIdsstring[]

Search by list of UUID of of the drivers

vehicleIdsstring[]

Search by list of UUID of vehicle(s)

referenceNosstring[]

Search by the referenceNo(s)

applicationNosstring[]

Search by the applicationNo(s)

businessServicestring

search by the businessService of the vehicleLog

applicationStatusstring[]

search by the list of applicationStatus of the vehicleLog

offsetinteger

offset for the pagination results

limitinteger

limit for the pagination results

sortOrderstring · enum

sort the search results in Ascending or descending order

Options: ASC, DESC

sortBystring · enum

sort the search results by fields

Options: applicationStatus, applicationiNo, referenceNo, vehicle, tripStartTime, tripEndTime, createdTime

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_search?tenantId=text'

202

400

202

{
  "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"
  },
  "totalCount": "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",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "status": "ACTIVE"
      },
      "applicationNo": "text",
      "additionalDetail": {},
      "businessService": "text",
      "applicationStatus": "text",
      "tripStartTime": 1,
      "tripEndTime": 1,
      "fstpEntryTime": 1,
      "fstpExitTime": 1,
      "volumeCarried": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "status": "ACTIVE",
      "tripDetails": [
        {
          "id": "text",
          "tenantId": "text",
          "referenceNo": "text",
          "referenceStatus": "text",
          "additionalDetail": {},
          "itemStartTime": 1,
          "itemEndTime": 1,
          "volume": 1,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "status": "ACTIVE"
        }
      ]
    }
  ]
}

Successful response sorted by reverse chrnological order of creation

Add new vehicleLog

Add the vehicleLog details into the system

post

/vehicle/trip/v1/_create

Body

requestInfoobjectrequired

RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseHeader in the response body to ensure correlation.

VehicleTriparrayrequired

vehicle Trip will be created for each trip for a specific service

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiInfo":{"id":"text","version":"text","path":"text"},"deviceDetail":{"id":"text","signature":"text"},"ts":1,"action":"text","msgId":"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"}]}]}},"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"}]}]},"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","auditDetails":{"createdBy":"text","lastModifiedBy":"text","createdTime":1,"lastModifiedTime":1},"status":"ACTIVE"},"additionalDetail":{},"businessService":"text","auditDetails":{"createdBy":"text","lastModifiedBy":"text","createdTime":1,"lastModifiedTime":1},"status":"ACTIVE","tripDetails":[{"id":"text","tenantId":"text","referenceNo":"text","referenceStatus":"text","additionalDetail":{},"itemStartTime":1,"itemEndTime":1,"volume":1,"auditDetails":{"createdBy":"text","lastModifiedBy":"text","createdTime":1,"lastModifiedTime":1},"status":"ACTIVE"}]}}'

202

400

202

{
  "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"
  },
  "totalCount": "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",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "status": "ACTIVE"
      },
      "applicationNo": "text",
      "additionalDetail": {},
      "businessService": "text",
      "applicationStatus": "text",
      "tripStartTime": 1,
      "tripEndTime": 1,
      "fstpEntryTime": 1,
      "fstpExitTime": 1,
      "volumeCarried": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "status": "ACTIVE",
      "tripDetails": [
        {
          "id": "text",
          "tenantId": "text",
          "referenceNo": "text",
          "referenceStatus": "text",
          "additionalDetail": {},
          "itemStartTime": 1,
          "itemEndTime": 1,
          "volume": 1,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "status": "ACTIVE"
        }
      ]
    }
  ]
}

Request submitted successfully

Update existing vehicleLog details

Updates the details of the vehicleLog

post

/vehicle/trip/v1/_update

Body

requestInfoobjectrequired

RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseHeader in the response body to ensure correlation.

VehicleTriparrayrequired

vehicle Trip will be created for each trip for a specific service

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiInfo":{"id":"text","version":"text","path":"text"},"deviceDetail":{"id":"text","signature":"text"},"ts":1,"action":"text","msgId":"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"}]}]}},"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"}]}]},"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","auditDetails":{"createdBy":"text","lastModifiedBy":"text","createdTime":1,"lastModifiedTime":1},"status":"ACTIVE"},"additionalDetail":{},"businessService":"text","auditDetails":{"createdBy":"text","lastModifiedBy":"text","createdTime":1,"lastModifiedTime":1},"status":"ACTIVE","tripDetails":[{"id":"text","tenantId":"text","referenceNo":"text","referenceStatus":"text","additionalDetail":{},"itemStartTime":1,"itemEndTime":1,"volume":1,"auditDetails":{"createdBy":"text","lastModifiedBy":"text","createdTime":1,"lastModifiedTime":1},"status":"ACTIVE"}]}}'

202

400

202

{
  "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"
  },
  "totalCount": "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",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "status": "ACTIVE"
      },
      "applicationNo": "text",
      "additionalDetail": {},
      "businessService": "text",
      "applicationStatus": "text",
      "tripStartTime": 1,
      "tripEndTime": 1,
      "fstpEntryTime": 1,
      "fstpExitTime": 1,
      "volumeCarried": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "status": "ACTIVE",
      "tripDetails": [
        {
          "id": "text",
          "tenantId": "text",
          "referenceNo": "text",
          "referenceStatus": "text",
          "additionalDetail": {},
          "itemStartTime": 1,
          "itemEndTime": 1,
          "volume": 1,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "status": "ACTIVE"
        }
      ]
    }
  ]
}

Request submitted successfully

plainsearch

post

/vehicle/trip/v1/_plainsearch

Query parameters

applicationNosstring[]

applicationStatusstring[]

businessServicestring

driverIdsstring[]

idsstring[]

limitinteger · int32

offsetinteger · int32

refernceNosstring[]

sortBystring · enum

Options: applicationStatus, applicationiNo, createdTime, referenceNo, tripEndTime, tripStartTime, vehicle

sortOrderstring · enum

Options: ASC, DESC

tenantIdstring

tripOwnerIdsstring[]

vehicleIdsstring[]

Body

RequestInfoRequestInfo

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_plainsearch' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"userInfo":{"roles":[{}]}}}'

200

201

401

403

404

200

{
  "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"
  },
  "totalCount": "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",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "status": "ACTIVE"
      },
      "applicationNo": "text",
      "additionalDetail": {},
      "businessService": "text",
      "applicationStatus": "text",
      "tripStartTime": 1,
      "tripEndTime": 1,
      "fstpEntryTime": 1,
      "fstpExitTime": 1,
      "volumeCarried": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "status": "ACTIVE",
      "tripDetails": [
        {
          "id": "text",
          "tenantId": "text",
          "referenceNo": "text",
          "referenceStatus": "text",
          "additionalDetail": {},
          "itemStartTime": 1,
          "itemEndTime": 1,
          "volume": 1,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "status": "ACTIVE"
        }
      ]
    }
  ]
}

OK