Faecal Sludge Management Service API
FSM Service Contract
Gets the list of fsm application for a particular ULB based on search criteria.
Unique id for a tenant.
Search by list of UUID
search application by list of application Status(s)
search application by list of Locality (s)
search by list of uuid(s) of the owner of the application
search by the created date faling between the fromdate and today
search by the created date faling between the fromdate and today
search application by list of applicationNo(s)
Search applicationb by mobileNumber of the Owner of the application
offset for the pagination results
limit for the pagination results
sort the search results in Ascending or descending order
sort the search results by fields
Successful response sorted by reverse chrnological order of creation
Invalid input.
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"fsm": {
"citizen": {
"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",
"applicationNo": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"applicationStatus": "text",
"source": "whatsapp, ivr etc",
"sanitationtype": "text",
"vehicleType": "text",
"vehicleCapacity": "text",
"paymentPreference": "text",
"propertyUsage": "text",
"noOfTrips": 1,
"status": "ACTIVE",
"vehicleId": "text",
"dsoId": "text",
"possibleServiceDate": 1,
"wasteCollected": 1,
"pitDetail": {
"citizen": {
"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",
"height": 1,
"length": 1,
"width": 1,
"diameter": 1,
"distanceFromRoad": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"id": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"slumName": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"rating": 1,
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"totalCount": "text"
}
Get the application audit log for every change in the response. Provides a record for each set of change
Unique id for a tenant.
search for audit log based on the application no of FSM
search for audit log based on the unique id of the application
Successful response sorted by reverse chrnological order of creation
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_audit HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
Successful response sorted by reverse chrnological order of creation
{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"fsmAudit": {
"who": "text",
"when": 1,
"what": {}
}
}
Apply for desludging
Request object for FSM
Application submitted successfully
Failed to process the application
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 1405
{
"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"
},
"fsm": {
"tenantId": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"sanitationtype": "text",
"vehicleType": "text",
"vehicleCapacity": "text",
"paymentPreference": "text",
"propertyUsage": "text",
"noOfTrips": 1,
"status": "ACTIVE",
"vehicleId": "text",
"dsoId": "text",
"possibleServiceDate": 1,
"wasteCollected": 1,
"pitDetail": {
"height": 1,
"length": 1,
"width": 1,
"diameter": 1,
"distanceFromRoad": 1
},
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"slumName": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]"
}
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"rating": 1,
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
}
}
{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"fsm": {
"citizen": {
"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",
"applicationNo": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"applicationStatus": "text",
"source": "whatsapp, ivr etc",
"sanitationtype": "text",
"vehicleType": "text",
"vehicleCapacity": "text",
"paymentPreference": "text",
"propertyUsage": "text",
"noOfTrips": 1,
"status": "ACTIVE",
"vehicleId": "text",
"dsoId": "text",
"possibleServiceDate": 1,
"wasteCollected": 1,
"pitDetail": {
"citizen": {
"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",
"height": 1,
"length": 1,
"width": 1,
"diameter": 1,
"distanceFromRoad": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"id": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"slumName": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"rating": 1,
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"totalCount": "text"
}
Updates service request
Request object for FSM
Application submitted successfully
Failed to process the application
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_update HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 1405
{
"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"
},
"fsm": {
"tenantId": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"sanitationtype": "text",
"vehicleType": "text",
"vehicleCapacity": "text",
"paymentPreference": "text",
"propertyUsage": "text",
"noOfTrips": 1,
"status": "ACTIVE",
"vehicleId": "text",
"dsoId": "text",
"possibleServiceDate": 1,
"wasteCollected": 1,
"pitDetail": {
"height": 1,
"length": 1,
"width": 1,
"diameter": 1,
"distanceFromRoad": 1
},
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"slumName": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]"
}
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"rating": 1,
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
}
}
{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"fsm": {
"citizen": {
"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",
"applicationNo": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"applicationStatus": "text",
"source": "whatsapp, ivr etc",
"sanitationtype": "text",
"vehicleType": "text",
"vehicleCapacity": "text",
"paymentPreference": "text",
"propertyUsage": "text",
"noOfTrips": 1,
"status": "ACTIVE",
"vehicleId": "text",
"dsoId": "text",
"possibleServiceDate": 1,
"wasteCollected": 1,
"pitDetail": {
"citizen": {
"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",
"height": 1,
"length": 1,
"width": 1,
"diameter": 1,
"distanceFromRoad": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"id": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"slumName": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"workflow": {
"action": "text",
"assignes": [
"text"
],
"comments": "text",
"rating": 1,
"varificationDocuments": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
},
"totalCount": "text"
}
Request object for BillingSlab
BillingSlab created successfully
Failed to process the BillingSlab
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 363
{
"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"
},
"fsm": {
"id": "text",
"tenantId": "text",
"capacityFrom": 1,
"capacityTo": 1,
"propertyType": "text",
"slum": "YES",
"price": 1,
"status": "ACTIVE"
}
}
{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"billingSlab": [
{
"id": "text",
"tenantId": "text",
"capacityFrom": 1,
"capacityTo": 1,
"propertyType": "text",
"slum": "YES",
"price": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"status": "ACTIVE"
}
]
}
Request object for BillingSlab
BillingSlab updated successfully
Failed to process the BillingSlab
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_update HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 363
{
"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"
},
"fsm": {
"id": "text",
"tenantId": "text",
"capacityFrom": 1,
"capacityTo": 1,
"propertyType": "text",
"slum": "YES",
"price": 1,
"status": "ACTIVE"
}
}
{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"billingSlab": [
{
"id": "text",
"tenantId": "text",
"capacityFrom": 1,
"capacityTo": 1,
"propertyType": "text",
"slum": "YES",
"price": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"status": "ACTIVE"
}
]
}
Unique id for a tenant.
offset for the pagination results
limit for the pagination results
sort the search results in Ascending or descending order
sort the search results by fields
serch by ids of the billingslab
search by propertyType
search by capacity
search by slum yes or no
Successful response sorted by reverse chrnological order of creation
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
Successful response sorted by reverse chrnological order of creation
{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"billingSlab": [
{
"id": "text",
"tenantId": "text",
"capacityFrom": 1,
"capacityTo": 1,
"propertyType": "text",
"slum": "YES",
"price": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"status": "ACTIVE"
}
]
}
Request object for Calcuation
calculated successfully
Failed to process the calcuation
POST /phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/_calculate HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 1201
{
"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"
},
"CalulationCriteria": {
"tenantId": "text",
"feeType": "APPLICATION_FEE",
"fsm": {
"tenantId": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"sanitationtype": "text",
"vehicleType": "text",
"vehicleCapacity": "text",
"paymentPreference": "text",
"propertyUsage": "text",
"noOfTrips": 1,
"status": "ACTIVE",
"vehicleId": "text",
"dsoId": "text",
"possibleServiceDate": 1,
"wasteCollected": 1,
"pitDetail": {
"height": 1,
"length": 1,
"width": 1,
"diameter": 1,
"distanceFromRoad": 1
},
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"slumName": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
"[Circular Reference]"
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
}
},
"applicationNo": "text"
}
}
{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Calculations": [
{
"tenantId": "text",
"feeType": "APPLICATION_FEE",
"fsm": {
"citizen": {
"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",
"applicationNo": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"applicationStatus": "text",
"source": "whatsapp, ivr etc",
"sanitationtype": "text",
"vehicleType": "text",
"vehicleCapacity": "text",
"paymentPreference": "text",
"propertyUsage": "text",
"noOfTrips": 1,
"status": "ACTIVE",
"vehicleId": "text",
"dsoId": "text",
"possibleServiceDate": 1,
"wasteCollected": 1,
"pitDetail": {
"citizen": {
"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",
"height": 1,
"length": 1,
"width": 1,
"diameter": 1,
"distanceFromRoad": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"id": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"slumName": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"applicationNumber": "text",
"taxHeadEstimates": [
{
"taxHeadCode": "text",
"estimateAmount": 1,
"category": "TAX"
}
]
}
]
}
Vehicle Service Contract
Gets the list of Vehicle for a particular ULB based on search criteria.
Unique id for a tenant.
Allows search for service type - comma separated list
Search by list of UUID
Search by mobile number of service requester
Search by uuid of service requester
Search by type of the vehicle
Search by model of the vehicle
Search by tankCapacity of the vehicle
sort the search results by fields
sorting order of the search resulsts
Search by model of the vehicle
limit on the resulsts
offset index of the overall search resulsts
Successful response sorted by reverse chrnological order of creation
Invalid input.
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 the vehicle details into the system
Request for vehicle details
Request submitted successfully
Failed to process the Request
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"
}
Updates the details of the vehicle
Request for vehicle details
Request submitted successfully
Failed to process the application
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"
}
Gets the list of VehicleLog for a particular ULB based on search criteria.
Unique id for a tenant.
Allows search for service type - comma separated list
Search by list of UUID of vehicleLog
Search by list of UUID of of the trip owners
Search by list of UUID of of the drivers
Search by list of UUID of vehicle(s)
Search by the referenceNo(s)
Search by the applicationNo(s)
search by the businessService of the vehicleLog
search by the list of applicationStatus of the vehicleLog
offset for the pagination results
limit for the pagination results
sort the search results in Ascending or descending order
sort the search results by fields
Successful response sorted by reverse chrnological order of creation
Invalid input.
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 the vehicleLog details into the system
Request for vehicleTrip details
Request submitted successfully
Failed to process the Request
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"
}
Updates the details of the vehicleLog
Request for vehicleTrip details
Request submitted successfully
Failed to process the application
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"
}
Last updated
Was this helpful?