Versions Compared

Old Version 4

changes.mady.by.user Tony Erskine

Saved on

compared with

New Version 5

changes.mady.by.user Tony Erskine

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Warning

This will permanently delete the person and all of his photos. You cannot undo this destructive action.

URI: `https://appapi.cloudcardtoolsonlinephotosubmission.com/api/people/{id}

Info

{id} refers to the database ID, which can be found in the id field of the response to Get a Person.  Unlike other endpoints, people can only be deleted by id - not by email or identifier.

Example URI: https://app.cloudcardtools.com/api/people/123Example URI: https://api.onlinephotosubmission.com/api/people/123 
Example URI: https://api.onlinephotosubmission.com/api/people/jon.doe@foo.edu?findBy=email
Example URI: https://api.onlinephotosubmission.com/api/people/A1234567?findBy=indentifier

Optional URL Parameters: findBy=[id|email|identifier] (default id)

Note

DEPRECATION NOTICE: Finding a person by email address or identifier (aka Student ID/Employee ID) without specifying the findBy parameter is still supported but has been deprecated, and will no longer be supported on or after April 1, 2019.


HTTP Method: DELETE (warning)

Required Headers: X-Auth-Token (see: Authentication)

...