term-details
Operations addressed under /term-details — 12 operations.
get-term-detail-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
query Parameters
orderByorderSortpageIndexpageSizeget-term-detail-list › 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 |
acceptanceStatusaccountingBusinessKeyavalStatuschequeNumberexportDocumentIdgroupGuididimportDocumentIdmaturityAmountmaturityDueDatematurityInstrumentTypematurityInstrumentTypeNamematurityPaymentConditionmaturityPaymentConditionDaymaturityStartingDatepolicyCorrespondentReturnDatepolicyCustomerReturnDatepolicyDeliveryDatepolicyHolderOfDraftpolicyProtestTypepolicyProtestTypeNamepolicyReturnDatepolicyStatusOfDraftreferencestatustermIndextermReturnDescriptiontoTheOrderOfPolicycreate-term-detail
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.
create-term-detail › Request Body
acceptanceStatusaccountingBusinessKeyavalStatuschequeNumberexportDocumentIdgroupGuidimportDocumentIdmaturityAmountmaturityDueDatematurityInstrumentTypematurityInstrumentTypeNamematurityPaymentConditionmaturityPaymentConditionDaymaturityStartingDatepolicyCorrespondentReturnDatepolicyCustomerReturnDatepolicyDeliveryDatepolicyHolderOfDraftpolicyProtestTypepolicyProtestTypeNamepolicyReturnDatepolicyStatusOfDraftreferencestatustermIndextermReturnDescriptiontoTheOrderOfPolicycreate-term-detail › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
get-term-detail-by-id
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 |
|---|---|---|
ERR_FRGN_TRD_41 | 400 | TERM_DETAIL_NOT_FOUND |
path Parameters
idget-term-detail-by-id › 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 |
acceptanceStatusaccountingBusinessKeyavalStatuschequeNumberexportDocumentIdgroupGuididimportDocumentIdmaturityAmountmaturityDueDatematurityInstrumentTypematurityInstrumentTypeNamematurityPaymentConditionmaturityPaymentConditionDaymaturityStartingDatepolicyCorrespondentReturnDatepolicyCustomerReturnDatepolicyDeliveryDatepolicyHolderOfDraftpolicyProtestTypepolicyProtestTypeNamepolicyReturnDatepolicyStatusOfDraftreferencestatustermIndextermReturnDescriptiontoTheOrderOfPolicyupdate-term-detail
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 |
|---|---|---|
ERR_FRGN_TRD_41 | 400 | TERM_DETAIL_NOT_FOUND |
path Parameters
idupdate-term-detail › Request Body optional
acceptanceStatusaccountingBusinessKeyavalStatuschequeNumberexportDocumentIdgroupGuidimportDocumentIdmaturityAmountmaturityDueDatematurityInstrumentTypematurityInstrumentTypeNamematurityPaymentConditionmaturityPaymentConditionDaymaturityStartingDatepolicyCorrespondentReturnDatepolicyCustomerReturnDatepolicyDeliveryDatepolicyHolderOfDraftpolicyProtestTypepolicyProtestTypeNamepolicyReturnDatepolicyStatusOfDraftreferencestatustermIndextermReturnDescriptiontoTheOrderOfPolicyupdate-term-detail › 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.
delete-term-detail
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_FRGN_TRD_41 | 400 | TERM_DETAIL_NOT_FOUND |
path Parameters
iddelete-term-detail › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
set-export-cancelled
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_FRGN_TRD_41 | 400 | TERM_DETAIL_NOT_FOUND |
path Parameters
idset-export-cancelled › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
set-export-feedback
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_FRGN_TRD_41 | 400 | TERM_DETAIL_NOT_FOUND |
path Parameters
idset-export-feedback › Request Body
policyCustomerReturnDatepolicyHolderOfDraftpolicyStatusOfDrafttermReturnDescriptionset-export-feedback › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
set-export-return
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_FRGN_TRD_41 | 400 | TERM_DETAIL_NOT_FOUND |
path Parameters
idset-export-return › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
set-import-cancelled
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_FRGN_TRD_41 | 400 | TERM_DETAIL_NOT_FOUND |
path Parameters
idset-import-cancelled › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
set-import-feedback
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_FRGN_TRD_41 | 400 | TERM_DETAIL_NOT_FOUND |
path Parameters
idset-import-feedback › Request Body
policyHolderOfDraftpolicyReturnDatepolicyStatusOfDraftset-import-feedback › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
set-import-free-of-payment
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_FRGN_TRD_41 | 400 | TERM_DETAIL_NOT_FOUND |
path Parameters
idset-import-free-of-payment › Request Body
policyHolderOfDraftpolicyReturnDateset-import-free-of-payment › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
set-import-return
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_FRGN_TRD_41 | 400 | TERM_DETAIL_NOT_FOUND |
path Parameters
idset-import-return › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.