REST API for Oracle Banking Collections

Retrieve the email id list of Party by Account ID

get

/DmAccountParty-service/accountParties/getPartyDetails/{accountId}

This endpoint is used to retrieve the email id list of party by Account ID.

Request

Supported Media Types

application/json
application/xml

Path Parameters

accountId(required): string

Account ID for which account party relationship is 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

200 Response

Returns list of party email details.

Root Schema : CrPartyInfoDTO

Type: object

CrPartyInfoDTO model

Show Source

accountId: string

Account ID
accountNbr: string

Account Number
accountStatus: string

Account Status
bankName: string

Bank Name
headOfficeBranch: string

Head Office Branch
headOfficeBranchAdd: string

Head Office Branch Address
headOfficeBranchContactNo: string

Head Office Branch Contact No
homeBranchCode: string

Home Branch Code
homeBranchCodeDes: string

Home Branch Code Description
partyDetails: array partyDetails

{
    "description":"CrPartyInfoDTO model",
    "type":"object",
    "properties":{
        "accountId":{
            "description":"Account ID",
            "type":"string"
        },
        "accountNbr":{
            "description":"Account Number",
            "type":"string"
        },
        "accountStatus":{
            "description":"Account Status",
            "type":"string"
        },
        "homeBranchCode":{
            "description":"Home Branch Code",
            "type":"string"
        },
        "homeBranchCodeDes":{
            "description":"Home Branch Code Description",
            "type":"string"
        },
        "bankName":{
            "description":"Bank Name",
            "type":"string"
        },
        "headOfficeBranch":{
            "description":"Head Office Branch",
            "type":"string"
        },
        "headOfficeBranchAdd":{
            "description":"Head Office Branch Address",
            "type":"string"
        },
        "headOfficeBranchContactNo":{
            "description":"Head Office Branch Contact No",
            "type":"string"
        },
        "partyDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CrPartyDetails"
            }
        }
    }
}

Nested Schema : partyDetails

Type: array

Show Source

Array of: object CrPartyDetails

CrPartyDetails model

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

Nested Schema : CrPartyDetails

Type: object

CrPartyDetails model

Show Source

acctRelTypeCd: string

Relationship type code of the Party
address: object address

Address of the Party
customerName: string

Name of the Party
customerNumber: string

Customer Number of the Party
emailId: string

Email id of the Party
partyId: string

Party ID
phoneNo: string

Phone no of the Party
whatsappNo: string

Whatsapp no of the Party

{
    "description":"CrPartyDetails model",
    "type":"object",
    "properties":{
        "partyId":{
            "description":"Party ID",
            "type":"string"
        },
        "acctRelTypeCd":{
            "description":"Relationship type code of the Party",
            "type":"string"
        },
        "customerName":{
            "description":"Name of the Party",
            "type":"string"
        },
        "customerNumber":{
            "description":"Customer Number of the Party",
            "type":"string"
        },
        "phoneNo":{
            "description":"Phone no of the Party",
            "type":"string"
        },
        "whatsappNo":{
            "description":"Whatsapp no of the Party",
            "type":"string"
        },
        "emailId":{
            "description":"Email id of the Party",
            "type":"string"
        },
        "address":{
            "type":"object",
            "description":"Address of the Party",
            "properties":{
                "addressLine1":{
                    "description":"AddressLine1 of the DmPartyAddress",
                    "type":"string"
                },
                "addressLine2":{
                    "description":"AddressLine2 of the DmPartyAddress",
                    "type":"string"
                },
                "addressLine3":{
                    "description":"AddressLine3 of the DmPartyAddress",
                    "type":"string"
                },
                "addressLine4":{
                    "description":"AddressLine4 of the DmPartyAddress",
                    "type":"string"
                },
                "city":{
                    "description":"City of the DmPartyAddress",
                    "type":"string"
                },
                "stateCd":{
                    "description":"State Code of the DmPartyAddress",
                    "type":"string"
                },
                "countryCd":{
                    "description":"Country Code of the DmPartyAddress",
                    "type":"string"
                },
                "zipCd":{
                    "description":"Zip Cd of the DmPartyAddress",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : address

Type: object

Address of the Party

Show Source

addressLine1: string

AddressLine1 of the DmPartyAddress
addressLine2: string

AddressLine2 of the DmPartyAddress
addressLine3: string

AddressLine3 of the DmPartyAddress
addressLine4: string

AddressLine4 of the DmPartyAddress
city: string

City of the DmPartyAddress
countryCd: string

Country Code of the DmPartyAddress
stateCd: string

State Code of the DmPartyAddress
zipCd: string

Zip Cd of the DmPartyAddress

{
    "type":"object",
    "description":"Address of the Party",
    "properties":{
        "addressLine1":{
            "description":"AddressLine1 of the DmPartyAddress",
            "type":"string"
        },
        "addressLine2":{
            "description":"AddressLine2 of the DmPartyAddress",
            "type":"string"
        },
        "addressLine3":{
            "description":"AddressLine3 of the DmPartyAddress",
            "type":"string"
        },
        "addressLine4":{
            "description":"AddressLine4 of the DmPartyAddress",
            "type":"string"
        },
        "city":{
            "description":"City of the DmPartyAddress",
            "type":"string"
        },
        "stateCd":{
            "description":"State Code of the DmPartyAddress",
            "type":"string"
        },
        "countryCd":{
            "description":"Country Code of the DmPartyAddress",
            "type":"string"
        },
        "zipCd":{
            "description":"Zip Cd of the DmPartyAddress",
            "type":"string"
        }
    }
}

201 Response

Returns message of success or failure.

Headers

Location: string

Returns list of party email details.

Root Schema : ResponseDtoWrapper

Type: object

Response Data Transfer object

Show Source

data: object ResponseResourceSupport
messages: object ResponseDto

Response Data Transfer object

{
    "type":"object",
    "description":"Response Data Transfer object",
    "properties":{
        "messages":{
            "description":"Messages",
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "description":"Data",
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Response Data Transfer object

Show Source

codes: array codes

Codes
id: string

ID
requestId: string

Request ID
status: string

Status

{
    "description":"Response Data Transfer object",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "codes":{
            "type":"array",
            "description":"Codes",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string",
            "description":"Request ID"
        }
    }
}

Nested Schema : codes

Type: array

Codes

Show Source

Array of: object ResponseCode

Response code

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

Nested Schema : ResponseCode

Type: object

Response code

Show Source

arg: string

Argument
args: array args

Arguments
Code: string

Code
Desc: string

Description
Language: string

Language
Type: string

Type

{
    "type":"object",
    "description":"Response code",
    "properties":{
        "Code":{
            "type":"string",
            "description":"Code"
        },
        "Desc":{
            "type":"string",
            "description":"Description"
        },
        "Type":{
            "type":"string",
            "description":"Type"
        },
        "Language":{
            "type":"string",
            "description":"Language"
        },
        "args":{
            "type":"array",
            "description":"Arguments",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string",
            "description":"Argument"
        }
    }
}

Nested Schema : args

Type: array

Arguments

Show Source

Array of: object items

{
    "type":"array",
    "description":"Arguments",
    "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.

500 Response

Internal error.