Child pages
  • Program Information API Use Cases

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added use cases to cover alternate IDs

...

ID

PIAPI-009

Title

A Specific Program is Offered by More Than One School/Program

Actors

Data Consumer - app, website, BI tool, etc

Data Provider - AAMC, FAIMER, etc

Trigger event

A user or system (data consumer) queries for a school/program by ID.

Success end condition

The Data Consumer receives school/program data that includes program data, which contains links to other schools/programs offering this program.

Assumptions

The data consumer has access to the data provider.

Description

A third party user or system (data consumer) requests school/program data by ID.

The data provider knows a program offered by this school/program is also offered by another school/program.

The data provider includes links to the other school’s/program's data.

The data provider returns school/program data, which includes links to the other school’s/program's data that offers the same program.

Transaction

Requesting a single record of school/program data from another system.

Exceptions

 

Potential Standards

School Data

Program Data

School/Program Data Application Programming Interface (API)

 

Data Provider

...

Includes Alternate IDs for School or Program Data 

ID

PIAPI-010

Title

Data Provider Supplies Additional FieldsIncludes Alternate IDs for School or Program Data

Actors

Data Consumer - app, website, BI tool, etc

Data Provider - AAMC, FAIMER, etc

Trigger event

A user or system requests school/program data from a Data Provider.

Success end condition

The Data Consumer receives all publicly available data for the school/program, plus additional information known by the specific Data Providerincluding alternate IDs for the data.

Assumptions

The data consumer has access to the data provider.

Description

A third party user or system (data consumer) wants school/program data.

That user or system makes a request to the system that maintains the list of schools/programs (data provider).

The maintaining system has additional information beyond what is defined in the response data model.The maintaining system uses a specified method to include additional data and returns the data provider has alternate IDs for the school/program.

The data provider returns the specific school/program data to the third party user or system, including the alternate IDs.

Transaction

Requesting a single record of school/program data from another system.

Exceptions

 

Potential Standards

School Data

Program Data

School/Program Data Application Programming Interface (API)

Data Consumer Retrieves School or Program Data Using an Alternate ID

ID

PIAPI-011

Title

Data Consumer Retrieves School or Program Data Using an Alternate ID

Actors

Data Consumer - app, website, BI tool, etc

Data Provider - AAMC, FAIMER, etc

Trigger event

A user or system requests school/program data from a Data Provider using an ID from another organization.

Success end condition

The Data Consumer receives all publicly available data for the school/program.

Assumptions

The data consumer has access to the data provider.

Description

A third party user or system is able to parse the data including the additional data(data consumer) wants school/program data.

That user or system makes a request to the system that maintains the list of schools/programs (data provider) using an ID from another organization.

The data provider maps the provided ID to its local identifier for the school/program.

The maintaining system returns the specific school/program data to the third party user or system.

Transaction

Requesting a single record of school/program data from another system.

Exceptions

 

Potential Standards

School Data

Program Data

School/Program Data Application Programming Interface (API)