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.

create

post

/vendor/v1/_create

Body

RequestInfoRequestInfo

vendorVendor

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/WalkingTreeDev/eGov-DSO/1.0.0/vendor/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}},"vendor":{"additionalDetails":{},"address":{"additionalDetails":{},"auditDetails":{},"geoLocation":{"additionalDetails":{}},"locality":{"code":"text","name":"text","children":[{"code":"text","name":"text","children":"[Circular Reference]"}]}},"auditDetails":{},"owner":{"gender":"text","mobileNumber":"text","name":"text","relationship":"FATHER","roles":[{}]},"status":"ACTIVE","drivers":[{"additionalDetails":{},"auditDetails":{},"owner":{"gender":"text","mobileNumber":"text","name":"text","relationship":"FATHER","roles":[{}]},"status":"ACTIVE","vendorDriverStatus":"ACTIVE"}],"vehicles":[{"additionalDetails":{},"auditDetails":{},"owner":{"gender":"text","mobileNumber":"text","name":"text","relationship":"FATHER","roles":[{}]},"status":"ACTIVE","vendorVehicleStatus":"ACTIVE"}]}}'

200

201

401

403

404

200

{
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "totalCount": 1,
  "vendor": [
    {
      "additionalDetails": {},
      "address": {
        "additionalDetails": {},
        "auditDetails": {},
        "geoLocation": {
          "additionalDetails": {}
        },
        "locality": {
          "code": "text",
          "name": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "children": "[Circular Reference]"
            }
          ]
        }
      },
      "agencyType": "text",
      "auditDetails": {},
      "description": "text",
      "id": "text",
      "name": "text",
      "owner": {
        "gender": "text",
        "mobileNumber": "text",
        "name": "text",
        "relationship": "FATHER",
        "roles": [
          {}
        ]
      },
      "ownerId": "text",
      "paymentPreference": "text",
      "source": "text",
      "tenantId": "text",
      "status": "ACTIVE",
      "drivers": [
        {
          "additionalDetails": {},
          "auditDetails": {},
          "owner": {
            "gender": "text",
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER",
            "roles": [
              {}
            ]
          },
          "status": "ACTIVE",
          "vendorDriverStatus": "ACTIVE"
        }
      ],
      "vehicles": [
        {
          "additionalDetails": {},
          "auditDetails": {},
          "owner": {
            "gender": "text",
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER",
            "roles": [
              {}
            ]
          },
          "status": "ACTIVE",
          "vendorVehicleStatus": "ACTIVE"
        }
      ]
    }
  ]
}

OK

plainsearch

post

/vendor/v1/_plainsearch

Query parameters

driverIdsstring[]

idsstring[]

limitinteger · int32

mobileNumberstring

namestring[]

offsetinteger · int32

ownerIdsstring[]

sortBystring · enum

Options: createdTime, driverIds, ids, mobileNumber, name, ownerIds, status, tenantId, vehicleCapacity, vehicleIds, vehicleRegistrationNumber, vehicleType, vendor_createdTime

sortOrderstring · enum

Options: ASC, DESC

statusstring[]

tenantIdstring

vehicleCapacitystring

vehicleIdsstring[]

vehicleRegistrationNumberstring[]

vehicleTypestring

Body

RequestInfoRequestInfo

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/WalkingTreeDev/eGov-DSO/1.0.0/vendor/v1/_plainsearch' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}}}'

200

201

401

403

404

200

{
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "totalCount": 1,
  "vendor": [
    {
      "additionalDetails": {},
      "address": {
        "additionalDetails": {},
        "auditDetails": {},
        "geoLocation": {
          "additionalDetails": {}
        },
        "locality": {
          "code": "text",
          "name": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "children": "[Circular Reference]"
            }
          ]
        }
      },
      "agencyType": "text",
      "auditDetails": {},
      "description": "text",
      "id": "text",
      "name": "text",
      "owner": {
        "gender": "text",
        "mobileNumber": "text",
        "name": "text",
        "relationship": "FATHER",
        "roles": [
          {}
        ]
      },
      "ownerId": "text",
      "paymentPreference": "text",
      "source": "text",
      "tenantId": "text",
      "status": "ACTIVE",
      "drivers": [
        {
          "additionalDetails": {},
          "auditDetails": {},
          "owner": {
            "gender": "text",
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER",
            "roles": [
              {}
            ]
          },
          "status": "ACTIVE",
          "vendorDriverStatus": "ACTIVE"
        }
      ],
      "vehicles": [
        {
          "additionalDetails": {},
          "auditDetails": {},
          "owner": {
            "gender": "text",
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER",
            "roles": [
              {}
            ]
          },
          "status": "ACTIVE",
          "vendorVehicleStatus": "ACTIVE"
        }
      ]
    }
  ]
}

OK

search

post

/vendor/v1/_search

Query parameters

driverIdsstring[]

idsstring[]

limitinteger · int32

mobileNumberstring

namestring[]

offsetinteger · int32

ownerIdsstring[]

sortBystring · enum

Options: createdTime, driverIds, ids, mobileNumber, name, ownerIds, status, tenantId, vehicleCapacity, vehicleIds, vehicleRegistrationNumber, vehicleType, vendor_createdTime

sortOrderstring · enum

Options: ASC, DESC

statusstring[]

tenantIdstring

vehicleCapacitystring

vehicleIdsstring[]

vehicleRegistrationNumberstring[]

vehicleTypestring

Body

RequestInfoRequestInfo

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/WalkingTreeDev/eGov-DSO/1.0.0/vendor/v1/_search' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}}}'

200

201

401

403

404

200

{
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "totalCount": 1,
  "vendor": [
    {
      "additionalDetails": {},
      "address": {
        "additionalDetails": {},
        "auditDetails": {},
        "geoLocation": {
          "additionalDetails": {}
        },
        "locality": {
          "code": "text",
          "name": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "children": "[Circular Reference]"
            }
          ]
        }
      },
      "agencyType": "text",
      "auditDetails": {},
      "description": "text",
      "id": "text",
      "name": "text",
      "owner": {
        "gender": "text",
        "mobileNumber": "text",
        "name": "text",
        "relationship": "FATHER",
        "roles": [
          {}
        ]
      },
      "ownerId": "text",
      "paymentPreference": "text",
      "source": "text",
      "tenantId": "text",
      "status": "ACTIVE",
      "drivers": [
        {
          "additionalDetails": {},
          "auditDetails": {},
          "owner": {
            "gender": "text",
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER",
            "roles": [
              {}
            ]
          },
          "status": "ACTIVE",
          "vendorDriverStatus": "ACTIVE"
        }
      ],
      "vehicles": [
        {
          "additionalDetails": {},
          "auditDetails": {},
          "owner": {
            "gender": "text",
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER",
            "roles": [
              {}
            ]
          },
          "status": "ACTIVE",
          "vendorVehicleStatus": "ACTIVE"
        }
      ]
    }
  ]
}

OK

update

post

/vendor/v1/_update

Body

RequestInfoRequestInfo

vendorVendor

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/WalkingTreeDev/eGov-DSO/1.0.0/vendor/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}},"vendor":{"additionalDetails":{},"address":{"additionalDetails":{},"auditDetails":{},"geoLocation":{"additionalDetails":{}},"locality":{"code":"text","name":"text","children":[{"code":"text","name":"text","children":"[Circular Reference]"}]}},"auditDetails":{},"owner":{"gender":"text","mobileNumber":"text","name":"text","relationship":"FATHER","roles":[{}]},"status":"ACTIVE","drivers":[{"additionalDetails":{},"auditDetails":{},"owner":{"gender":"text","mobileNumber":"text","name":"text","relationship":"FATHER","roles":[{}]},"status":"ACTIVE","vendorDriverStatus":"ACTIVE"}],"vehicles":[{"additionalDetails":{},"auditDetails":{},"owner":{"gender":"text","mobileNumber":"text","name":"text","relationship":"FATHER","roles":[{}]},"status":"ACTIVE","vendorVehicleStatus":"ACTIVE"}]}}'

200

201

401

403

404

200

{
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "totalCount": 1,
  "vendor": [
    {
      "additionalDetails": {},
      "address": {
        "additionalDetails": {},
        "auditDetails": {},
        "geoLocation": {
          "additionalDetails": {}
        },
        "locality": {
          "code": "text",
          "name": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "children": "[Circular Reference]"
            }
          ]
        }
      },
      "agencyType": "text",
      "auditDetails": {},
      "description": "text",
      "id": "text",
      "name": "text",
      "owner": {
        "gender": "text",
        "mobileNumber": "text",
        "name": "text",
        "relationship": "FATHER",
        "roles": [
          {}
        ]
      },
      "ownerId": "text",
      "paymentPreference": "text",
      "source": "text",
      "tenantId": "text",
      "status": "ACTIVE",
      "drivers": [
        {
          "additionalDetails": {},
          "auditDetails": {},
          "owner": {
            "gender": "text",
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER",
            "roles": [
              {}
            ]
          },
          "status": "ACTIVE",
          "vendorDriverStatus": "ACTIVE"
        }
      ],
      "vehicles": [
        {
          "additionalDetails": {},
          "auditDetails": {},
          "owner": {
            "gender": "text",
            "mobileNumber": "text",
            "name": "text",
            "relationship": "FATHER",
            "roles": [
              {}
            ]
          },
          "status": "ACTIVE",
          "vendorVehicleStatus": "ACTIVE"
        }
      ]
    }
  ]
}

OK

create

post

/vendor/driver/v1/_create

Body

RequestInfoRequestInfo

driverDriver

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/WalkingTreeDev/eGov-DSO/1.0.0/vendor/driver/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}},"driver":{"additionalDetails":{},"auditDetails":{},"owner":{"gender":"text","mobileNumber":"text","name":"text","relationship":"FATHER","roles":[{}]},"status":"ACTIVE","vendorDriverStatus":"ACTIVE"}}'

200

201

401

403

404

200

{
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "totalCount": 1,
  "driver": [
    {
      "additionalDetails": {},
      "auditDetails": {},
      "description": "text",
      "id": "text",
      "licenseNumber": "text",
      "name": "text",
      "owner": {
        "gender": "text",
        "mobileNumber": "text",
        "name": "text",
        "relationship": "FATHER",
        "roles": [
          {}
        ]
      },
      "ownerId": "text",
      "tenantId": "text",
      "status": "ACTIVE",
      "vendorDriverStatus": "ACTIVE"
    }
  ]
}

OK

search

post

/vendor/driver/v1/_search

Query parameters

driverWithNoVendorboolean

dsoNamestring[]

idsstring[]

limitinteger · int32

mobileNumberstring

namestring[]

offsetinteger · int32

ownerIdsstring[]

sortBystring · enum

Options: createdTime, driverWithNoVendor, dsoName, ids, mobileNumber, name, ownerIds, status, tenantId

sortOrderstring · enum

Options: ASC, DESC

statusstring[]

tenantIdstring

Body

RequestInfoRequestInfo

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/WalkingTreeDev/eGov-DSO/1.0.0/vendor/driver/v1/_search' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}}}'

200

201

401

403

404

200

{
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "totalCount": 1,
  "driver": [
    {
      "additionalDetails": {},
      "auditDetails": {},
      "description": "text",
      "id": "text",
      "licenseNumber": "text",
      "name": "text",
      "owner": {
        "gender": "text",
        "mobileNumber": "text",
        "name": "text",
        "relationship": "FATHER",
        "roles": [
          {}
        ]
      },
      "ownerId": "text",
      "tenantId": "text",
      "status": "ACTIVE",
      "vendorDriverStatus": "ACTIVE"
    }
  ]
}

OK

update

post

/vendor/driver/v1/_update

Body

RequestInfoRequestInfo

driverDriver

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/WalkingTreeDev/eGov-DSO/1.0.0/vendor/driver/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}},"driver":{"additionalDetails":{},"auditDetails":{},"owner":{"gender":"text","mobileNumber":"text","name":"text","relationship":"FATHER","roles":[{}]},"status":"ACTIVE","vendorDriverStatus":"ACTIVE"}}'

200

201

401

403

404

200

{
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "totalCount": 1,
  "driver": [
    {
      "additionalDetails": {},
      "auditDetails": {},
      "description": "text",
      "id": "text",
      "licenseNumber": "text",
      "name": "text",
      "owner": {
        "gender": "text",
        "mobileNumber": "text",
        "name": "text",
        "relationship": "FATHER",
        "roles": [
          {}
        ]
      },
      "ownerId": "text",
      "tenantId": "text",
      "status": "ACTIVE",
      "vendorDriverStatus": "ACTIVE"
    }
  ]
}

OK