Faecal Sludge Management Service API

FSM Service Contract

Get application details based on below criteria

post

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

Query parameters

tenantIdstring · varcharRequired

Unique id for a tenant.

idsstring[]Optional

Search by list of UUID

applicationStatusstring[]Optional

search application by list of application Status(s)

localitystring[]Optional

search application by list of Locality (s)

ownerIdsstring[]Optional

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

fromDateintegerOptional

search by the created date faling between the fromdate and today

toDateintegerOptional

search by the created date faling between the fromdate and today

applicationNosstring[]Optional

search application by list of applicationNo(s)

mobileNumberstringOptional

Search applicationb by mobileNumber of the Owner of the application

offsetintegerOptional

offset for the pagination results

limitintegerOptional

limit for the pagination results

sortOrderstring · enumOptional

sort the search results in Ascending or descending order

Possible values:

sortBystring · enumOptional

sort the search results by fields

Possible values:

Responses

202

Successful response sorted by reverse chrnological order of creation

*/*

400

Invalid input.

*/*

post

HTTPcURLJavaScriptPython

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

post

Query parameters

tenantIdstring · varcharRequired

Unique id for a tenant.

applicationNostringOptional

search for audit log based on the application no of FSM

idstringOptional

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

Responses

202

Successful response sorted by reverse chrnological order of creation

*/*

post

HTTPcURLJavaScriptPython

POST /phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_audit HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*

202

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

post

Apply for desludging

Body

Request object for FSM

Responses

202

Application submitted successfully

*/*

400

Failed to process the application

*/*

post

HTTPcURLJavaScriptPython

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

Update service requests

post

Updates service request

Body

Request object for FSM

Responses

202

Application submitted successfully

*/*

400

Failed to process the application

*/*

post

HTTPcURLJavaScriptPython

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

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

post

Body

Request object for BillingSlab

Responses

202

BillingSlab created successfully

*/*

400

Failed to process the BillingSlab

*/*

post

HTTPcURLJavaScriptPython

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

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

post

Body

Request object for BillingSlab

Responses

202

BillingSlab updated successfully

*/*

400

Failed to process the BillingSlab

*/*

post

HTTPcURLJavaScriptPython

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

Get the BillingSlab based on the search criteria

post

Query parameters

tenantIdstring · varcharRequired

Unique id for a tenant.

offsetintegerOptional

offset for the pagination results

limitintegerOptional

limit for the pagination results

sortOrderstring · enumOptional

sort the search results in Ascending or descending order

Possible values:

sortBystring · enumOptional

sort the search results by fields

Possible values:

idsstring[]Optional

serch by ids of the billingslab

propertyTypestringOptional

search by propertyType

capacitynumber · doubleOptional

search by capacity

slumstring · enumOptional

search by slum yes or no

Possible values:

Responses

202

Successful response sorted by reverse chrnological order of creation

*/*

post

HTTPcURLJavaScriptPython

POST /phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*

202

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

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

post

Body

Request object for Calcuation

Responses

202

calculated successfully

*/*

400

Failed to process the calcuation

*/*

post

HTTPcURLJavaScriptPython

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

Get the Vehicle details

post

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

Query parameters

tenantIdstring · varcharRequired

Unique id for a tenant.

registrationNumberstring[]Optional

Allows search for service type - comma separated list

idsstring[]Optional

Search by list of UUID

mobileNumberstringOptional

Search by mobile number of service requester

ownerIdstring[]Optional

Search by uuid of service requester

typestring[]Optional

Search by type of the vehicle

modelstring[]Optional

Search by model of the vehicle

tankCapacitystringOptional

Search by tankCapacity of the vehicle

sortBystring · enumOptional

sort the search results by fields

Possible values:

sortOrderstringOptional

sorting order of the search resulsts

suctionTypestring[]Optional

Search by model of the vehicle

limitstringOptional

limit on the resulsts

offsetstringOptional

offset index of the overall search resulsts

Responses

202

Successful response sorted by reverse chrnological order of creation

*/*

400

Invalid input.

*/*

post

HTTPcURLJavaScriptPython

POST /WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*

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

Add new vehicle

post

Add the vehicle details into the system

Body

Request for vehicle details

Responses

202

Request submitted successfully

*/*

400

Failed to process the Request

*/*

post

HTTPcURLJavaScriptPython

POST /WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 538

{
  "requestInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "ts": 1,
    "action": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "signature": "text"
  },
  "vehicle": {
    "tenantId": "text",
    "registrationNumber": "text",
    "model": "text",
    "type": "text",
    "tankCapicity": 1,
    "suctionType": "text",
    "pollutionCertiValidTill": 1,
    "InsuranceCertValidTill": 1,
    "fitnessValidTill": 1,
    "roadTaxPaidTill": 1,
    "gpsEnabled": true,
    "additionalDetail": {},
    "source": "whatsapp, ivr etc",
    "status": "ACTIVE"
  }
}

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

Update existing vehicle details

post

Updates the details of the vehicle

Body

Request for vehicle details

Responses

202

Request submitted successfully

*/*

400

Failed to process the application

*/*

post

HTTPcURLJavaScriptPython

POST /WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_update HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 538

{
  "requestInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "ts": 1,
    "action": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "signature": "text"
  },
  "vehicle": {
    "tenantId": "text",
    "registrationNumber": "text",
    "model": "text",
    "type": "text",
    "tankCapicity": 1,
    "suctionType": "text",
    "pollutionCertiValidTill": 1,
    "InsuranceCertValidTill": 1,
    "fitnessValidTill": 1,
    "roadTaxPaidTill": 1,
    "gpsEnabled": true,
    "additionalDetail": {},
    "source": "whatsapp, ivr etc",
    "status": "ACTIVE"
  }
}

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

Get the VehicleTrip details

post

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

Query parameters

tenantIdstring · varcharRequired

Unique id for a tenant.

registrationNumberstring[]Optional

Allows search for service type - comma separated list

idsstring[]Optional

Search by list of UUID of vehicleLog

tripOwnerIdsstring[]Optional

Search by list of UUID of of the trip owners

driverIdsstring[]Optional

Search by list of UUID of of the drivers

vehicleIdsstring[]Optional

Search by list of UUID of vehicle(s)

referenceNosstring[]Optional

Search by the referenceNo(s)

applicationNosstring[]Optional

Search by the applicationNo(s)

businessServicestringOptional

search by the businessService of the vehicleLog

applicationStatusstring[]Optional

search by the list of applicationStatus of the vehicleLog

offsetintegerOptional

offset for the pagination results

limitintegerOptional

limit for the pagination results

sortOrderstring · enumOptional

sort the search results in Ascending or descending order

Possible values:

sortBystring · enumOptional

sort the search results by fields

Possible values:

Responses

202

Successful response sorted by reverse chrnological order of creation

*/*

400

Invalid input.

*/*

post

HTTPcURLJavaScriptPython

POST /WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*

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

Add new vehicleLog

post

Add the vehicleLog details into the system

Body

Request for vehicleTrip details

Responses

202

Request submitted successfully

*/*

400

Failed to process the Request

*/*

post

HTTPcURLJavaScriptPython

POST /WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 941

{
  "requestInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "ts": 1,
    "action": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "signature": "text"
  },
  "VehicleTrip": {
    "tenantId": "text",
    "vehicle": {
      "tenantId": "text",
      "registrationNumber": "text",
      "model": "text",
      "type": "text",
      "tankCapicity": 1,
      "suctionType": "text",
      "pollutionCertiValidTill": 1,
      "InsuranceCertValidTill": 1,
      "fitnessValidTill": 1,
      "roadTaxPaidTill": 1,
      "gpsEnabled": true,
      "additionalDetail": {},
      "source": "whatsapp, ivr etc",
      "status": "ACTIVE"
    },
    "applicationNo": "text",
    "additionalDetail": {},
    "status": "ACTIVE",
    "businessService": "text",
    "tripDetails": [
      {
        "tenantId": "text",
        "referenceNo": "text",
        "referenceStatus": "text",
        "additionalDetail": {},
        "status": "ACTIVE",
        "itemStartTime": 1,
        "itemEndTime": 1,
        "volume": 1
      }
    ],
    "applicationStatus": "text",
    "tripStartTime": 1,
    "tripEndTime": 1,
    "fstpEntryTime": 1,
    "fstpExitTime": 1,
    "volumeCarried": 1
  }
}

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

Update existing vehicleLog details

post

Updates the details of the vehicleLog

Body

Request for vehicleTrip details

Responses

202

Request submitted successfully

*/*

400

Failed to process the application

*/*

post

HTTPcURLJavaScriptPython

POST /WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_update HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 941

{
  "requestInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "ts": 1,
    "action": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "signature": "text"
  },
  "VehicleTrip": {
    "tenantId": "text",
    "vehicle": {
      "tenantId": "text",
      "registrationNumber": "text",
      "model": "text",
      "type": "text",
      "tankCapicity": 1,
      "suctionType": "text",
      "pollutionCertiValidTill": 1,
      "InsuranceCertValidTill": 1,
      "fitnessValidTill": 1,
      "roadTaxPaidTill": 1,
      "gpsEnabled": true,
      "additionalDetail": {},
      "source": "whatsapp, ivr etc",
      "status": "ACTIVE"
    },
    "applicationNo": "text",
    "additionalDetail": {},
    "status": "ACTIVE",
    "businessService": "text",
    "tripDetails": [
      {
        "tenantId": "text",
        "referenceNo": "text",
        "referenceStatus": "text",
        "additionalDetail": {},
        "status": "ACTIVE",
        "itemStartTime": 1,
        "itemEndTime": 1,
        "volume": 1
      }
    ],
    "applicationStatus": "text",
    "tripStartTime": 1,
    "tripEndTime": 1,
    "fstpEntryTime": 1,
    "fstpExitTime": 1,
    "volumeCarried": 1
  }
}

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