Cyclos 4.13 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.

Model properties

To remove onModelPropertyNotes
4.14AccountBalanceLimitsQueryFiltersbroker

Use brokers instead.

4.14AdDataForSearchdefaultGroups

Use the groups returned in the query instead.

4.14DataForEditFullProfiledisplay

Use userConfiguration.details.display instead.

4.14DataForEditFullProfileshortDisplay

Use userConfiguration.details.shortDisplay instead.

4.14TransactionViewscheduled

See the documentation of scheduling instead.

4.15AdBasicDataowner

Use user instead.

4.15AdDataForEditedit

Use canEdit instead.

4.15AdDataForEditremove

Use canRemove instead.

4.15AdDetailedowner

Use user instead.

4.15AdInterestDataForEditedit

Use canEdit instead.

4.15AdInterestDataForEditremove

Use canRemove instead.

4.15AdInterestViewedit

Use canEdit instead.

4.15AdInterestViewremove

Use canRemove instead.

4.15AdQueryFiltersbroker

Use brokers instead.

4.15AdQueryFiltersowner

Use user instead.

4.15AdViewcanManage

Use canEdit or canRemove instead.

4.15AddressDataForEditedit

Use canEdit instead.

4.15AddressDataForEditremove

Use canRemove instead.

4.15AddressVieweditable

Use canEdit instead.

4.15AgreementWithContentcontent

This shouldn't be used. Instead, do an additional request to GET /agreements/{key}/content to fetch the content.

4.15BankingPermissionsrecurringPayments

Recurring payment permissions are no longer separated from scheduled payment permissions. Use scheduledPayments instead.

4.15BaseNotificationSettingseditable

Use canEdit instead.

4.15BaseTransQueryFiltersbroker

Use brokers instead.

4.15BaseTransferQueryFilterstransferKinds

Use kinds instead.

4.15ChangeForgottenPasswordkey

The key received by e-mail on the forgotten password reset request

4.15ContactInfoDataForEditedit

Use canEdit instead.

4.15ContactInfoDataForEditremove

Use canRemove instead.

4.15ContactInfoVieweditable

Use canEdit instead.

4.15ContactViewcanManage

Use canEdit instead.

4.15ContactViewowner

Use user instead.

4.15DataForChangeForgottenPasswordgenerated

Use passwordType.mode == 'generated' instead.

4.15DataForMobileUsercanActivateAsTrustedDevice

Use deviceActivationMode instead.

4.15DeliveryMethoddeliveryTime

Use minDeliveryTime and maxDeliveryTime instead.

4.15DeliveryMethodDataForEditedit

Use canEdit instead.

4.15DeliveryMethodDataForEditremove

Use canRemove instead.

4.15DeliveryMethodManagedeliveryTime

Use minDeliveryTime and maxDeliveryTime instead.

4.15DeliveryMethodViewedit

Use canEdit instead.

4.15DeliveryMethodViewremove

Use canRemove instead.

4.15DeviceDataForEditmanage

Use canEdit instead.

4.15DevicePinDataForEditmanage

Use canEdit instead.

4.15ImagesListDatacanManage

Use canEdit instead.

4.15InstallmentViewtransactionNumber

Use transferTransactionNumber instead.

4.15MarketplacePermissionsmanageOwnAdvertisements

Use mySimple.manage instead

4.15MarketplacePermissionsownAdvertisements

Use mySimple.enable instead

4.15MarketplacePermissionspurchase

Use userWebshop.purchase instead

4.15MarketplacePermissionsquestions

Use mySimple.questions instead.

4.15MarketplacePermissionssearch

Use userSimple.view or userWebshop.view instead

4.15MarketplacePermissionsviewAdvertisements

Use userSimple.view instead

4.15MarketplacePermissionsviewWebshop

Use userWebshop.view instead

4.15MobileTranslationscountries

The list of countries must be read from the already existing list in the mobile.

4.15OperationshowFormForMissingOptionalParameters

Use showForm instead.

4.15OperatorGroupDataForEditedit

Use canEdit instead.

4.15OperatorGroupDataForEditremove

Use canRemove instead.

4.15OperatorGroupVieweditable

Use canEdit instead.

4.15OrderDataForEditedit

Use canEdit instead.

4.15OrderDataForEditremove

Use canRemove instead.

4.15OrderViewdeliveryMethodName

Use deliveryMethod.name instead.

4.15OrderViewdeliveryPrice

Use deliveryMethod.price instead.

4.15OrderViewdeliveryTime

Use deliveryMethod.minTime and deliveryMethod.maxTime instead.

4.15OrderViewmaxDeliveryTime

Use deliveryMethod.maxTime instead.

4.15OrderViewminDeliveryTime

Use deliveryMethod.minTime instead.

4.15PhoneDataForEditedit

Use canEdit instead.

4.15PhoneDataForEditremove

Use canRemove instead.

4.15PhoneVieweditable

Use canEdit instead.

4.15RecordDataForEditedit

Use canEdit instead.

4.15RecordDataForEditremove

Use canRemove instead.

4.15RecordPermissionssingleId

Use singleRecordId property

4.15RecordPermissionsupdate

Use edit property

4.15RecordViewedit

Use canEdit instead.

4.15RecordViewremove

Use canRemove instead.

4.15ReferenceViewmanage

Use canEdit instead.

4.15RunOperationpageContext

Use exportFormat instead.

4.15SetDeliveryMethodtime

Use minTime and maxTime instead.

4.15TokensPermissionsnfc

Use either my, user or personalizeNfcTokensAsMember, filtering by physicalType to be nfcTag.

4.15TransactionfromKind

Use from.kind instead.

4.15TransactionfromUser

Use from.user instead.

4.15TransactiontoKind

Use to.kind instead.

4.15TransactiontoUser

Use to.user instead.

4.15TransactionOverviewResultfromKind

Use from.kind instead.

4.15TransactionOverviewResultfromUser

Use from.user instead.

4.15TransactionOverviewResulttoKind

Use to.kind instead.

4.15TransactionOverviewResulttoUser

Use to.user instead.

4.15TransactionResultrelatedKind

Use related.kind instead.

4.15TransactionResultrelatedUser

Use related.user instead.

4.15TransferQueryFilterscurrency

Use currencies instead.

4.15TransferQueryFiltersfromAccountType

Use fromAccountTypes instead.

4.15TransferQueryFilterstoAccountType

Use toAccountTypes instead.

4.15UsershortDisplay

The short display was originally meant for SMS only. Will be removed in Cyclos 4.15 with no replacement.

4.15UserAdInterestsListDatacanManage

Use canEdit instead.

4.15UserAddressesListDatacanManage

Use canEdit instead.

4.15UserContactInfosListDatacanManage

Use canEdit instead.

4.15UserDeliveryMethodsListDatacanManage

Use canEdit instead.

4.15UserMarketplacePermissionsmanageAdvertisements

Use simple.manage instead

4.15UserMarketplacePermissionsmanageWebshop

Use webshop.manage instead

4.15UserMarketplacePermissionsviewAdvertisements

Use simple.view instead

4.15UserMarketplacePermissionsviewPurchases

Use webshop.viewPurchases instead

4.15UserMarketplacePermissionsviewSales

Use webshop.viewSales instead

4.15UserMarketplacePermissionsviewWebshop

Use webshop.view instead

4.15UserOperatorGroupsListDatacanManage

Use canEdit instead.

4.15UserPermissionspersonalizeNfcTokens

Filter the tokens list with type.physicalType = 'nfcTag' and activate = true.

4.15UserPermissionsrecurringPayments

As of Cyclos 4.13, the recurring payments permissions are the same as scheduled payments. Use scheduledPayments instead.

4.15UserPhonesListDatacanManage

Use canEdit instead.

Service operations

To remove onURLMethodNotes
4.14/users/validate/email-change/{key}POST

Use POST /validate/email-change/{key}

4.14/users/validate/registration/{key}POST

Use POST /validate/registration/{key} instead.

4.15/accounts/data-for-limitsGET

Use GET /accounts/data-for-balance-limits instead.

4.15/accounts/limitsGET

Use GET /accounts/balance-limits instead.

4.15/accounts/limits/export/{format}GET

Use GET /accounts/balance-limits/export/{format} instead.

4.15/recurring-payments/occurrences/{id}/process-failedPOST

Use POST /installments/{key}/process instead.

4.15/scheduled-payments/installments/{id}/processPOST

Use POST /installments/{key}/process instead.

4.15/scheduled-payments/installments/{id}/settlePOST

Use POST /installments/{key}/process instead.

4.15/{user}/accounts/data-for-limitsGET

Use GET /{user}/accounts/data-for-balance-limits instead.

4.15/{user}/accounts/{accountType}/limitsGET

Use GET /{user}/accounts/{accountType}/balance-limits instead.

4.15/{user}/accounts/{accountType}/limitsPUT

Use POST /{user}/accounts/{accountType}/balance-limits instead.

4.15/{user}/vouchers/types-for-buyGET

Use GET /{user}/vouchers/data-for-buy without passing a type instead.

Service operation parameters

To remove onURLMethodParameterNotes
4.15/auth/data-for-loginGETpinId

Use pinPrincipal instead.

4.15/auth/forgotten-password/data-for-changeGETkey

Use both user and code instead.

4.15/mobile/data-for-guestGETpinId

Use pinPrincipal instead.

4.15/ui/data-for-uiGETpinId

Use pinPrincipal instead.