Dyknow/Reveal API Integration Fields

INTRODUCTION

A note about data representations: There are three different representations of the same data objects (first names, last names, etc) when dealing with Student Information Systems: the Database Column, the API Responses, and the UI Field. Between these three, some names can be the same while others may be different.

The Database Column is the name of the "column" for a specific table of information. Example: The "Student" table may have columns such as "FirstName", "LastName", "Birthday", etc.

The API Responses uses the database to create endpoints which will group together database columns to make a logical structure that is more broad than just a specific column in the database. Example: The "Enrollments" endpoint may have a "ClassName", "TeacherId", and a collection of "Students", where "Students" would be a collection of students each with their own data pulled from the columns in the "Student" table in the database.

The UI Field is the name used when managing data in a User Interface. These are a mixed bag of database columns and other representations of data (much like the "Enrollments" endpoint).

POWERSCHOOL

INFINITE CAMPUS

/// <summary>
/// UserAccount.UserName
/// System Administration > User Security > User Account
"We pull user account details from a single account, regardless of roles. If a person has multiple user accounts we grab the first account in this order: 1) Campus Application, 2) Campus Instruction, 3) Campus Portal, 4) Student Portal, 5) Highest UserID from any Other Account"
/// </summary>

SKYWARD

Unfortunately, we do not have a source for this documentation, but we would be happy to jump on a remote session with a willing participant to figure out the mappings.

BLACKBAUD

Unfortunately, we do not have a source for this documentation, but we would be happy to jump on a remote session with a willing participant to figure out the mappings.