Cyclos 4.16.18 REST deprecation notes.
Models
| To remove on | Model | Notes |
| 4.17 | NotificationKind | Use NotificationTypeEnum instead. |
| 4.17 | UserAuth | Starting with 4.15 the return from
Starting with 4.17, only those fields will be ever returned from this operation, even if the administrator has visible profile fields. |
Model properties
| To remove on | Model | Property | Notes |
| 4.17 | AdManage | customValues | Single dynamic values will change from returning value|label to only value. The catalog with the fields will be contained in the corresponding data in the property |
| 4.17 | AddressContacInfoManage | customValues | Single dynamic values will change from returning value|label to only value. The catalog with the fields will be contained in the corresponding data in the property |
| 4.17 | BaseCustomFieldValue | dynamicValue | Get the first element in |
| 4.17 | BaseUserDataForSearch | fieldsInSearch | Use |
| 4.17 | BasicUserManage | customValues | Single dynamic values will change from returning value|label to only value. The catalog with the fields will be contained in the corresponding data in the property |
| 4.17 | BuyVoucher | customValues | Use |
| 4.17 | ContactInfoManage | customValues | Single dynamic values will change from returning value|label to only value. The catalog with the fields will be contained in the corresponding data in the property |
| 4.17 | ContactManage | customValues | Single dynamic values will change from returning value|label to only value. The catalog with the fields will be contained in the corresponding data in the property |
| 4.17 | DataForLogin | forgotPasswordCaptchaProvider | Use |
| 4.17 | NotificationKind | accountBoughtVouchersAboutToExpire | Voucher notifications are no longer only for bought. |
| 4.17 | NotificationKind | accountBoughtVouchersExpirationDateChanged | Voucher notifications are no longer only for bought. |
| 4.17 | NotificationKind | accountBoughtVouchersExpired | Voucher notifications are no longer only for bought. |
| 4.17 | NotificationSettingsDataForEdit | forwardMessages | Use |
| 4.17 | NotificationTypeEnum | boughtVouchersAboutToExpire | Voucher notifications are no longer only for bought. |
| 4.17 | NotificationTypeEnum | boughtVouchersExpirationDateChanged | Voucher notifications are no longer only for bought. |
| 4.17 | NotificationTypeEnum | boughtVouchersExpired | Voucher notifications are no longer only for bought. |
| 4.17 | NotificationTypeMediums | kind | Use |
| 4.17 | OperatorGroupBasicData | canRedeemVouchers | Use |
| 4.17 | OperatorGroupManage | redeemVouchers | Use |
| 4.17 | OperatorGroupView | redeemVouchers | Use |
| 4.17 | PerformBaseTransaction | customValues | Single dynamic values will change from returning value|label to only value. The catalog with the fields will be contained in the corresponding data in the property |
| 4.17 | PerformVoucherTransaction | paymentCustomValues | Single dynamic values will change from returning value|label to only value. The catalog with the fields will be contained in the corresponding data in the property |
| 4.17 | RecordManage | customValues | Single dynamic values will change from returning value|label to only value. The catalog with the fields will be contained in the corresponding data in the property |
| 4.17 | TopUpVoucher | voucherCustomValues | Single dynamic values will change from returning value|label to only value. The catalog with the fields will be contained in the corresponding data in the property |
| 4.17 | TransactionKind | order | No longer used. Use |
| 4.17 | UserDataForNew | captchaType | Use |
| 4.17 | UserVouchersPermissions | viewBought | Use |
| 4.17 | UserVouchersPermissions | viewRedeemed | Use |
| 4.17 | UserVouchersQueryFilters | redeemBy | For redeemed, or starting with 4.15, voucher transactions, use |
| 4.17 | UserVouchersQueryFilters | redeemPeriod | For redeemed, or starting with 4.15, voucher transactions, use |
| 4.17 | UserVouchersQueryFilters | relation | For redeemed, or starting with 4.15, voucher transactions, use |
| 4.17 | VoucherBasicData | customFields | Use |
| 4.17 | VoucherDataForBuy | confirmationPasswordInput | The buying / sending should use a preview. So, call the preview operation and the confirmation password input will be returned on it |
| 4.17 | VoucherOrderByEnum | redeemDateAsc | This value is no longer used in the vouchers search, only in the transactions search. |
| 4.17 | VoucherOrderByEnum | redeemDateDesc | This value is no longer used in the vouchers search, only in the transactions search. |
| 4.17 | VoucherPermissions | viewBought | Use |
| 4.17 | VoucherPermissions | viewRedeemed | Use |
| 4.17 | VoucherRedeemResult | paymentId | Use |
| 4.17 | VoucherResult | redeemBy | This field doesn't belong to the voucher itself, but to the transaction. Search for voucher transactions instead. |
| 4.17 | VoucherResult | redeemDate | This field doesn't belong to the voucher itself, but to the transaction. Search for voucher transactions instead. |
| 4.17 | VoucherResult | redeemer | This field doesn't belong to the voucher itself, but to the transaction. Search for voucher transactions instead. |
| 4.17 | VoucherView | redeem | Use |
| 4.17 | VoucherView | redeemDate | Use |
| 4.17 | VouchersQueryFilters | redeemPeriod | Use |
| 4.17 | VouchersQueryFilters | redeemer | Use |
| 4.17 | VouchersQueryFilters | redeemerGroups | Use |
| 4.18 | BaseAuth | expiredSecondaryPassword | Use |
| 4.18 | BaseAuth | pendingSecondaryPassword | Use |
| 4.18 | BaseAuth | secondaryPasswordType | Use |
| 4.18 | BaseInstallmentDataForSearch | customFieldsInList | Use |
| 4.18 | BaseInstallmentDataForSearch | customFieldsInSearch | Use |
| 4.18 | BaseTransDataForSearch | customFieldsInList | Use |
| 4.18 | BaseTransDataForSearch | customFieldsInSearch | Use |
| 4.18 | CodeVerificationStatusEnum | codeNotSent | Since 4.16 this code is never returned, but failed is returned instead. |
| 4.18 | CodeVerificationStatusEnum | expired | Since 4.16 this code is never returned, but failed is returned instead. |
| 4.18 | DataForUi | footer | This was intended for internal use only and is no longer used. |
| 4.18 | DataForUi | header | This was intended for internal use only and is no longer used. |
| 4.18 | DataForUi | theme | This was intended for internal use only and is no longer used. |
| 4.18 | PasswordInput | buttonsPerRow | Use |
| 4.18 | PasswordInput | description | Use |
| 4.18 | PasswordInput | deviceAvailability | Use |
| 4.18 | PasswordInput | global | Use |
| 4.18 | PasswordInput | hasActiveDevice | Use |
| 4.18 | PasswordInput | hasActivePassword | Use |
| 4.18 | PasswordInput | id | Use |
| 4.18 | PasswordInput | inputMethod | Use |
| 4.18 | PasswordInput | internalName | Use |
| 4.18 | PasswordInput | lowerCaseLetters | Use |
| 4.18 | PasswordInput | maxLength | Use |
| 4.18 | PasswordInput | minLength | Use |
| 4.18 | PasswordInput | mode | Use |
| 4.18 | PasswordInput | name | Use |
| 4.18 | PasswordInput | numberOfButtons | Use |
| 4.18 | PasswordInput | numbers | Use |
| 4.18 | PasswordInput | onlyNumeric | Use |
| 4.18 | PasswordInput | pinAvailability | Use |
| 4.18 | PasswordInput | specialCharacters | Use |
| 4.18 | PasswordInput | upperCaseLetters | Use |
| 4.18 | SendActivationCodeRequest | mobilePhoneId | Use |
| 4.18 | SendOtpWithId | mobilePhoneId | Use |
| 4.18 | TransactionKind | chargeback | Chargebacks are now only handled at transfer level. Chargeback transactions no longer exist. |
| 4.18 | TransactionView | chargebackTransfer | Starting with Cyclos 4.16, chargebacks are only at transfer level, no transaction of kind chargeback exist anymore. |
| 4.18 | TransactionView | originalTransfer | Starting with Cyclos 4.16, chargebacks are only at transfer level, no transaction of kind chargeback exist anymore. |
| 4.18 | TransferDataForSearch | currencies | The currencies are already sent with account types. Use |
| 4.18 | TransferView | usersWhichCanAddToContacts | Use |
| 4.18 | TransferView | usersWhichCanViewProfile | Use |
| 4.18 | UnauthorizedError | missingSecondaryPassword | Use |
| 4.18 | UnauthorizedError | secondaryDeviceAllowed | Use |
| 4.18 | UserVoucherTransactionsQueryFilters | kind | Use |
| 4.18 | WizardStepDetailed | validateEmail | Lookup the |
| 4.18 | WizardStepDetailed | validateSms | Lookup the |
Service operations
| To remove on | URL | Method | Notes |
| 4.17 | /tickets | POST | Use |
| 4.17 | /tickets/data-for-new | GET | Use |
| 4.18 | /auth/session/secondary-password | GET | DEPRECATED |
| 4.18 | /auth/session/secondary-password | POST | DEPRECATED |
| 4.18 | /auth/session/secondary-password/otp | POST | DEPRECATED |
Service operation parameters
| To remove on | URL | Method | Parameter | Notes |
| 4.17 | /vouchers | GET | redeemPeriod | Use |
| 4.17 | /vouchers | GET | redeemer | Use |
| 4.17 | /vouchers | GET | redeemerGroups | Use |
| 4.17 | /vouchers/export/{format} | GET | redeemPeriod | Use |
| 4.17 | /vouchers/export/{format} | GET | redeemer | Use |
| 4.17 | /vouchers/export/{format} | GET | redeemerGroups | Use |
| 4.17 | /{user}/vouchers | GET | redeemBy | For redeemed, or starting with 4.15, voucher transactions, use The user who perform the transaction action. Only used when searching for redeemed, not bought vouchers. A user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, |
| 4.17 | /{user}/vouchers | GET | redeemPeriod | For redeemed, or starting with 4.15, voucher transactions, use The minimum / maximum voucher transaction date. Only used when searching for redeemed, not bought vouchers. Is expressed an array, with the lower bound as first element, and the upper bound as second element. When only one element, will have just the lower bound. To specify only the upper bound, prefix the value with a comma. |
| 4.17 | /{user}/vouchers | GET | relation | For redeemed, or starting with 4.15, voucher transactions, use |
| 4.17 | /{user}/vouchers/data-for-search | GET | relation | This operation will be only for owned vouchers. For voucher transactions, use |
| 4.17 | /{user}/vouchers/export/{format} | GET | redeemBy | For redeemed, or starting with 4.15, voucher transactions, use The user who perform the transaction action. Only used when searching for redeemed, not bought vouchers. A user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, |
| 4.17 | /{user}/vouchers/export/{format} | GET | redeemPeriod | For redeemed, or starting with 4.15, voucher transactions, use The minimum / maximum voucher transaction date. Only used when searching for redeemed, not bought vouchers. Is expressed an array, with the lower bound as first element, and the upper bound as second element. When only one element, will have just the lower bound. To specify only the upper bound, prefix the value with a comma. |
| 4.17 | /{user}/vouchers/export/{format} | GET | relation | For redeemed, or starting with 4.15, voucher transactions, use |
| 4.18 | /ui/data-for-ui | GET | footerIf | This was intended for internal use only and is no longer used. |
| 4.18 | /ui/data-for-ui | GET | headerIf | This was intended for internal use only and is no longer used. |
| 4.18 | /ui/data-for-ui | GET | themeIf | This was intended for internal use only and is no longer used. |