REST API for Oracle Banking Virtual Account Management

Get all valid structured address service

get

/service/structuredaddressservice

This endpoint is used to Get all valid structured address service maintenance records.

Request

Supported Media Types

application/json
application/xml

Query Parameters

authStat: string
checkerId: string
includecloseandunauth: boolean

includecloseandunauth need to be set to fetch summary record, defult value is false
limit: integer

limit is maximum no of records to be fetched
makerId: string
modNo: integer
offset: integer

offset is starting no of records to be fetched
onceAuth: string
postcode: string
recordStat: string
strrCountry: string
townName: string
virtualAccountNo: string

Response

Supported Media Types

application/json
text/csv
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

Root Schema : StructuredAddressServiceCollection

Type: object

Show Source

data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StructuredAddressDTO"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object StructuredAddressDTO

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

Nested Schema : StructuredAddressDTO

Type: object

Match All

Show Source

allOf GenericDto
object StructuredAddressDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "department":{
                    "type":"string",
                    "description":"Department",
                    "maxLength":"70"
                },
                "subDepartment":{
                    "type":"string",
                    "description":"Sub Department",
                    "maxLength":"70"
                },
                "streetName":{
                    "type":"string",
                    "description":"Street Name",
                    "maxLength":"70"
                },
                "buildingNumber":{
                    "type":"string",
                    "description":"Building Number",
                    "maxLength":"16"
                },
                "buildingName":{
                    "type":"string",
                    "description":"building Name",
                    "maxLength":"35"
                },
                "floor":{
                    "type":"string",
                    "description":"Floor",
                    "maxLength":"70"
                },
                "postbox":{
                    "type":"string",
                    "description":"postbox",
                    "maxLength":"16"
                },
                "room":{
                    "type":"string",
                    "description":"Room",
                    "maxLength":"70"
                },
                "postcode":{
                    "type":"string",
                    "description":"postcode",
                    "maxLength":"16"
                },
                "townName":{
                    "type":"string",
                    "description":"Town Name",
                    "maxLength":"35"
                },
                "townLocationName":{
                    "type":"string",
                    "description":"Town Location Name",
                    "maxLength":"35"
                },
                "districtName":{
                    "type":"string",
                    "description":"District name",
                    "maxLength":"35"
                },
                "countrySubDivision":{
                    "type":"string",
                    "description":"Country Sub Division",
                    "maxLength":"35"
                },
                "strrCountry":{
                    "type":"string",
                    "description":"country",
                    "maxLength":"2"
                },
                "custAccountNo":{
                    "type":"string",
                    "description":"Account number of the External customer",
                    "minLength":"1",
                    "maxLength":"35",
                    "pattern":"[a-zA-Z0-9]+"
                }
            },
            "required":[
                "custAccountNo",
                "strrCountry",
                "postcode",
                "townName"
            ]
        }
    ]
}

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

Type: object

Show Source

buildingName: string

Maximum Length: 35

building Name
buildingNumber: string

Maximum Length: 16

Building Number
countrySubDivision: string

Maximum Length: 35

Country Sub Division
custAccountNo(required): string

Minimum Length: 1

Maximum Length: 35

Pattern: [a-zA-Z0-9]+

Account number of the External customer
department: string

Maximum Length: 70

Department
districtName: string

Maximum Length: 35

District name
floor: string

Maximum Length: 70

Floor
postbox: string

Maximum Length: 16

postbox
postcode(required): string

Maximum Length: 16

postcode
room: string

Maximum Length: 70

Room
streetName: string

Maximum Length: 70

Street Name
strrCountry(required): string

Maximum Length: 2

country
subDepartment: string

Maximum Length: 70

Sub Department
townLocationName: string

Maximum Length: 35

Town Location Name
townName(required): string

Maximum Length: 35

Town Name

{
    "type":"object",
    "properties":{
        "department":{
            "type":"string",
            "description":"Department",
            "maxLength":"70"
        },
        "subDepartment":{
            "type":"string",
            "description":"Sub Department",
            "maxLength":"70"
        },
        "streetName":{
            "type":"string",
            "description":"Street Name",
            "maxLength":"70"
        },
        "buildingNumber":{
            "type":"string",
            "description":"Building Number",
            "maxLength":"16"
        },
        "buildingName":{
            "type":"string",
            "description":"building Name",
            "maxLength":"35"
        },
        "floor":{
            "type":"string",
            "description":"Floor",
            "maxLength":"70"
        },
        "postbox":{
            "type":"string",
            "description":"postbox",
            "maxLength":"16"
        },
        "room":{
            "type":"string",
            "description":"Room",
            "maxLength":"70"
        },
        "postcode":{
            "type":"string",
            "description":"postcode",
            "maxLength":"16"
        },
        "townName":{
            "type":"string",
            "description":"Town Name",
            "maxLength":"35"
        },
        "townLocationName":{
            "type":"string",
            "description":"Town Location Name",
            "maxLength":"35"
        },
        "districtName":{
            "type":"string",
            "description":"District name",
            "maxLength":"35"
        },
        "countrySubDivision":{
            "type":"string",
            "description":"Country Sub Division",
            "maxLength":"35"
        },
        "strrCountry":{
            "type":"string",
            "description":"country",
            "maxLength":"2"
        },
        "custAccountNo":{
            "type":"string",
            "description":"Account number of the External customer",
            "minLength":"1",
            "maxLength":"35",
            "pattern":"[a-zA-Z0-9]+"
        }
    },
    "required":[
        "custAccountNo",
        "strrCountry",
        "postcode",
        "townName"
    ]
}

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