Skip to main content

APIResponse

API response for the REX system.

colors object

Colors used in the REX system, used for display in the booklet and on the website.

dorms object

Colors for dorms, used for display in the booklet and on the website

property name*string<color>
groups object

Colors for groups within dorms, used for display in the booklet and on the website

property name* object
property name*string<color>
tags object

Colors for tags, used for display in the booklet and on the website

property name*string<color>
dormsstring[]

All dorms in the REX system, used for display in the booklet and on the website.

Default value: []
endstring<date>

End date of REX, used for display in the booklet and on the website.

events object[]

List of events in the REX system, used for display in the booklet and on the website. Can be uniquely identified by the Event.id field.

  • Array [
    • descriptionDescription (string)required

    Event description, displayed in the booklet

    Possible values: <= 280 characters

    dormstring[]required

    Dorms hosting the event. While typically a single dorm, this can also be multiple dorms.

    endstring<date-time>required

    Event end time

    group object

    Subcommunities running/hosting the event

    anyOf
  • Array [
    • string
  • ]
    • idId (string)required

    4-Digit Event Code, used for linking, bookmarking, and making event revisions.

    Possible values: >= 4 characters and <= 4 characters

    locationLocation (string)required

    Location of the event

    Possible values: <= 50 characters

    nameName (string)required

    Event name

    Possible values: <= 100 characters

    startstring<date-time>required

    Event start time

    tagsstring[]required

    Tags associated with the event, used for filtering and display

  • ]
    • groups object

    A dictionary mapping dorms to their groups, used for display in the booklet and on the website.

    property name* string[]
  • Array [
    • string
  • ]
    • nameName (string)

    Name of the REX season, e.g. 'REX 2025'

    publishedstring<date-time>

    When the API was published, used for display in the booklet and on the website

    startstring<date>

    Start date of REX, used for display in the booklet and on the website.

    tagsstring[]

    All tags in the REX system, used for display in the booklet and on the website.

    Default value: []
    APIResponse
    {
      "colors": {
        "dorms": {},
        "groups": {},
        "tags": {}
      },
      "dorms": [
        "string"
      ],
      "end": "2024-07-29",
      "events": [
        {
          "description": "string",
          "dorm": [
            "string"
          ],
          "end": "2024-07-29T15:51:28.071Z",
          "group": [
            "string"
          ],
          "id": "string",
          "location": "string",
          "name": "string",
          "start": "2024-07-29T15:51:28.071Z",
          "tags": [
            "string"
          ]
        }
      ],
      "groups": {},
      "name": "string",
      "published": "2024-07-29T15:51:28.071Z",
      "start": "2024-07-29",
      "tags": [
        "string"
      ]
    }