Includes

To avoid excess trips to the server, one can optionally get any associated records together with each resource. This is accomplished by using the includes parameter e.g. /v1/assignment?includes=unit,projects. This makes the server eager load the associated record and return them in the response. Each resource has specific association that it can include, and those may vary between Student and Lecturer. Refer to the params section of each Endpoint to see the available options for both Student and Lecturer. Each resource must be separated by comma, and the correct singular or plural form of the work must be used, depending on the nature of its relationship to the endpoint resource. For example, an Assignment has many projects, so the parametera passed should be projects, not project.

Available Associations for each Resource

Example

{
  "assignment": {
    "id": 3,
    "start_date": "2016-09-10",
    "end_date": "2017-02-01",
    "description": "Lorem ipsum dolor sit amet, pri in erant detracto antiopam, duis altera nostrud id eam. Feugait invenire ut vim, novum reprimique reformidans id vis, sit at quis hinc liberavisse. Eam ex sint elaboraret assueverit, sed an equidem reformidans, idque doming ut quo. Ex aperiri labores has, dolorem indoctum hendrerit has cu. At case posidonium pri.",
    "href": "/assignments/3",
    "unit": {
      "id": 1,
      "name": "Unit 193",
      "code": "OUuYh4VxV6yAcg==",
      "semester": "Spring",
      "year": 2014,
      "archived_at": null
    },
    "projects": [
      {
        "id": 1,
        "name": "Team 1",
        "logo": null,
        "enrollment_key": "2b43447611b6075b7e750c5fd7096bb0"
      },
      {
        "id": 2,
        "name": "Team 2",
        "logo": null,
        "enrollment_key": "fe55f11d0458ad599e51d5143a0b27ed"
      }
    ]
  }
}

Create Assignment

Request

POST /assignments

{
  "end_date": "2017-09-12",
  "lecturer": "9",
  "lecturer_id": "9",
  "name": "Assignment 0",
  "start_date": "2017-05-06",
  "unit_id": "1"
}

Response

Status: 201 -- Created

{
  "assignment": {
    "id": 5,
    "start_date": "2017-05-06T00:00:00.000Z",
    "end_date": "2017-09-12T00:00:00.000Z",
    "name": "Assignment 0",
    "unit_id": 1
  }
}

Example: Creating an Assignment with 2 Projects

Request

POST /assignments

{
  "end_date": "2017-08-06",
  "lecturer": "18",
  "lecturer_id": "18",
  "name": "Assignment 0",
  "projects_attributes": [
    {
      "description": "dddd",
      "enrollment_key": "key",
      "project_name": "New Project1",
      "team_name": "persons"
    },
    {
      "description": "descr",
      "enrollment_key": "key2",
      "project_name": "New Project2",
      "team_name": "persons2"
    }
  ],
  "start_date": "2017-05-06",
  "unit_id": "7"
}

Response

Status: 201 -- Created

{
  "assignment": {
    "id": 10,
    "start_date": "2017-05-06T00:00:00.000Z",
    "end_date": "2017-08-06T00:00:00.000Z",
    "name": "Assignment 0",
    "unit_id": 7,
    "projects": [
      {
        "id": 2,
        "assignment_id": 10,
        "project_name": "New Project2",
        "team_name": "persons2",
        "description": "descr",
        "logo": null,
        "enrollment_key": "key2",
        "unit_id": 7,
        "color": null,
        "pending_project_evaluation": false,
        "points": {
          "total": 0,
          "average": 0
        }
      },
      {
        "id": 1,
        "assignment_id": 10,
        "project_name": "New Project1",
        "team_name": "persons",
        "description": "dddd",
        "logo": null,
        "enrollment_key": "key",
        "unit_id": 7,
        "color": null,
        "pending_project_evaluation": false,
        "points": {
          "total": 0,
          "average": 0
        }
      }
    ]
  }
}

Example: Creating an Assignment with Game Settings

Request

POST /assignments/1/game_settings

{
  "end_date": "2017-10-04",
  "game_setting_attributes": {
    "max_logs_per_day": "3",
    "points_log": "86",
    "points_log_first_of_day": "10",
    "points_peer_assessment": "10",
    "points_peer_assessment_first_of_team": "10",
    "points_peer_assessment_submitted_first_day": "10",
    "points_project_evaluation": "10",
    "points_project_evaluation_first_of_team": "10",
    "points_project_evaluation_submitted_first_day": "10"
  },
  "lecturer": "27",
  "lecturer_id": "27",
  "name": "Assignment 0",
  "start_date": "2017-05-06",
  "unit_id": "13"
}

Response

Status: 201 -- Created

{
  "assignment": {
    "id": 15,
    "start_date": "2017-05-06T00:00:00.000Z",
    "end_date": "2017-10-04T00:00:00.000Z",
    "name": "Assignment 0",
    "unit_id": 13
  }
}

Example: Creating an Assignment with Iterations

Request

POST /assignments/1/game_settings

{
  "end_date": "2017-08-12",
  "iterations_attributes": [
    {
      "assignment": "20",
      "deadline": "2017-08-12",
      "name": "Analysis",
      "start_date": "2017-05-06"
    },
    {
      "assignment": "21",
      "deadline": "2017-08-12",
      "name": "Design",
      "start_date": "2017-05-06"
    }
  ],
  "lecturer": "36",
  "lecturer_id": "36",
  "name": "Assignment 0",
  "start_date": "2017-05-06",
  "unit_id": "19"
}

Response

Status: 201 -- Created

{
  "assignment": {
    "id": 22,
    "start_date": "2017-05-06T00:00:00.000Z",
    "end_date": "2017-08-12T00:00:00.000Z",
    "name": "Assignment 0",
    "unit_id": 19
  }
}

Example: Errors in projects_attributes

Request (Error)

POST /assignments

{
  "end_date": "2017-10-19",
  "lecturer": "60",
  "lecturer_id": "60",
  "name": "Assignment 0",
  "projects_attributes": [
    {
      "description": "dddd",
      "enrollment_key": "key",
      "project_name": "New Project1"
    },
    {
      "description": "descr",
      "enrollment_key": "key2",
      "team_name": "persons2"
    }
  ],
  "start_date": "2017-05-06",
  "unit_id": "35"
}

Response

Status: 422 -- Unprocessable Entity

{
  "errors": {
    "projects.project_name": [
      "can't be blank"
    ]
  }
}

Create a new Assignment. Only Lecturers can create a Assignment, and it will automatically be associated with the current user. Requires a unit_id, which must be a Unit that belongs to the current user. Can also create multiple Projects through the same request. See examples.

HTTP Request

POST http://example.com/v1/assignments

Query Parameters

Create Projects in same request

There is the Option of creating Projects for the Assignment through this endpoint. Pass the parameters for each project in an array, with "projects_attributes" as the key

{ "name": "New Unit", "projects_attributes": [ { "project_name": "New Project1", "team_name": "persons", "description": "dddd", "enrollment_key": "key" }, { "project_name": "New Project2", "team_name": "persons2", "description": "descr", "enrollment_key": "key2" } ] }

Projects will be validated normally, and errors will be returned in the response. If no team_name is specified, it will be autogenerated and it will follow the pattern 'Team 1', 'Team 2' etc.

Create Game Settings in same request

Game settings may also be created be passing its attributes insidde "game_setting_attributes". Note the singular 'setting'.

{ "points_log": 10, "points_log_first_of_day": 10, "points_log_first_of_team": 10, "points_log_first_of_assignment": 10, "points_peer_assessment": 10, "points_peer_assessment_first_of_day": 10, "points_peer_assessment_first_of_team": 10, "points_peer_assessment_first_of_assignment": 10, "points_project_evaluation": 10, "points_project_evaluation_first_of_day": 10, "points_project_evaluation_first_of_team": 10, "points_project_evaluation_first_of_assignment": 10 }

Game Settings will be validated normally, and if any values are ommited from the parameters, the default values will automatically be set.

Errors

Get Assignments

Request

GET /assignments

Response

Status: 200 -- OK

{
  "assignments": [
    {
      "id": 5,
      "start_date": "2017-05-06T00:00:00.000Z",
      "end_date": "2017-08-29T00:00:00.000Z",
      "name": "Assignment 0",
      "unit_id": 1,
      "pa_form": {
        "pa_form": {
          "id": 1,
          "iteration_id": 1,
          "questions": [
            {
              "text": "What do you typically have for breakfast?",
              "type_id": 1,
              "question_id": 1,
              "question_type": {
                "id": 1,
                "question_type": "text",
                "friendly_name": "name"
              }
            },
            {
              "text": "Could you ever hand milk a cow?",
              "type_id": 1,
              "question_id": 2,
              "question_type": {
                "id": 1,
                "question_type": "text",
                "friendly_name": "name"
              }
            },
            {
              "text": "Have you ever been in a helicopter?",
              "type_id": 1,
              "question_id": 3,
              "question_type": {
                "id": 1,
                "question_type": "text",
                "friendly_name": "name"
              }
            },
            {
              "text": "If you were a fashion designer, what style of clothing or accessories would you design?",
              "type_id": 1,
              "question_id": 4,
              "question_type": {
                "id": 1,
                "question_type": "text",
                "friendly_name": "name"
              }
            },
            {
              "text": "Can you play poker?",
              "type_id": 1,
              "question_id": 5,
              "question_type": {
                "id": 1,
                "question_type": "text",
                "friendly_name": "name"
              }
            }
          ],
          "start_date": "2017-08-31T03:00:00.000+03:00",
          "deadline": "2017-09-03T03:00:00.000+03:00"
        }
      }
    },
    {
      "id": 3,
      "start_date": "2017-05-06T00:00:00.000Z",
      "end_date": "2017-09-19T00:00:00.000Z",
      "name": "Assignment 0",
      "unit_id": 2
    },
    {
      "id": 2,
      "start_date": "2017-05-06T00:00:00.000Z",
      "end_date": "2017-09-04T00:00:00.000Z",
      "name": "Assignment 0",
      "unit_id": 1
    },
    {
      "id": 1,
      "start_date": "2017-05-06T00:00:00.000Z",
      "end_date": "2017-08-14T00:00:00.000Z",
      "name": "Assignment 0",
      "unit_id": 1
    }
  ]
}

Example: Get Assingments for specific Unit

Request

GET /assignments

{
  "unit_id": "1"
}

Response

Status: 200 -- OK

{
  "assignments": [
    {
      "id": 2,
      "start_date": "2017-05-06T00:00:00.000Z",
      "end_date": "2017-09-04T00:00:00.000Z",
      "name": "Assignment 0",
      "unit_id": 1
    },
    {
      "id": 1,
      "start_date": "2017-05-06T00:00:00.000Z",
      "end_date": "2017-08-14T00:00:00.000Z",
      "name": "Assignment 0",
      "unit_id": 1
    }
  ]
}

Returns all the Assignments for the current user. If a unit_id is passed in the parameters, the assignments will be scoped to that Unit.

HTTP Request

GET http://example.com/v1/assignments

Query Parameters

Errors

Update Assignment

Request

PATCH /assignments/:id

{
  "name": "new name",
  "id": "34"
}

Response

Status: 200 -- OK

{
  "assignment": {
    "id": 34,
    "start_date": "2017-05-06T00:00:00.000Z",
    "end_date": "2017-08-13T00:00:00.000Z",
    "name": "new name",
    "unit_id": 42
  }
}

Update an Assignment. Only Lecturers can create a Assignment, and it will automatically be associated with the current user. Requires a unit_id, which must be a Unit that belongs to the current user. Can also create multiple Projects through the same request. See examples.

HTTP Request

PATCH http://example.com/v1/assignments/:id

Query Parameters

There is the Option of creating Projects for the Assignment through this endpoint. Pass the parameters for each project in an array, with "projects_attributes" as the key

{ "name": "New Unit", "projects_attributes": [ { "project_name": "New Project1", "team_name": "persons", "description": "dddd", "enrollment_key": "key" }, { "project_name": "New Project2", "team_name": "persons2", "description": "descr", "enrollment_key": "key2" } ] }

Projects will be validated normally, and errors will be returned in the response.

Errors

Delete Assignment

Delete an Assignment. Only the Lecturer that created it may do so.

HTTP Request

DELETE http://example.com/v1/assignments/:id

Query Parameters

Errors

Sign In

Request

POST /sign_in

{
  "email": "alfredo66640_jump47088@gmail.com",
  "password": "12345678"
}

Response

Status: 200 -- OK

{
  "user": {
    "id": 2,
    "first_name": "Alfredo344",
    "last_name": "Jumpveryhigh45",
    "email": "alfredo66640_jump47088@gmail.com",
    "type": "Lecturer",
    "provider": "email",
    "avatar_url": "http://i.pravatar.cc/100",
    "position": "Master of Parking",
    "university": "University of Important Potato"
  }
}

Request (Error)

POST /sign_in

{
  "email": "alfredo88898_jump8272@gmail.com",
  "password": "wrongpassword"
}

Response

Status: 401 -- Unauthorized

{
  "errors": {
    "base": [
      "Invalid Login Credentials"
    ]
  }
}

Request (Error)

POST /sign_in

{
  "email": "alfredo63302_jump90718@gmail.com",
  "password": "12345678",
  "remember_me": "true"
}

Response

Status: 401 -- Unauthorized

{
  "errors": {
    "base": [
      "remember_me must be either '0' or '1'. Received value: true"
    ],
    "email": [
      "is unconfirmed"
    ]
  }
}

Request (Error)

POST /sign_in

{
  "email": "alfredo91707_jump8968@gmail.com",
  "password": "12345678"
}

Response

Status: 401 -- Unauthorized

{
  "errors": {
    "email": [
      "is unconfirmed"
    ]
  }
}

Sign In using Email and Password. The user must have confirmed their account through the confirmation email sent after /register. On successful authentication, the user is returned. The XSRF-TOKEN header is added to the response, which should be saved on the client, to be added in subsequent requests under the header X-XSRF-TOKEN. The response also sets two cookies, one with the access-token, and one with the refresh-token, which are secure and http-only, thus they are not accessible via javascript, and require no further action for the client in order to use them. The access-token cookie will automatically be sent to all subsequent requests, while the refresh-token cookie will only be sent to the /refresh path. The remember_me param should be either '0' for false, or '1' for true.

HTTP Request

POST http://example.com/v1/sign_in

Query Parameters

Errors

Me

Request

GET /me

Response

Status: 200 -- OK

{
  "user": {
    "id": 5,
    "first_name": "Alfredo227",
    "last_name": "Jumpveryhigh235",
    "email": "alfredo32353_jump75759@gmail.com",
    "type": "Lecturer",
    "provider": "email",
    "avatar_url": "http://i.pravatar.cc/100",
    "position": "Master of Parking",
    "university": "University of Important Potato"
  }
}

Authenticate with the server after exiting the application. Returns the current_user in the response body. Due to the short expiration time of the access-token, requests to this endpoint will most likely be successful for a short period of time. If the request is not successful, the application should send a request to the /refresh route, in order to receive a new access-token.

HTTP Request

GET http://example.com/v1/me

Errors

Update Department

Update Department

HTTP Request

PATCH http://example.com/v1/departments/:id

Query Parameters

Errors

Delete Department

Delete Department

HTTP Request

DELETE http://example.com/v1/departments/:id

Query Parameters

Errors

Get Form Templates

Request

GET /form_templates

Response

Status: 200 -- OK

{
  "form_templates": [
    {
      "id": 1,
      "name": "Sublimely Self-Righteous Ale Template",
      "lecturer_id": 1,
      "questions": [
        {
          "text": "At what age did you twig onto the fact Santa wasnt real?",
          "type_id": 1,
          "question_id": 1,
          "question_type": {
            "id": 1,
            "question_type": "text",
            "friendly_name": "name"
          }
        },
        {
          "text": "What horror fiction character scares you the most?",
          "type_id": 1,
          "question_id": 2,
          "question_type": {
            "id": 1,
            "question_type": "text",
            "friendly_name": "name"
          }
        },
        {
          "text": "If you were to join an emergency service which would it be?",
          "type_id": 1,
          "question_id": 3,
          "question_type": {
            "id": 1,
            "question_type": "text",
            "friendly_name": "name"
          }
        },
        {
          "text": "Could you ever hand milk a cow?",
          "type_id": 1,
          "question_id": 4,
          "question_type": {
            "id": 1,
            "question_type": "text",
            "friendly_name": "name"
          }
        },
        {
          "text": "What historical period would you like to live in if you could go back in time?",
          "type_id": 1,
          "question_id": 5,
          "question_type": {
            "id": 1,
            "question_type": "text",
            "friendly_name": "name"
          }
        }
      ]
    },
    {
      "id": 2,
      "name": "La Fin Du Monde Template",
      "lecturer_id": 1,
      "questions": [
        {
          "text": "What do you think the greatest invention has been?",
          "type_id": 1,
          "question_id": 1,
          "question_type": {
            "id": 1,
            "question_type": "text",
            "friendly_name": "name"
          }
        },
        {
          "text": "If you were a fashion designer, what style of clothing or accessories would you design?",
          "type_id": 1,
          "question_id": 2,
          "question_type": {
            "id": 1,
            "question_type": "text",
            "friendly_name": "name"
          }
        },
        {
          "text": "Could you ever hand milk a cow?",
          "type_id": 1,
          "question_id": 3,
          "question_type": {
            "id": 1,
            "question_type": "text",
            "friendly_name": "name"
          }
        },
        {
          "text": "Can you solve sudoko puzzles?",
          "type_id": 1,
          "question_id": 4,
          "question_type": {
            "id": 1,
            "question_type": "text",
            "friendly_name": "name"
          }
        },
        {
          "text": "If you were to join an emergency service which would it be?",
          "type_id": 1,
          "question_id": 5,
          "question_type": {
            "id": 1,
            "question_type": "text",
            "friendly_name": "name"
          }
        }
      ]
    }
  ]
}

Returns all the Form Templates associated with the current user.

HTTP Request

GET http://example.com/v1/form_templates

Errors

Create Form Template

Request

POST /form_templates

{
  "name": "new name",
  "questions": [
    {
      "text": "If you were to join an emergency service which would it be?",
      "type_id": "5"
    },
    {
      "text": "Have you ever been approached by someone who knew you but you couldn't remember them for the life of you?",
      "type_id": "5"
    },
    {
      "text": "Do you prefer Honey or Jam?",
      "type_id": "5"
    },
    {
      "text": "What do you think the greatest invention has been?",
      "type_id": "5"
    },
    {
      "text": "What do you typically have for breakfast?",
      "type_id": "5"
    }
  ]
}

Response

Status: 201 -- Created

{
  "form_template": {
    "id": 6,
    "name": "new name",
    "lecturer_id": 8,
    "questions": [
      {
        "question_id": 1,
        "text": "If you were to join an emergency service which would it be?",
        "type_id": "5"
      },
      {
        "question_id": 2,
        "text": "Have you ever been approached by someone who knew you but you couldn't remember them for the life of you?",
        "type_id": "5"
      },
      {
        "question_id": 3,
        "text": "Do you prefer Honey or Jam?",
        "type_id": "5"
      },
      {
        "question_id": 4,
        "text": "What do you think the greatest invention has been?",
        "type_id": "5"
      },
      {
        "question_id": 5,
        "text": "What do you typically have for breakfast?",
        "type_id": "5"
      }
    ]
  }
}

Create a new Form Template. The lecturer_id is automatically set to the current user's id.

HTTP Request

POST http://example.com/v1/form_templates

Query Parameters

Errors

Update Form Template

Request

PATCH /form_templates/:id

{
  "name": "new name",
  "questions": [
    {
      "text": "Can you solve sudoko puzzles?",
      "type_id": "2"
    },
    {
      "text": "Have you ever been approached by someone who knew you but you couldn't remember them for the life of you?",
      "type_id": "2"
    },
    {
      "text": "What historical period would you like to live in if you could go back in time?",
      "type_id": "2"
    },
    {
      "text": "Whats your favourite alcoholic drink beginning with the letter V?",
      "type_id": "2"
    },
    {
      "text": "What are cooler? Dinosaurs or Dragons?",
      "type_id": "2"
    }
  ],
  "id": "3"
}

Response

Status: 200 -- OK

{
  "form_template": {
    "id": 3,
    "name": "new name",
    "lecturer_id": 4,
    "questions": [
      {
        "question_id": 1,
        "text": "Can you solve sudoko puzzles?",
        "type_id": "2"
      },
      {
        "question_id": 2,
        "text": "Have you ever been approached by someone who knew you but you couldn't remember them for the life of you?",
        "type_id": "2"
      },
      {
        "question_id": 3,
        "text": "What historical period would you like to live in if you could go back in time?",
        "type_id": "2"
      },
      {
        "question_id": 4,
        "text": "Whats your favourite alcoholic drink beginning with the letter V?",
        "type_id": "2"
      },
      {
        "question_id": 5,
        "text": "What are cooler? Dinosaurs or Dragons?",
        "type_id": "2"
      }
    ]
  }
}

Update a Form Template.

HTTP Request

PATCH http://example.com/v1/form_templates/:id

Query Parameters

Errors

Delete Form Template

Request

PATCH /form_templates/:id

{
  "id": "7"
}

Response

Status: 204 -- No Content

{
  ""
}

Delete a Form Template. It must belong to the current user.

HTTP Request

DELETE http://example.com/v1/assignments/:id

Query Parameters

Errors

Get Game Setting

Request

GET /assignments/1/game_settings

{
  "assignment_id": "1"
}

Response

Status: 200 -- OK

{
  "game_settings": {
    "id": 1,
    "assignment_id": 1,
    "points_log": 10,
    "points_log_first_of_day": 10,
    "points_peer_assessment": 10,
    "points_peer_assessment_first_of_team": 10,
    "points_project_evaluation": 10,
    "points_project_evaluation_first_of_team": 10,
    "points_project_evaluation_submitted_first_day": 10,
    "points_peer_assessment_submitted_first_day": 10,
    "max_logs_per_day": 3
  }
}

Update the values of the project settings for an Assignment

HTTP Request

GET http://example.com/v1/assignments/:assignment_id/game_settings

Query Parameters

Errors

Create Game Setting

Request

POST /assignments/4/game_settings

{
  "assignment_id": "4"
}

Response

Status: 201 -- Created

{
  "game_settings": {
    "id": 2,
    "assignment_id": 4,
    "points_log": 50,
    "points_log_first_of_day": 0,
    "points_peer_assessment": 50,
    "points_peer_assessment_first_of_team": 5,
    "points_project_evaluation": 50,
    "points_project_evaluation_first_of_team": 5,
    "points_project_evaluation_submitted_first_day": 20,
    "points_peer_assessment_submitted_first_day": 20,
    "max_logs_per_day": 3
  }
}

Request

POST /assignments/5/game_settings

{
  "max_logs_per_day": "3",
  "points_log": "10",
  "points_log_first_of_day": "10",
  "points_peer_assessment": "10",
  "points_peer_assessment_first_of_team": "10",
  "points_peer_assessment_submitted_first_day": "10",
  "points_project_evaluation": "10",
  "points_project_evaluation_first_of_team": "10",
  "points_project_evaluation_submitted_first_day": "10",
  "assignment_id": "5"
}

Response

Status: 201 -- Created

{
  "game_settings": {
    "id": 3,
    "assignment_id": 5,
    "points_log": 10,
    "points_log_first_of_day": 10,
    "points_peer_assessment": 10,
    "points_peer_assessment_first_of_team": 10,
    "points_project_evaluation": 10,
    "points_project_evaluation_first_of_team": 10,
    "points_project_evaluation_submitted_first_day": 10,
    "points_peer_assessment_submitted_first_day": 10,
    "max_logs_per_day": 3
  }
}

Example: Error: Parameter is not a number

Request (Error)

POST /assignments/6/game_settings

{
  "max_logs_per_day": "3",
  "points_log": "wrong",
  "points_log_first_of_day": "10",
  "points_peer_assessment": "10",
  "points_peer_assessment_first_of_team": "10",
  "points_peer_assessment_submitted_first_day": "10",
  "points_project_evaluation": "10",
  "points_project_evaluation_first_of_team": "10",
  "points_project_evaluation_submitted_first_day": "10",
  "assignment_id": "6"
}

Response

Status: 422 -- Unprocessable Entity

{
  "errors": {
    "points_log": [
      "is not a number"
    ]
  }
}

Creates a new Game Setting for an Assignment. Parameters that are not provided will be replaced with the default values.

HTTP Request

POST http://example.com/v1/assignments/:assignment_id/game_settings

Query Parameters

Errors

Update Game Setting

Request

PATCH /assignments/1/game_settings

{
  "max_logs_per_day": "3",
  "points_log": "90",
  "points_log_first_of_day": "10",
  "points_peer_assessment": "10",
  "points_peer_assessment_first_of_team": "10",
  "points_peer_assessment_submitted_first_day": "10",
  "points_project_evaluation": "10",
  "points_project_evaluation_first_of_team": "10",
  "points_project_evaluation_submitted_first_day": "10",
  "assignment_id": "1"
}

Response

Status: 200 -- OK

{
  "game_settings": {
    "id": 1,
    "assignment_id": 1,
    "points_log": 90,
    "points_log_first_of_day": 10,
    "points_peer_assessment": 10,
    "points_peer_assessment_first_of_team": 10,
    "points_project_evaluation": 10,
    "points_project_evaluation_first_of_team": 10,
    "points_project_evaluation_submitted_first_day": 10,
    "points_peer_assessment_submitted_first_day": 10,
    "max_logs_per_day": 3
  }
}

Update the values of the project settings for an Assignment

HTTP Request

PATCH http://example.com/v1/assignments/:assignment_id/game_settings

Query Parameters

Errors

Get Assignment Iterations

Request

GET /iterations

{
  "assignment_id": "2"
}

Response

Status: 200 -- OK

{
  "iterations": [
    {
      "id": 2,
      "name": "Implementation",
      "start_date": "2017-05-06T00:00:00.000Z",
      "deadline": "2017-11-11T00:00:00.000Z",
      "assignment_id": 2
    },
    {
      "id": 3,
      "name": "Testing",
      "start_date": "2017-05-06T00:00:00.000Z",
      "deadline": "2017-11-11T00:00:00.000Z",
      "assignment_id": 2
    }
  ]
}

Returns all Iterations for a specific Assignment. Needs assignment_id in the params.

HTTP Request

GET http://example.com/v1/iterations

Query Parameters

Errors

Get Specific Iteration

Request

GET /iterations/2

{
  "id": "2"
}

Response

Status: 200 -- OK

{
  "iteration": {
    "id": 2,
    "name": "Implementation",
    "start_date": "2017-05-06T00:00:00.000Z",
    "deadline": "2017-11-11T00:00:00.000Z",
    "assignment_id": 2
  }
}

Returns a specific iteration

HTTP Request

GET http://example.com/v1/iterations/:id

Query Parameters

Errors

Create Iteration for Assignment

Request

POST /iterations

{
  "assignment_id": "1",
  "deadline": "2017-08-06T01:42:15+03:00",
  "name": "name",
  "start_date": "2017-05-13T01:42:15+03:00"
}

Response

Status: 201 -- Created

{
  "iteration": {
    "id": 4,
    "name": "name",
    "start_date": "2017-05-12T22:42:15.000Z",
    "deadline": "2017-08-05T22:42:15.000Z",
    "assignment_id": 1
  }
}

Example: Create Iteration with PaForm

Request

POST /iterations

{
  "assignment_id": "1",
  "deadline": "2017-08-06T01:42:15+03:00",
  "name": "name",
  "pa_form_attributes": {
    "end_offset": "432000",
    "questions": [
      {
        "text": "At what age did you twig onto the fact Santa wasnt real?",
        "type_id": "3"
      },
      {
        "text": "Can you play poker?",
        "type_id": "3"
      },
      {
        "text": "What are cooler? Dinosaurs or Dragons?",
        "type_id": "3"
      },
      {
        "text": "If you had friends round what DVDs would you have to watch?",
        "type_id": "3"
      },
      {
        "text": "Whats your favourite alcoholic drink beginning with the letter V?",
        "type_id": "3"
      }
    ],
    "start_offset": "172800"
  },
  "start_date": "2017-05-13T01:42:15+03:00"
}

Response

Status: 201 -- Created

{
  "iteration": {
    "id": 5,
    "name": "name",
    "start_date": "2017-05-12T22:42:15.000Z",
    "deadline": "2017-08-05T22:42:15.000Z",
    "assignment_id": 1
  }
}

Create a new Iteration for an Assignment. This endpoint can also receive attributes and create the PaForm of the Iteration. The Iteration duration must fall between the start_date and end_date of the associated Assignment.

HTTP Request

POST http://example.com/v1/iterations

Query Parameters

pa_form_attributes

Query Parameters

Errors

Update Iteration

Request

PATCH /projects/2

{
  "name": "different",
  "id": "2"
}

Response

Status: 200 -- OK

{
  "iteration": {
    "id": 2,
    "name": "different",
    "start_date": "2017-05-06T00:00:00.000Z",
    "deadline": "2017-11-11T00:00:00.000Z",
    "assignment_id": 2
  }
}

Update Iteration

HTTP Request

PATCH http://example.com/v1/iterations/:id

Query Parameters

Errors

Delete Iteration

Delete Iteration

HTTP Request

DELETE http://example.com/v1/iterations/:id

Query Parameters

Errors

Get Student's logs for Project

Request

GET /projects/12/logs?student_id=38

{
  "student_id": "38",
  "id": "1"
}

Response

Status: 200 -- OK

{
  "logs": [
    {
      "text": "Worked on database and use cases",
      "stage": "Analysis",
      "date_worked": "1493937737",
      "time_worked": "36000",
      "date_submitted": "1494024137"
    },
    {
      "text": "Worked on database and use cases",
      "stage": "Analysis",
      "date_worked": "1493937737",
      "time_worked": "36000",
      "date_submitted": "1494024137"
    }
  ]
}

Get all the logs for a specific Student, in a Specific Project

HTTP Request

GET http://example.com/v1/projects/:id/logs

Query Parameters

Errors

Create new PA Form

Request

POST /pa_forms

{
  "deadline": "2017-09-29 00:00:00 UTC",
  "iteration_id": "1",
  "questions": [
    {
      "text": "Who is it?",
      "type_id": "4"
    },
    {
      "text": "Human?",
      "type_id": "4"
    },
    {
      "text": "Hello?",
      "type_id": "3"
    },
    {
      "text": "Favorite Power Ranger?",
      "type_id": "4"
    }
  ],
  "start_date": "2017-09-27 00:00:00 UTC"
}

Response

Status: 201 -- Created

{
  "pa_form": {
    "id": 3,
    "iteration_id": 1,
    "questions": [
      {
        "question_id": 1,
        "text": "Who is it?",
        "type_id": "4"
      },
      {
        "question_id": 2,
        "text": "Human?",
        "type_id": "4"
      },
      {
        "question_id": 3,
        "text": "Hello?",
        "type_id": "3"
      },
      {
        "question_id": 4,
        "text": "Favorite Power Ranger?",
        "type_id": "4"
      }
    ],
    "start_date": "2017-09-27T03:00:00.000+03:00",
    "deadline": "2017-09-29T03:00:00.000+03:00"
  }
}