{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pure activity studentProject API",
    "version": "5.35.3-4"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "api-key",
      "value": "{{api-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "studentProject",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists all student projects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects",
            "params": [
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of returned student projects per request."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The offset for the returned list. 0 or null value is from the start"
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The order of the list, must be a value from /student-projects/orderings"
              }
            ]
          },
          "docs": "Lists all student projects in the Pure instance. If you need to filter the student projects returned, see the POST version which supports additional filtering."
        },
        {
          "info": {
            "name": "Create student project",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create student project"
        },
        {
          "info": {
            "name": "A list of allowed document licenses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/allowed-appendix-document-licenses"
          },
          "docs": "Get a list of allowed document licenses for student projects"
        },
        {
          "info": {
            "name": "A list of allowed document types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/allowed-appendix-document-types"
          },
          "docs": "Get a list of allowed types for documents on student projects"
        },
        {
          "info": {
            "name": "A list of allowed campuses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/allowed-campuses"
          },
          "docs": "Get a list of allowed campuses on student projects"
        },
        {
          "info": {
            "name": "A list of allowed document licenses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/allowed-document-licenses"
          },
          "docs": "Get a list of allowed document licenses for student projects"
        },
        {
          "info": {
            "name": "A list of allowed document types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/allowed-document-types"
          },
          "docs": "Get a list of allowed types for documents on student projects"
        },
        {
          "info": {
            "name": "A list of allowed external collaborator rules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/allowed-external-collaborator-roles"
          },
          "docs": "Get a list of allowed external collaborator rules for the 'externalCollaborators' property on student projects"
        },
        {
          "info": {
            "name": "A list of allowed groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/allowed-groups"
          },
          "docs": "Get a list of allowed groups on student projects"
        },
        {
          "info": {
            "name": "A list of allowed image types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/allowed-image-types"
          },
          "docs": "Get a list of allowed image types that can be used for the 'images.type' attribute of activities"
        },
        {
          "info": {
            "name": "A list of keyword group configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/allowed-keyword-group-configurations"
          },
          "docs": "Get a list of allowed keyword group configurations that can be used when submitting keyword groups."
        },
        {
          "info": {
            "name": "A list of allowed classifications for the specified keyword group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/allowed-keyword-group-configurations/:id/classifications",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Pure id of the keyword group configuration"
              }
            ]
          },
          "docs": "Get a list of allowed classifications that can be used when submitting a specified keyword group."
        },
        {
          "info": {
            "name": "A list of allowed languages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/allowed-languages"
          },
          "docs": "Get a list of allowed languages on student projects"
        },
        {
          "info": {
            "name": "A list of allowed link types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/allowed-link-types"
          },
          "docs": "Get a list of allowed link types that can be used for the 'links.linkType' attribute of student project"
        },
        {
          "info": {
            "name": "A list of allowed locales in localized strings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/allowed-locales"
          },
          "docs": "Get a list of allowed locales that can be used when submitting localized string entities."
        },
        {
          "info": {
            "name": "A list of allowed supervisor types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/allowed-supervisor-types"
          },
          "docs": "Get a list of allowed supervisor types on student projects"
        },
        {
          "info": {
            "name": "A list of allowed student project types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/allowed-types"
          },
          "docs": "Get a list of allowed types that can be used for the 'type' attribute of student project"
        },
        {
          "info": {
            "name": "A list of allowed workflow steps in localized strings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/allowed-workflow-steps"
          },
          "docs": "Get a list of allowed workflow steps."
        },
        {
          "info": {
            "name": "Upload file to a specific student project",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/file-uploads",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ]
          },
          "docs": "Uploads file for the student project"
        },
        {
          "info": {
            "name": "Lists available orderings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/orderings"
          },
          "docs": "Lists all orderings available to the student project endpoint. These values can be used by the order parameter."
        },
        {
          "info": {
            "name": "Query operation for student project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/search",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Lists student projects in the Pure instance that matches the provided query, similar to the GET version, instead of using parameters to alter the response, an JSON document is posted with the request. The JSON document contains fields for all the parameters available for the GET version, but also additional filtering options."
        },
        {
          "info": {
            "name": "Get student project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired student project"
              }
            ]
          },
          "docs": "Get student project with specific UUID."
        },
        {
          "info": {
            "name": "Update student project",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the student project to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update student project with specific UUID."
        },
        {
          "info": {
            "name": "Delete student project",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the student project"
              }
            ]
          },
          "docs": "Delete student project with specific UUID."
        },
        {
          "info": {
            "name": "Lock the content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/:uuid/actions/lock",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the content to lock"
              }
            ]
          },
          "docs": "Mark the content as external (used when content contains synchronised data). This has no effect on interactions with the content through the API."
        },
        {
          "info": {
            "name": "Unlock the content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/:uuid/actions/unlock",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the content to unlock"
              }
            ]
          },
          "docs": "Remove the external mark on the content (used when content contains synchronised data). This has no effect on interactions with the content through the API."
        },
        {
          "info": {
            "name": "Lists all dependents to the student project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/:uuid/dependents",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the student project"
              },
              {
                "name": "verbose",
                "value": "",
                "type": "query",
                "description": "DEPRECATED - Parameter has no effect."
              }
            ]
          },
          "docs": "Lists all dependents to the student project with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. "
        },
        {
          "info": {
            "name": "Get file from the student project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/:uuid/files/:fileId",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the student project"
              },
              {
                "name": "fileId",
                "value": "",
                "type": "path",
                "description": "File id "
              }
            ]
          },
          "docs": "Get file from the student project"
        },
        {
          "info": {
            "name": "Lists notes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the student project to get notes for"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of returned notes per request"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The offset for the returned list. 0 or null value is from the start"
              }
            ]
          },
          "docs": "Lists notes associated with an student project ordered by date (nulls last)"
        },
        {
          "info": {
            "name": "Create note",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://pure.qub.ac.uk/ws/api/student-projects/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the student project to add note to"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create note and associate it with an student project"
        }
      ]
    }
  ],
  "bundled": true
}