Endpoints¶
Update multiple deals¶
Update multiple properties of multiple deals.
PATCH /api/apiGateway/bulkUpdateDeals
Request¶
Body: UpdateDealsRequestDto
Response¶
UpdateDealsResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/bulkUpdateDeals
Create commercial deal¶
Create new commercial deal.
POST /api/apiGateway/CreateCommercialDeal
Request¶
Body: CreateCommercialDealDto
Response¶
CreateResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/CreateCommercialDeal
Create residential deal¶
Create new residential deal.
POST /api/apiGateway/CreateResidentialDeal
Request¶
Body: CreateResidentialDealDto
Response¶
CreateResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/CreateResidentialDeal
Create hotel deal¶
Create new hotel deal.
POST /api/apiGateway/CreateHotelDeal
Request¶
Body: CreateHotelDealDto
Response¶
CreateResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/CreateHotelDeal
Get deal info¶
Get info of a single deal.
GET /api/apiGateway/getDealInfo/{id}
Request¶
Path: String id
Response¶
SeedInfoResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/getDealInfo/{id}
Get Commercial Rentroll Info¶
Get the details of a single commercial rentroll, identified by its id
GET /api/apiGateway/getCommercialRentrollInfo/{id}
Request¶
Path: String id
Response¶
CommercialRentRollInfoResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/getCommercialRentrollInfo
Get All Deal Ids¶
Get list of all deal ids in the system
GET /api/apiGateway/getAllDealIds
Request¶
Response¶
DealIdsResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/getAllDealIds
Get Residential Component Info¶
Get the details of a single residential component, identified by its id
GET /api/apiGateway/getResidentialComponentInfo/{id}
Request¶
Path: String id
Response¶
ResidentialComponentInfoResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/getResidentialComponentInfo
Get Base Component Info¶
Get the generic details of a component, identified by its id, regardless of type
GET /api/apiGateway/getBaseComponentInfo/{id}
Request¶
Path: String id
Response¶
ComponentInfoResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/getBaseComponentInfo
Get Collateral Component Summary¶
Get summary of all components in a given collateral, identified by its id
GET /api/apiGateway/getCollateralComponentSummary/{collateralId}
Request¶
Path: String collateralId
Response¶
ComponentSummaryResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/getCollateralComponentSummary
Create Commercial Deal¶
Create commercial deal
POST /api/apiGateway/createCommercialDeal
Request¶
Body: CreateCommercialDealDto
Response¶
CreateResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/createCommercialDeal
Get Commercial Component Info¶
Get the details of a single commercial component, identified by its id
GET /api/apiGateway/getCommercialComponentInfo/{id}
Request¶
Path: String id
Response¶
CommercialComponentInfoResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/getCommercialComponentInfo
Get Company Info¶
Get the details of a single company, identified by its id
GET /api/apiGateway/getCompanyInfo/{id}
Request¶
Path: String id
Response¶
CompanyInfoResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/getCompanyInfo
Get Person Info¶
Get the details of a single person, identified by its id
GET /api/apiGateway/getPersonInfo/{id}
Request¶
Path: String id
Response¶
PersonInfoResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/getPersonInfo
Create Residential Deal¶
Create new residential deal
POST /api/apiGateway/createResidentialDeal
Request¶
Body: CreateResidentialDealDto
Response¶
CreateResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/createResidentialDeal
Get Hotel Component Info¶
Get the details of a single component of type hotel
GET /api/apiGateway/getHotelComponentInfo/{id}
Request¶
Path: String id
Response¶
HotelComponentInfoResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/getHotelComponentInfo
Get Deal Component Summary¶
Get summary of all components in all collaterals in a given deal, identified by its id
GET /api/apiGateway/getDealComponentSummary/{dealId}
Request¶
Path: String dealId
Response¶
ComponentSummaryResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/getDealComponentSummary
Get Deal Collateral Summary¶
Get summary of all collaterals in a given deal, identified by its id
GET /api/apiGateway/getDealCollateralSummary/{dealId}
Request¶
Path: String dealId
Response¶
CollateralSummaryResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/getDealCollateralSummary
Create Hotel Deal¶
Create new deal of type hotel
POST /api/apiGateway/createHotelDeal
Request¶
Body: CreateHotelDealDto
Response¶
CreateResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/createHotelDeal
Get Residential Rentroll Info¶
Get details of a single residential rentroll, identified by its id
GET /api/apiGateway/getResidentialRentrollInfo/{id}
Request¶
Path: String id
Response¶
ResidentialRentRollInfoResponseDto
Swagger Docs /api/apiGateway/swagger-ui/index.html#/getResidentialRentrollInfo