Jump to

• Request
• Response

Retrieves the BOD structure master ID by header branch code

get

/structure/structureBod/{headerBranchCode}

This endpoint is used to get the BOD structure master ID by header branch code.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• headerBranchCode: string
  Header Branch Code

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the BOD Structure Master Id details by header Branch Code.

Body ()

Root Schema : LmmTmStructureCollection

Type: object

Collection of structures.

Show Source

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object LmmTmStructureDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : LmmTmStructureDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmmTmStructureDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "structureId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[A-Z0-9]{1,30}"
                },
                "structureDescription":{
                    "type":"string",
                    "description":""
                },
                "customerId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "structureType":{
                    "type":"string",
                    "description":""
                },
                "struturePriority":{
                    "type":"integer",
                    "description":""
                },
                "effectiveDate":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "endDate":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "headerAccountNumber":{
                    "type":"string",
                    "description":""
                },
                "headerBranchCode":{
                    "type":"string",
                    "description":""
                },
                "headerCurrency":{
                    "type":"string",
                    "description":""
                },
                "multiBankFlag":{
                    "type":"string",
                    "description":""
                },
                "crossBorderFlag":{
                    "type":"string",
                    "description":""
                },
                "crossCurrencyFlag":{
                    "type":"string",
                    "description":""
                },
                "balanceType":{
                    "type":"string",
                    "description":""
                },
                "structureFrequency":{
                    "type":"string",
                    "description":""
                },
                "currencyRateType":{
                    "type":"string",
                    "description":""
                },
                "allowSweepOnCurrencyHol":{
                    "type":"string",
                    "description":""
                },
                "interestMethod":{
                    "type":"string",
                    "description":""
                },
                "ratePickUp":{
                    "type":"string",
                    "description":""
                },
                "nextRunDate":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "eodExecution":{
                    "type":"string",
                    "description":""
                },
                "reverseFrequency":{
                    "type":"string",
                    "description":""
                },
                "instructionType":{
                    "type":"string",
                    "description":""
                },
                "reallocationMethod":{
                    "type":"string",
                    "description":""
                },
                "centralAccountNumber":{
                    "type":"string",
                    "description":""
                },
                "centralAccountBranch":{
                    "type":"string",
                    "description":""
                },
                "centralAccountCurrency":{
                    "type":"string",
                    "description":""
                },
                "nextRunDateReverse":{
                    "type":"string",
                    "format":"date",
                    "description":""
                },
                "structureStatus":{
                    "type":"string",
                    "description":""
                },
                "fxRatePickup":{
                    "type":"string",
                    "description":""
                },
                "limitTrackingFlag":{
                    "type":"string",
                    "description":""
                },
                "customerName":{
                    "type":"string",
                    "description":""
                },
                "LmmTmStructureDetailsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LmmTmStructureDetailsDTO"
                    }
                }
            },
            "required":[
                "id",
                "structureId"
            ]
        }
    ]
}

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

Type: object

Show Source

• allowSweepOnCurrencyHol(optional): string
• balanceType(optional): string
• centralAccountBranch(optional): string
• centralAccountCurrency(optional): string
• centralAccountNumber(optional): string
• crossBorderFlag(optional): string
• crossCurrencyFlag(optional): string
• currencyRateType(optional): string
• customerId(optional): string
  Pattern: [a-zA-Z0-9]{1,20}
• customerName(optional): string
• effectiveDate(optional): string(date)
• endDate(optional): string(date)
• eodExecution(optional): string
• fxRatePickup(optional): string
• headerAccountNumber(optional): string
• headerBranchCode(optional): string
• headerCurrency(optional): string
• instructionType(optional): string
• interestMethod(optional): string
• limitTrackingFlag(optional): string
• LmmTmStructureDetailsDTO(optional): array LmmTmStructureDetailsDTO
• multiBankFlag(optional): string
• nextRunDate(optional): string(date)
• nextRunDateReverse(optional): string(date)
• ratePickUp(optional): string
• reallocationMethod(optional): string
• reverseFrequency(optional): string
• structureDescription(optional): string
• structureFrequency(optional): string
• structureId: string
  Pattern: [A-Z0-9]{1,30}
• structureStatus(optional): string
• structureType(optional): string
• struturePriority(optional): integer

{
    "type":"object",
    "properties":{
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "structureDescription":{
            "type":"string",
            "description":""
        },
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "structureType":{
            "type":"string",
            "description":""
        },
        "struturePriority":{
            "type":"integer",
            "description":""
        },
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "headerAccountNumber":{
            "type":"string",
            "description":""
        },
        "headerBranchCode":{
            "type":"string",
            "description":""
        },
        "headerCurrency":{
            "type":"string",
            "description":""
        },
        "multiBankFlag":{
            "type":"string",
            "description":""
        },
        "crossBorderFlag":{
            "type":"string",
            "description":""
        },
        "crossCurrencyFlag":{
            "type":"string",
            "description":""
        },
        "balanceType":{
            "type":"string",
            "description":""
        },
        "structureFrequency":{
            "type":"string",
            "description":""
        },
        "currencyRateType":{
            "type":"string",
            "description":""
        },
        "allowSweepOnCurrencyHol":{
            "type":"string",
            "description":""
        },
        "interestMethod":{
            "type":"string",
            "description":""
        },
        "ratePickUp":{
            "type":"string",
            "description":""
        },
        "nextRunDate":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "eodExecution":{
            "type":"string",
            "description":""
        },
        "reverseFrequency":{
            "type":"string",
            "description":""
        },
        "instructionType":{
            "type":"string",
            "description":""
        },
        "reallocationMethod":{
            "type":"string",
            "description":""
        },
        "centralAccountNumber":{
            "type":"string",
            "description":""
        },
        "centralAccountBranch":{
            "type":"string",
            "description":""
        },
        "centralAccountCurrency":{
            "type":"string",
            "description":""
        },
        "nextRunDateReverse":{
            "type":"string",
            "format":"date",
            "description":""
        },
        "structureStatus":{
            "type":"string",
            "description":""
        },
        "fxRatePickup":{
            "type":"string",
            "description":""
        },
        "limitTrackingFlag":{
            "type":"string",
            "description":""
        },
        "customerName":{
            "type":"string",
            "description":""
        },
        "LmmTmStructureDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmStructureDetailsDTO"
            }
        }
    },
    "required":[
        "id",
        "structureId"
    ]
}

Nested Schema : LmmTmStructureDetailsDTO

Type: array

Show Source

• Array of: object LmmTmStructureDetailsDTO

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

Nested Schema : LmmTmStructureDetailsDTO

Type: object

Show Source

• accountCurrency(optional): string
• accountLevel(optional): integer
• accountNumber(optional): string
• accountType(optional): string
• allowReverseSweep(optional): string
• bookingAccountBranch(optional): string
• bookingAccountCurrency(optional): string
• bookingAccountNumber(optional): string
• branchCode(optional): string
• centralAccountBranch(optional): string
• centralAccountCurrency(optional): string
• centralAccountNumber(optional): string
• eodExecution(optional): string
• id(optional): string
• instructionPriority(optional): integer
• isExternalAccount(optional): string
• isHold(optional): string
• isNominatedAccount(optional): string
• isTwoWay(optional): string
• LmmTmStructureInstructionDTO(optional): array LmmTmStructureInstructionDTO
• onlineBalanceFetch(optional): string
• parentAccountBranch(optional): string
• parentAccountCurrency(optional): string
• parentAccountNumber(optional): string
• partialReverseSweep(optional): string
• partialTransferAllowed(optional): string
• percentageChildShare(optional): integer
• percentageShare(optional): integer
• ratePickUp(optional): string
• rateType(optional): string
• reallocationMethod(optional): string
• reallocationRequired(optional): string
• reverseSweepFrequency(optional): string
• structureMasterId: string
• twowaySweepPriority(optional): integer

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "structureMasterId":{
            "type":"string",
            "description":""
        },
        "accountNumber":{
            "type":"string",
            "description":""
        },
        "branchCode":{
            "type":"string",
            "description":""
        },
        "accountCurrency":{
            "type":"string",
            "description":""
        },
        "isExternalAccount":{
            "type":"string",
            "description":""
        },
        "parentAccountNumber":{
            "type":"string",
            "description":""
        },
        "parentAccountBranch":{
            "type":"string",
            "description":""
        },
        "parentAccountCurrency":{
            "type":"string",
            "description":""
        },
        "bookingAccountNumber":{
            "type":"string",
            "description":""
        },
        "bookingAccountBranch":{
            "type":"string",
            "description":""
        },
        "bookingAccountCurrency":{
            "type":"string",
            "description":""
        },
        "rateType":{
            "type":"string",
            "description":""
        },
        "accountType":{
            "type":"string",
            "description":""
        },
        "instructionPriority":{
            "type":"integer",
            "description":""
        },
        "isTwoWay":{
            "type":"string",
            "description":""
        },
        "reverseSweepFrequency":{
            "type":"string",
            "description":""
        },
        "twowaySweepPriority":{
            "type":"integer",
            "description":""
        },
        "onlineBalanceFetch":{
            "type":"string",
            "description":""
        },
        "partialReverseSweep":{
            "type":"string",
            "description":""
        },
        "isHold":{
            "type":"string",
            "description":""
        },
        "eodExecution":{
            "type":"string",
            "description":""
        },
        "ratePickUp":{
            "type":"string",
            "description":""
        },
        "reallocationRequired":{
            "type":"string",
            "description":""
        },
        "reallocationMethod":{
            "type":"string",
            "description":""
        },
        "allowReverseSweep":{
            "type":"string",
            "description":""
        },
        "isNominatedAccount":{
            "type":"string",
            "description":""
        },
        "accountLevel":{
            "type":"integer",
            "description":""
        },
        "centralAccountNumber":{
            "type":"string",
            "description":""
        },
        "centralAccountBranch":{
            "type":"string",
            "description":""
        },
        "centralAccountCurrency":{
            "type":"string",
            "description":""
        },
        "percentageShare":{
            "type":"integer",
            "description":""
        },
        "percentageChildShare":{
            "type":"integer",
            "description":""
        },
        "partialTransferAllowed":{
            "type":"string",
            "description":""
        },
        "LmmTmStructureInstructionDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmStructureInstructionDTO"
            }
        }
    },
    "required":[
        "structureMasterId"
    ]
}

Nested Schema : LmmTmStructureInstructionDTO

Type: array

Show Source

• Array of: object LmmTmStructureInstructionDTO

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

Nested Schema : LmmTmStructureInstructionDTO

Type: object

Show Source

• id(optional): string
• instructionId(optional): string
• instructionPriority(optional): integer
• LmmTmStructureInstructionDetDTO(optional): array LmmTmStructureInstructionDetDTO
• LmmTmStructureInstructionFrequencyDTO(optional): array LmmTmStructureInstructionFrequencyDTO
• structureDetailsId: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "structureDetailsId":{
            "type":"string",
            "description":""
        },
        "instructionId":{
            "type":"string",
            "description":""
        },
        "instructionPriority":{
            "type":"integer",
            "description":""
        },
        "LmmTmStructureInstructionFrequencyDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmStructureInstructionFrequencyDTO"
            }
        },
        "LmmTmStructureInstructionDetDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmStructureInstructionDetDTO"
            }
        }
    },
    "required":[
        "structureDetailsId"
    ]
}

Nested Schema : LmmTmStructureInstructionDetDTO

Type: array

Show Source

• Array of: object LmmTmStructureInstructionDetDTO

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

Nested Schema : LmmTmStructureInstructionFrequencyDTO

Type: array

Show Source

• Array of: object LmmTmStructureInstructionFrequencyDTO

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

Nested Schema : LmmTmStructureInstructionDetDTO

Type: object

Show Source

• id(optional): string
• paramName(optional): string
• paramValue(optional): string
• structureInstructionId: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "structureInstructionId":{
            "type":"string",
            "description":""
        },
        "paramName":{
            "type":"string",
            "description":""
        },
        "paramValue":{
            "type":"string",
            "description":""
        }
    },
    "required":[
        "structureInstructionId"
    ]
}

Nested Schema : LmmTmStructureInstructionFrequencyDTO

Type: object

Show Source

• frequencyId(optional): string
• id(optional): string
• structureInstructionId: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "structureInstructionId":{
            "type":"string",
            "description":""
        },
        "frequencyId":{
            "type":"string",
            "description":""
        }
    },
    "required":[
        "structureInstructionId"
    ]
}

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