ReST API for Oracle Banking Corporate Lending Process Management

Get a list of all valid Party Maintenance

get

/api/1.0/partymaintenance

This operation gets list of all valid party maintenance records using PartyMaintenance Service.

Request

Supported Media Types

application/json
application/xml

Query Parameters

includecloseandunauth(optional): boolean

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

limit is maximum no of records to be fetched
offset(optional): integer

offset is starting no of records to be fetched
partyNumber(optional): string

partyNumber to filter

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

Root Schema : ClmoTmPartyCollection

Type: object

Collection of party.

Show Source

data(optional): array data
paging(optional): object PagingDto

Paging DTO

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

Nested Schema : data

Type: array

Show Source

Array of: object Party

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

Nested Schema : PagingDto

Type: object

Paging DTO

Show Source

links(optional): string

links
totalResults(optional): string

TotalResults

{
    "description":"Paging DTO",
    "type":"object",
    "properties":{
        "totalResults":{
            "description":"TotalResults",
            "type":"string"
        },
        "links":{
            "description":"links",
            "type":"string"
        }
    }
}

Nested Schema : Party

Type: object

Match All

Show Source

allOf GenericDto
object Party-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "countryOfIncorporation":{
                    "type":"string",
                    "description":"Country Of Incorporation"
                },
                "dateOfIncorporation":{
                    "type":"string",
                    "description":"Date Of Incorporation"
                },
                "demographicType":{
                    "type":"string",
                    "description":"Demographic Type"
                },
                "organizationType":{
                    "type":"string",
                    "description":"Organization Type"
                },
                "kycStatus":{
                    "type":"string",
                    "description":"KYC Status"
                },
                "holdingPattern":{
                    "type":"string",
                    "description":"Holding Pattern"
                },
                "partyName":{
                    "type":"string",
                    "description":"Party Name"
                },
                "partyNumber":{
                    "type":"string",
                    "description":"Party Number"
                },
                "partyType":{
                    "type":"string",
                    "description":"Party Type"
                },
                "placeOfIncorporation":{
                    "type":"string",
                    "description":"Place Of Incorporation"
                },
                "languageCode":{
                    "type":"string",
                    "description":"Language Code"
                },
                "reportLocale":{
                    "type":"string",
                    "description":"Report Locale"
                },
                "address":{
                    "$ref":"#/definitions/AddressDto"
                },
                "partyContact":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ClmoTmPartyContactDTO"
                    }
                }
            }
        }
    ]
}

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

Type: object

Show Source

address(optional): object AddressDto
countryOfIncorporation(optional): string

Country Of Incorporation
dateOfIncorporation(optional): string

Date Of Incorporation
demographicType(optional): string

Demographic Type
holdingPattern(optional): string

Holding Pattern
kycStatus(optional): string

KYC Status
languageCode(optional): string

Language Code
organizationType(optional): string

Organization Type
partyContact(optional): array partyContact
partyName(optional): string

Party Name
partyNumber(optional): string

Party Number
partyType(optional): string

Party Type
placeOfIncorporation(optional): string

Place Of Incorporation
reportLocale(optional): string

Report Locale

{
    "type":"object",
    "properties":{
        "countryOfIncorporation":{
            "type":"string",
            "description":"Country Of Incorporation"
        },
        "dateOfIncorporation":{
            "type":"string",
            "description":"Date Of Incorporation"
        },
        "demographicType":{
            "type":"string",
            "description":"Demographic Type"
        },
        "organizationType":{
            "type":"string",
            "description":"Organization Type"
        },
        "kycStatus":{
            "type":"string",
            "description":"KYC Status"
        },
        "holdingPattern":{
            "type":"string",
            "description":"Holding Pattern"
        },
        "partyName":{
            "type":"string",
            "description":"Party Name"
        },
        "partyNumber":{
            "type":"string",
            "description":"Party Number"
        },
        "partyType":{
            "type":"string",
            "description":"Party Type"
        },
        "placeOfIncorporation":{
            "type":"string",
            "description":"Place Of Incorporation"
        },
        "languageCode":{
            "type":"string",
            "description":"Language Code"
        },
        "reportLocale":{
            "type":"string",
            "description":"Report Locale"
        },
        "address":{
            "$ref":"#/definitions/AddressDto"
        },
        "partyContact":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ClmoTmPartyContactDTO"
            }
        }
    }
}

Nested Schema : AddressDto

Type: object

Show Source

addressType(optional): string

Address Type
area(optional): string

Area
building(optional): string

Building
city(optional): string

City
country(optional): string

Country
id(optional): string

ID
landmark(optional): string

Landmark
locality(optional): string

Locality
parentId(optional): string

Area
state(optional): string

State
street(optional): string

Street
zipcode(optional): string

ZIP Code

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID"
        },
        "parentId":{
            "type":"string",
            "description":"Area"
        },
        "addressType":{
            "type":"string",
            "description":"Address Type"
        },
        "area":{
            "type":"string",
            "description":"Area"
        },
        "building":{
            "type":"string",
            "description":"Building"
        },
        "street":{
            "type":"string",
            "description":"Street"
        },
        "landmark":{
            "type":"string",
            "description":"Landmark"
        },
        "locality":{
            "type":"string",
            "description":"Locality"
        },
        "city":{
            "type":"string",
            "description":"City"
        },
        "state":{
            "type":"string",
            "description":"State"
        },
        "country":{
            "type":"string",
            "description":"Country"
        },
        "zipcode":{
            "type":"string",
            "description":"ZIP Code"
        }
    }
}

Nested Schema : partyContact

Type: array

Show Source

Array of: object ClmoTmPartyContactDTO

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

Nested Schema : ClmoTmPartyContactDTO

Type: object

Show Source

designation(optional): string

Designation
firstName(optional): string

First Name
id(optional): string

ID
lastName(optional): string

Last Name
partyContactMedia(optional): array partyContactMedia
partyId(optional): string

Party Id
salutation(optional): string

Salutation

{
    "type":"object",
    "properties":{
        "salutation":{
            "type":"string",
            "description":"Salutation"
        },
        "firstName":{
            "type":"string",
            "description":"First Name"
        },
        "lastName":{
            "type":"string",
            "description":"Last Name"
        },
        "designation":{
            "type":"string",
            "description":"Designation"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "partyContactMedia":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ClmoTmPartyContactMediaDTO"
            }
        }
    }
}

Nested Schema : partyContactMedia

Type: array

Show Source

Array of: object ClmoTmPartyContactMediaDTO

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

Nested Schema : ClmoTmPartyContactMediaDTO

Type: object

Show Source

address(optional): object AddressDto
id(optional): string

ID
mediaAddress(optional): string

Media Address
mediaType(optional): string

Media Type
partyContactId(optional): string

Party Contact ID
preferredFlag(optional): string

Preferred Flag

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID"
        },
        "mediaAddress":{
            "type":"string",
            "description":"Media Address"
        },
        "mediaType":{
            "type":"string",
            "description":"Media Type"
        },
        "partyContactId":{
            "type":"string",
            "description":"Party Contact ID"
        },
        "preferredFlag":{
            "type":"string",
            "description":"Preferred Flag"
        },
        "address":{
            "$ref":"#/definitions/AddressDto"
        }
    }
}

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