queries
Operations addressed under /queries — 3 operations.
get-allotment-query-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<AllotmentQueryDto>.
| Field | Declared type | Nullable |
|---|---|---|
CustomerId | Guid? | yes |
QueryDate | DateTime? | yes |
AllotmentAssignmentId | Guid | no |
AllotmentAssignmentProductId | Guid | no |
AllotmentProductId | Guid | no |
AllotmentAmount | decimal? | yes |
CurrencyNumber | string | no |
ProductAllotmentAmount | decimal? | yes |
CustomerRiskId | Guid? | yes |
AvailableAmount | decimal? | yes |
ProductCollaterals | List<AllotmentQueryCollateralDto> (collection) | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-allotment-query-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.
allotmentAmountallotmentAssignmentIdallotmentAssignmentProductIdallotmentProductIdavailableAmountcurrencyNumbercustomerIdcustomerRiskIdidproductAllotmentAmountqueryDatecreate-allotment-query
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_CORE_11 | 400 | CURRENCY_NUMBER_IS_NOT_VALID |
create-allotment-query › Request Body
allotmentAmountallotmentAssignmentIdavailableAmountcurrencyNumbercustomerIdcustomerRiskIdqueryDateallotmentAssignmentProductIdallotmentProductIdproductAllotmentAmountcreate-allotment-query › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
idget-allotment-query-by-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 AllotmentQueryDto.
| Field | Declared type | Nullable |
|---|---|---|
CustomerId | Guid? | yes |
QueryDate | DateTime? | yes |
AllotmentAssignmentId | Guid | no |
AllotmentAssignmentProductId | Guid | no |
AllotmentProductId | Guid | no |
AllotmentAmount | decimal? | yes |
CurrencyNumber | string | no |
ProductAllotmentAmount | decimal? | yes |
CustomerRiskId | Guid? | yes |
AvailableAmount | decimal? | yes |
ProductCollaterals | List<AllotmentQueryCollateralDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ALLTMNT_29 | 400 | ALLOTMENT_QUERY_IS_NOT_FOUND_WITH_THE_GIVEN_ID | Allotment query is cannot be found with the given:{0}. |
path Parameters
idget-allotment-query-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
allotmentAmountallotmentAssignmentIdallotmentAssignmentProductIdallotmentProductIdavailableAmountcurrencyNumbercustomerIdcustomerRiskIdidproductAllotmentAmountqueryDate