Cyclos 4.16.18 REST deprecation notes.

This page reports the deprecated elements in Cyclos REST web services.
As policy, breaking changes are marked as deprecated for at least 2 major Cyclos versions, then removed.

Models

To remove onModelNotes
4.17NotificationKind

Use NotificationTypeEnum instead.

4.17UserAuth

Starting with 4.15 the return from POST /sessions, which is to login a user being authenticated as administrator, will only return the following fields when the administrator has no visible profile fields:

  • sessionToken
  • group
  • configuration

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 onModelPropertyNotes
4.17AdManagecustomValues

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 customFields.

4.17AddressContacInfoManagecustomValues

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 customFields.

4.17BaseCustomFieldValuedynamicValue

Get the first element in dynamicValues for type dynamicSelection.

4.17BaseUserDataForSearchfieldsInSearch

Use fieldsInBasicSearch and fieldsInAdvancedSearch instead.

4.17BasicUserManagecustomValues

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 customFields.

4.17BuyVouchercustomValues

Use paymentCustomValues instead.

4.17ContactInfoManagecustomValues

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 customFields.

4.17ContactManagecustomValues

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 customFields.

4.17DataForLoginforgotPasswordCaptchaProvider

Use forgotPasswordCaptchaInput.provider instead.

4.17NotificationKindaccountBoughtVouchersAboutToExpire

Voucher notifications are no longer only for bought.

4.17NotificationKindaccountBoughtVouchersExpirationDateChanged

Voucher notifications are no longer only for bought.

4.17NotificationKindaccountBoughtVouchersExpired

Voucher notifications are no longer only for bought.

4.17NotificationSettingsDataForEditforwardMessages

Use settings.forwardMessages instead.

4.17NotificationTypeEnumboughtVouchersAboutToExpire

Voucher notifications are no longer only for bought.

4.17NotificationTypeEnumboughtVouchersExpirationDateChanged

Voucher notifications are no longer only for bought.

4.17NotificationTypeEnumboughtVouchersExpired

Voucher notifications are no longer only for bought.

4.17NotificationTypeMediumskind

Use type instead.

4.17OperatorGroupBasicDatacanRedeemVouchers

Use canPerformVoucherTransactions instead

4.17OperatorGroupManageredeemVouchers

Use voucherTransactions instead

4.17OperatorGroupViewredeemVouchers

Use voucherTransactions instead

4.17PerformBaseTransactioncustomValues

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 customFields.

4.17PerformVoucherTransactionpaymentCustomValues

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 customFields.

4.17RecordManagecustomValues

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 customFields.

4.17TopUpVouchervoucherCustomValues

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 customFields.

4.17TransactionKindorder

No longer used. Use payment instead.

4.17UserDataForNewcaptchaType

Use captchaInput.provider instead. The captcha provider used to requested a captcha for registration, or null if no captcha is needed.

4.17UserVouchersPermissionsviewBought

Use viewTransactions instead.

4.17UserVouchersPermissionsviewRedeemed

Use view instead.

4.17UserVouchersQueryFiltersredeemBy

For redeemed, or starting with 4.15, voucher transactions, use GET /voucher-transactions instead.

4.17UserVouchersQueryFiltersredeemPeriod

For redeemed, or starting with 4.15, voucher transactions, use GET /voucher-transactions instead.

4.17UserVouchersQueryFiltersrelation

For redeemed, or starting with 4.15, voucher transactions, use GET /voucher-transactions instead.

4.17VoucherBasicDatacustomFields

Use paymentCustomFields instead.

4.17VoucherDataForBuyconfirmationPasswordInput

The buying / sending should use a preview. So, call the preview operation and the confirmation password input will be returned on it

4.17VoucherOrderByEnumredeemDateAsc

This value is no longer used in the vouchers search, only in the transactions search.

4.17VoucherOrderByEnumredeemDateDesc

This value is no longer used in the vouchers search, only in the transactions search.

4.17VoucherPermissionsviewBought

Use viewVouchers instead.

4.17VoucherPermissionsviewRedeemed

Use viewTransactions instead.

4.17VoucherRedeemResultpaymentId

Use payment.id instead (handling the case when it can be null).

4.17VoucherResultredeemBy

This field doesn't belong to the voucher itself, but to the transaction. Search for voucher transactions instead.

4.17VoucherResultredeemDate

This field doesn't belong to the voucher itself, but to the transaction. Search for voucher transactions instead.

4.17VoucherResultredeemer

This field doesn't belong to the voucher itself, but to the transaction. Search for voucher transactions instead.

4.17VoucherViewredeem

Use singleRedeem.payment instead.

4.17VoucherViewredeemDate

Use singleRedeem.date instead.

4.17VouchersQueryFiltersredeemPeriod

Use transactionPeriod instead

4.17VouchersQueryFiltersredeemer

Use transactionUser instead.

4.17VouchersQueryFiltersredeemerGroups

Use transactionUserGroups instead.

4.18BaseAuthexpiredSecondaryPassword

Use loginConfirmation.passwordStatus in [expired, reset]

4.18BaseAuthpendingSecondaryPassword

Use loginConfirmation != null

4.18BaseAuthsecondaryPasswordType

Use loginConfirmation.passwordType

4.18BaseInstallmentDataForSearchcustomFieldsInList

Use fieldsInList instead.

4.18BaseInstallmentDataForSearchcustomFieldsInSearch

Use fieldsInBasicSearch instead.

4.18BaseTransDataForSearchcustomFieldsInList

Use fieldsInList instead.

4.18BaseTransDataForSearchcustomFieldsInSearch

Use fieldsInBasicSearch instead.

4.18CodeVerificationStatusEnumcodeNotSent

Since 4.16 this code is never returned, but failed is returned instead.

4.18CodeVerificationStatusEnumexpired

Since 4.16 this code is never returned, but failed is returned instead.

4.18DataForUifooter

This was intended for internal use only and is no longer used.

4.18DataForUiheader

This was intended for internal use only and is no longer used.

4.18DataForUitheme

This was intended for internal use only and is no longer used.

4.18PasswordInputbuttonsPerRow

Use passwordType.buttonsPerRow instead

4.18PasswordInputdescription

Use passwordType.description instead

4.18PasswordInputdeviceAvailability

Use allowedCredentials instead, which should contain device.

4.18PasswordInputglobal

Use passwordType.global instead

4.18PasswordInputhasActiveDevice

Use activeCredentials instead, which should contain device.

4.18PasswordInputhasActivePassword

Use activeCredentials instead, which should contain password.

4.18PasswordInputid

Use passwordType.id instead

4.18PasswordInputinputMethod

Use passwordType.inputMethod instead

4.18PasswordInputinternalName

Use passwordType.internalName instead

4.18PasswordInputlowerCaseLetters

Use passwordType.lowerCaseLetters instead

4.18PasswordInputmaxLength

Use passwordType.maxLength instead

4.18PasswordInputminLength

Use passwordType.minLength instead

4.18PasswordInputmode

Use passwordType.mode instead

4.18PasswordInputname

Use passwordType.name instead

4.18PasswordInputnumberOfButtons

Use passwordType.numberOfButtons instead

4.18PasswordInputnumbers

Use passwordType.numbers instead

4.18PasswordInputonlyNumeric

Use passwordType.onlyNumeric instead

4.18PasswordInputpinAvailability

Use allowedCredentials instead, which should contain pin.

4.18PasswordInputspecialCharacters

Use passwordType.specialCharacters instead

4.18PasswordInputupperCaseLetters

Use passwordType.upperCaseLetters instead

4.18SendActivationCodeRequestmobilePhoneId

Use mobilePhone instead, as this parameter only allows id, while mobilePhone allows either id or number

4.18SendOtpWithIdmobilePhoneId

Use mobilePhone instead, as this parameter only allows id, while mobilePhone allows either id or number

4.18TransactionKindchargeback

Chargebacks are now only handled at transfer level. Chargeback transactions no longer exist.

4.18TransactionViewchargebackTransfer

Starting with Cyclos 4.16, chargebacks are only at transfer level, no transaction of kind chargeback exist anymore.

4.18TransactionVieworiginalTransfer

Starting with Cyclos 4.16, chargebacks are only at transfer level, no transaction of kind chargeback exist anymore.

4.18TransferDataForSearchcurrencies

The currencies are already sent with account types. Use accountTypes.currency instead.

4.18TransferViewusersWhichCanAddToContacts

Use transaction.usersWhichCanAddToContacts instead.

4.18TransferViewusersWhichCanViewProfile

Use transaction.usersWhichCanViewProfile instead.

4.18UnauthorizedErrormissingSecondaryPassword

Use missingLoginConfirmationPasswordType instead.

4.18UnauthorizedErrorsecondaryDeviceAllowed

Use missingLoginConfirmationCredentials instead, which should contain device.

4.18UserVoucherTransactionsQueryFilterskind

Use kinds instead.

4.18WizardStepDetailedvalidateEmail

Lookup the requireVerification property in fields array for the object with basicProfileField = email.

4.18WizardStepDetailedvalidateSms

Lookup the requireVerification property in fields array for the object with phoneKind = mobile.

Service operations

To remove onURLMethodNotes
4.17/ticketsPOST

Use POST /{user}/tickets instead.

4.17/tickets/data-for-newGET

Use GET /{user}/tickets/data-for-new instead

4.18/auth/session/secondary-passwordGET

DEPRECATED

4.18/auth/session/secondary-passwordPOST

DEPRECATED

4.18/auth/session/secondary-password/otpPOST

DEPRECATED

Service operation parameters

To remove onURLMethodParameterNotes
4.17/vouchersGETredeemPeriod

Use transactionPeriod instead

4.17/vouchersGETredeemer

Use transactionUser instead.

4.17/vouchersGETredeemerGroups

Use transactionUserGroups instead.

4.17/vouchers/export/{format}GETredeemPeriod

Use transactionPeriod instead

4.17/vouchers/export/{format}GETredeemer

Use transactionUser instead.

4.17/vouchers/export/{format}GETredeemerGroups

Use transactionUserGroups instead.

4.17/{user}/vouchersGETredeemBy

For redeemed, or starting with 4.15, voucher transactions, use GET /voucher-transactions instead.

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, '1234567890;

4.17/{user}/vouchersGETredeemPeriod

For redeemed, or starting with 4.15, voucher transactions, use GET /voucher-transactions instead.

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}/vouchersGETrelation

For redeemed, or starting with 4.15, voucher transactions, use GET /voucher-transactions instead.

4.17/{user}/vouchers/data-for-searchGETrelation

This operation will be only for owned vouchers. For voucher transactions, use GET /{user}/voucher-transactions/data-for-search or GET /{user}/voucher-transactions.

4.17/{user}/vouchers/export/{format}GETredeemBy

For redeemed, or starting with 4.15, voucher transactions, use GET /voucher-transactions instead.

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, '1234567890;

4.17/{user}/vouchers/export/{format}GETredeemPeriod

For redeemed, or starting with 4.15, voucher transactions, use GET /voucher-transactions instead.

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}GETrelation

For redeemed, or starting with 4.15, voucher transactions, use GET /voucher-transactions instead.

4.18/ui/data-for-uiGETfooterIf

This was intended for internal use only and is no longer used.

4.18/ui/data-for-uiGETheaderIf

This was intended for internal use only and is no longer used.

4.18/ui/data-for-uiGETthemeIf

This was intended for internal use only and is no longer used.