/
account_delete ()

account_delete ()

Owned by Pedro Jose Sanchez Luling, created
Last updated: Dec 12, 2024
2 min read

Function prototype

account_delete (session, [user] , [remove_data = false])

API Version

2.7.32 and higher

Supported interfaces

SOAP, REST

Description

Delete a user’s account

A USER’s account can be deleted in 2 ways:

  • “Soft” delete: this option doesn’t remove the data associated with the account, but anonymizes personal data (name, surname, contact data, IDENTIFIERS, images, etc.).

  • “Hard” delete: Remove the account and all associated data. No information related with the USER’s account will remain in the DB

In the case of choosing the “soft” delete option, the data that is preserved is:

  • Gender: because it may be significant in the context of some SUBSCRIPTIONS regarding the medical procedures applied.

  • TEAM IDENTIFIERS and SUBSCRIPTION IDENTIFIERS, because they are not considered personal data

  • ADMISSIONS (if the account corresponds to a CASE)

  • TASK assignments

In all cases the following data is always removed:

  • Notifications sent to the USER

  • Username associated to the account

  • Name/Surname, Birthdate

  • Contact data (email, phone number, etc)

  • Addresses

  • IDENTIFIERS

  • Images

  • All associations with other CASES, either acting as an ASSOCIATE (caregiver) or acting a as a “cared by” another ASSOCIATE

Required permissions: The account can only be deleted by:

  • The owner of the account. In this case only a “soft” delete is allowed

  • A Super-administrator. Can do a “soft” or a “hard” delete of the account

Input parameters:

  • session: is the session token obtained in the session_init() call

  • user: (optional) If not provided, the active USER’s account will be deleted (“soft” delete)

  • remove_data: true/false (default = false). Only a super administrator can indicate “true” to remove definitively all data related with the account.

Output parameters:

  • result: empty

  • ErrorMsg: If any error occurs, then this value contains a description of the error translated to the current language

  • ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

Request example

account_delete ( “LCAAAAAAAAAAAA”)

Response

The response format is XML when the function has been invoked via the SOAP API, and JSON when it has been invoked via the REST API

Return Error codes

ERROR CODE

 

ERROR CODE

 

INVALID_TOKEN

The session token provided is not valid

INSUFFICIENT_PRIVILEGES

The session user does not have the necessary privileges to delete the account



Related content