Retrieves the structure ID
get
/service/lma/structure/getStructureId
This endpoint is used to get the 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 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 : LmmTmStructureServiceDTO-allOf[1]
Type:
Show Source
object-
action(optional):
string
-
allowSweepOnCurrencyHol(optional):
string
Maximum Length:
1Default Value:Y -
backwardTreatment(optional):
string
Maximum Length:
20 -
balanceType(optional):
string
Maximum Length:
1Default Value:VPattern:[B,V] -
batchStatus(optional):
string
-
bodExecution(optional):
string
Maximum Length:
1Pattern:[Y,N] -
callFromValidate(optional):
boolean
Default Value:
false -
centralAccountBranch(optional):
string
Maximum Length:
4 -
centralAccountCurrency(optional):
string
Maximum Length:
3 -
centralAccountNumber(optional):
string
Maximum Length:
30 -
chargeAccountCcy(optional):
string
Maximum Length:
3The charge funding account Currency from where the charges needs to be collected -
chargeAccountNo(optional):
string
Maximum Length:
35The charge funding account from where the charges needs to be collected -
chargeBranchCode(optional):
string
Maximum Length:
4The charge funding branch Code from where the charges needs to be collected -
considerPostSweepBalance(optional):
string
Maximum Length:
1Pattern:[Y,N] -
crossBorderFlag(optional):
string
Maximum Length:
1Default Value:NPattern:[Y,N] -
crossCurrencyFlag(optional):
string
Maximum Length:
1Default Value:NPattern:[Y,N] -
currencyRateType(optional):
string
Maximum Length:
20 -
customerId(optional):
string
Pattern:
[a-zA-Z0-9]{1,20} -
customerName(optional):
string
Maximum Length:
105 -
effectiveDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2} -
endDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2} -
eodExecution(optional):
string
Maximum Length:
1Default Value:NPattern:[Y,N] -
exStrId(optional):
string
Maximum Length:
36 -
fxRatePickup(optional):
string
Maximum Length:
15 -
hasRegulatedDebitAcc(optional):
string
Maximum Length:
1If regulated debit account exists on structure then Y else N -
headerAccountNumber(optional):
string
Maximum Length:
30 -
headerBranchCode(optional):
string
Maximum Length:
4 -
headerCurrency(optional):
string
Maximum Length:
3 -
holidayTreatment(optional):
string
Maximum Length:
20 -
instructionType(optional):
string
Maximum Length:
20 -
interestMethod(optional):
string
Maximum Length:
40 -
investmentSweep(optional):
string
Maximum Length:
2 -
isDirty(optional):
string
Maximum Length:
1Pattern:[Y,N] -
isSimulation(optional):
string
Maximum Length:
1Pattern:[Y,N] -
isSimulationMode(optional):
boolean
Default Value:
falseTo check for simulation -
isViewMode(optional):
boolean
Default Value:
falseTo check for view mode in simulation structure -
lastSuccessfulSweepDate(optional):
string(date)
-
limitTrackingFlag(optional):
string
Maximum Length:
1 -
LmmTmStructureAccountsDTO(optional):
array LmmTmStructureAccountsDTO
-
LmmTmStructureDetailsDTO(optional):
array LmmTmStructureDetailsDTO
-
LmmTmTempStructurePriorityDTO(optional):
array LmmTmTempStructurePriorityDTO
-
LmxTmSimAccountVdBalDTO(optional):
array LmxTmSimAccountVdBalDTO
-
maxBackwardDays(optional):
integer
-
multiBankFlag(optional):
string
-
nextRunDate(optional):
string
-
nextRunDateReverse(optional):
string
-
numberOfAccountsLinked(optional):
integer
-
pauseEndDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2} -
pauseStartDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2} -
prevRunDateReverse(optional):
string
-
prospect(optional):
string
Maximum Length:
20 -
ratePickUp(optional):
string
Maximum Length:
40 -
reallocationMethod(optional):
string
Maximum Length:
50 -
reverseFrequency(optional):
string
Maximum Length:
20 -
revFreqBodExecution(optional):
string
Maximum Length:
1Pattern:[Y,N] -
revFreqEodExecution(optional):
string
Maximum Length:
1Pattern:[Y,N] -
simulationFromDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2} -
simulationId(optional):
string
Maximum Length:
30 -
simulationToDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2} -
sourceSystem(optional):
string
Maximum Length:
35 -
structureDescription(optional):
string
Maximum Length:
200Pattern:[A-Za-z0-9 ()_+:"',.?/-]{1,200} -
structureFrequency(optional):
string
Maximum Length:
20 -
structureId:
string
Pattern:
[A-Z0-9]{1,30} -
structureStatus(optional):
string
Maximum Length:
20 -
structureType(optional):
string
Maximum Length:
20 -
struturePriority(optional):
integer
Minimum Value:
1 -
systemAccountBranch(optional):
string
-
systemAccountCurrency(optional):
string
-
systemAccountNumber(optional):
string
-
trackIcl(optional):
string
Maximum Length:
1Pattern:[Y,N] -
versionNo(optional):
integer
Nested Schema : LmmTmStructureAccountsDTO
Type:
Show Source
object-
accCategory(optional):
string
Maximum Length:
10 -
accountBranch(optional):
string
-
accountCurrency(optional):
string
-
accountDescription(optional):
string
Maximum Length:
105 -
accountNumber(optional):
string
Maximum Length:
30 -
accountType(optional):
string
Maximum Length:
20 -
acyAvailableBal(optional):
number
-
bankCode(optional):
string
-
bankDesc(optional):
string
-
cityId(optional):
string
-
countryId(optional):
string
-
customerDesc(optional):
string
Maximum Length:
105Customer Description -
customerName(optional):
string
Customer Name
-
customerNumber(optional):
string
Maximum Length:
20Customer number -
entityID(optional):
string
Entity ID
-
entityName(optional):
string
Entity Name
-
groupCode(optional):
string
Maximum Length:
5 -
iban(optional):
string
IBAN Number
-
id(optional):
string
Maximum Length:
36 -
isDebitUnlimited(optional):
string
Maximum Length:
1 -
isExternal(optional):
string
-
isNotional(optional):
string
Maximum Length:
1Default Value:NPattern:[Y,N] -
isRegulatedDebits(optional):
string
Maximum Length:
1 -
isSelected(optional):
string
Maximum Length:
1 -
region(optional):
string
-
simAccountNumber(optional):
string
-
structureMasterId(optional):
string
Maximum Length:
36
Nested Schema : LmmTmStructureDetailsDTO
Type:
Show Source
object-
accCategory(optional):
string
-
accountCurrency(optional):
string
-
accountDescription(optional):
string
-
accountLevel(optional):
integer
-
accountNumber(optional):
string
Maximum Length:
30 -
accountType(optional):
string
Maximum Length:
20 -
acyAvailableBal(optional):
number
-
allowReverseSweep(optional):
string
Maximum Length:
1Default Value:NPattern:[Y,N] -
bankCode(optional):
string
-
bankDesc(optional):
string
-
bookingAccountBranch(optional):
string
Maximum Length:
4 -
bookingAccountCurrency(optional):
string
Maximum Length:
3 -
bookingAccountNumber(optional):
string
Maximum Length:
30 -
branchCode(optional):
string
Maximum Length:
4 -
centralAccountBranch(optional):
string
Maximum Length:
4 -
centralAccountCurrency(optional):
string
Maximum Length:
3 -
centralAccountNumber(optional):
string
Maximum Length:
30 -
cityId(optional):
string
-
countryId(optional):
string
-
customerName(optional):
string
Customer Name
-
entityID(optional):
string
Entity ID
-
entityName(optional):
string
Entity Name
-
eodExecution(optional):
string
Maximum Length:
1 -
holdEndDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2} -
holdStartDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2} -
iban(optional):
string
IBAN Number
-
id(optional):
string
Maximum Length:
36 -
isExternal(optional):
string
-
isHold(optional):
string
Maximum Length:
1Default Value:NPattern:[Y,N] -
isNominatedAccount(optional):
string
Maximum Length:
1 -
isNotional(optional):
string
-
isRegulatedDebits(optional):
string
-
isTwoWay(optional):
string
Maximum Length:
1Default Value:NPattern:[Y,N] -
isVirtual(optional):
string
-
latitude(optional):
number
-
LmmTmStrRevSweepDetailsDTO(optional):
array LmmTmStrRevSweepDetailsDTO
-
LmmTmStructureAccPriorityDTO(optional):
array LmmTmStructureAccPriorityDTO
-
LmmTmStructureIclDTO(optional):
array LmmTmStructureIclDTO
-
LmmTmStructureInstructionDTO(optional):
array LmmTmStructureInstructionDTO
-
LmmTmStructurePaymentDTO(optional):
array LmmTmStructurePaymentDTO
-
longitude(optional):
number
-
oneWayAccountGroup(optional):
string
Maximum Length:
5 -
onlineBalanceFetch(optional):
string
Maximum Length:
1 -
parentAccountBranch(optional):
string
Maximum Length:
4 -
parentAccountCurrency(optional):
string
Maximum Length:
3 -
parentAccountNumber(optional):
string
Maximum Length:
30 -
partialReverseSweep(optional):
string
Maximum Length:
1Default Value:N -
partialTransferAllowed(optional):
string
Maximum Length:
1 - percentageChildShare(optional): integer
- percentageShare(optional): integer
-
ratePickUp(optional):
string
Maximum Length:
40 -
rateType(optional):
string
Maximum Length:
8 -
reallocationMethod(optional):
string
Maximum Length:
40 -
reallocationRequired(optional):
string
Maximum Length:
1 -
region(optional):
string
-
reverseSweepFrequency(optional):
string
Maximum Length:
20 -
structureMasterId:
string
Maximum Length:
36 -
sweepPriority(optional):
integer
-
twoWayAccountGroup(optional):
string
Maximum Length:
5 -
twowaySweepPriority(optional):
integer
-
useDefaultPaymntIns(optional):
string
Maximum Length:
1Default Value:NPattern:[Y,N]payment ins is defaulted or not
Nested Schema : LmmTmStrRevSweepDetailsDTO
Type:
Show Source
object-
accountBranch(optional):
string
Maximum Length:
4 -
accountCurrency(optional):
string
Maximum Length:
3 -
accountNumber(optional):
string
Maximum Length:
30 -
bodExecution(optional):
string
Maximum Length:
1Pattern:[Y,N] -
eodExecution(optional):
string
Maximum Length:
1Pattern:[Y,N] -
id(optional):
string
Maximum Length:
36 -
nextRunDate(optional):
string
-
previousRunDate(optional):
string
-
reverseSweepFrequency(optional):
string
Maximum Length:
20 -
structureDetailsId(optional):
string
Maximum Length:
36 -
structureMasterId(optional):
string
Maximum Length:
36
Nested Schema : LmmTmStructureAccPriorityDTO
Type:
Show Source
object-
accountNumber(optional):
string
Maximum Length:
30 -
branchCode(optional):
string
Maximum Length:
4 -
effectiveDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2} -
endDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2} -
id(optional):
string
Maximum Length:
36 -
structureDescription(optional):
string
Pattern:
[A-Za-z0-9 ()_+:"',.?/-]{1,200} -
structureDetailsId(optional):
string
Maximum Length:
36 -
structureId(optional):
string
Pattern:
[A-Z0-9]{1,30} -
structureMasterId(optional):
string
Maximum Length:
36 -
structurePriority(optional):
integer
-
structureType(optional):
string
-
versionNo(optional):
integer
Nested Schema : LmmTmStructureIclDTO
Type:
Show Source
object-
iclBookingReport(optional):
string
Maximum Length:
1Pattern:[Y,N] -
iclReference(optional):
string
Maximum Length:
100 -
iclSettlementReport(optional):
string
Maximum Length:
1Pattern:[Y,N] -
id(optional):
string
Maximum Length:
36 -
loanType(optional):
string
Maximum Length:
1 -
structureDetailsId(optional):
string
Maximum Length:
36 -
structureMasterId(optional):
string
Maximum Length:
36 -
trackIcl(optional):
string
Maximum Length:
1Pattern:[Y,N]
Nested Schema : LmmTmStructureInstructionDTO
Type:
Show Source
object-
id(optional):
string
Maximum Length:
36 -
instrDesc(optional):
string
Maximum Length:
100 -
instructionId(optional):
string
Maximum Length:
15 -
instructionPriority(optional):
integer
-
LmmTmStructureInstructionDetDTO(optional):
array LmmTmStructureInstructionDetDTO
-
LmmTmStructureInstructionFrequencyDTO(optional):
array LmmTmStructureInstructionFrequencyDTO
-
structureDetailsId:
string
Maximum Length:
36 -
suspensionEndDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2} -
suspensionStartDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}
Nested Schema : LmmTmStructureInstructionDetDTO
Type:
Show Source
object-
id(optional):
string
Maximum Length:
36 -
paramName(optional):
string
Maximum Length:
25 -
paramValue(optional):
string
Maximum Length:
100 -
structureInstructionId:
string
Maximum Length:
36
Nested Schema : LmmTmStructureInstructionFrequencyDTO
Type:
Show Source
object-
freqDesc(optional):
string
-
frequencyId(optional):
string
Maximum Length:
25 -
id(optional):
string
Maximum Length:
36 -
structureInstructionId:
string
Maximum Length:
36
Nested Schema : LmmTmStructurePaymentDTO
Type:
Show Source
object-
id(optional):
string
Maximum Length:
150 -
interfaceMasterId(optional):
string
Maximum Length:
36 -
LmmTmStructurePaymentDetailDTO(optional):
array LmmTmStructurePaymentDetailDTO
-
structureDetailsId:
string
Maximum Length:
36 -
sweepDirection(optional):
string
Maximum Length:
10
Nested Schema : LmmTmStructurePaymentDetailDTO
Type:
Show Source
object-
id(optional):
string
Maximum Length:
36 -
paramName(optional):
string
Maximum Length:
50 -
paramValue(optional):
string
Maximum Length:
100 -
structurePaymentId:
string
Maximum Length:
36
Nested Schema : LmmTmTempStructurePriorityDTO
Type:
Show Source
object-
id(optional):
string
Maximum Length:
36ID -
structureId(optional):
string
Maximum Length:
30Structure ID -
structureMasterId(optional):
string
Maximum Length:
36Structure Master ID -
structurePriority(optional):
integer
Minimum Value:
1Structure Priority
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