Faecal Sludge Management Service API

FSM Service Contract

Get application details based on below criteria

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

post

/fsm/v1/_search

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

idsstring[]

Search by list of UUID

applicationStatusstring[]

search application by list of application Status(s)

localitystring[]

search application by list of Locality (s)

ownerIdsstring[]

search by list of uuid(s) of the owner of the application

fromDateinteger

search by the created date faling between the fromdate and today

toDateinteger

search by the created date faling between the fromdate and today

applicationNosstring[]

search application by list of applicationNo(s)

mobileNumberstring

Search applicationb by mobileNumber of the Owner of the application

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, applicationNumber, propertyUsage, vehicle, locality, createdTime

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_search?tenantId=text'

202

400

202

{
  "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,
    "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",
        "materializedPath": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "children": "[Circular Reference]"
          }
        ]
      },
      "geoLocation": {
        "latitude": 1,
        "longitude": 1,
        "additionalDetails": {}
      }
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "status": "ACTIVE"
  },
  "workflow": {
    "action": "text",
    "comments": "text",
    "rating": 1,
    "assignes": [
      "text"
    ],
    "varificationDocuments": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ]
  },
  "totalCount": "text"
}

Successful response sorted by reverse chrnological order of creation

Get the application audit log for every change in the response. Provides a record for each set of change

post

/fsm/v1/_audit

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

applicationNostring

search for audit log based on the application no of FSM

idstring

search for audit log based on the unique id of the application

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_audit?tenantId=text'

202

202

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "fsmAudit": {
    "who": "text",
    "when": 1,
    "what": {}
  }
}

Successful response sorted by reverse chrnological order of creation

Apply for desludging

Apply for desludging

post

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

fsmobjectrequired

Request schema of FSM application.

workflowobject

BPA application object to capture the details of land, land owners, and address of the land.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiInfo":{},"deviceDetail":{},"ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text","code":"text","tenantId":"text","description":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text","code":"text","tenantId":"text","description":"text"}]}]}},"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"}]}]},"tenantId":"text","additionalDetail":{},"source":"whatsapp, ivr etc","propertyUsage":"text","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","materializedPath":"text","children":[{"code":"text","name":"text","label":"text","latitude":"text","longitude":"text","materializedPath":"text","children":"[Circular Reference]"}]},"geoLocation":{"latitude":1,"longitude":1,"additionalDetails":{}}},"auditDetails":{"createdBy":"text","lastModifiedBy":"text","createdTime":1,"lastModifiedTime":1},"status":"ACTIVE"},"workflow":{"assignes":[null],"varificationDocuments":[{"id":"text","documentType":"text","fileStore":"text","documentUid":"text","additionalDetails":{}}]}}'

202

400

202

{
  "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,
    "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",
        "materializedPath": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "children": "[Circular Reference]"
          }
        ]
      },
      "geoLocation": {
        "latitude": 1,
        "longitude": 1,
        "additionalDetails": {}
      }
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "status": "ACTIVE"
  },
  "workflow": {
    "action": "text",
    "comments": "text",
    "rating": 1,
    "assignes": [
      "text"
    ],
    "varificationDocuments": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ]
  },
  "totalCount": "text"
}

Application submitted successfully

Update service requests

Updates service request

post

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

fsmobjectrequired

Request schema of FSM application.

workflowobject

BPA application object to capture the details of land, land owners, and address of the land.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiInfo":{},"deviceDetail":{},"ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text","code":"text","tenantId":"text","description":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text","code":"text","tenantId":"text","description":"text"}]}]}},"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"}]}]},"tenantId":"text","additionalDetail":{},"source":"whatsapp, ivr etc","propertyUsage":"text","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","materializedPath":"text","children":[{"code":"text","name":"text","label":"text","latitude":"text","longitude":"text","materializedPath":"text","children":"[Circular Reference]"}]},"geoLocation":{"latitude":1,"longitude":1,"additionalDetails":{}}},"auditDetails":{"createdBy":"text","lastModifiedBy":"text","createdTime":1,"lastModifiedTime":1},"status":"ACTIVE"},"workflow":{"assignes":[null],"varificationDocuments":[{"id":"text","documentType":"text","fileStore":"text","documentUid":"text","additionalDetails":{}}]}}'

202

400

202

{
  "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,
    "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",
        "materializedPath": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "children": "[Circular Reference]"
          }
        ]
      },
      "geoLocation": {
        "latitude": 1,
        "longitude": 1,
        "additionalDetails": {}
      }
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "status": "ACTIVE"
  },
  "workflow": {
    "action": "text",
    "comments": "text",
    "rating": 1,
    "assignes": [
      "text"
    ],
    "varificationDocuments": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ]
  },
  "totalCount": "text"
}

Application submitted successfully

Create Billing Slab record for the combination of propertyusage, slum ,tancapcity

post

/fsm-calculator/v1/billingSlab/_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.

fsmobject

Representation of billing slab

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_create' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiInfo":{},"deviceDetail":{},"ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text","code":"text","tenantId":"text","description":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text","code":"text","tenantId":"text","description":"text"}]}]}},"fsm":{"auditDetails":{},"slum":"YES","status":"ACTIVE"}}'

202

400

202

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "billingSlab": [
    {
      "id": "text",
      "tenantId": "text",
      "capacityFrom": 1,
      "capacityTo": 1,
      "propertyType": "text",
      "price": 1,
      "auditDetails": {},
      "slum": "YES",
      "status": "ACTIVE"
    }
  ]
}

BillingSlab created successfully

update Billing Slab record for the combination of propertyusage, slum ,tancapcity

post

/fsm-calculator/v1/billingSlab/_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.

fsmobject

Representation of billing slab

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_update' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiInfo":{},"deviceDetail":{},"ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text","code":"text","tenantId":"text","description":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text","code":"text","tenantId":"text","description":"text"}]}]}},"fsm":{"auditDetails":{},"slum":"YES","status":"ACTIVE"}}'

202

400

202

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "billingSlab": [
    {
      "id": "text",
      "tenantId": "text",
      "capacityFrom": 1,
      "capacityTo": 1,
      "propertyType": "text",
      "price": 1,
      "auditDetails": {},
      "slum": "YES",
      "status": "ACTIVE"
    }
  ]
}

BillingSlab updated successfully

Get the BillingSlab based on the search criteria

post

/fsm-calculator/v1/billingSlab/_search

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

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: id, propertyType, capacity

idsstring[]

serch by ids of the billingslab

propertyTypestring

search by propertyType

capacitynumber · double

search by capacity

slumstring · enum

search by slum yes or no

Options: YES, NO

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_search?tenantId=text'

202

202

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "billingSlab": [
    {
      "id": "text",
      "tenantId": "text",
      "capacityFrom": 1,
      "capacityTo": 1,
      "propertyType": "text",
      "price": 1,
      "auditDetails": {},
      "slum": "YES",
      "status": "ACTIVE"
    }
  ]
}

Successful response sorted by reverse chrnological order of creation

Calcualte the FSM Charges and generate Demand for the same, based on the billingslab

post

/fsm-calculator/v1/_calculate

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.

CalulationCriteriaobjectrequired

Calculation Criteria to calcaulte and generate Demand

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/_calculate' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiInfo":{},"deviceDetail":{},"ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text","code":"text","tenantId":"text","description":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text","code":"text","tenantId":"text","description":"text"}]}]}},"CalulationCriteria":{"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"}]}]},"tenantId":"text","additionalDetail":{},"source":"whatsapp, ivr etc","propertyUsage":"text","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","materializedPath":"text","children":[{"code":"text","name":"text","label":"text","latitude":"text","longitude":"text","materializedPath":"text","children":"[Circular Reference]"}]},"geoLocation":{"latitude":1,"longitude":1,"additionalDetails":{}}},"auditDetails":{"createdBy":"text","lastModifiedBy":"text","createdTime":1,"lastModifiedTime":1},"status":"ACTIVE"},"feeType":"APPLICATION_FEE"}}'

202

400

202

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Calculations": [
    {
      "tenantId": "text",
      "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,
        "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",
            "materializedPath": "text",
            "children": [
              {
                "code": "text",
                "name": "text",
                "label": "text",
                "latitude": "text",
                "longitude": "text",
                "materializedPath": "text",
                "children": "[Circular Reference]"
              }
            ]
          },
          "geoLocation": {
            "latitude": 1,
            "longitude": 1,
            "additionalDetails": {}
          }
        },
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "status": "ACTIVE"
      },
      "applicationNumber": "text",
      "feeType": "APPLICATION_FEE",
      "taxHeadEstimates": [
        {
          "taxHeadCode": "text",
          "estimateAmount": 1,
          "category": "TAX"
        }
      ]
    }
  ]
}

calculated successfully

Vehicle Service Contract

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

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