Module Communications

From ETC Public Wiki
Jump to: navigation, search

The image below is the flow chart describing the communication between defined modules. Each module exposes an API (Application Programming Interface) that serves as endpoint for other modules).

Diagram

Example.jpg

Data Information

Modules

Core Module

Exhibit API

This API allows Exhbits to retrieve Avatars and award achievements.

Data IN Data OUT
  • Achievement identification (as given by exhibit)
  • timestamp
Avatar data

Onsite API

This API allows users at the Academy to locally modify their avatars and achievements, specifically it is a subset of what a guest can encounter at home in the Academy VC Website.

Analytics API

This API allows the Analytics module to recolect data on :

  • Users
  • Avatars
  • Achievements
  • Website Access
Data IN Data OUT
  • Valid credential (Academy staff only)
  • Users
  • Avatars
  • Achievements
  • Website Access

Access Technologies

Exhibit Access API

This API allows Exhibits to access ID hardware and identify the avatars linked to them

Data IN Data OUT
  • Technology piece ID
  • Avatar ID.

Onsite Access API

This API links an access technology piece to a specific avatar.

Data IN Data OUT
  • Avatar id
  • Confirmation of success / error.

Database API

This API allows the Analytics module to recolect data on the usage of the access technologies.

Data IN Data OUT
  • Valid credential (Academy staff only)
  • All data stored in the database

Ticket Access API

This API allow the linkage between a ticket at a show and an access technology.

Data IN Data OUT
  • Request for linkage
  • Confirmation of success / error.
  • access technology unique id