follow-types
Operations addressed under /follow-types — 14 operations.
get-follow-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<FollowTypeDto>.
| Field | Declared type | Nullable |
|---|---|---|
FollowType | int | no |
Name | string | no |
Description | string | no |
MinDayOfDelay | int? | yes |
MaxDayOfDelay | int? | yes |
IsClosedCollection | bool | no |
CustomerType | int | no |
IsActive | bool | no |
FollowTypeCode | int | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-follow-type-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.
customerTypePermitted values — validated against the customer_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Individual | en: Individual · tr: Bireysel · ar: فرد |
2 | Corporate | en: Corporate · tr: Kurumsal · ar: شركة |
descriptionfollowTypePermitted values — validated against the follow_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Customer | en: Customer · tr: Müşteri · ar: عميل |
2 | Loan | en: Loan · tr: Kredi · ar: قرض |
followTypeCodeidisActiveisClosedCollectionmaxDayOfDelayminDayOfDelaynamecreate-follow-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 declares its response as AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LGLFLLW_1 | 400 | DEFINITION_ALREADY_REGISTERED | There is a follow definition with the same code. Code:{0} |
ERR_LGLFLLW_2 | 400 | MINDAYOFDELAY_CONTROL | The minimum number of days of delay cannot be less than the maximum number of days of delay in a different tracking state, and cannot be greater than the minimum number of days of delay.Follow Code:{0} |
ERR_LGLFLLW_3 | 400 | MINDAYOFDELAY_GREATER_THAN_MAXDAYOFDELAY | min Day Of Delay must be less than max Day Of Delay. |
create-follow-type › Request Body
customerTypePermitted values — validated against the customer_type parameter.
| Value | Meaning |
|---|---|
1 | Individual |
2 | Corporate |
Permitted values — validated against the customer_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Individual | en: Individual · tr: Bireysel · ar: فرد |
2 | Corporate | en: Corporate · tr: Kurumsal · ar: شركة |
followTypePermitted values — validated against the follow_type parameter.
| Value | Meaning |
|---|---|
1 | Customer |
2 | Loan |
Permitted values — validated against the follow_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Customer | en: Customer · tr: Müşteri · ar: عميل |
2 | Loan | en: Loan · tr: Kredi · ar: قرض |
followTypeCodeisClosedCollectionmaxDayOfDelayminDayOfDelaynamedescriptioncreate-follow-type › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-follow-type-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 FollowTypeDto.
| Field | Declared type | Nullable |
|---|---|---|
FollowType | int | no |
Name | string | no |
Description | string | no |
MinDayOfDelay | int? | yes |
MaxDayOfDelay | int? | yes |
IsClosedCollection | bool | no |
CustomerType | int | no |
IsActive | bool | no |
FollowTypeCode | int | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LGLFLLW_4 | 400 | FOLLOWTYPE_NOT_FOUND | Follow Type cannot be found. :{0} |
path Parameters
idget-follow-type-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
update-follow-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_LGLFLLW_2 | 400 | MINDAYOFDELAY_CONTROL | The minimum number of days of delay cannot be less than the maximum number of days of delay in a different tracking state, and cannot be greater than the minimum number of days of delay.Follow Code:{0} |
ERR_LGLFLLW_3 | 400 | MINDAYOFDELAY_GREATER_THAN_MAXDAYOFDELAY | min Day Of Delay must be less than max Day Of Delay. |
ERR_LGLFLLW_4 | 400 | FOLLOWTYPE_NOT_FOUND | Follow Type cannot be found. :{0} |
path Parameters
idupdate-follow-type › Request Body
customerTypePermitted values — validated against the customer_type parameter.
| Value | Meaning |
|---|---|
1 | Individual |
2 | Corporate |
Permitted values — validated against the customer_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Individual | en: Individual · tr: Bireysel · ar: فرد |
2 | Corporate | en: Corporate · tr: Kurumsal · ar: شركة |
followTypePermitted values — validated against the follow_type parameter.
| Value | Meaning |
|---|---|
1 | Customer |
2 | Loan |
Permitted values — validated against the follow_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Customer | en: Customer · tr: Müşteri · ar: عميل |
2 | Loan | en: Loan · tr: Kredi · ar: قرض |
isClosedCollectionmaxDayOfDelayminDayOfDelaynamedescriptionupdate-follow-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.
update-follow-type-active
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_LGLFLLW_4 | 400 | FOLLOWTYPE_NOT_FOUND | Follow Type cannot be found. :{0} |
ERR_LGLFLLW_5 | 400 | MINDAYOFDELAY_CONTROL_ACTIVATED_FOLLOW_TYPE | It cannot be activated because it includes minDayOfDelay - maxDayOfDelayy with different active Follow Type.:{0} |
path Parameters
idupdate-follow-type-active › 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-follow-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 FollowTypeDetailDto.
| Field | Declared type | Nullable |
|---|---|---|
Provisions | List<FollowTypeProvisionDto> (collection) | no |
Notifications | List<FollowTypeNotificationDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LGLFLLW_4 | 400 | FOLLOWTYPE_NOT_FOUND | Follow Type cannot be found. :{0} |
path Parameters
idget-follow-type-details-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.
customerTypePermitted values — validated against the customer_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Individual | en: Individual · tr: Bireysel · ar: فرد |
2 | Corporate | en: Corporate · tr: Kurumsal · ar: شركة |
descriptionfollowTypePermitted values — validated against the follow_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Customer | en: Customer · tr: Müşteri · ar: عميل |
2 | Loan | en: Loan · tr: Kredi · ar: قرض |
followTypeCodeidisActiveisClosedCollectionmaxDayOfDelayminDayOfDelaynameget-follow-type-notification-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<FollowTypeNotificationDto>.
| Field | Declared type | Nullable |
|---|---|---|
NotificationType | int | no |
Period | int | no |
RepeatCount | int? | yes |
TemplateId | Guid? | yes |
DelayDayCount | int? | yes |
IsActive | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LGLFLLW_4 | 400 | FOLLOWTYPE_NOT_FOUND | Follow Type cannot be found. :{0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-follow-type-notification-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.
delayDayCountidisActivenotificationTypePermitted values — validated against the notification_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | SMS | en: SMS · tr: SMS · ar: رسالة قصيرة |
2 | CALL | en: CALL · tr: Arama · ar: مكالمة |
3 | DUNNINGLETTER | en: DUNNINGLETTER · tr: İhtarname · ar: خطاب التنبيه |
periodPermitted values — validated against the notification_period parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | DAILY | en: DAILY · tr: Günlük · ar: يومي |
2 | WEEKLY | en: WEEKLY · tr: Haftalık · ar: أسبوعي |
repeatCounttemplateIdcreate-follow-type-notification
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 AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LGLFLLW_4 | 400 | FOLLOWTYPE_NOT_FOUND | Follow Type cannot be found. :{0} |
path Parameters
idcreate-follow-type-notification › Request Body
minDelayDayCountnotificationTypePermitted values — validated against the notification_type parameter.
| Value | Meaning |
|---|---|
1 | SMS |
2 | CALL |
3 | DUNNINGLETTER |
Permitted values — validated against the notification_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | SMS | en: SMS · tr: SMS · ar: رسالة قصيرة |
2 | CALL | en: CALL · tr: Arama · ar: مكالمة |
3 | DUNNINGLETTER | en: DUNNINGLETTER · tr: İhtarname · ar: خطاب التنبيه |
periodPermitted values — validated against the notification_period parameter.
| Value | Meaning |
|---|---|
1 | DAILY |
2 | WEEKLY |
Permitted values — validated against the notification_period parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | DAILY | en: DAILY · tr: Günlük · ar: يومي |
2 | WEEKLY | en: WEEKLY · tr: Haftalık · ar: أسبوعي |
repeatCounttemplateIdcreate-follow-type-notification › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
update-follow-type-notification
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_LGLFLLW_4 | 400 | FOLLOWTYPE_NOT_FOUND | Follow Type cannot be found. :{0} |
ERR_LGLFLLW_8 | 400 | FOLLOWTYPE_NOTIFICATION_NOT_FOUND | Follow Type - information cannot be found. Notification:{0} |
path Parameters
idnotificationIdupdate-follow-type-notification › Request Body
minDelayDayCountnotificationTypePermitted values — validated against the notification_type parameter.
| Value | Meaning |
|---|---|
1 | SMS |
2 | CALL |
3 | DUNNINGLETTER |
Permitted values — validated against the notification_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | SMS | en: SMS · tr: SMS · ar: رسالة قصيرة |
2 | CALL | en: CALL · tr: Arama · ar: مكالمة |
3 | DUNNINGLETTER | en: DUNNINGLETTER · tr: İhtarname · ar: خطاب التنبيه |
periodPermitted values — validated against the notification_period parameter.
| Value | Meaning |
|---|---|
1 | DAILY |
2 | WEEKLY |
Permitted values — validated against the notification_period parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | DAILY | en: DAILY · tr: Günlük · ar: يومي |
2 | WEEKLY | en: WEEKLY · tr: Haftalık · ar: أسبوعي |
repeatCounttemplateIdupdate-follow-type-notification › 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.
update-follow-type-notification-active
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_LGLFLLW_4 | 400 | FOLLOWTYPE_NOT_FOUND | Follow Type cannot be found. :{0} |
ERR_LGLFLLW_8 | 400 | FOLLOWTYPE_NOTIFICATION_NOT_FOUND | Follow Type - information cannot be found. Notification:{0} |
path Parameters
idnotificationIdupdate-follow-type-notification-active › 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-follow-type-provision-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<FollowTypeProvisionDto>.
| Field | Declared type | Nullable |
|---|---|---|
DebtItem | int | no |
LedgerMatrixId | Guid? | yes |
LedgerMatrixFieldId | Guid? | yes |
GeneralProvisonRate | decimal? | yes |
SpecialProvisionRate | decimal? | yes |
IsActive | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LGLFLLW_4 | 400 | FOLLOWTYPE_NOT_FOUND | Follow Type cannot be found. :{0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-follow-type-provision-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.
debtItemPermitted values — validated against the debt_item parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Principial Amount | en: Principial Amount · tr: Anapara Tutarı · ar: المبلغ الرئيسي |
2 | Profit Amount | en: Profit Amount · tr: Kâr Tutarı · ar: مبلغ الربح |
generalProvisonRateidisActiveledgerMatrixFieldIdledgerMatrixIdprovisionDatereversedDatespecialProvisionRatecreate-follow-type-provision
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 AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LGLFLLW_4 | 400 | FOLLOWTYPE_NOT_FOUND | Follow Type cannot be found. :{0} |
ERR_LGLFLLW_6 | 400 | FOLLOWTYPE_PROVISION_FOUND_IS_ACTIVE | There is a record for this debt item in this follow type. |
path Parameters
idcreate-follow-type-provision › Request Body
debtItemPermitted values — validated against the debt_item parameter.
| Value | Meaning |
|---|---|
1 | Principial Amount |
2 | Profit Amount |
Permitted values — validated against the debt_item parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Principial Amount | en: Principial Amount · tr: Anapara Tutarı · ar: المبلغ الرئيسي |
2 | Profit Amount | en: Profit Amount · tr: Kâr Tutarı · ar: مبلغ الربح |
generalProvisonRateledgerMatrixFieldIdledgerMatrixIdspecialProvisionRatecreate-follow-type-provision › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
update-follow-type-provision
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_LGLFLLW_4 | 400 | FOLLOWTYPE_NOT_FOUND | Follow Type cannot be found. :{0} |
ERR_LGLFLLW_7 | 400 | FOLLOWTYPE_PROVISION_NOT_FOUND | Follow Type - provision cannot be found. Provision: {0} |
path Parameters
idprovisionIdupdate-follow-type-provision › Request Body
generalProvisonRateledgerMatrixFieldIdledgerMatrixIdspecialProvisionRateupdate-follow-type-provision › 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.
update-follow-type-provision-active
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_LGLFLLW_4 | 400 | FOLLOWTYPE_NOT_FOUND | Follow Type cannot be found. :{0} |
ERR_LGLFLLW_6 | 400 | FOLLOWTYPE_PROVISION_FOUND_IS_ACTIVE | There is a record for this debt item in this follow type. |
ERR_LGLFLLW_7 | 400 | FOLLOWTYPE_PROVISION_NOT_FOUND | Follow Type - provision cannot be found. Provision: {0} |
path Parameters
idprovisionIdupdate-follow-type-provision-active › 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.