mc3-handcar-api
Overview
What is Handcar?
Known issues/Issues under consideration for implementation in future releases
Other Related Documentation
Model Diagram
Model Description
Implementation Details
What is the base URL for Handcar?
Production Tier
Demo/Test Tier
Objective Banks
Basic Lookup
Looking up objects within a bank
Configuration Data
Objectives
Basic Objective Lookup Examples
Looking up objectives in a hierarchy
Looking up requisite and dependent objectives
Activities
Basic Lookup
Looking up related objects
Assets
Basic Lookup
Cross Bank Support
Example #1 Finding an objective by id without specifying its bank
Example #2 Finding an activity by id without specifying its bank
Example #3 Finding an asset by id without specifying its bank
Extension Records
What is an extension record?
Example #1 Fetch a Particular Objective Bank’s Extension Record
Example #2 Fetch a Particular Objective’s Extension Record
Example #3 Fetch a Particular Activity’s Extension Record
Example #4 Fetch a Particular Asset’s Extension Record
Example #5 Fetch a Particular Asset Content’s Extension Record
Administration – Creating and Updating Objects in Handcar
A Word about Types
How can I get my own objective bank in the production tier on MC3?
Creating a “Sandbox” Objective Bank in MC3-DEMO
You can create and update 3 kinds (types) of Objectives
Creating and Updating Activities
Creating and Updating Assets
Administration – Deleting objects
Delete Objective Bank
Delete Objective
Delete Activity
Delete Asset
Delete Asset Content
Delete a Relationship Family
Delete a Relationship
Two Authentication Mechanisms
Which authentication mechanism should I use?
Ok, my app can authenticate to handcar but how can I get Touchstone to authenticate users to my app?
Authenticating to Handcar via Touchstone
Authenticating to Handcar using Agent Keys
Authorization
The MC3$GUEST account
MIT Roles
Qualifiers
What if a user has no authorizations?
Authorization Hints
The Relationship Service
Introduction
Basic Lookup
Documentation TODOs
mc3-handcar-api
Docs
»
Welcome to mc3-handcar-api’s documentation!
Edit on GitHub
Welcome to mc3-handcar-api’s documentation!
¶
Contents:
Overview
What is Handcar?
Known issues/Issues under consideration for implementation in future releases
Other Related Documentation
Model Diagram
Model Description
Implementation Details
What is the base URL for Handcar?
Production Tier
Demo/Test Tier
Objective Banks
Basic Lookup
Looking up objects within a bank
Configuration Data
Objectives
Basic Objective Lookup Examples
Looking up objectives in a hierarchy
Looking up requisite and dependent objectives
Activities
Basic Lookup
Looking up related objects
Assets
Basic Lookup
Cross Bank Support
Example #1 Finding an objective by id without specifying its bank
Example #2 Finding an activity by id without specifying its bank
Example #3 Finding an asset by id without specifying its bank
Extension Records
What is an extension record?
Example #1 Fetch a Particular Objective Bank’s Extension Record
Example #2 Fetch a Particular Objective’s Extension Record
Example #3 Fetch a Particular Activity’s Extension Record
Example #4 Fetch a Particular Asset’s Extension Record
Example #5 Fetch a Particular Asset Content’s Extension Record
Administration – Creating and Updating Objects in Handcar
A Word about Types
How can I get my own objective bank in the production tier on MC3?
Creating a “Sandbox” Objective Bank in MC3-DEMO
You can create and update 3 kinds (types) of Objectives
Creating and Updating Activities
Creating and Updating Assets
Administration – Deleting objects
Delete Objective Bank
Delete Objective
Delete Activity
Delete Asset
Delete Asset Content
Delete a Relationship Family
Delete a Relationship
Two Authentication Mechanisms
Which authentication mechanism should I use?
Ok, my app can authenticate to handcar but how can I get Touchstone to authenticate users to my app?
Authenticating to Handcar via Touchstone
Authenticating to Handcar using Agent Keys
Authorization
The MC3$GUEST account
MIT Roles
Qualifiers
What if a user has no authorizations?
Authorization Hints
The Relationship Service
Introduction
Basic Lookup
Documentation TODOs
Indices and tables
¶
Index
Module Index
Search Page