Cyclos 4.15.15 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.16OtpError

Starting with Cyclos 4.14, email and SMS sending errors are reported as code 503.
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.16OwnerRecordPermissionscount

Use UserView.records instead using the record type id or internal name as the key of the map.
4.16PasswordInputtypeId

Starting with Cyclos 4.16, the id property is always the password type id. Before 4.16, the id is overridden by the virtual keyboard id when it is used.
4.16UserDocumentsPermissionscount

Use UserView.documents instead.
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

A separated enum was created
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.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.

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

Service operation parameters

To remove onURLMethodParameterNotes
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.