Jump to

• Request
• Response

Adds a new structure details report

post

/structuredetailsreport/save

This endpoint is used to add a new structure details report.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Request Body that contains data required for creating a new structuredetailsreport

Root Schema : StructureMasterbodyDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object StructureMasterbodyDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "customerId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "effectiveDate":{
                    "type":"string",
                    "description":""
                },
                "endDate":{
                    "type":"string",
                    "description":""
                },
                "headerAccountCurrency":{
                    "type":"string",
                    "description":"",
                    "maxLength":3
                },
                "headerBranchCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":4
                },
                "headerAccountDescription":{
                    "type":"string",
                    "description":"",
                    "maxLength":50
                },
                "headerAccountNumber":{
                    "type":"string",
                    "description":"",
                    "maxLength":30
                },
                "headerBranchName":{
                    "type":"string",
                    "description":"",
                    "maxLength":50
                },
                "structureType":{
                    "type":"string",
                    "description":"",
                    "maxLength":20
                },
                "isCrossBorder":{
                    "type":"string",
                    "description":"",
                    "maxLength":1,
                    "pattern":"[Y.N]"
                },
                "isCrossCurrency":{
                    "type":"string",
                    "description":"",
                    "maxLength":1,
                    "pattern":"[Y.N]"
                },
                "isMultiBank":{
                    "type":"string",
                    "description":"",
                    "maxLength":1,
                    "pattern":"[Y.N]"
                },
                "reallocationMethod":{
                    "type":"string",
                    "description":"",
                    "maxLength":50
                },
                "interestMethod":{
                    "type":"string",
                    "description":"",
                    "maxLength":40
                },
                "participatingAccountCount":{
                    "type":"number",
                    "description":""
                },
                "structureStatus":{
                    "type":"string",
                    "description":"",
                    "maxLength":20
                },
                "versionNo":{
                    "type":"number",
                    "description":""
                },
                "modNumber":{
                    "type":"number",
                    "description":""
                },
                "structureDomain":{
                    "type":"string",
                    "description":""
                },
                "structureDescription":{
                    "type":"string",
                    "description":"",
                    "maxLength":200
                },
                "newlyCreated":{
                    "type":"string",
                    "description":""
                },
                "amendedStr":{
                    "type":"string",
                    "description":""
                },
                "totalAmend":{
                    "type":"string",
                    "description":""
                },
                "structureId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[A-Z0-9]{1,30}"
                },
                "checkerDtStamp":{
                    "type":"string",
                    "description":""
                },
                "liquidityType":{
                    "type":"string",
                    "description":"",
                    "maxLength":30
                }
            }
        }
    ]
}

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

Type: object

Show Source

• amendedStr(optional): string
• checkerDtStamp(optional): string
• customerId(optional): string
  Pattern: [a-zA-Z0-9]{1,20}
• effectiveDate(optional): string
• endDate(optional): string
• headerAccountCurrency(optional): string
  Maximum Length: 3
• headerAccountDescription(optional): string
  Maximum Length: 50
• headerAccountNumber(optional): string
  Maximum Length: 30
• headerBranchCode(optional): string
  Maximum Length: 4
• headerBranchName(optional): string
  Maximum Length: 50
• interestMethod(optional): string
  Maximum Length: 40
• isCrossBorder(optional): string
  Maximum Length: 1

  Pattern: [Y.N]
• isCrossCurrency(optional): string
  Maximum Length: 1

  Pattern: [Y.N]
• isMultiBank(optional): string
  Maximum Length: 1

  Pattern: [Y.N]
• liquidityType(optional): string
  Maximum Length: 30
• modNumber(optional): number
• newlyCreated(optional): string
• participatingAccountCount(optional): number
• reallocationMethod(optional): string
  Maximum Length: 50
• structureDescription(optional): string
  Maximum Length: 200
• structureDomain(optional): string
• structureId(optional): string
  Pattern: [A-Z0-9]{1,30}
• structureStatus(optional): string
  Maximum Length: 20
• structureType(optional): string
  Maximum Length: 20
• totalAmend(optional): string
• versionNo(optional): number

{
    "type":"object",
    "properties":{
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "effectiveDate":{
            "type":"string",
            "description":""
        },
        "endDate":{
            "type":"string",
            "description":""
        },
        "headerAccountCurrency":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "headerBranchCode":{
            "type":"string",
            "description":"",
            "maxLength":4
        },
        "headerAccountDescription":{
            "type":"string",
            "description":"",
            "maxLength":50
        },
        "headerAccountNumber":{
            "type":"string",
            "description":"",
            "maxLength":30
        },
        "headerBranchName":{
            "type":"string",
            "description":"",
            "maxLength":50
        },
        "structureType":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "isCrossBorder":{
            "type":"string",
            "description":"",
            "maxLength":1,
            "pattern":"[Y.N]"
        },
        "isCrossCurrency":{
            "type":"string",
            "description":"",
            "maxLength":1,
            "pattern":"[Y.N]"
        },
        "isMultiBank":{
            "type":"string",
            "description":"",
            "maxLength":1,
            "pattern":"[Y.N]"
        },
        "reallocationMethod":{
            "type":"string",
            "description":"",
            "maxLength":50
        },
        "interestMethod":{
            "type":"string",
            "description":"",
            "maxLength":40
        },
        "participatingAccountCount":{
            "type":"number",
            "description":""
        },
        "structureStatus":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "versionNo":{
            "type":"number",
            "description":""
        },
        "modNumber":{
            "type":"number",
            "description":""
        },
        "structureDomain":{
            "type":"string",
            "description":""
        },
        "structureDescription":{
            "type":"string",
            "description":"",
            "maxLength":200
        },
        "newlyCreated":{
            "type":"string",
            "description":""
        },
        "amendedStr":{
            "type":"string",
            "description":""
        },
        "totalAmend":{
            "type":"string",
            "description":""
        },
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "checkerDtStamp":{
            "type":"string",
            "description":""
        },
        "liquidityType":{
            "type":"string",
            "description":"",
            "maxLength":30
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created structuredetailsreport

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): object ResponseResourceSupport
• messages(optional): object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

• arg(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top