Jump to

• Request
• Response

Get all valid vendor.

get

/api/1.0/vendor

Get all valid vendors.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• authStat: string
  Authorize status
• cacheMiss: boolean
• includecloseandunauth: boolean
  Include close and unauthorized records of vendors.
• limit: integer
  Maximum no of records to be fetched
• offset: integer
  Initial number of records to be fetched.
• recordStat: string
  Record status
• vendorCd: string
  Search on the basis of Vendor Id
• vendorName: string
  Search on the basis of Vendor Name

Header Parameters

• appId(required): string
• branchCode(required): string
• contentType: string
• tenantId: string
• userId(required): string

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Headers

• Location: string

Body ()

Root Schema : DmTmVendorCollection

Type: object

Collection of vendor object.

Show Source

• data: array data
• paging: object PagingDto

{
    "description":"Collection of vendor object.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmVendorDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object DmTmVendorDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DmTmVendorDTO"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults: integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : DmTmVendorDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object DmTmVendorDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "vendorCd":{
                    "description":"",
                    "type":"string"
                },
                "vendorName":{
                    "description":"",
                    "type":"string"
                },
                "dmTmVendorFeesChargeDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DmTmVendorFeesChargeDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : DmTmVendorDTO-allOf[1]

Type: object

Show Source

• dmTmVendorFeesChargeDTO: array dmTmVendorFeesChargeDTO
• vendorCd: string
• vendorName: string

{
    "type":"object",
    "properties":{
        "vendorCd":{
            "description":"",
            "type":"string"
        },
        "vendorName":{
            "description":"",
            "type":"string"
        },
        "dmTmVendorFeesChargeDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmVendorFeesChargeDTO"
            }
        }
    }
}

Nested Schema : dmTmVendorFeesChargeDTO

Type: array

Show Source

• Array of: object DmTmVendorFeesChargeDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DmTmVendorFeesChargeDTO"
    }
}

Nested Schema : DmTmVendorFeesChargeDTO

Type: object

Show Source

• feesCode: string
• frequency: string
• id: string
• vendorMasterId: string

{
    "type":"object",
    "properties":{
        "feesCode":{
            "description":"",
            "type":"string"
        },
        "frequency":{
            "description":"",
            "type":"string"
        },
        "id":{
            "type":"string",
            "description":""
        },
        "vendorMasterId":{
            "type":"string",
            "description":""
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top