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.

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_search

Query parameters

Response

202400

Successful response sorted by reverse chrnological order of creation

Body

*/*

fsm*FSM (object)

Request schema of FSM application.

workflowWorkflow (object)

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

totalCount*string

totalcount of records available in the system satifyig the search criteria

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_search', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "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",
    "applicationStatus": "text",
    "source": "whatsapp, ivr etc",
    "sanitationtype": "text",
    "vehicleType": "text",
    "vehicleCapacity": "text",
    "paymentPreference": "text",
    "propertyUsage": "text",
    "status": "ACTIVE",
    "vehicleId": "text",
    "dsoId": "text",
    "wasteCollected": 0,
    "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": 0,
      "length": 0,
      "width": 0,
      "diameter": 0,
      "distanceFromRoad": 0,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    },
    "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",
      "geoLocation": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  },
  "workflow": {
    "action": "text",
    "assignes": [
      "text"
    ],
    "comments": "text",
    "varificationDocuments": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text"
      }
    ]
  },
  "totalCount": "text"
}

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

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_audit

Query parameters

Response

202

Successful response sorted by reverse chrnological order of creation

Body

*/*

fsmAudit*FSMAudit (object)

Representation of FSM Audit

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_audit', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "fsmAudit": {
    "who": "text"
  }
}

Apply for desludging

Apply for desludging

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_create

Body

application/json

Request schema.

requestInfo*RequestHeader (object)

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.

fsm*FSM (object)

Request schema of FSM application.

workflowWorkflow (object)

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

Response

202400

Application submitted successfully

Body

*/*

responseInfo*any

fsm*any

workflowWorkflow (object)

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

totalCount*string

totalcount of records available in the system satifyig the search criteria

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "msgId": "text",
        "action": "text"
      },
      "fsm": {
        "tenantId": "text",
        "propertyUsage": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "workflow": {
    "action": "text",
    "assignes": [
      "text"
    ],
    "comments": "text",
    "varificationDocuments": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text"
      }
    ]
  },
  "totalCount": "text"
}

Update service requests

Updates service request

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_update

Body

application/json

Request schema.

requestInfo*RequestHeader (object)

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.

fsm*FSM (object)

Request schema of FSM application.

workflowWorkflow (object)

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

Response

202400

Application submitted successfully

Body

*/*

fsm*any

workflowWorkflow (object)

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

totalCount*string

totalcount of records available in the system satifyig the search criteria

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "msgId": "text",
        "action": "text"
      },
      "fsm": {
        "tenantId": "text",
        "propertyUsage": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "workflow": {
    "action": "text",
    "assignes": [
      "text"
    ],
    "comments": "text",
    "varificationDocuments": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text"
      }
    ]
  },
  "totalCount": "text"
}

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

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_create

Body

application/json

Reuqest Schema for BillingSlab

requestInfo*RequestHeader (object)

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.

fsmBillingSlab (object)

Representation of billing slab

Response

202400

BillingSlab created successfully

Body

*/*

responseInfo*any

billingSlab*array of BillingSlab (object)

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "msgId": "text",
        "action": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "billingSlab": [
    {
      "id": "text",
      "tenantId": "text",
      "capacityFrom": 0,
      "capacityTo": 0,
      "propertyType": "text",
      "slum": "YES",
      "price": 0,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "status": "ACTIVE"
    }
  ]
}

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

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_update

Body

application/json

Reuqest Schema for BillingSlab

requestInfo*RequestHeader (object)

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.

fsmBillingSlab (object)

Representation of billing slab

Response

202400

BillingSlab updated successfully

Body

*/*

responseInfo*any

billingSlab*array of BillingSlab (object)

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "msgId": "text",
        "action": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "billingSlab": [
    {
      "id": "text",
      "tenantId": "text",
      "capacityFrom": 0,
      "capacityTo": 0,
      "propertyType": "text",
      "slum": "YES",
      "price": 0,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "status": "ACTIVE"
    }
  ]
}

Get the BillingSlab based on the search criteria

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_search

Query parameters

Response

202

Successful response sorted by reverse chrnological order of creation

Body

*/*

billingSlab*array of BillingSlab (object)

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/billingSlab/_search', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "billingSlab": [
    {
      "id": "text",
      "tenantId": "text",
      "capacityFrom": 0,
      "capacityTo": 0,
      "propertyType": "text",
      "slum": "YES",
      "price": 0,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "status": "ACTIVE"
    }
  ]
}

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

POSThttps://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/_calculate

Body

application/json

Reuqest Schema calculate api

requestInfo*RequestHeader (object)

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.

CalulationCriteria*CalulationCriteria (object)

Calculation Criteria to calcaulte and generate Demand

Response

202400

calculated successfully

Body

*/*

Calculations*array of Calculation (object)

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/phanikiran-wtt-egov/FSM/1.0.0/fsm-calculator/v1/_calculate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "msgId": "text",
        "action": "text"
      },
      "CalulationCriteria": {}
    }),
});
const data = await response.json();

Response

{
  "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",
        "applicationStatus": "text",
        "source": "whatsapp, ivr etc",
        "sanitationtype": "text",
        "vehicleType": "text",
        "vehicleCapacity": "text",
        "paymentPreference": "text",
        "propertyUsage": "text",
        "status": "ACTIVE",
        "vehicleId": "text",
        "dsoId": "text",
        "wasteCollected": 0,
        "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": 0,
          "length": 0,
          "width": 0,
          "diameter": 0,
          "distanceFromRoad": 0,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        },
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        }
      },
      "applicationNumber": "text",
      "taxHeadEstimates": [
        {
          "taxHeadCode": "text",
          "estimateAmount": 0,
          "category": "TAX"
        }
      ]
    }
  ]
}

Vehicle Service Contract

Get the Vehicle details

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

POSThttps://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_search

Query parameters

Response

202400

Successful response sorted by reverse chrnological order of creation

Body

*/*

responseInfoRequestHeader (object)

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.

vehicleVehicle (object)

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

totalCountstring

count of total records in the system meeting the search criteria

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_search', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "responseInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "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",
    "suctionType": "text",
    "gpsEnabled": false,
    "source": "whatsapp, ivr etc",
    "status": "ACTIVE",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  },
  "totalCount": "text"
}

Add new vehicle

Add the vehicle details into the system

POSThttps://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_create

Body

application/json

Request schema.

requestInfoRequestHeader (object)

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.

vehicleVehicle (object)

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

Response

202400

Request submitted successfully

Body

*/*

responseInfoRequestHeader (object)

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.

vehicleVehicle (object)

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

totalCountstring

count of total records in the system meeting the search criteria

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "responseInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "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",
    "suctionType": "text",
    "gpsEnabled": false,
    "source": "whatsapp, ivr etc",
    "status": "ACTIVE",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  },
  "totalCount": "text"
}

Update existing vehicle details

Updates the details of the vehicle

POSThttps://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_update

Body

application/json

Request schema.

requestInfoRequestHeader (object)

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.

vehicleVehicle (object)

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

Response

202400

Request submitted successfully

Body

*/*

responseInfoRequestHeader (object)

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.

vehicleVehicle (object)

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

totalCountstring

count of total records in the system meeting the search criteria

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "responseInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "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",
    "suctionType": "text",
    "gpsEnabled": false,
    "source": "whatsapp, ivr etc",
    "status": "ACTIVE",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text"
    }
  },
  "totalCount": "text"
}

Get the VehicleTrip details

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

POSThttps://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_search

Query parameters

Response

202400

Successful response sorted by reverse chrnological order of creation

Body

*/*

responseInfo*RequestHeader (object)

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.

VehicleTrip*array of VehicleTrip (object)

totalCountstring

count of total records in the system meeting the search criteria

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_search', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "responseInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "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",
        "suctionType": "text",
        "gpsEnabled": false,
        "source": "whatsapp, ivr etc",
        "status": "ACTIVE",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        }
      },
      "applicationNo": "text",
      "status": "ACTIVE",
      "businessService": "text",
      "tripDetails": [
        {
          "id": "text",
          "tenantId": "text",
          "referenceNo": "text",
          "referenceStatus": "text",
          "status": "ACTIVE",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "applicationStatus": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ],
  "totalCount": "text"
}

Add new vehicleLog

Add the vehicleLog details into the system

POSThttps://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_create

Body

application/json

Request schema.

requestInfo*RequestHeader (object)

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.

VehicleTrip*VehicleTrip (object)

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

Response

202400

Request submitted successfully

Body

*/*

responseInfo*RequestHeader (object)

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.

VehicleTrip*array of VehicleTrip (object)

totalCountstring

count of total records in the system meeting the search criteria

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "msgId": "text",
        "action": "text"
      },
      "VehicleTrip": {
        "tenantId": "text",
        "businessService": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "responseInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "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",
        "suctionType": "text",
        "gpsEnabled": false,
        "source": "whatsapp, ivr etc",
        "status": "ACTIVE",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        }
      },
      "applicationNo": "text",
      "status": "ACTIVE",
      "businessService": "text",
      "tripDetails": [
        {
          "id": "text",
          "tenantId": "text",
          "referenceNo": "text",
          "referenceStatus": "text",
          "status": "ACTIVE",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "applicationStatus": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ],
  "totalCount": "text"
}

Update existing vehicleLog details

Updates the details of the vehicleLog

POSThttps://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_update

Body

application/json

Request schema.

requestInfo*RequestHeader (object)

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.

VehicleTrip*VehicleTrip (object)

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

Response

202400

Request submitted successfully

Body

*/*

responseInfo*RequestHeader (object)

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.

VehicleTrip*array of VehicleTrip (object)

totalCountstring

count of total records in the system meeting the search criteria

Request

JavaScriptCurl

const response = await fetch('https://virtserver.swaggerhub.com/WalkingTreeDev/VehicleRegistry/1.0.0/vehicle/trip/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "msgId": "text",
        "action": "text"
      },
      "VehicleTrip": {
        "tenantId": "text",
        "businessService": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "responseInfo": {
    "apiInfo": {
      "id": "text",
      "version": "text",
      "path": "text"
    },
    "deviceDetail": {
      "id": "text",
      "signature": "text"
    },
    "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",
        "suctionType": "text",
        "gpsEnabled": false,
        "source": "whatsapp, ivr etc",
        "status": "ACTIVE",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        }
      },
      "applicationNo": "text",
      "status": "ACTIVE",
      "businessService": "text",
      "tripDetails": [
        {
          "id": "text",
          "tenantId": "text",
          "referenceNo": "text",
          "referenceStatus": "text",
          "status": "ACTIVE",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "applicationStatus": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ],
  "totalCount": "text"
}