REST API for Oracle Banking Collections

Update Existing Product Processor

put

/obedm-common-services/productprocessor/{id}

This endpoint is used to update an existing product processor.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id(required): string

Key of the Product Processor Maintenance.

Header Parameters

appId(required): string

The ID of the Application.
branchCode(required): string

The branch code associated with the request.
contentType: string

The Content Type of the request.
tenantId: string

The ID of the Tenant.
userId(required): string

The ID of the User.

Request Body that contains data required for updating an existing Product Processor.

Root Schema : DmTmProductProcessorDTO

Type: object

Match All

Show Source

allOf GenericDto
object DmTmProductProcessorDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "productProcessorCd":{
                    "description":"Code that uniquely identifies the product processor.",
                    "type":"string"
                },
                "productProcessorDesc":{
                    "description":"Description of the product processor.",
                    "type":"string"
                },
                "groupBasisCd":{
                    "description":"Code that identifies the group basis to which the product processor belongs.",
                    "type":"string"
                },
                "autoPopPtcCompanyInd":{
                    "description":"Indicates whether PTC company details should be automatically populated or not.",
                    "type":"boolean"
                },
                "effectiveDt":{
                    "description":"Effective date of the product processor.",
                    "type":"string"
                },
                "expiryDt":{
                    "description":"Expiry date of the product processor.",
                    "type":"string"
                },
                "bureauInt":{
                    "description":"Indicates whether bureau integration is required for the product processor or not.",
                    "type":"boolean"
                },
                "decisionSvc":{
                    "description":"Indicates whether decision service is required for the product processor or not.",
                    "type":"boolean"
                },
                "DmTmProductProcessorExtnDTO":{
                    "description":"List of extended attributes for the product processor.",
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DmTmProductProcessorExtnDTO"
                    }
                }
            }
        }
    ]
}

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 : DmTmProductProcessorDTO-allOf[1]

Type: object

Show Source

autoPopPtcCompanyInd: boolean

Indicates whether PTC company details should be automatically populated or not.
bureauInt: boolean

Indicates whether bureau integration is required for the product processor or not.
decisionSvc: boolean

Indicates whether decision service is required for the product processor or not.
DmTmProductProcessorExtnDTO: array DmTmProductProcessorExtnDTO

List of extended attributes for the product processor.
effectiveDt: string

Effective date of the product processor.
expiryDt: string

Expiry date of the product processor.
groupBasisCd: string

Code that identifies the group basis to which the product processor belongs.
productProcessorCd: string

Code that uniquely identifies the product processor.
productProcessorDesc: string

Description of the product processor.

{
    "type":"object",
    "properties":{
        "productProcessorCd":{
            "description":"Code that uniquely identifies the product processor.",
            "type":"string"
        },
        "productProcessorDesc":{
            "description":"Description of the product processor.",
            "type":"string"
        },
        "groupBasisCd":{
            "description":"Code that identifies the group basis to which the product processor belongs.",
            "type":"string"
        },
        "autoPopPtcCompanyInd":{
            "description":"Indicates whether PTC company details should be automatically populated or not.",
            "type":"boolean"
        },
        "effectiveDt":{
            "description":"Effective date of the product processor.",
            "type":"string"
        },
        "expiryDt":{
            "description":"Expiry date of the product processor.",
            "type":"string"
        },
        "bureauInt":{
            "description":"Indicates whether bureau integration is required for the product processor or not.",
            "type":"boolean"
        },
        "decisionSvc":{
            "description":"Indicates whether decision service is required for the product processor or not.",
            "type":"boolean"
        },
        "DmTmProductProcessorExtnDTO":{
            "description":"List of extended attributes for the product processor.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmProductProcessorExtnDTO"
            }
        }
    }
}

Nested Schema : DmTmProductProcessorExtnDTO

Type: array

List of extended attributes for the product processor.

Show Source

Array of: object DmTmProductProcessorExtnDTO

{
    "description":"List of extended attributes for the product processor.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/DmTmProductProcessorExtnDTO"
    }
}

Nested Schema : DmTmProductProcessorExtnDTO

Type: object

Show Source

attrType: string

Maximum Length: 30

The attribute type.
attrValue: string

Maximum Length: 100

The attribute value.
id: string

The unique identifier.
productProcessorMasterId: string

The unique identifier of the product processor master.

{
    "type":"object",
    "properties":{
        "attrType":{
            "description":"The attribute type.",
            "type":"string",
            "maxLength":"30"
        },
        "attrValue":{
            "description":"The attribute value.",
            "type":"string",
            "maxLength":"100"
        },
        "id":{
            "type":"string",
            "description":"The unique identifier."
        },
        "productProcessorMasterId":{
            "type":"string",
            "description":"The unique identifier of the product processor master."
        }
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Returns updated Product Processor.

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.