Vendor Registration
Vendor Registration APIs
API specs to register vendors for desludging operations, map vehicles to operators, search vendor details, or update existing vendor details.
Last updated
API specs to register vendors for desludging operations, map vehicles to operators, search vendor details, or update existing vendor details.
Last updated
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
OK
const response = await fetch('https://virtserver.swaggerhub.com/WalkingTreeDev/eGov-DSO/1.0.0/vendor/v1/_search', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({}),
});
const data = await response.json();
{
"responseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ver": "text"
},
"vendor": [
{
"address": {
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"buildingName": "text",
"city": "text",
"country": "text",
"district": "text",
"doorNo": "text",
"geoLocation": {
"id": "text",
"latitude": 0,
"longitude": 0
},
"id": "text",
"landmark": "text",
"locality": {
"children": [],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text"
},
"agencyType": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"description": "text",
"drivers": [
{
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"description": "text",
"id": "text",
"licenseNumber": "text",
"name": "text",
"owner": {
"aadhaarNumber": "text",
"accountLocked": false,
"active": false,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"emailId": "text",
"fatherOrHusbandName": "text",
"gender": "text",
"identificationMark": "text",
"lastModifiedBy": "text",
"locale": "text",
"mobileNumber": "text",
"name": "text",
"otpReference": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"relationship": "FATHER",
"roles": [
{
"code": "text",
"name": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"ownerId": "text",
"status": "ACTIVE",
"tenantId": "text",
"vendorDriverStatus": "ACTIVE"
}
],
"id": "text",
"name": "text",
"owner": {
"aadhaarNumber": "text",
"accountLocked": false,
"active": false,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"emailId": "text",
"fatherOrHusbandName": "text",
"gender": "text",
"identificationMark": "text",
"lastModifiedBy": "text",
"locale": "text",
"mobileNumber": "text",
"name": "text",
"otpReference": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"relationship": "FATHER",
"roles": [
{
"code": "text",
"name": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"ownerId": "text",
"paymentPreference": "text",
"source": "text",
"status": "ACTIVE",
"tenantId": "text",
"vehicles": [
{
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"gpsEnabled": false,
"id": "text",
"model": "text",
"owner": {
"aadhaarNumber": "text",
"accountLocked": false,
"active": false,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"emailId": "text",
"fatherOrHusbandName": "text",
"gender": "text",
"identificationMark": "text",
"lastModifiedBy": "text",
"locale": "text",
"mobileNumber": "text",
"name": "text",
"otpReference": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"relationship": "FATHER",
"roles": [
{
"code": "text",
"name": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"registrationNumber": "text",
"source": "text",
"status": "ACTIVE",
"suctionType": "text",
"tenantId": "text",
"type": "text",
"vendorVehicleStatus": "ACTIVE"
}
]
}
]
}
OK
const response = await fetch('https://virtserver.swaggerhub.com/WalkingTreeDev/eGov-DSO/1.0.0/vendor/v1/_plainsearch', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({}),
});
const data = await response.json();
{
"responseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ver": "text"
},
"vendor": [
{
"address": {
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"buildingName": "text",
"city": "text",
"country": "text",
"district": "text",
"doorNo": "text",
"geoLocation": {
"id": "text",
"latitude": 0,
"longitude": 0
},
"id": "text",
"landmark": "text",
"locality": {
"children": [],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text"
},
"agencyType": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"description": "text",
"drivers": [
{
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"description": "text",
"id": "text",
"licenseNumber": "text",
"name": "text",
"owner": {
"aadhaarNumber": "text",
"accountLocked": false,
"active": false,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"emailId": "text",
"fatherOrHusbandName": "text",
"gender": "text",
"identificationMark": "text",
"lastModifiedBy": "text",
"locale": "text",
"mobileNumber": "text",
"name": "text",
"otpReference": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"relationship": "FATHER",
"roles": [
{
"code": "text",
"name": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"ownerId": "text",
"status": "ACTIVE",
"tenantId": "text",
"vendorDriverStatus": "ACTIVE"
}
],
"id": "text",
"name": "text",
"owner": {
"aadhaarNumber": "text",
"accountLocked": false,
"active": false,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"emailId": "text",
"fatherOrHusbandName": "text",
"gender": "text",
"identificationMark": "text",
"lastModifiedBy": "text",
"locale": "text",
"mobileNumber": "text",
"name": "text",
"otpReference": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"relationship": "FATHER",
"roles": [
{
"code": "text",
"name": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"ownerId": "text",
"paymentPreference": "text",
"source": "text",
"status": "ACTIVE",
"tenantId": "text",
"vehicles": [
{
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"gpsEnabled": false,
"id": "text",
"model": "text",
"owner": {
"aadhaarNumber": "text",
"accountLocked": false,
"active": false,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"emailId": "text",
"fatherOrHusbandName": "text",
"gender": "text",
"identificationMark": "text",
"lastModifiedBy": "text",
"locale": "text",
"mobileNumber": "text",
"name": "text",
"otpReference": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"relationship": "FATHER",
"roles": [
{
"code": "text",
"name": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"registrationNumber": "text",
"source": "text",
"status": "ACTIVE",
"suctionType": "text",
"tenantId": "text",
"type": "text",
"vendorVehicleStatus": "ACTIVE"
}
]
}
]
}
OK
const response = await fetch('https://virtserver.swaggerhub.com/WalkingTreeDev/eGov-DSO/1.0.0/vendor/driver/v1/_search', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({}),
});
const data = await response.json();
{
"driver": [
{
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"description": "text",
"id": "text",
"licenseNumber": "text",
"name": "text",
"owner": {
"aadhaarNumber": "text",
"accountLocked": false,
"active": false,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"emailId": "text",
"fatherOrHusbandName": "text",
"gender": "text",
"identificationMark": "text",
"lastModifiedBy": "text",
"locale": "text",
"mobileNumber": "text",
"name": "text",
"otpReference": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"relationship": "FATHER",
"roles": [
{
"code": "text",
"name": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"ownerId": "text",
"status": "ACTIVE",
"tenantId": "text",
"vendorDriverStatus": "ACTIVE"
}
],
"responseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ver": "text"
}
}
OK
const response = await fetch('https://virtserver.swaggerhub.com/WalkingTreeDev/eGov-DSO/1.0.0/vendor/driver/v1/_create', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({}),
});
const data = await response.json();
{
"driver": [
{
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"description": "text",
"id": "text",
"licenseNumber": "text",
"name": "text",
"owner": {
"aadhaarNumber": "text",
"accountLocked": false,
"active": false,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"emailId": "text",
"fatherOrHusbandName": "text",
"gender": "text",
"identificationMark": "text",
"lastModifiedBy": "text",
"locale": "text",
"mobileNumber": "text",
"name": "text",
"otpReference": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"relationship": "FATHER",
"roles": [
{
"code": "text",
"name": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"ownerId": "text",
"status": "ACTIVE",
"tenantId": "text",
"vendorDriverStatus": "ACTIVE"
}
],
"responseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ver": "text"
}
}
OK
const response = await fetch('https://virtserver.swaggerhub.com/WalkingTreeDev/eGov-DSO/1.0.0/vendor/driver/v1/_update', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({}),
});
const data = await response.json();
{
"driver": [
{
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"description": "text",
"id": "text",
"licenseNumber": "text",
"name": "text",
"owner": {
"aadhaarNumber": "text",
"accountLocked": false,
"active": false,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"emailId": "text",
"fatherOrHusbandName": "text",
"gender": "text",
"identificationMark": "text",
"lastModifiedBy": "text",
"locale": "text",
"mobileNumber": "text",
"name": "text",
"otpReference": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"relationship": "FATHER",
"roles": [
{
"code": "text",
"name": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"ownerId": "text",
"status": "ACTIVE",
"tenantId": "text",
"vendorDriverStatus": "ACTIVE"
}
],
"responseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ver": "text"
}
}
OK
const response = await fetch('https://virtserver.swaggerhub.com/WalkingTreeDev/eGov-DSO/1.0.0/vendor/v1/_update', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({}),
});
const data = await response.json();
{
"responseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ver": "text"
},
"vendor": [
{
"address": {
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"buildingName": "text",
"city": "text",
"country": "text",
"district": "text",
"doorNo": "text",
"geoLocation": {
"id": "text",
"latitude": 0,
"longitude": 0
},
"id": "text",
"landmark": "text",
"locality": {
"children": [],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text"
},
"agencyType": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"description": "text",
"drivers": [
{
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"description": "text",
"id": "text",
"licenseNumber": "text",
"name": "text",
"owner": {
"aadhaarNumber": "text",
"accountLocked": false,
"active": false,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"emailId": "text",
"fatherOrHusbandName": "text",
"gender": "text",
"identificationMark": "text",
"lastModifiedBy": "text",
"locale": "text",
"mobileNumber": "text",
"name": "text",
"otpReference": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"relationship": "FATHER",
"roles": [
{
"code": "text",
"name": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"ownerId": "text",
"status": "ACTIVE",
"tenantId": "text",
"vendorDriverStatus": "ACTIVE"
}
],
"id": "text",
"name": "text",
"owner": {
"aadhaarNumber": "text",
"accountLocked": false,
"active": false,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"emailId": "text",
"fatherOrHusbandName": "text",
"gender": "text",
"identificationMark": "text",
"lastModifiedBy": "text",
"locale": "text",
"mobileNumber": "text",
"name": "text",
"otpReference": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"relationship": "FATHER",
"roles": [
{
"code": "text",
"name": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"ownerId": "text",
"paymentPreference": "text",
"source": "text",
"status": "ACTIVE",
"tenantId": "text",
"vehicles": [
{
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"gpsEnabled": false,
"id": "text",
"model": "text",
"owner": {
"aadhaarNumber": "text",
"accountLocked": false,
"active": false,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"emailId": "text",
"fatherOrHusbandName": "text",
"gender": "text",
"identificationMark": "text",
"lastModifiedBy": "text",
"locale": "text",
"mobileNumber": "text",
"name": "text",
"otpReference": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"relationship": "FATHER",
"roles": [
{
"code": "text",
"name": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"registrationNumber": "text",
"source": "text",
"status": "ACTIVE",
"suctionType": "text",
"tenantId": "text",
"type": "text",
"vendorVehicleStatus": "ACTIVE"
}
]
}
]
}
OK
const response = await fetch('https://virtserver.swaggerhub.com/WalkingTreeDev/eGov-DSO/1.0.0/vendor/v1/_create', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({}),
});
const data = await response.json();
{
"responseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ver": "text"
},
"vendor": [
{
"address": {
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"buildingName": "text",
"city": "text",
"country": "text",
"district": "text",
"doorNo": "text",
"geoLocation": {
"id": "text",
"latitude": 0,
"longitude": 0
},
"id": "text",
"landmark": "text",
"locality": {
"children": [],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text"
},
"agencyType": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"description": "text",
"drivers": [
{
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"description": "text",
"id": "text",
"licenseNumber": "text",
"name": "text",
"owner": {
"aadhaarNumber": "text",
"accountLocked": false,
"active": false,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"emailId": "text",
"fatherOrHusbandName": "text",
"gender": "text",
"identificationMark": "text",
"lastModifiedBy": "text",
"locale": "text",
"mobileNumber": "text",
"name": "text",
"otpReference": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"relationship": "FATHER",
"roles": [
{
"code": "text",
"name": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"ownerId": "text",
"status": "ACTIVE",
"tenantId": "text",
"vendorDriverStatus": "ACTIVE"
}
],
"id": "text",
"name": "text",
"owner": {
"aadhaarNumber": "text",
"accountLocked": false,
"active": false,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"emailId": "text",
"fatherOrHusbandName": "text",
"gender": "text",
"identificationMark": "text",
"lastModifiedBy": "text",
"locale": "text",
"mobileNumber": "text",
"name": "text",
"otpReference": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"relationship": "FATHER",
"roles": [
{
"code": "text",
"name": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"ownerId": "text",
"paymentPreference": "text",
"source": "text",
"status": "ACTIVE",
"tenantId": "text",
"vehicles": [
{
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text"
},
"gpsEnabled": false,
"id": "text",
"model": "text",
"owner": {
"aadhaarNumber": "text",
"accountLocked": false,
"active": false,
"altContactNumber": "text",
"bloodGroup": "text",
"correspondenceAddress": "text",
"correspondenceCity": "text",
"correspondencePinCode": "text",
"createdBy": "text",
"emailId": "text",
"fatherOrHusbandName": "text",
"gender": "text",
"identificationMark": "text",
"lastModifiedBy": "text",
"locale": "text",
"mobileNumber": "text",
"name": "text",
"otpReference": "text",
"pan": "text",
"password": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPinCode": "text",
"photo": "text",
"relationship": "FATHER",
"roles": [
{
"code": "text",
"name": "text",
"tenantId": "text"
}
],
"salutation": "text",
"signature": "text",
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"registrationNumber": "text",
"source": "text",
"status": "ACTIVE",
"suctionType": "text",
"tenantId": "text",
"type": "text",
"vendorVehicleStatus": "ACTIVE"
}
]
}
]
}