Texas Essential Knowledge and Skills API.

The Competencies and Academic Standards Exchange (CASE) Service enables the exchange of data between a Competency Records Service Provider and the consumers of the associated data. This service has been described using the IMS Model Driven Specification development approach: this being the Platform Specific Model (PSM) of the service.

The generated code uses the Newtonsoft Json.NET NuGet Package. If the automatic NuGet package restore is enabled, these dependencies will be installed automatically. Therefore, you will need internet access for build.

"This library requires Visual Studio 2017 for compilation."

1. Open the solution (TeksAPI.sln) file.
2. Invoke the build process using Ctrl+Shift+B shortcut key or using the Build menu as shown below.

The build process generates a portable class library, which can be used like a normal class library. The generated library is compatible with Windows Forms, Windows RT, Windows Phone 8, Silverlight 5, Xamarin iOS, Xamarin Android and Mono. More information on how to use can be found at the MSDN Portable Class Libraries documentation.

The following section explains how to use the TeksAPI library in a new console project.

For starting a new project, right click on the current solution from the solution explorer and choose Add -> New Project.

Next, choose "Console Application", provide a TestConsoleProject as the project name and click OK.

The new console project is the entry point for the eventual execution. This requires us to set the TestConsoleProject as the start-up project. To do this, right-click on the TestConsoleProject and choose Set as StartUp Project form the context menu.

In order to use the TeksAPI library in the new project, first we must add a projet reference to the TestConsoleProject. First, right click on the References node in the solution explorer and click Add Reference....

Next, a window will be displayed where we must set the checkbox on TeksAPI.Standard and click OK. By doing this, we have added a reference of the TeksAPI.Standard project into the new TestConsoleProject.

Once the TestConsoleProject is created, a file named Program.cs will be visible in the solution explorer with an empty Main method. This is the entry point for the execution of the entire solution. Here, you can add code to initialize the client library and acquire the instance of a Controller class. Sample code to initialize the client library and using controller methods is given in the subsequent sections.

The generated SDK also contain one or more Tests, which are contained in the Tests project. In order to invoke these test cases, you will need NUnit 3.0 Test Adapter Extension for Visual Studio. Once the SDK is complied, the test cases should appear in the Test Explorer window. Here, you can click Run All to execute these test cases.

API client can be initialized as following.

TeksAPIClient client = new TeksAPIClient();

• AssociationsManagerController
• DefinitionsManagerController
• DocumentsManagerController
• ItemsManagerController
• PackagesManagerController
• RubricsManagerController

The singleton instance of the AssociationsManagerController class can be accessed from the API Client.

AssociationsManagerController associationsManager = client.AssociationsManager;

Tags: Skips Authentication

This is a request to the service provider to provide the information for the specific Competency Framework Association. If the identified record cannot be found then the 'unknownobject' status code must be reported.

Task<Models.CFAssociation> GetCFAssociation(string sourcedId)

string sourcedId = "sourcedId";

Models.CFAssociation result = await associationsManager.GetCFAssociation(sourcedId);

Tags: Skips Authentication

This is a request to the Service Provider to provide the all of the Competency Associations for the specified CFItem and the information about the CFItem itself. If the identified record cannot be found then the 'unknownobject' status code must be reported.

Task<Models.CFAssociationSet> GetCFItemAssociations(string sourcedId)

string sourcedId = "sourcedId";

Models.CFAssociationSet result = await associationsManager.GetCFItemAssociations(sourcedId);

Back to List of Controllers

The singleton instance of the DefinitionsManagerController class can be accessed from the API Client.

DefinitionsManagerController definitionsManager = client.DefinitionsManager;

Tags: Skips Authentication

This is a request to the Service Provider to provide the specified Competency Framework Association Grouping. If the identified record cannot be found then the 'unknownobject' status code must be reported.

Task<Models.CFAssociationGrouping> GetCFAssociationGrouping(string sourcedId)

string sourcedId = "sourcedId";

Models.CFAssociationGrouping result = await definitionsManager.GetCFAssociationGrouping(sourcedId);

Tags: Skips Authentication

This is a request to the Service Provider to provide the specified Competency Framework Concept and the set of children CFConcepts as identified by the hierarchy codes. If the identified record cannot be found then the 'unknownobject' status code must be reported.

Task<Models.CFConceptSet> GetCFConcept(string sourcedId)

string sourcedId = "sourcedId";

Models.CFConceptSet result = await definitionsManager.GetCFConcept(sourcedId);

Tags: Skips Authentication

This is a request to the Service Provider to provide the specified Competency Framework Item Type and the set of children CFItemTypes as identified by the hierarchy codes. If the identified record cannot be found then the 'unknownobject' status code must be reported.

Task<Models.CFItemTypeSet> GetCFItemType(string sourcedId)

string sourcedId = "sourcedId";

Models.CFItemTypeSet result = await definitionsManager.GetCFItemType(sourcedId);

Tags: Skips Authentication

This is a request to the Service Provider to provide the specified Competency Framework License. If the identified record cannot be found then the 'unknownobject' status code must be reported.

Task<Models.CFLicense> GetCFLicense(string sourcedId)

string sourcedId = "sourcedId";

Models.CFLicense result = await definitionsManager.GetCFLicense(sourcedId);

Tags: Skips Authentication

This is a request to the Service Provider to provide the specified Competency Framework Subject and the set of children CFSubjects as identified by the hierarchy codes. If the identified record cannot be found then the 'unknownobject' status code must be reported.

Task<Models.CFSubjectSet> GetCFSubject(string sourcedId)

string sourcedId = "sourcedId";

Models.CFSubjectSet result = await definitionsManager.GetCFSubject(sourcedId);

Back to List of Controllers

The singleton instance of the DocumentsManagerController class can be accessed from the API Client.

DocumentsManagerController documentsManager = client.DocumentsManager;

Tags: Skips Authentication

This is a request to the Service Provider to provide all of the Competency Framework Documents.

Task<Models.CFDocumentSet> GetAllCFDocuments(
        int? limit = 100,
        int? offset = 0,
        string sort = null,
        Models.OrderByEnum? orderBy = null,
        string filter = null,
        List<string> fields = null)

int? limit = 100;
int? offset = 0;
string sort = "sort";
var orderBy = Models.OrderByEnum?Helper.ParseString("asc");
string filter = "filter";
List<string> fields = new List<string> { "fields" };

Models.CFDocumentSet result = await documentsManager.GetAllCFDocuments(limit, offset, sort, orderBy, filter, fields);

Tags: Skips Authentication

This is a request to the service provider to provide the information for the specific Competency Framework Document. If the identified record cannot be found then the 'unknownobject' status code must be reported.

Task<Models.CFDocument> GetCFDocument(string sourcedId)

string sourcedId = "sourcedId";

Models.CFDocument result = await documentsManager.GetCFDocument(sourcedId);

Back to List of Controllers

The singleton instance of the ItemsManagerController class can be accessed from the API Client.

ItemsManagerController itemsManager = client.ItemsManager;

Tags: Skips Authentication

This is a request to the Service Provider to provide the specified Competency Framework Item. If the identified record cannot be found then the 'unknownobject' status code must be reported.

Task<Models.CFItem> GetCFItem(string sourcedId)

string sourcedId = "sourcedId";

Models.CFItem result = await itemsManager.GetCFItem(sourcedId);

Back to List of Controllers

The singleton instance of the PackagesManagerController class can be accessed from the API Client.

PackagesManagerController packagesManager = client.PackagesManager;

Tags: Skips Authentication

This is a request to the service provider to provide the information for the specific Competency Framework Package. If the identified record cannot be found then the 'unknownobject' status code must be reported.

Task<Models.CFPackage> GetCFPackage(string sourcedId)

string sourcedId = "sourcedId";

Models.CFPackage result = await packagesManager.GetCFPackage(sourcedId);

Back to List of Controllers

The singleton instance of the RubricsManagerController class can be accessed from the API Client.

RubricsManagerController rubricsManager = client.RubricsManager;

Tags: Skips Authentication

This is a request to the service provider to provide the information for the specific Competency Framework Rubric. If the identified record cannot be found then the 'unknownobject' status code must be reported.

Task<Models.CFRubricType> GetCFRubric(string sourcedId)

string sourcedId = "sourcedId";

Models.CFRubricType result = await rubricsManager.GetCFRubric(sourcedId);

Back to List of Controllers