loan-campaigns
Operations addressed under /loan-campaigns — 4 operations.
aurax-bff-redirect-get-loan-campaign-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-loan-campaign-list; this entry declares none of its own.
Response body, read from the service source
The route declares its response as IEnumerable<LoanCampaignDto>.
| Field | Declared type | Nullable |
|---|---|---|
PartnerId | Guid | no |
LoanProductId | Guid | no |
BeginDate | DateOnly | no |
EndDate | DateOnly | no |
Amount | decimal | no |
Priority | int | no |
Name | string | no |
Description | string | no |
DelayMonth | int? | yes |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeaurax-bff-redirect-get-loan-campaign-list › Responses
Success. Returns a page of records: the collection under data, with total carrying the unpaged count.
Response records carried by this page.
totalTotal matching records, ignoring paging.
create-loan-campaign-bpm
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-bff-redirect-create-loan-campaign-bpm service definition through POST /loan-campaigns.
Request and response fields are declared on the routing target create-loan-campaign-bpm; this entry declares none of its own.
create-loan-campaign-bpm › Request Body
amountbeginDatedelayMonthdescriptionendDateloanProductIdnamepartnerIdprioritycreate-loan-campaign-bpm › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
idaurax-bff-redirect-get-loan-campaign-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-loan-campaign-by-id; this entry declares none of its own.
Response body, read from the service source
The route declares its response as LoanCampaignDto.
| Field | Declared type | Nullable |
|---|---|---|
PartnerId | Guid | no |
LoanProductId | Guid | no |
BeginDate | DateOnly | no |
EndDate | DateOnly | no |
Amount | decimal | no |
Priority | int | no |
Name | string | no |
Description | string | no |
DelayMonth | int? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_CAMPAIGN_1 | 400 | LOAN_CAMPAIGN_MUST_BE_NOT_NULL |
path Parameters
idaurax-bff-redirect-get-loan-campaign-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
edit-loan-campaign-bpm
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-bff-redirect-edit-loan-campaign-bpm service definition through PUT /loan-campaigns/{id}.
Request and response fields are declared on the routing target edit-loan-campaign-bpm; this entry declares none of its own.
path Parameters
idedit-loan-campaign-bpm › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.