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

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

Available options:

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

*/*

objectOptional

Response of vehicle detail

*/*

post

HTTPcURLJavaScriptPython

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

Add new vehicle

post

Add the vehicle details into the system

Body

Request for vehicle details

requestInfoobjectOptional

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.

vehicleobjectOptional

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

*/*

objectOptional

Response of vehicle detail

*/*

post

HTTPcURLJavaScriptPython

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

requestInfoobjectOptional

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.

vehicleobjectOptional

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

*/*

objectOptional

Response of vehicle detail

*/*

post

HTTPcURLJavaScriptPython

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 · enumOptionalAvailable options:

sortOrderstring · enumOptionalAvailable options:

statusstring[]Optional

suctionTypestring[]Optional

tankCapacitynumber · doubleOptional

tenantIdstringOptional

typestring[]Optional

vehicleOwnerstring[]Optional

vehicleWithNoVendorbooleanOptional

vendorVehicleStatusstring[]Optional

Body

RequestInfoobjectOptional

Responses

*/*

objectOptional

Response of vehicle detail

post

HTTPcURLJavaScriptPython

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 · enumOptionalAvailable options:

sortOrderstring · enumOptionalAvailable options:

statusstring[]Optional

suctionTypestring[]Optional

tankCapacitynumber · doubleOptional

tenantIdstringOptional

typestring[]Optional

vehicleOwnerstring[]Optional

vehicleWithNoVendorbooleanOptional

vendorVehicleStatusstring[]Optional

Responses

*/*

objectOptional

post

HTTPcURLJavaScriptPython

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 · enumOptionalAvailable options:

sortOrderstring · enumOptionalAvailable options:

tenantIdstringOptional

tripOwnerIdsstring[]Optional

vehicleIdsstring[]Optional

Responses

*/*

objectOptional

post

HTTPcURLJavaScriptPython

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
      }
    }
  ]
}

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

Available options:

sortBystring · enumOptional

sort the search results by fields

Available options:

Responses

*/*

objectOptional

Response of VehicleTrip detail

*/*

post

HTTPcURLJavaScriptPython

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

Add new vehicleLog

post

Add the vehicleLog details into the system

Body

Request for vehicleTrip details

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

*/*

objectOptional

Response of VehicleTrip detail

*/*

post

HTTPcURLJavaScriptPython

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

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

*/*

objectOptional

Response of VehicleTrip detail

*/*

post

HTTPcURLJavaScriptPython

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 · enumOptionalAvailable options:

sortOrderstring · enumOptionalAvailable options:

tenantIdstringOptional

tripOwnerIdsstring[]Optional

vehicleIdsstring[]Optional

Body

RequestInfoobjectOptional

Responses

*/*

objectOptional

Response of VehicleTrip detail

post

HTTPcURLJavaScriptPython

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