Jump to

• Request
• Response

Updates the Commercial Construction Loan of the loan origination/restructuring application

post

/loanapplication-services/service/api/v1/commercialconstructionloan/{applicationNumber}

This operation updates the given applicant details of the loan origination/restructuring application of the given application number using LoanOriginationApplication Service.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• applicationNumber: string
  applicationNumber of the Loan origination/restructuring applicantion

Body ()

Request Body containing the Commercial Construction Loan of the application number

Root Schema : CommercialConstructionLoanModel

Type: object

CommercialConstructionLoan model

Match All

Show Source

• allOf GenericDatasegmentModel
• object CommercialConstructionLoanModel-allOf[1]

{
    "description":"CommercialConstructionLoan model",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDatasegmentModel"
        },
        {
            "type":"object",
            "properties":{
                "commercialPropertyDetails":{
                    "description":"Details of the Commercial Property",
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/CommercialPropertyDetailsModel"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDatasegmentModel

Match All

Show Source

• object GenericDatasegmentModel-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDatasegmentModel-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : CommercialConstructionLoanModel-allOf[1]

Type: object

Show Source

• commercialPropertyDetails(optional): array commercialPropertyDetails
  Details of the Commercial Property

{
    "type":"object",
    "properties":{
        "commercialPropertyDetails":{
            "description":"Details of the Commercial Property",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CommercialPropertyDetailsModel"
            }
        }
    }
}

Nested Schema : commercialPropertyDetails

Type: array

Details of the Commercial Property

Show Source

• Array of: object CommercialPropertyDetailsModel
  CommercialPropertyDetails model

{
    "description":"Details of the Commercial Property",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CommercialPropertyDetailsModel"
    }
}

Nested Schema : CommercialPropertyDetailsModel

Type: object

CommercialPropertyDetails model

Show Source

• addressLine1: string
  Maximum Length: 105

  addressLine1 of the Details model
• addressLine2: string
  Maximum Length: 105

  addressLine2 of the Details model
• addressLine3(optional): string
  Maximum Length: 105

  addressLine3 of the Details model
• addressLine4(optional): string
  Maximum Length: 105

  addressLine4 of the Details model
• city(optional): string
  Maximum Length: 22

  city of the Details model
• commercialDocumentDetails(optional): array commercialDocumentDetails
• commercialLoanId(optional): string
  Maximum Length: 36

  commercialLoanId of the Details model
• commercialRegulatorDetails(optional): array commercialRegulatorDetails
• commercialSpecialZoneDetails(optional): array commercialSpecialZoneDetails
• commercialSupplierDetails(optional): array commercialSupplierDetails
• constructionCost(optional): integer(int64)
  constructionCost of the Details model
• constructionCostCurrency(optional): string
  Maximum Length: 3

  construction cost currency of the Details model
• constructionStartDate(optional): string
  constructionStartDate of the Details model
• country(optional): string
  Maximum Length: 3

  country of the Details model
• expectedEndDate(optional): string
  expectedEndDate of the Details model
• id(optional): string(int64)
  Maximum Length: 36

  Id of the Banking details model
• leaseEffectiveDate(optional): string
  leaseEffectiveDate of the Details model
• leaseExpiryDate(optional): string
  leaseExpiryDate of the Details model
• lessor(optional): string
  Maximum Length: 105

  lessor of the Details model
• propertyDescription: string
  Maximum Length: 2000

  propertyDescription of the Details model
• propertyTitleHolder(optional): string
  Allowed Values: [ "FREEHOLD", "THIRDPARTY", "LEASEHOLD" ]

  Party model
• propertyType: string
  Maximum Length: 35

  propertyType of the Details model
• regulatorApproval(optional): string
  regulatorApproval of the Details model
• specialZone(optional): string
  specialZone of the Details model
• state(optional): string
  Maximum Length: 22

  state of the Details model
• thirdPartyLocation(optional): string
  Maximum Length: 50

  thirdPartyLocation of the Details model
• thirdPartyName(optional): string
  Maximum Length: 50

  thirdPartyName of the Details model
• totalConstructionArea(optional): integer(int64)
  totalConstructionArea of the Details model
• unit(optional): string
  Maximum Length: 20

  unit of the Details model
• zipCode(optional): string
  Maximum Length: 8

  zipCode of the Details model

{
    "description":"CommercialPropertyDetails model",
    "type":"object",
    "required":[
        "propertyType",
        "propertyDescription",
        "addressLine1",
        "addressLine2"
    ],
    "properties":{
        "id":{
            "description":"Id of the Banking details model",
            "type":"string",
            "format":"int64",
            "maxLength":36
        },
        "commercialLoanId":{
            "description":"commercialLoanId of the Details model",
            "type":"string",
            "maxLength":36
        },
        "propertyType":{
            "description":"propertyType of the Details model",
            "type":"string",
            "maxLength":35
        },
        "propertyDescription":{
            "description":"propertyDescription of the Details model",
            "type":"string",
            "maxLength":2000
        },
        "addressLine1":{
            "description":"addressLine1 of the Details model",
            "type":"string",
            "maxLength":105
        },
        "addressLine2":{
            "description":"addressLine2 of the Details model",
            "type":"string",
            "maxLength":105
        },
        "addressLine3":{
            "description":"addressLine3 of the Details model",
            "type":"string",
            "maxLength":105
        },
        "addressLine4":{
            "description":"addressLine4 of the Details model",
            "type":"string",
            "maxLength":105
        },
        "city":{
            "description":"city of the Details model",
            "type":"string",
            "maxLength":22
        },
        "state":{
            "description":"state of the Details model",
            "type":"string",
            "maxLength":22
        },
        "country":{
            "description":"country of the Details model",
            "type":"string",
            "maxLength":3
        },
        "constructionCostCurrency":{
            "description":"construction cost currency of the Details model",
            "type":"string",
            "maxLength":3
        },
        "zipCode":{
            "description":"zipCode of the Details model",
            "type":"string",
            "maxLength":8
        },
        "unit":{
            "description":"unit of the Details model",
            "type":"string",
            "maxLength":20
        },
        "lessor":{
            "description":"lessor of the Details model",
            "type":"string",
            "maxLength":105
        },
        "regulatorApproval":{
            "description":"regulatorApproval of the Details model",
            "type":"string"
        },
        "specialZone":{
            "description":"specialZone of the Details model",
            "type":"string"
        },
        "thirdPartyName":{
            "description":"thirdPartyName of the Details model",
            "type":"string",
            "maxLength":50
        },
        "thirdPartyLocation":{
            "description":"thirdPartyLocation of the Details model",
            "type":"string",
            "maxLength":50
        },
        "propertyTitleHolder":{
            "description":"propertyTitleHolder of the Details model",
            "$ref":"#/definitions/PropertyHoldingType"
        },
        "constructionStartDate":{
            "description":"constructionStartDate of the Details model",
            "type":"string"
        },
        "expectedEndDate":{
            "description":"expectedEndDate of the Details model",
            "type":"string"
        },
        "leaseEffectiveDate":{
            "description":"leaseEffectiveDate of the Details model",
            "type":"string"
        },
        "leaseExpiryDate":{
            "description":"leaseExpiryDate of the Details model",
            "type":"string"
        },
        "totalConstructionArea":{
            "description":"totalConstructionArea of the Details model",
            "type":"integer",
            "format":"int64"
        },
        "constructionCost":{
            "description":"constructionCost of the Details model",
            "type":"integer",
            "format":"int64"
        },
        "commercialRegulatorDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CommercialRegulatorDetailsModel"
            }
        },
        "commercialSpecialZoneDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CommercialSpecialZoneDetailsModel"
            }
        },
        "commercialSupplierDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CommercialSupplierDetailsModel"
            }
        },
        "commercialDocumentDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DocumentLinkageModel"
            }
        }
    }
}

Nested Schema : commercialDocumentDetails

Type: array

Show Source

• Array of: object DocumentLinkageModel
  DocumentLinkageModel

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

Nested Schema : commercialRegulatorDetails

Type: array

Show Source

• Array of: object CommercialRegulatorDetailsModel
  CommercialRegulatorDetails model

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

Nested Schema : commercialSpecialZoneDetails

Type: array

Show Source

• Array of: object CommercialSpecialZoneDetailsModel
  CommercialSpecialZoneDetails model

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

Nested Schema : commercialSupplierDetails

Type: array

Show Source

• Array of: object CommercialSupplierDetailsModel
  CommercialSupplierDetailsModel model

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

Nested Schema : DocumentLinkageModel

Type: object

DocumentLinkageModel

Show Source

• documentLinkageId(optional): string
  Maximum Length: 36

  documentLinkageId
• documentName(optional): string
  Maximum Length: 105

  documentName
• documentType(optional): string
  Maximum Length: 50

  documentType
• id(optional): string
  Maximum Length: 36

  Id
• parentDatasegmentId(optional): string
  Maximum Length: 36

  parentDatasegmentId

{
    "description":"DocumentLinkageModel",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id",
            "type":"string",
            "maxLength":36
        },
        "parentDatasegmentId":{
            "description":"parentDatasegmentId",
            "type":"string",
            "maxLength":36
        },
        "documentLinkageId":{
            "description":"documentLinkageId",
            "type":"string",
            "maxLength":36
        },
        "documentName":{
            "description":"documentName",
            "type":"string",
            "maxLength":105
        },
        "documentType":{
            "description":"documentType",
            "type":"string",
            "maxLength":50
        }
    }
}

Nested Schema : CommercialRegulatorDetailsModel

Type: object

CommercialRegulatorDetails model

Show Source

• authorityDescription(optional): string
  Maximum Length: 105

  authorityDescription of the CommercialRegulatorDetailsModel
• commercialPropertyId(optional): string
  Maximum Length: 36

  commercialPropertyId of CommercialRegulatorDetailsModel
• id(optional): string
  Maximum Length: 36

  Id of the CommercialRegulatorDetails
• regulatingAuthority(optional): string
  Maximum Length: 50

  regulatingAuthority of the CommercialRegulatorDetailsModel

{
    "description":"CommercialRegulatorDetails model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the CommercialRegulatorDetails",
            "type":"string",
            "maxLength":36
        },
        "regulatingAuthority":{
            "description":"regulatingAuthority of the CommercialRegulatorDetailsModel",
            "type":"string",
            "maxLength":50
        },
        "authorityDescription":{
            "description":"authorityDescription of the CommercialRegulatorDetailsModel",
            "type":"string",
            "maxLength":105
        },
        "commercialPropertyId":{
            "description":"commercialPropertyId of CommercialRegulatorDetailsModel",
            "type":"string",
            "maxLength":36
        }
    }
}

Nested Schema : CommercialSpecialZoneDetailsModel

Type: object

CommercialSpecialZoneDetails model

Show Source

• commercialPropertyId(optional): string
  Maximum Length: 36

  commercialPropertyId of CommercialSpecialZoneDetails
• id(optional): string
  Maximum Length: 36

  Id of the CommercialSpecialZoneDetails
• zoneDescription(optional): string
  Maximum Length: 105

  zoneDescription of the CommercialSpecialZoneDetails
• zoneType(optional): string
  Maximum Length: 50

  zoneType of the CommercialSpecialZoneDetails

{
    "description":"CommercialSpecialZoneDetails model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the CommercialSpecialZoneDetails",
            "type":"string",
            "maxLength":36
        },
        "zoneType":{
            "description":"zoneType of the CommercialSpecialZoneDetails",
            "type":"string",
            "maxLength":50
        },
        "zoneDescription":{
            "description":"zoneDescription of the CommercialSpecialZoneDetails",
            "type":"string",
            "maxLength":105
        },
        "commercialPropertyId":{
            "description":"commercialPropertyId of CommercialSpecialZoneDetails",
            "type":"string",
            "maxLength":36
        }
    }
}

Nested Schema : CommercialSupplierDetailsModel

Type: object

CommercialSupplierDetailsModel model

Show Source

• commercialPropertyId(optional): string
  Maximum Length: 36

  commercialPropertyId of CommercialSupplierDetailsModel
• id(optional): string
  Maximum Length: 36

  Id of the CommercialSupplierDetailsModel
• supplierLocation(optional): string
  Maximum Length: 105

  supplierLocation of the CommercialSupplierDetailsModel
• supplierName(optional): string
  Maximum Length: 36

  supplierName of the CommercialSupplierDetailsModel

{
    "description":"CommercialSupplierDetailsModel model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the CommercialSupplierDetailsModel",
            "type":"string",
            "maxLength":36
        },
        "supplierName":{
            "description":"supplierName of the CommercialSupplierDetailsModel",
            "type":"string",
            "maxLength":36
        },
        "supplierLocation":{
            "description":"supplierLocation of the CommercialSupplierDetailsModel",
            "type":"string",
            "maxLength":105
        },
        "commercialPropertyId":{
            "description":"commercialPropertyId of CommercialSupplierDetailsModel",
            "type":"string",
            "maxLength":36
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns updated CommercialConstructionLoan

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

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

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

Nested Schema : ResponseResourceSupport

Match All

Show Source

• object ResponseResourceSupport-allOf[0]
  Discriminator: resouce_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resouce_type"
        }
    ]
}

Nested Schema : ResponseDto

Type: object

ResponseDto model

Show Source

• codes(optional): string
  Codes
• httpStatusCode(optional): array httpStatusCode
  Schedule Details
• keyId(optional): string
  KeyId
• overrideAuthLevelsReqd(optional): string
  OverrideAuthLevelsReqd
• requestId(optional): string
  RequestId
• status(optional): string
  Status

{
    "description":"ResponseDto model",
    "properties":{
        "keyId":{
            "description":"KeyId",
            "type":"string"
        },
        "status":{
            "description":"Status",
            "type":"string"
        },
        "codes":{
            "description":"Codes",
            "type":"string"
        },
        "httpStatusCode":{
            "type":"array",
            "description":"Schedule Details",
            "items":{
                "$ref":"#/definitions/responseCodes"
            }
        },
        "overrideAuthLevelsReqd":{
            "description":"OverrideAuthLevelsReqd",
            "type":"string"
        },
        "requestId":{
            "description":"RequestId",
            "type":"string"
        }
    }
}

Nested Schema : ResponseResourceSupport-allOf[0]

Type: object

Discriminator: resouce_type

Nested Schema : httpStatusCode

Type: array

Schedule Details

Show Source

• Array of: object responseCodes
  ResponseCodes

{
    "type":"array",
    "description":"Schedule Details",
    "items":{
        "$ref":"#/definitions/responseCodes"
    }
}

Nested Schema : responseCodes

Type: object

ResponseCodes

Show Source

• code(optional): string
  Code
• desc(optional): string
  Description
• error(optional): string
  Error
• info(optional): string
  Info
• language(optional): string
  Language
• override(optional): string
  Override
• type(optional): string
  Type

{
    "description":"ResponseCodes",
    "type":"object",
    "properties":{
        "code":{
            "description":"Code",
            "type":"string"
        },
        "desc":{
            "description":"Description",
            "type":"string"
        },
        "type":{
            "description":"Type",
            "type":"string"
        },
        "language":{
            "description":"Language",
            "type":"string"
        },
        "error":{
            "description":"Error",
            "type":"string"
        },
        "override":{
            "description":"Override",
            "type":"string"
        },
        "info":{
            "description":"Info",
            "type":"string"
        }
    }
}

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