Previous Next JavaScript must be enabled to correctly display this content

## Retrives the real time liquidity structure by given ID

get

/service/lrt/structure/{id}/history

This endpoint is used to get the real time liquidity structure history by ID.

### Request

Supported Media Types

- application/json
- application/xml

Path Parameters

- id: string
  Id of the user that needs to be fetched

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 200 Response

Returns the realtimeliquiditystructure based on given id.
Body ()
Root Schema : LrtTmStructureMasterCollection
Type: `object`
Collection of structure.
Show Source

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

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

Nested Schema : data
Type: `array`
Show Source

- Array of: object LrtTmStructureMasterDTO

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

Nested Schema : PagingDto
Type: `object`
Show Source

- totalResults(optional): integer

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

Nested Schema : LrtTmStructureMasterDTO
Type: `object`
Match All
Show Source

- allOf GenericDto
- object LrtTmStructureMasterDTO-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "allowBcOnCurrencyHol":{
                        "type":"string",
                        "description":""
                    },
                    "crossCurrencyFlag":{
                        "type":"string",
                        "description":""
                    },
                    "customerId":{
                        "type":"string",
                        "description":"",
                        "pattern":"[a-zA-Z0-9]{1,20}"
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":""
                    },
                    "endDate":{
                        "type":"string",
                        "format":"date",
                        "description":""
                    },
                    "fxRatePickupForHol":{
                        "type":"string",
                        "description":"",
                        "maxLength":40
                    },
                    "headerAccountNumber":{
                        "type":"string",
                        "description":"",
                        "maxLength":30
                    },
                    "headerBranchCode":{
                        "type":"string",
                        "description":"",
                        "maxLength":5
                    },
                    "headerCurrency":{
                        "type":"string",
                        "description":"",
                        "maxLength":3
                    },
                    "isreverseOnFail":{
                        "type":"string",
                        "description":""
                    },
                    "logCode":{
                        "type":"string",
                        "description":"",
                        "maxLength":20
                    },
                    "logCodeStatus":{
                        "type":"string",
                        "description":"",
                        "maxLength":20
                    },
                    "ratePickupOnline":{
                        "type":"string",
                        "description":""
                    },
                    "sourceSystem":{
                        "type":"string",
                        "description":"",
                        "maxLength":50
                    },
                    "structureDescription":{
                        "type":"string",
                        "description":"",
                        "maxLength":200
                    },
                    "structureId":{
                        "type":"string",
                        "description":"",
                        "pattern":"[A-Z0-9]{1,30}"
                    },
                    "structureStatus":{
                        "type":"string",
                        "description":"",
                        "maxLength":20
                    },
                    "versionNo":{
                        "type":"number",
                        "description":""
                    },
                    "noOfGroup":{
                        "type":"number",
                        "description":""
                    },
                    "noOfAccount":{
                        "type":"number",
                        "description":""
                    },
                    "includecloseandunauth":{
                        "type":"boolean",
                        "description":""
                    },
                    "initialOffset":{
                        "type":"number",
                        "description":""
                    },
                    "initialLimit":{
                        "type":"number",
                        "description":""
                    },
                    "isCallFromSubmit":{
                        "type":"boolean",
                        "description":""
                    },
                    "LrtTmStrAccDetailsDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/LrtTmStrAccDetailsDTO"
                        }
                    },
                    "LrtTmStrGroupDetailsDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/LrtTmStrGroupDetailsDTO"
                        }
                    }
                }
            }
        ]
    }

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 : LrtTmStructureMasterDTO-allOf[1]
Type: `object`
Show Source

- allowBcOnCurrencyHol(optional): string
- crossCurrencyFlag(optional): string
- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
- effectiveDate(optional): string(date)
- endDate(optional): string(date)
- fxRatePickupForHol(optional): string
  Maximum Length: `40`
- headerAccountNumber(optional): string
  Maximum Length: `30`
- headerBranchCode(optional): string
  Maximum Length: `5`
- headerCurrency(optional): string
  Maximum Length: `3`
- includecloseandunauth(optional): boolean
- initialLimit(optional): number
- initialOffset(optional): number
- isCallFromSubmit(optional): boolean
- isreverseOnFail(optional): string
- logCode(optional): string
  Maximum Length: `20`
- logCodeStatus(optional): string
  Maximum Length: `20`
- LrtTmStrAccDetailsDTO(optional): array LrtTmStrAccDetailsDTO
- LrtTmStrGroupDetailsDTO(optional): array LrtTmStrGroupDetailsDTO
- noOfAccount(optional): number
- noOfGroup(optional): number
- ratePickupOnline(optional): string
- sourceSystem(optional): string
  Maximum Length: `50`
- structureDescription(optional): string
  Maximum Length: `200`
- structureId(optional): string
  Pattern: `[A-Z0-9]{1,30}`
- structureStatus(optional): string
  Maximum Length: `20`
- versionNo(optional): number

    {
        "type":"object",
        "properties":{
            "allowBcOnCurrencyHol":{
                "type":"string",
                "description":""
            },
            "crossCurrencyFlag":{
                "type":"string",
                "description":""
            },
            "customerId":{
                "type":"string",
                "description":"",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "endDate":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "fxRatePickupForHol":{
                "type":"string",
                "description":"",
                "maxLength":40
            },
            "headerAccountNumber":{
                "type":"string",
                "description":"",
                "maxLength":30
            },
            "headerBranchCode":{
                "type":"string",
                "description":"",
                "maxLength":5
            },
            "headerCurrency":{
                "type":"string",
                "description":"",
                "maxLength":3
            },
            "isreverseOnFail":{
                "type":"string",
                "description":""
            },
            "logCode":{
                "type":"string",
                "description":"",
                "maxLength":20
            },
            "logCodeStatus":{
                "type":"string",
                "description":"",
                "maxLength":20
            },
            "ratePickupOnline":{
                "type":"string",
                "description":""
            },
            "sourceSystem":{
                "type":"string",
                "description":"",
                "maxLength":50
            },
            "structureDescription":{
                "type":"string",
                "description":"",
                "maxLength":200
            },
            "structureId":{
                "type":"string",
                "description":"",
                "pattern":"[A-Z0-9]{1,30}"
            },
            "structureStatus":{
                "type":"string",
                "description":"",
                "maxLength":20
            },
            "versionNo":{
                "type":"number",
                "description":""
            },
            "noOfGroup":{
                "type":"number",
                "description":""
            },
            "noOfAccount":{
                "type":"number",
                "description":""
            },
            "includecloseandunauth":{
                "type":"boolean",
                "description":""
            },
            "initialOffset":{
                "type":"number",
                "description":""
            },
            "initialLimit":{
                "type":"number",
                "description":""
            },
            "isCallFromSubmit":{
                "type":"boolean",
                "description":""
            },
            "LrtTmStrAccDetailsDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LrtTmStrAccDetailsDTO"
                }
            },
            "LrtTmStrGroupDetailsDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LrtTmStrGroupDetailsDTO"
                }
            }
        }
    }

Nested Schema : LrtTmStrAccDetailsDTO
Type: `array`
Show Source

- Array of: object LrtTmStrAccDetailsDTO

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

Nested Schema : LrtTmStrGroupDetailsDTO
Type: `array`
Show Source

- Array of: object LrtTmStrGroupDetailsDTO

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

Nested Schema : LrtTmStrAccDetailsDTO
Type: `object`
Show Source

- accountCurrency: string
  Maximum Length: `3`
- accountDescription(optional): string
  Maximum Length: `105`
- accountNumber: string
  Maximum Length: `20`
- branchCode: string
  Maximum Length: `5`
- ddaRef(optional): string
- handoffType: string
- id(optional): string
  Maximum Length: `36`
- isPartialCoverAllowed: string
- structureId: string
  Pattern: `[A-Z0-9]{1,30}`
- structureMasterId: string
  Maximum Length: `36`
- sublimitAmount(optional): string
  Maximum Length: `12`
  Pattern: `^[.]?[1-9]*[.]?[0-9]*$`
- sublimitCurrency(optional): string
  Maximum Length: `3`
- sublimitEndDate(optional): string(date)
- sublimitFrequencyType(optional): string
- sublimitStartDate(optional): string(date)
- sublimitUtilization(optional): number
  Pattern: `^[.]?[1-9]*[.]?[0-9]*$`
- subscriptionEndDate(optional): string(date)
- subscriptionStartDate: string(date)
- suspensionEndDate(optional): string(date)
- suspensionStartDate(optional): string(date)

    {
        "type":"object",
        "properties":{
            "accountCurrency":{
                "type":"string",
                "description":"",
                "maxLength":3
            },
            "accountNumber":{
                "type":"string",
                "description":"",
                "maxLength":20
            },
            "branchCode":{
                "type":"string",
                "description":"",
                "maxLength":5
            },
            "handoffType":{
                "type":"string",
                "description":""
            },
            "id":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "isPartialCoverAllowed":{
                "type":"string",
                "description":""
            },
            "structureId":{
                "type":"string",
                "description":"",
                "pattern":"[A-Z0-9]{1,30}"
            },
            "structureMasterId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "sublimitAmount":{
                "type":"string",
                "description":"",
                "pattern":"^[.]?[1-9]*[.]?[0-9]*$",
                "maxLength":12
            },
            "sublimitCurrency":{
                "type":"string",
                "description":"",
                "maxLength":3
            },
            "sublimitEndDate":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "sublimitFrequencyType":{
                "type":"string",
                "description":""
            },
            "sublimitStartDate":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "subscriptionEndDate":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "subscriptionStartDate":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "suspensionEndDate":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "suspensionStartDate":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "ddaRef":{
                "type":"string",
                "description":""
            },
            "sublimitUtilization":{
                "type":"number",
                "description":"",
                "pattern":"^[.]?[1-9]*[.]?[0-9]*$"
            },
            "accountDescription":{
                "type":"string",
                "description":"",
                "maxLength":105
            }
        },
        "required":[
            "accountCurrency",
            "accountNumber",
            "branchCode",
            "handoffType",
            "isPartialCoverAllowed",
            "structureId",
            "structureMasterId",
            "subscriptionStartDate"
        ]
    }

Nested Schema : LrtTmStrGroupDetailsDTO
Type: `object`
Show Source

- groupDescription: string
  Maximum Length: `200`
- groupName: string
  Maximum Length: `20`
- groupPriority: integer
  Minimum Value: `1`
  Maximum Value: `100`
- id(optional): string
  Maximum Length: `36`
- LrtTmStrGroupAccMappingDTO(optional): array LrtTmStrGroupAccMappingDTO
- noOfAccount(optional): number
- reverseOnfail: string
- structureId: string
  Pattern: `[A-Z0-9]{1,30}`
- structureMasterId(optional): string
  Maximum Length: `36`

    {
        "type":"object",
        "properties":{
            "groupDescription":{
                "type":"string",
                "description":"",
                "maxLength":200
            },
            "groupName":{
                "type":"string",
                "description":"",
                "maxLength":20
            },
            "groupPriority":{
                "type":"integer",
                "description":"",
                "minimum":1,
                "maximum":100
            },
            "id":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "reverseOnfail":{
                "type":"string",
                "description":""
            },
            "structureId":{
                "type":"string",
                "description":"",
                "pattern":"[A-Z0-9]{1,30}"
            },
            "structureMasterId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "noOfAccount":{
                "type":"number",
                "description":""
            },
            "LrtTmStrGroupAccMappingDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LrtTmStrGroupAccMappingDTO"
                }
            }
        },
        "required":[
            "groupDescription",
            "groupName",
            "groupPriority",
            "reverseOnfail",
            "structureId"
        ]
    }

Nested Schema : LrtTmStrGroupAccMappingDTO
Type: `array`
Show Source

- Array of: object LrtTmStrGroupAccMappingDTO

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

Nested Schema : LrtTmStrGroupAccMappingDTO
Type: `object`
Show Source

- accountCurrency: string
  Maximum Length: `3`
- accountNumber: string
  Maximum Length: `20`
- accountPriority: integer
  Minimum Value: `1`
  Maximum Value: `100`
- branchCode: string
  Maximum Length: `5`
- groupName(optional): string
  Maximum Length: `20`
- id(optional): string
  Maximum Length: `36`
- structureAccId(optional): string
  Maximum Length: `36`
- structureGroupId(optional): string
  Maximum Length: `36`
- structureId: string
  Pattern: `[A-Z0-9]{1,30}`
- structureMasterId: string
  Maximum Length: `36`

    {
        "type":"object",
        "properties":{
            "accountPriority":{
                "type":"integer",
                "description":"",
                "minimum":1,
                "maximum":100
            },
            "id":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "structureAccId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "structureGroupId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "structureId":{
                "type":"string",
                "pattern":"[A-Z0-9]{1,30}"
            },
            "groupName":{
                "type":"string",
                "description":"",
                "maxLength":20
            },
            "structureMasterId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "accountCurrency":{
                "type":"string",
                "description":"",
                "maxLength":3
            },
            "accountNumber":{
                "type":"string",
                "description":"",
                "maxLength":20
            },
            "branchCode":{
                "type":"string",
                "description":"",
                "maxLength":5
            }
        },
        "required":[
            "accountPriority",
            "accountCurrency",
            "accountNumber",
            "branchCode",
            "structureId",
            "structureMasterId"
        ]
    }

#### 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