Jump to

• Request
• Response

Update an existing vendor.

put

/api/1.0/vendor/{id}

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id(required): string
  Key of the vendor Maintenance

Header Parameters

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

Body ()

Request body that contains data required for updating an existing vendor.

Root 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":""
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns updated vendor object.

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data: object ResponseResourceSupport
• messages: object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes: array codes
• id: string
• requestId: string
• status: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

• arg: string
• args: array args
• Code: string
• Desc: string
• Language: string
• Type: string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

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