Jump to

• Request
• Response

Retrieves the IE structure ID

get

/interestenhancement/getIEStructureId

This endpoint is used to get the interest enhancement structure ID.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the IE structure id.

Body ()

Root Schema : LmmTmIeStructureWrapperDTO

Type: object

Show Source

• data(optional): object LmmTmIeStructureDTO

{
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/LmmTmIeStructureDTO"
        }
    }
}

Nested Schema : LmmTmIeStructureDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmmTmIeStructureDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "branchCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":4
                },
                "customerId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "effectiveDate":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "endDate":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "enhancementType":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                },
                "interestMethod":{
                    "type":"string",
                    "description":"",
                    "maxLength":20
                },
                "isTemp":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                },
                "logCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":20
                },
                "nominatedAccNo":{
                    "type":"string",
                    "description":"",
                    "maxLength":30
                },
                "sourceSystem":{
                    "type":"string",
                    "description":"",
                    "maxLength":35
                },
                "pauseStartDate":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "pauseEndDate":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "structureDescription":{
                    "type":"string",
                    "description":"",
                    "maxLength":20
                },
                "structureId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[A-Z0-9]{1,30}"
                },
                "thresholdAmount":{
                    "type":"number",
                    "description":""
                },
                "thresholdCurrency":{
                    "type":"string",
                    "description":"",
                    "maxLength":3
                },
                "versionNo":{
                    "type":"number",
                    "description":""
                },
                "LmmTmIeAccountDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LmmTmIeAccountDTO"
                    }
                },
                "LmmTmIeRateDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LmmTmIeRateDTO"
                    }
                },
                "LmmTmIeThresholdDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LmmTmIeThresholdDTO"
                    }
                }
            },
            "required":[
                "LmmTmIeAccountDTO",
                "LmmTmIeRateDTO",
                "LmmTmIeThresholdDTO"
            ]
        }
    ]
}

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

Type: object

Show Source

• branchCode(optional): string
  Maximum Length: 4
• customerId(optional): string
  Pattern: [a-zA-Z0-9]{1,20}
• effectiveDate(optional): string(date)
• endDate(optional): string(date)
• enhancementType(optional): string
  Maximum Length: 1
• interestMethod(optional): string
  Maximum Length: 20
• isTemp(optional): string
  Maximum Length: 1
• LmmTmIeAccountDTO: array LmmTmIeAccountDTO
• LmmTmIeRateDTO: array LmmTmIeRateDTO
• LmmTmIeThresholdDTO: array LmmTmIeThresholdDTO
• logCode(optional): string
  Maximum Length: 20
• nominatedAccNo(optional): string
  Maximum Length: 30
• pauseEndDate(optional): string(date)
• pauseStartDate(optional): string(date)
• sourceSystem(optional): string
  Maximum Length: 35
• structureDescription(optional): string
  Maximum Length: 20
• structureId(optional): string
  Pattern: [A-Z0-9]{1,30}
• thresholdAmount(optional): number
• thresholdCurrency(optional): string
  Maximum Length: 3
• versionNo(optional): number

{
    "type":"object",
    "properties":{
        "branchCode":{
            "type":"string",
            "description":"",
            "maxLength":4
        },
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "enhancementType":{
            "type":"string",
            "description":"",
            "maxLength":1
        },
        "interestMethod":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "isTemp":{
            "type":"string",
            "description":"",
            "maxLength":1
        },
        "logCode":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "nominatedAccNo":{
            "type":"string",
            "description":"",
            "maxLength":30
        },
        "sourceSystem":{
            "type":"string",
            "description":"",
            "maxLength":35
        },
        "pauseStartDate":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "pauseEndDate":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "structureDescription":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "thresholdAmount":{
            "type":"number",
            "description":""
        },
        "thresholdCurrency":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "versionNo":{
            "type":"number",
            "description":""
        },
        "LmmTmIeAccountDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmIeAccountDTO"
            }
        },
        "LmmTmIeRateDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmIeRateDTO"
            }
        },
        "LmmTmIeThresholdDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmIeThresholdDTO"
            }
        }
    },
    "required":[
        "LmmTmIeAccountDTO",
        "LmmTmIeRateDTO",
        "LmmTmIeThresholdDTO"
    ]
}

Nested Schema : LmmTmIeAccountDTO

Type: array

Show Source

• Array of: object LmmTmIeAccountDTO

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

Nested Schema : LmmTmIeRateDTO

Type: array

Show Source

• Array of: object LmmTmIeRateDTO

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

Nested Schema : LmmTmIeThresholdDTO

Type: array

Show Source

• Array of: object LmmTmIeThresholdDTO

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

Nested Schema : LmmTmIeAccountDTO

Type: object

Show Source

• accountNumber(optional): string
  Maximum Length: 30
• availableBalance(optional): number
• branchCode(optional): string
  Maximum Length: 4
• currency(optional): string
  Maximum Length: 3
• id(optional): string
  Maximum Length: 36
• ieStructureId(optional): string
  Maximum Length: 36

{
    "type":"object",
    "properties":{
        "accountNumber":{
            "type":"string",
            "description":"",
            "maxLength":30
        },
        "branchCode":{
            "type":"string",
            "description":"",
            "maxLength":4
        },
        "currency":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "id":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "ieStructureId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "availableBalance":{
            "type":"number",
            "description":""
        }
    }
}

Nested Schema : LmmTmIeRateDTO

Type: object

Show Source

• currency(optional): string
  Maximum Length: 3
• enhancementRate(optional): number
• fromAmount(optional): number
• id(optional): string
  Maximum Length: 36
• ieStructureId(optional): string
  Maximum Length: 36
• rateType(optional): string
  Maximum Length: 5
• toAmount(optional): number

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "enhancementRate":{
            "type":"number",
            "description":""
        },
        "fromAmount":{
            "type":"number",
            "description":""
        },
        "id":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "ieStructureId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "rateType":{
            "type":"string",
            "description":"",
            "maxLength":5
        },
        "toAmount":{
            "type":"number",
            "description":""
        }
    }
}

Nested Schema : LmmTmIeThresholdDTO

Type: object

Show Source

• amount(optional): number
• currency(optional): string
  Maximum Length: 3
• enhancementRate(optional): number
• id(optional): string
  Maximum Length: 36
• ieStructureId(optional): string
  Maximum Length: 36

{
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":""
        },
        "currency":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "enhancementRate":{
            "type":"number",
            "description":""
        },
        "id":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "ieStructureId":{
            "type":"string",
            "description":"",
            "maxLength":36
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top