DIGIT Specifications
PlatformUrbanHealthPublic FinanceSanitation
  • Specifications Overview
    • Standardisation Approach
  • Common Service Specs
    • Access Control
    • Analytics
    • Billing
    • Collection
    • Dashboard Analytics
    • Decision Support System Ingest
    • Document Controller
    • Employee
    • Encryption
    • Filestore
    • ID Generation
    • Inbox
    • Indexer
    • Master
    • Master Data Management
    • OTP
    • Payment Gateway
    • PDF Generation
    • URL Shortening
    • User
    • Workflow
  • Domain Service Specs
    • Attendance
    • Bank Account
    • Billing Calculator
    • Birth-Death
    • Building Plan Approval
    • Building Plan Calculator
    • Campaign
    • Campaign Delivery
    • Contracts
    • Estimates
    • eChallan
    • Facility
    • Faecal Sludge Management (FSM)
    • Fire NOC
    • Fire NOC Calculator
    • Household
    • Individual
    • Inventory
    • Land
    • Muster Roll
    • National Dashboard Ingest
    • No Objection Certificate
    • Organization
    • Planning
    • Product
    • Project
    • Property Registry
    • Property Tax Calculator
    • Public Grievance Redressal
    • Registration
    • Sewerage Connection
    • Stock
    • Supervision
    • Sync
    • Trade Licence
    • Trade Licence Calculator
    • User Events
    • Vehicle Registration
    • Vendor Registration
    • Water Connection
  • Archived-docs
    • DIGIT Urban Service Specs
      • Property Tax Service
        • Property Tax Taxonomy
        • Property Tax Data Model
        • Property Tax Service API
      • Public Grievance Redressal Service
        • Public Grievance Redressal Taxonomy
        • Public Grievance Redressal Data Model
        • Public Grievance Redressal Service API
      • Trade License Service
        • Trade License Taxonomy
        • Trade License Data Model
        • Trade License API
      • Fire NOC Service
        • Fire NOC Taxonomy
        • Fire NOC Data Model
        • Fire NOC API
      • Miscellaneous Collection Service
        • Miscellaneous Collections Taxonomy
        • Miscellaneous Collections Data Model
        • Miscellaneous Collection API
      • Online Building Plan Approval Service
        • Online Building Plan Approval Taxonomy
        • Online Building Plan Approval Data Model
        • Online Building Plan Approval Service API
      • Water & Sewerage Service
        • Water & Sewerage Taxonomy
        • Water Service Data Model
        • Sewerage Service Data Model
        • Water & Sewerage Service API
      • Birth & Death Service
        • Birth & Death Taxonomy
        • Birth & Death Data Model
        • Birth & Death Service API
    • DIGIT Public Finance Management Service Specs
      • iFIX Master Data Service API
      • Adapter Master Data Service API
      • mGramSeva iFIX Adapter Service API
      • iFIX Department Entity Service API
      • Fiscal Event API
    • DIGIT Health Service Specs
      • Health Service Data Model
      • Health Service API
    • DIGIT Sanitation Service Specs
      • Faecal Sludge Management Service
        • Faecal Sludge Management Data Model
        • Faecal Sludge Management Service API
Powered by GitBook

​All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.

On this page

Was this helpful?

Export as PDF
  1. Domain Service Specs

Vendor Registration

PreviousVehicle RegistrationNextWater Connection

Last updated 2 years ago

Was this helpful?

Vendor Registration APIs

API specs to register vendors for desludging operations, map vehicles to operators, search vendor details, or update existing vendor details.

  • Vendor Registration APIs
  • POSTcreate
  • POSTplainsearch
  • POSTsearch
  • POSTupdate
  • POSTcreate
  • POSTsearch
  • POSTupdate

create

post
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /WalkingTreeDev/eGov-DSO/1.0.0/vendor/v1/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 4525

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "text"
    },
    "ts": 1,
    "userInfo": {
      "emailId": "text",
      "id": 1,
      "mobileNumber": "text",
      "name": "text",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "name": "text",
          "tenantId": "text"
        }
      ],
      "tenantId": "text",
      "type": "text",
      "userName": "text",
      "uuid": "text"
    },
    "ver": "text"
  },
  "vendor": {
    "additionalDetails": {},
    "address": {
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "buildingName": "text",
      "city": "text",
      "country": "text",
      "district": "text",
      "doorNo": "text",
      "geoLocation": {
        "additionalDetails": {},
        "id": "text",
        "latitude": 1,
        "longitude": 1
      },
      "id": "text",
      "landmark": "text",
      "locality": {
        "children": [
          {
            "children": "[Circular Reference]",
            "code": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "name": "text"
          }
        ],
        "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",
      "createdTime": 1,
      "lastModifiedBy": "text",
      "lastModifiedTime": 1
    },
    "description": "text",
    "drivers": [
      {
        "additionalDetails": {},
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "description": "text",
        "id": "text",
        "licenseNumber": "text",
        "name": "text",
        "owner": {
          "aadhaarNumber": "text",
          "accountLocked": true,
          "active": true,
          "altContactNumber": "text",
          "bloodGroup": "text",
          "correspondenceAddress": "text",
          "correspondenceCity": "text",
          "correspondencePinCode": "text",
          "createdBy": "text",
          "createdDate": 1,
          "dob": 1,
          "emailId": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "id": 1,
          "identificationMark": "text",
          "lastModifiedBy": "text",
          "lastModifiedDate": 1,
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "otpReference": "text",
          "pan": "text",
          "password": "text",
          "permanentAddress": "text",
          "permanentCity": "text",
          "permanentPinCode": "text",
          "photo": "text",
          "pwdExpiryDate": 1,
          "relationship": "FATHER",
          "roles": [
            {
              "code": "text",
              "id": 1,
              "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": true,
      "active": true,
      "altContactNumber": "text",
      "bloodGroup": "text",
      "correspondenceAddress": "text",
      "correspondenceCity": "text",
      "correspondencePinCode": "text",
      "createdBy": "text",
      "createdDate": 1,
      "dob": 1,
      "emailId": "text",
      "fatherOrHusbandName": "text",
      "gender": "text",
      "id": 1,
      "identificationMark": "text",
      "lastModifiedBy": "text",
      "lastModifiedDate": 1,
      "locale": "text",
      "mobileNumber": "text",
      "name": "text",
      "otpReference": "text",
      "pan": "text",
      "password": "text",
      "permanentAddress": "text",
      "permanentCity": "text",
      "permanentPinCode": "text",
      "photo": "text",
      "pwdExpiryDate": 1,
      "relationship": "FATHER",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "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": [
      {
        "InsuranceCertValidTill": 1,
        "additionalDetails": {},
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "fitnessValidTill": 1,
        "gpsEnabled": true,
        "id": "text",
        "model": "text",
        "owner": {
          "aadhaarNumber": "text",
          "accountLocked": true,
          "active": true,
          "altContactNumber": "text",
          "bloodGroup": "text",
          "correspondenceAddress": "text",
          "correspondenceCity": "text",
          "correspondencePinCode": "text",
          "createdBy": "text",
          "createdDate": 1,
          "dob": 1,
          "emailId": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "id": 1,
          "identificationMark": "text",
          "lastModifiedBy": "text",
          "lastModifiedDate": 1,
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "otpReference": "text",
          "pan": "text",
          "password": "text",
          "permanentAddress": "text",
          "permanentCity": "text",
          "permanentPinCode": "text",
          "photo": "text",
          "pwdExpiryDate": 1,
          "relationship": "FATHER",
          "roles": [
            {
              "code": "text",
              "id": 1,
              "name": "text",
              "tenantId": "text"
            }
          ],
          "salutation": "text",
          "signature": "text",
          "tenantId": "text",
          "type": "text",
          "userName": "text",
          "uuid": "text"
        },
        "pollutionCertiValidTill": 1,
        "registrationNumber": "text",
        "roadTaxPaidTill": 1,
        "source": "text",
        "status": "ACTIVE",
        "suctionType": "text",
        "tankCapacity": 1,
        "tenantId": "text",
        "type": "text",
        "vendorVehicleStatus": "ACTIVE"
      }
    ]
  }
}
{
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "totalCount": 1,
  "vendor": [
    {
      "additionalDetails": {},
      "address": {
        "additionalDetails": {},
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "buildingName": "text",
        "city": "text",
        "country": "text",
        "district": "text",
        "doorNo": "text",
        "geoLocation": {
          "additionalDetails": {},
          "id": "text",
          "latitude": 1,
          "longitude": 1
        },
        "id": "text",
        "landmark": "text",
        "locality": {
          "children": [
            "[Circular Reference]"
          ],
          "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",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "description": "text",
      "drivers": [
        {
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "description": "text",
          "id": "text",
          "licenseNumber": "text",
          "name": "text",
          "owner": {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "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": true,
        "active": true,
        "altContactNumber": "text",
        "bloodGroup": "text",
        "correspondenceAddress": "text",
        "correspondenceCity": "text",
        "correspondencePinCode": "text",
        "createdBy": "text",
        "createdDate": 1,
        "dob": 1,
        "emailId": "text",
        "fatherOrHusbandName": "text",
        "gender": "text",
        "id": 1,
        "identificationMark": "text",
        "lastModifiedBy": "text",
        "lastModifiedDate": 1,
        "locale": "text",
        "mobileNumber": "text",
        "name": "text",
        "otpReference": "text",
        "pan": "text",
        "password": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPinCode": "text",
        "photo": "text",
        "pwdExpiryDate": 1,
        "relationship": "FATHER",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "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": [
        {
          "InsuranceCertValidTill": 1,
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "fitnessValidTill": 1,
          "gpsEnabled": true,
          "id": "text",
          "model": "text",
          "owner": {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userName": "text",
            "uuid": "text"
          },
          "pollutionCertiValidTill": 1,
          "registrationNumber": "text",
          "roadTaxPaidTill": 1,
          "source": "text",
          "status": "ACTIVE",
          "suctionType": "text",
          "tankCapacity": 1,
          "tenantId": "text",
          "type": "text",
          "vendorVehicleStatus": "ACTIVE"
        }
      ]
    }
  ]
}

plainsearch

post
Query parameters
driverIdsstring[]Optional
idsstring[]Optional
limitinteger · int32Optional
mobileNumberstringOptional
namestring[]Optional
offsetinteger · int32Optional
ownerIdsstring[]Optional
sortBystring · enumOptionalPossible values:
sortOrderstring · enumOptionalPossible values:
statusstring[]Optional
tenantIdstringOptional
vehicleCapacitystringOptional
vehicleIdsstring[]Optional
vehicleRegistrationNumberstring[]Optional
vehicleTypestringOptional
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /WalkingTreeDev/eGov-DSO/1.0.0/vendor/v1/_plainsearch HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "text"
    },
    "ts": 1,
    "userInfo": {
      "emailId": "text",
      "id": 1,
      "mobileNumber": "text",
      "name": "text",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "name": "text",
          "tenantId": "text"
        }
      ],
      "tenantId": "text",
      "type": "text",
      "userName": "text",
      "uuid": "text"
    },
    "ver": "text"
  }
}
{
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "totalCount": 1,
  "vendor": [
    {
      "additionalDetails": {},
      "address": {
        "additionalDetails": {},
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "buildingName": "text",
        "city": "text",
        "country": "text",
        "district": "text",
        "doorNo": "text",
        "geoLocation": {
          "additionalDetails": {},
          "id": "text",
          "latitude": 1,
          "longitude": 1
        },
        "id": "text",
        "landmark": "text",
        "locality": {
          "children": [
            "[Circular Reference]"
          ],
          "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",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "description": "text",
      "drivers": [
        {
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "description": "text",
          "id": "text",
          "licenseNumber": "text",
          "name": "text",
          "owner": {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "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": true,
        "active": true,
        "altContactNumber": "text",
        "bloodGroup": "text",
        "correspondenceAddress": "text",
        "correspondenceCity": "text",
        "correspondencePinCode": "text",
        "createdBy": "text",
        "createdDate": 1,
        "dob": 1,
        "emailId": "text",
        "fatherOrHusbandName": "text",
        "gender": "text",
        "id": 1,
        "identificationMark": "text",
        "lastModifiedBy": "text",
        "lastModifiedDate": 1,
        "locale": "text",
        "mobileNumber": "text",
        "name": "text",
        "otpReference": "text",
        "pan": "text",
        "password": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPinCode": "text",
        "photo": "text",
        "pwdExpiryDate": 1,
        "relationship": "FATHER",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "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": [
        {
          "InsuranceCertValidTill": 1,
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "fitnessValidTill": 1,
          "gpsEnabled": true,
          "id": "text",
          "model": "text",
          "owner": {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userName": "text",
            "uuid": "text"
          },
          "pollutionCertiValidTill": 1,
          "registrationNumber": "text",
          "roadTaxPaidTill": 1,
          "source": "text",
          "status": "ACTIVE",
          "suctionType": "text",
          "tankCapacity": 1,
          "tenantId": "text",
          "type": "text",
          "vendorVehicleStatus": "ACTIVE"
        }
      ]
    }
  ]
}

search

post
Query parameters
driverIdsstring[]Optional
idsstring[]Optional
limitinteger · int32Optional
mobileNumberstringOptional
namestring[]Optional
offsetinteger · int32Optional
ownerIdsstring[]Optional
sortBystring · enumOptionalPossible values:
sortOrderstring · enumOptionalPossible values:
statusstring[]Optional
tenantIdstringOptional
vehicleCapacitystringOptional
vehicleIdsstring[]Optional
vehicleRegistrationNumberstring[]Optional
vehicleTypestringOptional
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /WalkingTreeDev/eGov-DSO/1.0.0/vendor/v1/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "text"
    },
    "ts": 1,
    "userInfo": {
      "emailId": "text",
      "id": 1,
      "mobileNumber": "text",
      "name": "text",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "name": "text",
          "tenantId": "text"
        }
      ],
      "tenantId": "text",
      "type": "text",
      "userName": "text",
      "uuid": "text"
    },
    "ver": "text"
  }
}
{
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "totalCount": 1,
  "vendor": [
    {
      "additionalDetails": {},
      "address": {
        "additionalDetails": {},
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "buildingName": "text",
        "city": "text",
        "country": "text",
        "district": "text",
        "doorNo": "text",
        "geoLocation": {
          "additionalDetails": {},
          "id": "text",
          "latitude": 1,
          "longitude": 1
        },
        "id": "text",
        "landmark": "text",
        "locality": {
          "children": [
            "[Circular Reference]"
          ],
          "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",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "description": "text",
      "drivers": [
        {
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "description": "text",
          "id": "text",
          "licenseNumber": "text",
          "name": "text",
          "owner": {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "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": true,
        "active": true,
        "altContactNumber": "text",
        "bloodGroup": "text",
        "correspondenceAddress": "text",
        "correspondenceCity": "text",
        "correspondencePinCode": "text",
        "createdBy": "text",
        "createdDate": 1,
        "dob": 1,
        "emailId": "text",
        "fatherOrHusbandName": "text",
        "gender": "text",
        "id": 1,
        "identificationMark": "text",
        "lastModifiedBy": "text",
        "lastModifiedDate": 1,
        "locale": "text",
        "mobileNumber": "text",
        "name": "text",
        "otpReference": "text",
        "pan": "text",
        "password": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPinCode": "text",
        "photo": "text",
        "pwdExpiryDate": 1,
        "relationship": "FATHER",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "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": [
        {
          "InsuranceCertValidTill": 1,
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "fitnessValidTill": 1,
          "gpsEnabled": true,
          "id": "text",
          "model": "text",
          "owner": {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userName": "text",
            "uuid": "text"
          },
          "pollutionCertiValidTill": 1,
          "registrationNumber": "text",
          "roadTaxPaidTill": 1,
          "source": "text",
          "status": "ACTIVE",
          "suctionType": "text",
          "tankCapacity": 1,
          "tenantId": "text",
          "type": "text",
          "vendorVehicleStatus": "ACTIVE"
        }
      ]
    }
  ]
}

update

post
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /WalkingTreeDev/eGov-DSO/1.0.0/vendor/v1/_update HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 4525

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "text"
    },
    "ts": 1,
    "userInfo": {
      "emailId": "text",
      "id": 1,
      "mobileNumber": "text",
      "name": "text",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "name": "text",
          "tenantId": "text"
        }
      ],
      "tenantId": "text",
      "type": "text",
      "userName": "text",
      "uuid": "text"
    },
    "ver": "text"
  },
  "vendor": {
    "additionalDetails": {},
    "address": {
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "buildingName": "text",
      "city": "text",
      "country": "text",
      "district": "text",
      "doorNo": "text",
      "geoLocation": {
        "additionalDetails": {},
        "id": "text",
        "latitude": 1,
        "longitude": 1
      },
      "id": "text",
      "landmark": "text",
      "locality": {
        "children": [
          {
            "children": "[Circular Reference]",
            "code": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "materializedPath": "text",
            "name": "text"
          }
        ],
        "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",
      "createdTime": 1,
      "lastModifiedBy": "text",
      "lastModifiedTime": 1
    },
    "description": "text",
    "drivers": [
      {
        "additionalDetails": {},
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "description": "text",
        "id": "text",
        "licenseNumber": "text",
        "name": "text",
        "owner": {
          "aadhaarNumber": "text",
          "accountLocked": true,
          "active": true,
          "altContactNumber": "text",
          "bloodGroup": "text",
          "correspondenceAddress": "text",
          "correspondenceCity": "text",
          "correspondencePinCode": "text",
          "createdBy": "text",
          "createdDate": 1,
          "dob": 1,
          "emailId": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "id": 1,
          "identificationMark": "text",
          "lastModifiedBy": "text",
          "lastModifiedDate": 1,
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "otpReference": "text",
          "pan": "text",
          "password": "text",
          "permanentAddress": "text",
          "permanentCity": "text",
          "permanentPinCode": "text",
          "photo": "text",
          "pwdExpiryDate": 1,
          "relationship": "FATHER",
          "roles": [
            {
              "code": "text",
              "id": 1,
              "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": true,
      "active": true,
      "altContactNumber": "text",
      "bloodGroup": "text",
      "correspondenceAddress": "text",
      "correspondenceCity": "text",
      "correspondencePinCode": "text",
      "createdBy": "text",
      "createdDate": 1,
      "dob": 1,
      "emailId": "text",
      "fatherOrHusbandName": "text",
      "gender": "text",
      "id": 1,
      "identificationMark": "text",
      "lastModifiedBy": "text",
      "lastModifiedDate": 1,
      "locale": "text",
      "mobileNumber": "text",
      "name": "text",
      "otpReference": "text",
      "pan": "text",
      "password": "text",
      "permanentAddress": "text",
      "permanentCity": "text",
      "permanentPinCode": "text",
      "photo": "text",
      "pwdExpiryDate": 1,
      "relationship": "FATHER",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "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": [
      {
        "InsuranceCertValidTill": 1,
        "additionalDetails": {},
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "fitnessValidTill": 1,
        "gpsEnabled": true,
        "id": "text",
        "model": "text",
        "owner": {
          "aadhaarNumber": "text",
          "accountLocked": true,
          "active": true,
          "altContactNumber": "text",
          "bloodGroup": "text",
          "correspondenceAddress": "text",
          "correspondenceCity": "text",
          "correspondencePinCode": "text",
          "createdBy": "text",
          "createdDate": 1,
          "dob": 1,
          "emailId": "text",
          "fatherOrHusbandName": "text",
          "gender": "text",
          "id": 1,
          "identificationMark": "text",
          "lastModifiedBy": "text",
          "lastModifiedDate": 1,
          "locale": "text",
          "mobileNumber": "text",
          "name": "text",
          "otpReference": "text",
          "pan": "text",
          "password": "text",
          "permanentAddress": "text",
          "permanentCity": "text",
          "permanentPinCode": "text",
          "photo": "text",
          "pwdExpiryDate": 1,
          "relationship": "FATHER",
          "roles": [
            {
              "code": "text",
              "id": 1,
              "name": "text",
              "tenantId": "text"
            }
          ],
          "salutation": "text",
          "signature": "text",
          "tenantId": "text",
          "type": "text",
          "userName": "text",
          "uuid": "text"
        },
        "pollutionCertiValidTill": 1,
        "registrationNumber": "text",
        "roadTaxPaidTill": 1,
        "source": "text",
        "status": "ACTIVE",
        "suctionType": "text",
        "tankCapacity": 1,
        "tenantId": "text",
        "type": "text",
        "vendorVehicleStatus": "ACTIVE"
      }
    ]
  }
}
{
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "totalCount": 1,
  "vendor": [
    {
      "additionalDetails": {},
      "address": {
        "additionalDetails": {},
        "auditDetails": {
          "createdBy": "text",
          "createdTime": 1,
          "lastModifiedBy": "text",
          "lastModifiedTime": 1
        },
        "buildingName": "text",
        "city": "text",
        "country": "text",
        "district": "text",
        "doorNo": "text",
        "geoLocation": {
          "additionalDetails": {},
          "id": "text",
          "latitude": 1,
          "longitude": 1
        },
        "id": "text",
        "landmark": "text",
        "locality": {
          "children": [
            "[Circular Reference]"
          ],
          "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",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "description": "text",
      "drivers": [
        {
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "description": "text",
          "id": "text",
          "licenseNumber": "text",
          "name": "text",
          "owner": {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "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": true,
        "active": true,
        "altContactNumber": "text",
        "bloodGroup": "text",
        "correspondenceAddress": "text",
        "correspondenceCity": "text",
        "correspondencePinCode": "text",
        "createdBy": "text",
        "createdDate": 1,
        "dob": 1,
        "emailId": "text",
        "fatherOrHusbandName": "text",
        "gender": "text",
        "id": 1,
        "identificationMark": "text",
        "lastModifiedBy": "text",
        "lastModifiedDate": 1,
        "locale": "text",
        "mobileNumber": "text",
        "name": "text",
        "otpReference": "text",
        "pan": "text",
        "password": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPinCode": "text",
        "photo": "text",
        "pwdExpiryDate": 1,
        "relationship": "FATHER",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "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": [
        {
          "InsuranceCertValidTill": 1,
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "createdTime": 1,
            "lastModifiedBy": "text",
            "lastModifiedTime": 1
          },
          "fitnessValidTill": 1,
          "gpsEnabled": true,
          "id": "text",
          "model": "text",
          "owner": {
            "aadhaarNumber": "text",
            "accountLocked": true,
            "active": true,
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "createdDate": 1,
            "dob": 1,
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "id": 1,
            "identificationMark": "text",
            "lastModifiedBy": "text",
            "lastModifiedDate": 1,
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "pwdExpiryDate": 1,
            "relationship": "FATHER",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userName": "text",
            "uuid": "text"
          },
          "pollutionCertiValidTill": 1,
          "registrationNumber": "text",
          "roadTaxPaidTill": 1,
          "source": "text",
          "status": "ACTIVE",
          "suctionType": "text",
          "tankCapacity": 1,
          "tenantId": "text",
          "type": "text",
          "vendorVehicleStatus": "ACTIVE"
        }
      ]
    }
  ]
}

create

post
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /WalkingTreeDev/eGov-DSO/1.0.0/vendor/driver/v1/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 1502

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "text"
    },
    "ts": 1,
    "userInfo": {
      "emailId": "text",
      "id": 1,
      "mobileNumber": "text",
      "name": "text",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "name": "text",
          "tenantId": "text"
        }
      ],
      "tenantId": "text",
      "type": "text",
      "userName": "text",
      "uuid": "text"
    },
    "ver": "text"
  },
  "driver": {
    "additionalDetails": {},
    "auditDetails": {
      "createdBy": "text",
      "createdTime": 1,
      "lastModifiedBy": "text",
      "lastModifiedTime": 1
    },
    "description": "text",
    "id": "text",
    "licenseNumber": "text",
    "name": "text",
    "owner": {
      "aadhaarNumber": "text",
      "accountLocked": true,
      "active": true,
      "altContactNumber": "text",
      "bloodGroup": "text",
      "correspondenceAddress": "text",
      "correspondenceCity": "text",
      "correspondencePinCode": "text",
      "createdBy": "text",
      "createdDate": 1,
      "dob": 1,
      "emailId": "text",
      "fatherOrHusbandName": "text",
      "gender": "text",
      "id": 1,
      "identificationMark": "text",
      "lastModifiedBy": "text",
      "lastModifiedDate": 1,
      "locale": "text",
      "mobileNumber": "text",
      "name": "text",
      "otpReference": "text",
      "pan": "text",
      "password": "text",
      "permanentAddress": "text",
      "permanentCity": "text",
      "permanentPinCode": "text",
      "photo": "text",
      "pwdExpiryDate": 1,
      "relationship": "FATHER",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "name": "text",
          "tenantId": "text"
        }
      ],
      "salutation": "text",
      "signature": "text",
      "tenantId": "text",
      "type": "text",
      "userName": "text",
      "uuid": "text"
    },
    "ownerId": "text",
    "status": "ACTIVE",
    "tenantId": "text",
    "vendorDriverStatus": "ACTIVE"
  }
}
{
  "driver": [
    {
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "description": "text",
      "id": "text",
      "licenseNumber": "text",
      "name": "text",
      "owner": {
        "aadhaarNumber": "text",
        "accountLocked": true,
        "active": true,
        "altContactNumber": "text",
        "bloodGroup": "text",
        "correspondenceAddress": "text",
        "correspondenceCity": "text",
        "correspondencePinCode": "text",
        "createdBy": "text",
        "createdDate": 1,
        "dob": 1,
        "emailId": "text",
        "fatherOrHusbandName": "text",
        "gender": "text",
        "id": 1,
        "identificationMark": "text",
        "lastModifiedBy": "text",
        "lastModifiedDate": 1,
        "locale": "text",
        "mobileNumber": "text",
        "name": "text",
        "otpReference": "text",
        "pan": "text",
        "password": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPinCode": "text",
        "photo": "text",
        "pwdExpiryDate": 1,
        "relationship": "FATHER",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "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",
    "ts": 1,
    "ver": "text"
  },
  "totalCount": 1
}

search

post
Query parameters
driverWithNoVendorbooleanOptional
dsoNamestring[]Optional
idsstring[]Optional
limitinteger · int32Optional
mobileNumberstringOptional
namestring[]Optional
offsetinteger · int32Optional
ownerIdsstring[]Optional
sortBystring · enumOptionalPossible values:
sortOrderstring · enumOptionalPossible values:
statusstring[]Optional
tenantIdstringOptional
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /WalkingTreeDev/eGov-DSO/1.0.0/vendor/driver/v1/_search HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "text"
    },
    "ts": 1,
    "userInfo": {
      "emailId": "text",
      "id": 1,
      "mobileNumber": "text",
      "name": "text",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "name": "text",
          "tenantId": "text"
        }
      ],
      "tenantId": "text",
      "type": "text",
      "userName": "text",
      "uuid": "text"
    },
    "ver": "text"
  }
}
{
  "driver": [
    {
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "description": "text",
      "id": "text",
      "licenseNumber": "text",
      "name": "text",
      "owner": {
        "aadhaarNumber": "text",
        "accountLocked": true,
        "active": true,
        "altContactNumber": "text",
        "bloodGroup": "text",
        "correspondenceAddress": "text",
        "correspondenceCity": "text",
        "correspondencePinCode": "text",
        "createdBy": "text",
        "createdDate": 1,
        "dob": 1,
        "emailId": "text",
        "fatherOrHusbandName": "text",
        "gender": "text",
        "id": 1,
        "identificationMark": "text",
        "lastModifiedBy": "text",
        "lastModifiedDate": 1,
        "locale": "text",
        "mobileNumber": "text",
        "name": "text",
        "otpReference": "text",
        "pan": "text",
        "password": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPinCode": "text",
        "photo": "text",
        "pwdExpiryDate": 1,
        "relationship": "FATHER",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "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",
    "ts": 1,
    "ver": "text"
  },
  "totalCount": 1
}

update

post
Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /WalkingTreeDev/eGov-DSO/1.0.0/vendor/driver/v1/_update HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 1502

{
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "text"
    },
    "ts": 1,
    "userInfo": {
      "emailId": "text",
      "id": 1,
      "mobileNumber": "text",
      "name": "text",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "name": "text",
          "tenantId": "text"
        }
      ],
      "tenantId": "text",
      "type": "text",
      "userName": "text",
      "uuid": "text"
    },
    "ver": "text"
  },
  "driver": {
    "additionalDetails": {},
    "auditDetails": {
      "createdBy": "text",
      "createdTime": 1,
      "lastModifiedBy": "text",
      "lastModifiedTime": 1
    },
    "description": "text",
    "id": "text",
    "licenseNumber": "text",
    "name": "text",
    "owner": {
      "aadhaarNumber": "text",
      "accountLocked": true,
      "active": true,
      "altContactNumber": "text",
      "bloodGroup": "text",
      "correspondenceAddress": "text",
      "correspondenceCity": "text",
      "correspondencePinCode": "text",
      "createdBy": "text",
      "createdDate": 1,
      "dob": 1,
      "emailId": "text",
      "fatherOrHusbandName": "text",
      "gender": "text",
      "id": 1,
      "identificationMark": "text",
      "lastModifiedBy": "text",
      "lastModifiedDate": 1,
      "locale": "text",
      "mobileNumber": "text",
      "name": "text",
      "otpReference": "text",
      "pan": "text",
      "password": "text",
      "permanentAddress": "text",
      "permanentCity": "text",
      "permanentPinCode": "text",
      "photo": "text",
      "pwdExpiryDate": 1,
      "relationship": "FATHER",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "name": "text",
          "tenantId": "text"
        }
      ],
      "salutation": "text",
      "signature": "text",
      "tenantId": "text",
      "type": "text",
      "userName": "text",
      "uuid": "text"
    },
    "ownerId": "text",
    "status": "ACTIVE",
    "tenantId": "text",
    "vendorDriverStatus": "ACTIVE"
  }
}
{
  "driver": [
    {
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "description": "text",
      "id": "text",
      "licenseNumber": "text",
      "name": "text",
      "owner": {
        "aadhaarNumber": "text",
        "accountLocked": true,
        "active": true,
        "altContactNumber": "text",
        "bloodGroup": "text",
        "correspondenceAddress": "text",
        "correspondenceCity": "text",
        "correspondencePinCode": "text",
        "createdBy": "text",
        "createdDate": 1,
        "dob": 1,
        "emailId": "text",
        "fatherOrHusbandName": "text",
        "gender": "text",
        "id": 1,
        "identificationMark": "text",
        "lastModifiedBy": "text",
        "lastModifiedDate": 1,
        "locale": "text",
        "mobileNumber": "text",
        "name": "text",
        "otpReference": "text",
        "pan": "text",
        "password": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPinCode": "text",
        "photo": "text",
        "pwdExpiryDate": 1,
        "relationship": "FATHER",
        "roles": [
          {
            "code": "text",
            "id": 1,
            "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",
    "ts": 1,
    "ver": "text"
  },
  "totalCount": 1
}