PersonalDataDestructionAPI web service methods
PersonalDataDestructionAPI provides the following methods:
- requestContactRemovalWithABUID(addressBookUID : String, requesterID: String) : String – A request to destroy a contact by AddressBookUID. In ContactManager, the AddressBookUID is checked against the LinkID of an ABContact object. This method is implemented as an asynchronous process that uses work queues.
- requestContactRemovalWithPublicID(contactPublicID : String, requesterID: String) : String – A request to destroy a contact by PublicID. In ContactManager, the contact is an ABContact. This method is implemented as an asynchronous process that uses work queues.
- doesABUIDExist(addressBookUID: String): boolean – Uses translateABUIDToPublicIDs as defined in the class that implements the PersonalContactDestroyer interface. In ContactManager, this translation method compares the AddressBookUID to the LinkID of an ABContact.
- doesContactWithPublicIDExist(publicID: String): boolean – In ContactManager, the contact is an ABContact object.
- currentDestructionRequestStatusByRequestID(uniqueRequestID : String): DestructionRequestStatus
- destroyUser(username : String) : boolean
– Given a ContactManager user name, verifies the existence of the credential
and the user. This method is a synchronous destruction request that does
not involve work queues and does not require coordination with core applications.
It works with the Contact
object and not with ABContact
because User is a subtype
of Contact.
- If the credential exists and the user does not, then the method obfuscates the credential, logs that the user does not exist, and returns credential.IsObfuscated.
- If both
credential and user exist, the method attempts to obfuscate the user,
which obfuscates both the credential and the UserContact object. If the obfuscation
succeeds, the method returns
true. If not, it logs that there was a failure and returnsfalse.
See also
