Skip to content

Latest commit

 

History

History
57 lines (42 loc) · 1.94 KB

SPECIFICATION.md

File metadata and controls

57 lines (42 loc) · 1.94 KB

Specification

Entities

Location

A location is a physical place that an agent may be stationed

  • Site Name is the codename for that location, e.g. MI6
  • Location is the long description of the location, e.g. London
  • Time Zone is the time zone in one of the following formats:
    • UTC: 'UTC', 'UT or 'GMT'
    • Offsets: '+01:00', 'UTC-02:00', 'GMT+03:00' etc.
    • Zone ID: 'Europe/London', 'America/New_York' etc.

Region

A region encompassing an area in the world

  • Region Name is the name for that region, e.g. England
  • Locations are locations that fall under that region

Location Report

A report from a specific agent about a specific location

  • Location is the location that the report was made
  • Status is a numeric code for the report type (the significance of any particular code is secret)
  • Time is the time of the report, calculated on submission
  • Body is the content of the report

Region Summary

Region summaries are similar to reports, but made for an entire region

  • Region is the region which the summary covers
  • Status is a numeric code for the region status
  • Time is the time of the summary, calculated on submission
  • Body is the content of the summary

Users

A user is somebody who can access the site by logging in with their username and password. This gives them permission to:

  • View their profile
  • Encode and Decode today's message

A user with admin set to true is also an administrator, this gives them permission to:

  • Manage regions, locations and users
  • Search location reports and region summaries

Agents

A user may also be associated with a particular agent. This requires some additional information:

  • Call Sign is the agent's codename
  • First Name and Last Name are their real names
  • Date of Birth is self-explanatory
  • Rank is their current ranking level

An agent may submit location reports and region summaries.