Person Memories Portrait

Description

The Person Memories Portrait resource defines the portrait for a Tree person.

Operations

GET - Get the location of the portrait image. A successful invocation will return a 307 redirect to the image.

Produces - Specify a returned data format using the Accept header.
  • */*
Parameters
Name Type Description
pid path The id of the person.
default query The URI to the image to use if no portrait has been assigned.
Status Codes
  • 204  -  If a portrait has not been set for the person.
  • 301  -  If the person has been merged into another person.
  • 307  -  The requested portrait can be retrieved from the URI in the Location header.
  • 404  -  If the person is not found.
  • 410  -  If the person has been deleted.
  • 429  -  If the request was throttled.

DELETE - Delete a portrait. The delete operation will only remove the current user's portrait selection, meaning the user may still see a "default" portrait that was selected by another user.

Produces - Specify a returned data format using the Accept header.
  • */*
Parameters
Name Type Description
X-Reason header Header giving the reason for deleting a portrait.
pid path The id of the person.
Status Codes
  • 204  -  The delete was successful.
  • 404  -  If the requested resource is not found.

Example Requests

Delete Person Portrait Selection How to delete the portrait selection of a user for a person.
Read Person Portrait How to read a portrait for a person.
Read Person Portrait With Default How to read a portrait for a person with a default image.
Change Language
Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.