Tin Can Recipes

Actors

An Actor in the video recipe is a watcher of a video. They are identified here by email address and the mbox value provided in the statements.

Actors List

Provides access to all of the actors/watchers found by this recipe.

GET All Actors

GET

/actors{?recipeId}

https://server.abc/Recipes/actors?recipeId=http://id.tincanapi.com/recipe/video/base/1

Response 200Toggle

Headers

Content-Type: application/json

Body

{ "results" : [ { "actors" : [ { "mbox" : "mailto:jimmy@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:joe.user.4@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:joe.user.5@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:joe.user3@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:test@tester.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:tester@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:tester2@testing.com",
              "objectType" : "Agent"
            }
          ] } ] }

Response 400Toggle

Headers

Content-Type: application/json

Body

{"results":[],"error":"recipeId was not supplied in the queryParams"}

Actors by Email

Provides access to all of the actors/watchers found by this recipe filtered by the provided email fragment.

GET Actors by Email

GET

/actors{?recipeId,email}

https://server.abc/Recipes/actors?recipeId=http://id.tincanapi.com/recipe/video/base/1&email=testing.com

Response 200Toggle

Headers

Content-Type: application/json

Body

{ "results" : [ { "actors" : [ { "mbox" : "mailto:jimmy@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:joe.user.4@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:joe.user.5@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:joe.user3@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:tester@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:tester2@testing.com",
              "objectType" : "Agent"
            }
          ] } ] }

Response 400Toggle

Headers

Content-Type: application/json

Body

{"results":[],"error":"recipeId was not supplied in the queryParams"}

Objects

Provides access to all the objects/videos found by this recipe. Use this to populate selectors for object/video specific queries.

Objects List

Provides access to all of the actors/watchers found by this recipe.

GET All Objects

GET

/objects{?recipeId}

https://server.abc/Recipes/objects?recipeId=http://id.tincanapi.com/recipe/video/base/1

Response 200Toggle

Headers

Content-Type: application/json

Body

{"results":[
    {"objectIds":[
        "http://www.youtube.com/ae97jo4wtis",
        "http://www.youtube.com/v/ePkDzxVn-7Q",
        "https://www.youtube.com/PPs72CY4NQ8"
        ]
    }
    ]
}

Response 400Toggle

Headers

Content-Type: application/json

Body

{"results":[],"error":"recipeId was not supplied in the queryParams"}

Results

Aggregate data from all statements matching the recipe. Perform a pre-defined query on the datastore with optional parameters

Results List

Get CompletionCountForAllObjects

GET

/results{?recipeId,recipeQueryId,limit,*additional parameters*}

https://server.abc/Recipes/results?recipeQueryId=CompletionCountForAllObjects&recipeId=http://id.tincanapi.com/recipe/video/base/1

Parameters
recipeId
URI (required) Example: http://registry.tincanapi.com/recipes/video/base/1
recipeQueryId
videoQuery (required) Example: GetCompletionCountByObjectId
Choices: CompletionCountForAllObjects, CompletionsByObjectId, CompletionsByObjectId, TotalsData, CompletionsByWatcher
additionalParams
queryStringParameter (optional) Example: objectId=123

Response 200Toggle

Headers

Content-Type: application/json

Body

{"results":
    [
        {"completions":1,"object_id":"http://www.youtube.com/ae97jo4wtis"},
        {"completions":6,"object_id":"http://www.youtube.com/v/ePkDzxVn-7Q"},
        {"completions":3,"object_id":"https://www.youtube.com/PPs72CY4NQ8"}
    ]
}

Response 400Toggle

Headers

Content-Type: application/json

Body

{"results":[],"error":"recipeId was not supplied in the queryParams"}

Get CompletionsByObjectId

GET

/results{?recipeId,recipeQueryId,limit,*additional parameters*}

https://server.abc/Recipes/results?recipeQueryId=CompletionsByObjectId&recipeId=http://id.tincanapi.com/recipe/video/base/1&objectId=http://www.youtube.com/ae97jo4wtis

Parameters
recipeId
(required)
recipeQueryId
(required)
objectId
(required)

Response 200Toggle

Headers

Content-Type: application/json

Body

{ "results" : [ { "actor_json" : "{\"objectType\":\"Agent\",\"mbox\":\"mailto:tester@testing.com\"}",
        "ending_point" : 1729,
        "object_id" : "http://www.youtube.com/ae97jo4wtis",
        "starting_point" : null,
        "statement_id" : "43460ce4-8808-41f5-aca4-fb0e58550cd5",
        "update_dt_utc" : "2014-05-06T06:33:34.087",
        "verb_id" : "http://adlnet.gov/expapi/verbs/completed"
      } ] }

Response 400Toggle

Headers

Content-Type: application/json

Body

{"results":[],"error":"recipeId was not supplied in the queryParams"}

Get TotalsData

GET

/results{?recipeId,recipeQueryId,limit,*additional parameters*}

https://server.abc/Recipes/results?recipeQueryId=TotalsData&recipeId=http://id.tincanapi.com/recipe/video/base/1

Parameters
recipeId
(required)
recipeQueryId
(required)

Response 200Toggle

Headers

Content-Type: application/json

Body

{ "results" : [ { "completionData" : { "total_completions" : 11 },
        "durationData" : { "watched_duration" : 918 },
        "objectData" : { "unique_objects" : 3 },
        "watcherData" : { "unique_watchers" : 8 }
      } ] }

Response 400Toggle

Headers

Content-Type: application/json

Body

{"results":[],"error":"recipeId was not supplied in the queryParams"}