CCCTC Docs

CCCTC Docs

  • Help

Overview

The placement adapter runs at the college but must communicate securely with the API Gateway.

Access to student placement data will be limited as detailed below.

Business Case

This service should run standalone on windows. Additionally, it may run aligned with other Tech Platform services as a Docker image using Rancher.

We will promote a "standard" deployment with Docke, but to help colleges adopt the Technology Platform, must also allow a detached way to run and get placement data.

API Gateway

Placement data is written to Amazon s3 as described here: Student Placement

Service Router

Authorization and service routing by URI are described below.

Authorization

Proper Authentication and Authorization credentials are required to access all endpoints.

Each placement adapter is given client credentials (CLIENT_ID / CLIENT_SECRET). Each deployment will have their own client credentials and this will be used to authorize access to placement data.

Example:

GET {{ROUTER}}/student-placements/001

This is secure to clients who have all the roles (PLACEMENT, 001) associated with their CLIENT_ID.

This would allow access to placement data only for mis 001.

Servie Conductor

Workflow Definitions

A new workflow for the above URI will be called.

The workflow will interact with the s3 microservice (see S3) to retrieve all new placement data for that mis code.

Related links:

PLATFORM-24

CONDUCTOR-76

CONDUCTOR-35

PLATFORM-31