Skip to main content

APIResponse

API response for the REX system.

colors objectrequired

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

dorms objectrequired

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

property name*color
groups objectrequired

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

property name* object
property name*color
tags objectrequired

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

property name*color
dormsstring[]required

List of dorms in the REX system, used for display in the booklet and on the website

enddaterequired

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

events object[]required

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 [
    • descriptionDescriptionrequired

    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.

    enddate-timerequired

    Event end time

    groupstring[]

    Subcommunities running/hosting the event

    idIdrequired

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

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

    locationLocationrequired

    Location of the event

    Possible values: <= 50 characters

    nameNamerequired

    Event name

    Possible values: <= 100 characters

    startdate-timerequired

    Event start time

    tagsstring[]required

    Tags associated with the event, used for filtering and display

  • ]
    • groups objectrequired

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

    property name* string[]
  • Array [
    • string
  • ]
    • nameNamerequired

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

    publisheddate-timerequired

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

    startdaterequired

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

    tagsstring[]required

    List of tags in the REX system, used for display in the booklet and on the website

    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"
      ]
    }