Package edu.wisc.game.rest

The RESTful web API

The methods in GameService and GameService2 map to URLs which are used by the client to cause the server to perform various operations.

Software Copyright University Wisconsin-Madison, under Apache License, Version 2.0

Class Summary

Class	Description
ActivateBonusWrapper
AutomaticRuleGeneratorService	The AutomaticRuleGenerator demo service.
BoardDisplayService	HTML display for user-upload boards (in JSON format), for use by the ML team (Shubham)
BoardDisplayService.BoardList
CheckPlanService	The "Check my experiment plan" service.
ColorMap
Files	Information about the data files the Rule Game web server reads and writes
FileUploadResource
FileWriteReport	This data structure is converted to JSON and send to the client in response to the /writeFile web API call.
GameService	The "First Batch" of API calls, primarily for use in the research environment, where a player can choose any game to play
GameService2	The "Second Batch" of API calls, primarily for use with players constrained by an experiment plan, and playing a sequence of games as outlined in the trial list to which the player is assigned.
GameService2Html	The HTML wrapper for the Second Batch calls, to allow for the "HTML Play".
GameServiceHtml	The HTML wrapper for the First Batch calls, to allow for the "HTML Play".
GetBookletPageWrapper	Returns the content of the specified page of the instruction booklet for the specified player
GetSvgWrapper	Returns the content of the SVG file for the specified shape
GiveUpWrapper
GuessWriteReport	This data structure is converted to JSON and send to the client in response to the /guess web API call.
ListShapesWrapper	Lists all available shapes
ManagerDashboardService	Tools for the manager dashboard.
MlcUploadService	Uploading and processing results files by MLC participants.
NewEpisodeWrapper
NewEpisodeWrapper2	This is an object that's converted to a JSON structure and sent to the client as a response in /GameService2/newEpisode calls.
ParaSet
PlayerResponse	The object returned by the /player call.
PregameService	Retrieving various pages needed by the client to customize the player's pregame and postgame experience.
PregameService.BookletSize	An HTML page + error code
PregameService.Page	An HTML page + error code
PregameService.PregameResponseBase	Some info + error code
ResponseBase	The parent class for various structures that are returned, in JSON form,' by REST calls.
TrialList
TrialList.ExperimentPlanHandle	Identifies an experiment plan as a static or dynamic (P: or R: type) one
UserResponse	Used by LoginServlet and the Android app for registering new users and logging in

Enum Summary

Enum	Description
ParaSet.Incentive	Various incentive schemes available to experiment designers.