Memories

Description

The Memories resource defines the list of all memories in the system. A memory is a container for user-contributed artifacts, such as photos, stories, documents and audio. The Memories resource is used to upload, annotate and organize memories and then attach them to persons in the Tree. Each memory artifact has an associated source description that contains metadata about the artifact, such as a title, a created timestamp, links, references and any extracted information.

Operations

GET - If the 'mids' query parameter is set, retrieve all memories specified by the ids in the 'mids' query parameter. Otherwise, retrieve all memories for the current user, which is accomplished by a redirect to the memories for the current user.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
mids query Comma and/or space separated list of memory description ids.
Status Codes
  • 200  -  Upon a successful read.
  • 204  -  Upon a successful read with no results.

POST - Create a memory by uploading an artifact and some associated metadata.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
Content-Disposition header The header value used to determine filename when multipart type data is not used.
Content-Type header The header value for the incoming request's Content-Type. Multipart type data is supported and a boundary parameter on the Content-Type is required when using multipart/form-data or multipart/mixed Required.
description query The description to use for artifacts being uploaded or when no value is available via multipart type posts.
filename query The file name to use for artifacts being uploaded.\
title query The title used for artifacts being uploaded or when no value is available via multipart type posts.
type query The artifact type to use for the artifact being uploaded. If this parameter is not supplied, an appropriate default will be supplied based on the media type. Possible values include Document, Obituary, Photo, and Story. This parameter has no effect on a read.
Status Codes
  • 201  -  The creation of the artifact was successful. Expect a location header specifying the link to the created artifact.

Example Requests

Create User-Uploaded Source How to create a source for an artifact that a user has uploaded.
Upload Image as a Document How to upload an image as a document.
Upload Multiple Photo Memories How to upload multiple photo memories using a multipart request.
Upload PDF Document How to upload a PDF document.
Upload Photo How to upload a photo.
Upload Photo Via Multipart Form Data How to upload a photo via multipart form data.
Upload Story How to upload a story.
Upload Story Memories How to upload multiple stories using a multipart request.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.