Student Portfolio Evidence

Create Evidence

post

Create a new evidence for a student portfolio

Path parameters

portfolioIdstringRequired

Student Portfolio UUID

Body

application/json

requirementIdstring · uuidRequired

descriptionstring | nullableRequired

reflectionstring | nullableRequired

linksstring[]Required

teammateCanvasIdsnumber[]Required

statusall of | nullableRequired

string · enumOptionalPossible values:

Responses

200

Evidence created successfully

application/json

post

HTTPcURLJavaScriptPython

POST /v1/student-portfolios/{portfolioId}/evidences HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 243

{
  "requirementId": "123e4567-e89b-12d3-a456-426614174000",
  "description": "text",
  "reflection": "text",
  "links": [
    "text"
  ],
  "attachments": [
    {
      "url": "text",
      "mimeType": "text",
      "fileSize": 1,
      "fileName": "text"
    }
  ],
  "teammateCanvasIds": [
    1
  ],
  "status": "not_submitted"
}

200

Evidence created successfully

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "requirementId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "not_submitted",
  "description": "text",
  "reflection": "text",
  "links": [
    "text"
  ],
  "attachments": [
    {
      "url": "text",
      "mimeType": "text",
      "fileSize": 1,
      "fileName": "text"
    }
  ],
  "teammateCanvasIds": [
    1
  ],
  "commentCount": 1,
  "skillCount": 1
}

Update Evidence

patch

Update an existing evidence for a student portfolio

Path parameters

uuidstringRequired

Evidence UUID

portfolioIdstringRequired

Student Portfolio UUID

Body

application/json

statusall of | nullableOptional

string · enumOptionalPossible values:

descriptionstring | nullableOptional

reflectionstring | nullableOptional

linksstring[]Optional

teammateCanvasIdsnumber[]Optional

Responses

200

Evidence updated successfully

application/json

patch

HTTPcURLJavaScriptPython

PATCH /v1/student-portfolios/{portfolioId}/evidences/{uuid} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "status": "not_submitted",
  "description": "text",
  "reflection": "text",
  "links": [
    "text"
  ],
  "attachments": [
    {
      "url": "text",
      "mimeType": "text",
      "fileSize": 1,
      "fileName": "text"
    }
  ],
  "teammateCanvasIds": [
    1
  ]
}

200

Evidence updated successfully

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "requirementId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "not_submitted",
  "description": "text",
  "reflection": "text",
  "links": [
    "text"
  ],
  "attachments": [
    {
      "url": "text",
      "mimeType": "text",
      "fileSize": 1,
      "fileName": "text"
    }
  ],
  "teammateCanvasIds": [
    1
  ],
  "commentCount": 1,
  "skillCount": 1
}

Get Evidence

get

Get a specific evidence by its UUID

Path parameters

uuidstringRequired

Evidence UUID

portfolioIdstringRequired

Student Portfolio UUID

Responses

200

Evidence retrieved successfully

application/json

401

User is not authorized to access this evidence.

404

Evidence not found.

get

HTTPcURLJavaScriptPython

GET /v1/student-portfolios/{portfolioId}/evidences/{uuid} HTTP/1.1
Host: 
Accept: */*

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "requirementId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "not_submitted",
  "description": "text",
  "reflection": "text",
  "links": [
    "text"
  ],
  "attachments": [
    {
      "url": "text",
      "mimeType": "text",
      "fileSize": 1,
      "fileName": "text"
    }
  ],
  "teammateCanvasIds": [
    1
  ],
  "commentCount": 1,
  "skillCount": 1
}

Delete Evidence

delete

Delete a specific evidence by its UUID

Path parameters

uuidstringRequired

Evidence UUID

portfolioIdstringRequired

Student Portfolio UUID

Responses

200

Evidence deleted successfully

No content

delete

HTTPcURLJavaScriptPython

DELETE /v1/student-portfolios/{portfolioId}/evidences/{uuid} HTTP/1.1
Host: 
Accept: */*

200

Evidence deleted successfully

No content

Get teammates

get

Retrieve teammates associated with a specific evidence

Path parameters

uuidstringRequired

Evidence UUID

portfolioIdstringRequired

Student Portfolio UUID

Responses

200

Teammates retrieved successfully

application/json

401

User is not authorized to access this evidence.

404

Evidence not found.

get

HTTPcURLJavaScriptPython

GET /v1/student-portfolios/{portfolioId}/evidences/{uuid}/teammates HTTP/1.1
Host: 
Accept: */*

[
  {
    "canvasUserId": 1,
    "name": "text",
    "email": "text",
    "avatarUrl": "text"
  }
]