Get component summaries for a collateral

GET

/api/apiGateway/getCollateralComponentSummary/{collateralId}

Get the component summaries for the provided collateral id.

Parameters

collateralId string

The unique identifier of the collateral that you want to retrieve component summaries for.

Response

Type: application/json

Schema: ComponentSummaryResponseDto

success boolean

Indicates whether the request completed successfully.

error ErrorDto

componentSummary array [ ComponentSummaryDto ]

HTTPcURL

GET ${BASE_URL}/api/apiGateway/getCollateralComponentSummary/0b6696e4-7c45-46c2-bb1f-d36d3ee93df7
Accept: */*
Authorization: Bearer eyJz93a...k4laUWw

curl --request GET \
    --url "${BASE_URL}/api/apiGateway/getCollateralComponentSummary/0b6696e4-7c45-46c2-bb1f-d36d3ee93df7" \
    --header 'Accept: */*' \
    --header 'Authorization: Bearer eyJz93a...k4laUWw'

Response

{
  "success": true,
  "error": {
    "target": "string",
    "code": "Duplicated",
    "message": "string",
    "details": ["string"]
  },
  "componentSummary": [
    {
      "id": "string",
      "collateralId": "string",
      "componentType": "Unknown",
      "assetType": "None",
      "leaseToPreLeaseRatio": 0,
      "totalUnits": 0,
      "totalSf": 0,
      "saleValue": 0,
      "totalMarketAnnualRevenue": 0,
      "totalConcludedRentAnnualRevenue": 0,
      "marketVacancy": 0,
      "selectedRentRollId": "string",
      "totalRentRollAnnualRevenue": 0,
      "rentRollVacancy": 0
    }
  ]
}