REST API for Oracle Banking Collections

Retrieve List of Segments Associated with an List of Account ID

post

/api/1.0/segmentBatch/getSegmentCdAndAcctIdMapping

This endpoint is used to retrieve list of Segments associated with an list of Account IDs.

Request

Supported Media Types

application/json
application/xml

Query Parameters

limit: integer

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

Offset is starting number of records 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.

Request Body that contains AccountIds List.

Root Schema : DmAccountIdsAndSegmentCodesCollection

Type: object

Collection of list of Account IDs and List of Segment Codes.

Show Source

accountId: array accountId

List of Account IDs
segmentCode: array segmentCode

List of Segment Codes

{
    "type":"object",
    "description":"Collection of list of Account IDs and List of Segment Codes.",
    "properties":{
        "accountId":{
            "type":"array",
            "description":"List of Account IDs",
            "items":{
                "type":"string"
            }
        },
        "segmentCode":{
            "type":"array",
            "description":"List of Segment Codes",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : accountId

Type: array

List of Account IDs

Show Source

Array of: string

{
    "type":"array",
    "description":"List of Account IDs",
    "items":{
        "type":"string"
    }
}

Nested Schema : segmentCode

Type: array

List of Segment Codes

Show Source

Array of: string

{
    "type":"array",
    "description":"List of Segment Codes",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Returns map of accounts and Segment Code

Root Schema : DmAccountSegmentCodeMap

Type: object

Collection of Map of Segment Code and Account.

Show Source

segmentCdAccountMap: array segmentCdAccountMap

List of Map of Segment Code and Account.

{
    "description":"Collection of Map of Segment Code and Account.",
    "type":"object",
    "properties":{
        "segmentCdAccountMap":{
            "type":"array",
            "description":"List of Map of Segment Code and Account.",
            "items":{
                "$ref":"#/definitions/DmAccountSegmentCodePair"
            }
        }
    }
}

Nested Schema : segmentCdAccountMap

Type: array

List of Map of Segment Code and Account.

Show Source

Array of: object DmAccountSegmentCodePair

Map of Segment Code and Account ID.

{
    "type":"array",
    "description":"List of Map of Segment Code and Account.",
    "items":{
        "$ref":"#/definitions/DmAccountSegmentCodePair"
    }
}

Nested Schema : DmAccountSegmentCodePair

Type: object

Map of Segment Code and Account ID.

Show Source

accountId: string

Account ID
segmentCode: array segmentCode

Segment Code

{
    "description":"Map of Segment Code and Account ID.",
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "description":"Account ID"
        },
        "segmentCode":{
            "type":"array",
            "description":"Segment Code",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : segmentCode

Type: array

Segment Code

Show Source

Array of: string

{
    "type":"array",
    "description":"Segment Code",
    "items":{
        "type":"string"
    }
}

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