Jump to

• Request
• Response

Retrieves the list of total investment details

get

/investmentdetails

This endpoint is used to get the list of total investment details.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• customerId(optional): string
  Maximum Length: 36

  Pattern: [a-zA-Z0-9]

  fetch record according to customerId
• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched
• structureId(optional): string
  Pattern: [A-Z0-9]{1,30}

  fetch record according to structureId

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : LmdRdInvestmentDetailsCollection

Type: object

Collection of Investment details

Show Source

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

{
    "description":"Collection of Investment details",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmdRdInvestmentDetailsDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object LmdRdInvestmentDetailsDTO
  InvestmentDetails DTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : LmdRdInvestmentDetailsDTO

Type: object

InvestmentDetails DTO

Match All

Show Source

• allOf GenericDto
• object LmdRdInvestmentDetailsDTO-allOf[1]

{
    "description":"InvestmentDetails DTO",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "structureId":{
                    "description":"structure id in Investment details",
                    "type":"string",
                    "pattern":"[A-Z0-9]{1,30}"
                },
                "valueDate":{
                    "description":"value date in Investment details",
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
                },
                "accountNumber":{
                    "description":"account number in Investment details",
                    "type":"string",
                    "maxLength":30
                },
                "parentAccountNumber":{
                    "description":"Parent account number in Investment details",
                    "type":"string",
                    "maxLength":30
                },
                "availableBalance":{
                    "description":"Available Balance in Investment details",
                    "type":"number"
                },
                "currencyCode":{
                    "description":"Currency code in Investment details",
                    "type":"string",
                    "maxLength":3
                },
                "customerId":{
                    "description":"Customer Id for Investment details",
                    "type":"string",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "instrumentType":{
                    "description":"Instrument Type for Investment details",
                    "type":"string"
                }
            }
        }
    ]
}

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

Type: object

Show Source

• accountNumber(optional): string
  Maximum Length: 30

  account number in Investment details
• availableBalance(optional): number
  Available Balance in Investment details
• currencyCode(optional): string
  Maximum Length: 3

  Currency code in Investment details
• customerId(optional): string
  Pattern: [a-zA-Z0-9]{1,20}

  Customer Id for Investment details
• instrumentType(optional): string
  Instrument Type for Investment details
• parentAccountNumber(optional): string
  Maximum Length: 30

  Parent account number in Investment details
• structureId(optional): string
  Pattern: [A-Z0-9]{1,30}

  structure id in Investment details
• valueDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

  value date in Investment details

{
    "type":"object",
    "properties":{
        "structureId":{
            "description":"structure id in Investment details",
            "type":"string",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "valueDate":{
            "description":"value date in Investment details",
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
        },
        "accountNumber":{
            "description":"account number in Investment details",
            "type":"string",
            "maxLength":30
        },
        "parentAccountNumber":{
            "description":"Parent account number in Investment details",
            "type":"string",
            "maxLength":30
        },
        "availableBalance":{
            "description":"Available Balance in Investment details",
            "type":"number"
        },
        "currencyCode":{
            "description":"Currency code in Investment details",
            "type":"string",
            "maxLength":3
        },
        "customerId":{
            "description":"Customer Id for Investment details",
            "type":"string",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "instrumentType":{
            "description":"Instrument Type for Investment details",
            "type":"string"
        }
    }
}

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