Cyclos 4.12 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.13BaseCustomFieldValuelinkedEntityValue

Use one of the specific fields: - userValue: If the entity type is user - recordValue: If the entity type is record - transactionValue: If the entity type is transaction - transferValue: If the entity type is transfer - adValue: If the entity type is advertisement

4.13CustomFieldDetailedallowedMimeTypes

Use mimeTypes instead.

4.13CustomFieldDetailedotherMimeTypes

Use mimeTypes instead.

4.13Notificationlocation

Use entityType instead.

4.13OperationcanRunDirectly

Use the other flags instead. This flag was decomposed in several others to allow better control at the moment of run a custom operation. For example, if your front-end asks for the confirmation password in a popup instead of in its own page and the only thing you need to run the operation is that (i.e thereare no missing parameters, no file upload, etc) then you could show the popup to collect the password and then run the custom operation directly in the same page on which you are.

4.13PaymentRequestPermissionsauthorize

Use accept instead

4.13TransactionDataForSearchcanViewScheduled

Use visibleKinds instead.

4.13TransactionTypeDatarequiresDescription

Use descriptionAvailability instead

4.13VoucherViewcanCancel

This is redundant with cancelAction, is false if cancelAction is null, and true if cancelAction is not null.

4.14AdDataForSearchdefaultGroups

Use the groups returned in the query instead.

4.14DataForEditFullProfiledisplay

DEPRECATED. Use userConfiguration.details.display instead.

Contains the formatting of the user according to the configuration. Is only returned if no profile fields are marked to return in user list.

4.14DataForEditFullProfileshortDisplay

DEPRECATED. Use userConfiguration.details.shortDisplay instead.

Contains the short formatting of the user according to the configuration. Is only returned if no profile fields are marked to return in user list

4.14TransactionViewscheduled

See the documentation of scheduling instead.

4.15TokensPermissionsnfc

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

Permissions over each visible nfc token type

nullAdQueryFiltersbroker

DEPRECATED. Use brokers instead.

nullUserPermissionspersonalizeNfcTokens

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

NFC tokens the authenticated user can personalize for the given user

Service operations

To remove onURLMethodNotes
4.13/contactInfos/{id}/imagePOST

Use POST /contact-infos/{id}/image

4.13/images/{id}/contentGET

Use GET /images/{idOrKey}/content instead. Generally clients should use the Image.url property, which is always correct.

4.13/images/{kind}/{file}GET

Use GET /images/{idOrKey}/content instead. Generally clients should use the Image.url property, which is always correct.

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}

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

Instead use "/{user}/vouchers/data-for-buy" without passing a type.

List the voucher types the user can buy to another user (or himself)