Academic Benchmarks API Methods

Any of these methods may be used independently or, depending on the desired goals, as a series of API calls made in sequence.  Contact us for more information about our Web Services API Methods.

Basic API Methods

Browse and Search

To browse the standards of a chosen authority (i.e. state), use the Browse API method. Most user interfaces will present a method (e.g. a visual map, a drop-down list) for the user to select their authority of interest or possibly will assume the user's authority of interest based on his/her site profile. Use the Search method to limit browse responses to a particular subset, possibly by keyword.

Maintain Asset

To add an asset to the AB database for alignment, use the Maintain Asset method. Submit asset metadata and receive an AB-generated GUID for the asset. Use this method to update or delete assets.

Handpick Alignment Method
Use this method to adjust an asset's alignment profile by handpicking learning standards with a label that indicates the strength of the match.

Review Handpick Alignment Method

Once the Handpick Alignments are in place for an asset, use Review Handpick Alignment to see all handpicks for an asset with an option to remove undesirable handpicks.

Premium API Methods

Target

To locate standards relevant to another standard, use the Target method, which is informed by AB’s standards relationship data. Select one standard and request related standards in other authorities. Suitable for state to state comparisons. Not suitable as a replacement for Predict Alignment method, which is described here.

Predict AB Framework Statement

Use the Predict AB Framework Statement method to ask AB's alignment system to assess asset metadata (including existing alignments) and reveal potential AB Framework alignments. Confirm the appropriate AB Framework objective statement(s) via the Handpick Alignment method. Use the Predict Alignment method to review specific authorities’ standards based on the confirmed AB Framework Statement alignments. Follow up with the Handpick Alignment method to confirm authority alignments. The Predict AB Framework Statement method can fail if there is insufficient information for guessing AB Framework objective statements.

Predict Alignment Method

Use this method to retrieve predicted alignments for a given asset based on existing handpicked AB Frameworks Statements or authorities’ standards. The returned alignments can be passed to the Handpick Alignment method to fine-tune predicted alignments.  This method can fail if there are no handpicked frameworks or standards.

API Method Bundles

 Academic Benchmarks Topic Taxonomy (ABTT) Tagging

If the AB Topic Taxonomy is included on your license, use the Browse Method against the AB Topic Taxonomy document to locate the nodes to associate with your assets. Use in concert with the Maintain Asset method. One the AB Topic Taxonomy nodes are assigned to assets, use the Predict Alignment method to see suggested standards in standards documents.