collateral-types
Operations addressed under /collateral-types — 9 operations.
get-collateral-type-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<CollateralTypeDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
Name | string | no |
MainType | int? | yes |
Type | int? | yes |
IsActive | bool? | yes |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-collateral-type-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
create-collateral-type
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 | Message |
|---|---|---|---|
ERR_CLLTRL_1 | 400 | DEFINITION_ALREADY_REGISTERED | There is a definition with the same code: {0} |
create-collateral-type › Request Body
codemainTypePermitted values — validated against the collateral_main_type parameter.
| Value | Meaning |
|---|---|
1 | Cash |
2 | Noncash |
Permitted values — validated against the collateral_main_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Cash | en: Cash · tr: Nakdi · ar: نقد |
2 | Noncash | en: Noncash · tr: Gayrinakdi · ar: غير نقدي |
nametypePermitted values — validated against the collateral_type parameter.
| Value | Meaning |
|---|---|
1 | Car |
2 | House |
3 | Corporate |
Permitted values — validated against the collateral_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Car | en: Car · tr: Araç · ar: سيارة |
2 | House | en: House · tr: Konut · ar: بيت |
3 | Corporate | ar: شركة |
create-collateral-type › 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.
update-collateral-type
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_CLLTRL_2 | 400 | COLLATERAL_TYPE_NOT_FOUND | Collateral type cannot be found.: {0} |
path Parameters
idupdate-collateral-type › Request Body
isActivemainTypePermitted values — validated against the collateral_main_type parameter.
| Value | Meaning |
|---|---|
1 | Cash |
2 | Noncash |
Permitted values — validated against the collateral_main_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Cash | en: Cash · tr: Nakdi · ar: نقد |
2 | Noncash | en: Noncash · tr: Gayrinakdi · ar: غير نقدي |
nametypePermitted values — validated against the collateral_type parameter.
| Value | Meaning |
|---|---|
1 | Car |
2 | House |
3 | Corporate |
Permitted values — validated against the collateral_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Car | en: Car · tr: Araç · ar: سيارة |
2 | House | en: House · tr: Konut · ar: بيت |
3 | Corporate | ar: شركة |
update-collateral-type › 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-collateral-type
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_CLLTRL_2 | 400 | COLLATERAL_TYPE_NOT_FOUND | Collateral type cannot be found.: {0} |
ERR_CLLTRL_3 | 400 | DEFINITION_ALREADY_REGISTERED_FOR_CUSTOMER_COLLATERAL | This definition was used in customer collateral, it cannot be deleted. |
path Parameters
iddelete-collateral-type › 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.
get-collateral-type-details-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 CollateralTypeDetailsDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
Name | string | no |
MainType | int? | yes |
Type | int? | yes |
IsActive | bool? | yes |
Fields | List<CollateralFieldDetailsDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CLLTRL_2 | 400 | COLLATERAL_TYPE_NOT_FOUND | Collateral type cannot be found.: {0} |
path Parameters
idget-collateral-type-details-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-collateral-field-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<CollateralFieldDetailsDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Name | string | no |
IsMandatory | bool? | yes |
DataType | int? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CLLTRL_2 | 400 | COLLATERAL_TYPE_NOT_FOUND | Collateral type cannot be found.: {0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-collateral-field-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
create-collateral-type-field
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 | Message |
|---|---|---|---|
ERR_CLLTRL_2 | 400 | COLLATERAL_TYPE_NOT_FOUND | Collateral type cannot be found.: {0} |
ERR_CLLTRL_4 | 400 | FIELD_EXISTS_WITH_SAME_NAME | There is a field with the same name: {0} |
path Parameters
idcreate-collateral-type-field › Request Body
dataTypePermitted values — validated against the field_data_type parameter.
| Value | Meaning |
|---|---|
1 | string |
2 | date |
3 | integer |
4 | decimal |
Permitted values — validated against the field_data_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | string | en: string · tr: string · ar: سلسلة |
2 | date | en: date · tr: tarih · ar: تاريخ |
3 | integer | en: integer · tr: tam sayı · ar: عدد صحيح |
4 | decimal | en: decimal · tr: ondalıklı sayı · ar: عدد صحيح |
isMandatorynamecreate-collateral-type-field › 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.
update-collateral-type-field
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_CLLTRL_2 | 400 | COLLATERAL_TYPE_NOT_FOUND | Collateral type cannot be found.: {0} |
ERR_CLLTRL_4 | 400 | FIELD_EXISTS_WITH_SAME_NAME | There is a field with the same name: {0} |
ERR_CLLTRL_5 | 400 | FIELD_NOT_FOUND | Field cannot be found.: {0} |
path Parameters
idfieldIdupdate-collateral-type-field › Request Body
dataTypePermitted values — validated against the field_data_type parameter.
| Value | Meaning |
|---|---|
1 | string |
2 | date |
3 | integer |
4 | decimal |
Permitted values — validated against the field_data_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | string | en: string · tr: string · ar: سلسلة |
2 | date | en: date · tr: tarih · ar: تاريخ |
3 | integer | en: integer · tr: tam sayı · ar: عدد صحيح |
4 | decimal | en: decimal · tr: ondalıklı sayı · ar: عدد صحيح |
isMandatorynameupdate-collateral-type-field › 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-collateral-type-field
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_CLLTRL_2 | 400 | COLLATERAL_TYPE_NOT_FOUND | Collateral type cannot be found.: {0} |
ERR_CLLTRL_5 | 400 | FIELD_NOT_FOUND | Field cannot be found.: {0} |
ERR_CLLTRL_6 | 400 | FIELD_ALREADY_REGISTERED_FOR_CUSTOMER_COLLATERAL | This field was used in customer collateral, it cannot be deleted. |
path Parameters
idfieldIddelete-collateral-type-field › 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.