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.
Provides access to all of the actors/watchers found by this recipe.
https://server.abc/Recipes/actors?recipeId=http://id.tincanapi.com/recipe/video/base/1
200
ToggleContent-Type: application/json
{ "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"
}
] } ] }
400
ToggleContent-Type: application/json
{"results":[],"error":"recipeId was not supplied in the queryParams"}
Provides access to all of the actors/watchers found by this recipe filtered by the provided email fragment.
https://server.abc/Recipes/actors?recipeId=http://id.tincanapi.com/recipe/video/base/1&email=testing.com
200
ToggleContent-Type: application/json
{ "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"
}
] } ] }
400
ToggleContent-Type: application/json
{"results":[],"error":"recipeId was not supplied in the queryParams"}
Provides access to all the objects/videos found by this recipe. Use this to populate selectors for object/video specific queries.
Provides access to all of the actors/watchers found by this recipe.
https://server.abc/Recipes/objects?recipeId=http://id.tincanapi.com/recipe/video/base/1
200
ToggleContent-Type: application/json
{"results":[
{"objectIds":[
"http://www.youtube.com/ae97jo4wtis",
"http://www.youtube.com/v/ePkDzxVn-7Q",
"https://www.youtube.com/PPs72CY4NQ8"
]
}
]
}
400
ToggleContent-Type: application/json
{"results":[],"error":"recipeId was not supplied in the queryParams"}
Aggregate data from all statements matching the recipe. Perform a pre-defined query on the datastore with optional parameters
https://server.abc/Recipes/results?recipeQueryId=CompletionCountForAllObjects&recipeId=http://id.tincanapi.com/recipe/video/base/1
URI
(required) Example: http://registry.tincanapi.com/recipes/video/base/1videoQuery
(required) Example: GetCompletionCountByObjectIdChoices: CompletionCountForAllObjects
, CompletionsByObjectId
, CompletionsByObjectId
, TotalsData
, CompletionsByWatcher
queryStringParameter
(optional) Example: objectId=123200
ToggleContent-Type: application/json
{"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"}
]
}
400
ToggleContent-Type: application/json
{"results":[],"error":"recipeId was not supplied in the queryParams"}
https://server.abc/Recipes/results?recipeQueryId=CompletionsByObjectId&recipeId=http://id.tincanapi.com/recipe/video/base/1&objectId=http://www.youtube.com/ae97jo4wtis
(required)
(required)
(required) 200
ToggleContent-Type: application/json
{ "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"
} ] }
400
ToggleContent-Type: application/json
{"results":[],"error":"recipeId was not supplied in the queryParams"}
https://server.abc/Recipes/results?recipeQueryId=TotalsData&recipeId=http://id.tincanapi.com/recipe/video/base/1
(required)
(required) 200
ToggleContent-Type: application/json
{ "results" : [ { "completionData" : { "total_completions" : 11 },
"durationData" : { "watched_duration" : 918 },
"objectData" : { "unique_objects" : 3 },
"watcherData" : { "unique_watchers" : 8 }
} ] }
400
ToggleContent-Type: application/json
{"results":[],"error":"recipeId was not supplied in the queryParams"}
Generated by aglio on 06 Aug 2015