{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pure activity education API",
    "version": "5.35.1-2"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "api-key",
      "value": "{{api-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "education",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists all educations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/educations",
            "params": [
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of returned educations 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 /educations/orderings"
              }
            ]
          },
          "docs": "Lists all educations in the Pure instance. If you need to filter the educations returned, see the POST version which supports additional filtering."
        },
        {
          "info": {
            "name": "Create education",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/educations",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create education"
        },
        {
          "info": {
            "name": "A list of allowed funding classifications",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/educations/allowed-education-types"
          },
          "docs": "Get a list of allowed education types for property 'educationType' on educations"
        },
        {
          "info": {
            "name": "A list of keyword group configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/educations/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": "/ws/api/educations/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 link types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/educations/allowed-link-types"
          },
          "docs": "Get a list of allowed link types that can be used for the 'links.linkType' attribute of education"
        },
        {
          "info": {
            "name": "A list of allowed locales in localized strings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/educations/allowed-locales"
          },
          "docs": "Get a list of allowed locales that can be used when submitting localized string entities."
        },
        {
          "info": {
            "name": "A list of allowed education types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/educations/allowed-types"
          },
          "docs": "Get a list of allowed types that can be used for the 'type' attribute of education"
        },
        {
          "info": {
            "name": "Lists available orderings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/educations/orderings"
          },
          "docs": "Lists all orderings available to the education endpoint. These values can be used by the order parameter."
        },
        {
          "info": {
            "name": "Query operation for education",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/ws/api/educations/search",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Lists educations 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 education",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/educations/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired education"
              }
            ]
          },
          "docs": "Get education with specific UUID."
        },
        {
          "info": {
            "name": "Update education",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/educations/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the education to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update education with specific UUID."
        },
        {
          "info": {
            "name": "Delete education",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/ws/api/educations/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the education"
              }
            ]
          },
          "docs": "Delete education with specific UUID."
        },
        {
          "info": {
            "name": "Lock the content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/ws/api/educations/: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": "/ws/api/educations/: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 education",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/educations/:uuid/dependents",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the education"
              },
              {
                "name": "verbose",
                "value": "",
                "type": "query",
                "description": "Default: false. Setting this to true will add links and names to the output but will also have an impact on performance. Use with caution."
              }
            ]
          },
          "docs": "Lists all dependents to the education 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": "Lists notes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/educations/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the education 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 education ordered by date (nulls last)"
        },
        {
          "info": {
            "name": "Create note",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/educations/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the education to add note to"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create note and associate it with an education"
        }
      ]
    }
  ],
  "bundled": true
}