Retrieves the IO structure ID
get
                    /simulation/interest-optimization/getIOStructureId
This endpoint is used to get the interest optimisation structure ID.
                Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
                - application/json
 - application/xml
 
200 Response
Returns the IO structure id.
                
                
                    Nested Schema : GenericDto
    
      
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Match All
    Show Source
    - 
            
            object 
            
            
         GenericDto-allOf[0]
            
        Discriminator:
resource_type 
Nested Schema : GenericDto-allOf[0]
    
      Type: 
      
    
    
    
    
    objectDiscriminator: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
resource_typeNested Schema : LmxTmIOStructureMasterDTO-allOf[1]
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            branchCode(optional): 
            string
            Maximum Length:
4 - 
            copyTemplate(optional): 
            string
            Pattern:
[A-Z0-9]{1,30} - 
            customerId: 
            string
            Pattern:
[a-zA-Z0-9]{1,20} - 
            customerName(optional): 
            string
            
 - 
            effectiveDate: 
            string(date)
            
 - 
            endDate(optional): 
            string(date)
            
 - 
            interestMethod(optional): 
            string
            Maximum Length:
25 - 
            ioRateType(optional): 
            string
            Maximum Length:
8 - 
            isSimulation(optional): 
            boolean
            Default Value:
falseDenotes whether this is a simulation structure - 
            isStructureCreated(optional): 
            boolean
            Default Value:
falseDenotes whether this is a IO Structure created using this simulation structure - 
            isTemp(optional): 
            string
            Maximum Length:
1 - 
            LmxTmIOCurrencyRateDTO: 
            array  LmxTmIOCurrencyRateDTO
            
            
 - 
            LmxTmIOCurrencyThresholdDTO: 
            array  LmxTmIOCurrencyThresholdDTO
            
            
 - 
            LmxTmIOStructureDetailDTO: 
            array  LmxTmIOStructureDetailDTO
            
            
 - 
            LmxTmSimAccountVdBalDTO(optional): 
            array  LmxTmSimAccountVdBalDTO
            
            
 - 
            logCode(optional): 
            string
            Maximum Length:
20 - 
            nominatedAccBranch(optional): 
            string
            Maximum Length:
4 - 
            nominatedAccCcy(optional): 
            string
            Maximum Length:
3 - 
            nominatedAccNo(optional): 
            string
            Maximum Length:
30 - 
            pauseEndDate(optional): 
            string(date)
            
 - 
            pauseStartDate(optional): 
            string(date)
            
 - 
            prospect(optional): 
            string
            Pattern:
[a-zA-Z0-9]{1,20} - 
            simulationId(optional): 
            string
            Pattern:
[A-Z0-9]{1,30} - 
            sourceSystem(optional): 
            string
            Maximum Length:
35 - 
            structureDescription: 
            string
            Maximum Length:
200 - 
            structureId: 
            string
            Pattern:
[A-Z0-9]{1,30} - 
            thresholdAmount: 
            number
            
 - 
            thresholdCurrency: 
            string
            Maximum Length:
3 - 
            versionNo(optional): 
            number
            
 
Nested Schema : LmxTmIOCurrencyRateDTO
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            currency: 
            string
            Maximum Length:
3 - 
            enhancementRate: 
            number
            
 - 
            fromAmount: 
            number
            
 - 
            id(optional): 
            string
            Maximum Length:
36 - 
            rateType: 
            string
            Maximum Length:
5 - 
            structureMasterId(optional): 
            string
            Maximum Length:
36 - 
            toAmount: 
            number
            
 
Nested Schema : LmxTmIOCurrencyThresholdDTO
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            amount: 
            number
            
 - 
            currency: 
            string
            Maximum Length:
3 - 
            enhancementRate(optional): 
            number
            
 - 
            id(optional): 
            string
            Maximum Length:
36 - 
            structureMasterId(optional): 
            string
            Maximum Length:
36 
Nested Schema : LmxTmIOStructureDetailDTO
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            accountBalance(optional): 
            number
            Maximum Length:
30 - 
            accountDescription(optional): 
            string
            Maximum Length:
30 - 
            accountNumber: 
            string
            Maximum Length:
30 - 
            branchCode: 
            string
            Maximum Length:
4 - 
            currency: 
            string
            Maximum Length:
3 - 
            customerName(optional): 
            string
            Maximum Length:
30 - 
            customerNumber(optional): 
            string
            Maximum Length:
30 - 
            groupCode(optional): 
            string
            Maximum Length:
30 - 
            id(optional): 
            string
            Maximum Length:
36 - 
            structureMasterId(optional): 
            string
            Maximum Length:
36 
Nested Schema : LmxTmSimAccountVdBalDTO
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            accountBranch(optional): 
            string
            Maximum Length:
4 - 
            accountCurrency(optional): 
            string
            Maximum Length:
3 - 
            accountNumber(optional): 
            string
            Maximum Length:
50 - 
            accountVdBal(optional): 
            number
            
 - 
            id(optional): 
            string
            Maximum Length:
36 - 
            modNo(optional): 
            integer
            
 - 
            structureMasterId(optional): 
            string
            Maximum Length:
36 - 
            valueDate(optional): 
            string(date)
            
 
400 Response
Malformed syntax.
                
                
                401 Response
Request does not have sufficient credentials.
                
                
                403 Response
Request is not authorized.
                
                
                500 Response
Internal error