REST API for Oracle Banking Collections

Get All Valid Communication Template

get

/obedm-correspondence-services/commtemplate

This endpoint is used to get all valid Communication Template Maintenance records.

Request

Supported Media Types

application/json
application/xml

Query Parameters

authStat: string

Auth Status of the Communication Template to be fetched
communicationCode: string

Code of the Communication Template to be fetched
communicationDesc: string

Description of the Communication Template to be fetched
communicationMode: string

Mode of the Communication Template to be fetched
includecloseandunauth: boolean

Include close and unauthorized value need to be provided to fetch summary record, default value is false.
limit: integer

Limit is maximum number of records to be fetched
offset: integer

Offset is starting number of records to be fetched
recordStat: string

Record Status of the call Action to be fetched

Header Parameters

appId(required): string

The application ID of host service.
branchCode(required): string

The branch code of requesting branch.
contentType: string

The content type of request or response body.
userId(required): string

The user ID of requesting user.

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of success or failure

Headers

Location: string

URL of newly created Communication Template

Root Schema : DmTmCommTemplateCollection

Type: object

Collection of Communication Template.

Show Source

data: array data
paging: object PagingDto

Paging data transfer object.

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

Nested Schema : data

Type: array

Show Source

Array of: object DmTmCommTemplateDTO

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

Nested Schema : PagingDto

Type: object

Paging data transfer object.

Show Source

totalResults: integer

Total results

{
    "description":"Paging data transfer object.",
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"Total results"
        }
    }
}

Nested Schema : DmTmCommTemplateDTO

Type: object

Match All

Show Source

allOf GenericDto
object DmTmCommTemplateDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "communicationMode":{
                    "description":"Communication Mode",
                    "type":"string"
                },
                "communicationCode":{
                    "description":"Communication Code",
                    "type":"string"
                },
                "communicationDesc":{
                    "description":"Communication Desc",
                    "type":"string"
                },
                "attachmentCd":{
                    "description":"Attachment Code",
                    "type":"string"
                },
                "blockPeriod":{
                    "description":"Block Period",
                    "type":"integer"
                },
                "communicationPurposeCode":{
                    "description":"Communication Purpose Code",
                    "type":"string"
                },
                "applicability":{
                    "description":"Applicability",
                    "type":"string"
                },
                "executionType":{
                    "description":"Execution Type",
                    "type":"string"
                },
                "subject":{
                    "description":"Subject",
                    "type":"string"
                },
                "message":{
                    "description":"Message",
                    "type":"string"
                },
                "ruleId":{
                    "description":"Rule ID",
                    "type":"string"
                },
                "effectiveDt":{
                    "description":"Effective Date",
                    "type":"string"
                },
                "expiryDt":{
                    "description":"Expiry Date",
                    "type":"string"
                },
                "DmTmCommunicationRecipientDTO":{
                    "type":"array",
                    "description":"Collection of list of Recipients.",
                    "items":{
                        "$ref":"#/definitions/DmTmCommunicationRecipientDTO"
                    }
                }
            }
        }
    ]
}

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

Type: object

Show Source

applicability: string

Applicability
attachmentCd: string

Attachment Code
blockPeriod: integer

Block Period
communicationCode: string

Communication Code
communicationDesc: string

Communication Desc
communicationMode: string

Communication Mode
communicationPurposeCode: string

Communication Purpose Code
DmTmCommunicationRecipientDTO: array DmTmCommunicationRecipientDTO

Collection of list of Recipients.
effectiveDt: string

Effective Date
executionType: string

Execution Type
expiryDt: string

Expiry Date
message: string

Message
ruleId: string

Rule ID
subject: string

Subject

{
    "type":"object",
    "properties":{
        "communicationMode":{
            "description":"Communication Mode",
            "type":"string"
        },
        "communicationCode":{
            "description":"Communication Code",
            "type":"string"
        },
        "communicationDesc":{
            "description":"Communication Desc",
            "type":"string"
        },
        "attachmentCd":{
            "description":"Attachment Code",
            "type":"string"
        },
        "blockPeriod":{
            "description":"Block Period",
            "type":"integer"
        },
        "communicationPurposeCode":{
            "description":"Communication Purpose Code",
            "type":"string"
        },
        "applicability":{
            "description":"Applicability",
            "type":"string"
        },
        "executionType":{
            "description":"Execution Type",
            "type":"string"
        },
        "subject":{
            "description":"Subject",
            "type":"string"
        },
        "message":{
            "description":"Message",
            "type":"string"
        },
        "ruleId":{
            "description":"Rule ID",
            "type":"string"
        },
        "effectiveDt":{
            "description":"Effective Date",
            "type":"string"
        },
        "expiryDt":{
            "description":"Expiry Date",
            "type":"string"
        },
        "DmTmCommunicationRecipientDTO":{
            "type":"array",
            "description":"Collection of list of Recipients.",
            "items":{
                "$ref":"#/definitions/DmTmCommunicationRecipientDTO"
            }
        }
    }
}

Nested Schema : DmTmCommunicationRecipientDTO

Type: array

Collection of list of Recipients.

Show Source

Array of: object DmTmCommunicationRecipientDTO

{
    "type":"array",
    "description":"Collection of list of Recipients.",
    "items":{
        "$ref":"#/definitions/DmTmCommunicationRecipientDTO"
    }
}

Nested Schema : DmTmCommunicationRecipientDTO

Type: object

Show Source

commtemplateMasterId: string

Commtemplate Master ID
id: string

ID
recipientType: string

Recipient Type

{
    "type":"object",
    "properties":{
        "recipientType":{
            "description":"Recipient Type",
            "type":"string"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "commtemplateMasterId":{
            "type":"string",
            "description":"Commtemplate Master ID"
        }
    }
}

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