loans--collateral-usages
Operations addressed under /loans — 79 operations.
Rendered section: This page contains the collateral-usages route group from loans. This is a presentation-only partition; it does not change the API contract or operation tags in the downloadable OpenAPI.
get-loan-collateral-usage-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<LoanCollateralUsageDto>.
| Field | Declared type | Nullable |
|---|---|---|
LoanId | Guid | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-loan-collateral-usage-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
collateralUsageIdidloanIdget-loan-collateral-usage-list-by-loan-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<LoanCollateralUsageBaseDto>.
| Field | Declared type | Nullable |
|---|---|---|
CollateralUsageId | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-loan-collateral-usage-list-by-loan-id › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
collateralUsageIdidcreate-loan-collateral-usage
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL | not published in this snapshot |
ERR_LOAN_36 | 400 | LOAN_USAGE_ALREADY_EXISTS | This collateral usage was associated with a loan. Loan:{0}, Collatera ln Usage:{1} |
path Parameters
idcreate-loan-collateral-usage › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.