{
  "opencollection": "1.0.0",
  "info": {
    "name": "Open edX agreements user_tours API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "user_tours",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "user_tours_discussion_tours_read",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://open.kaznu.kz/api/user_tours/discussion_tours/:tour_id/",
            "params": [
              {
                "name": "tour_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Return a list of all tours in the database."
        },
        {
          "info": {
            "name": "user_tours_discussion_tours_update",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://open.kaznu.kz/api/user_tours/discussion_tours/:tour_id/",
            "params": [
              {
                "name": "tour_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Update an existing tour with the data in the request body."
        },
        {
          "info": {
            "name": "Retrieve the User Tour for the given username.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://open.kaznu.kz/api/user_tours/v1/:username",
            "params": [
              {
                "name": "username",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Allows staff users to retrieve any user's User Tour.\n\nReturns\n    200 with the following fields:\n        course_home_tour_status (str): one of UserTour.CourseHomeChoices\n        show_courseware_tour (bool): indicates if courseware tour should be shown.\n\n    400 if there is a not allowed request (requesting a user you don't have access to)\n    401 if unauthorized request\n    403 if tours are disabled\n    404 if the UserTour does not exist (shouldn't happen, but safety first)"
        },
        {
          "info": {
            "name": "user_tours_v1_update",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://open.kaznu.kz/api/user_tours/v1/:username",
            "params": [
              {
                "name": "username",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unsupported method."
        },
        {
          "info": {
            "name": "Patch the User Tour for the request.user.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://open.kaznu.kz/api/user_tours/v1/:username",
            "params": [
              {
                "name": "username",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Supports updating the `course_home_tour_status` and `show_courseware_tour` fields."
        }
      ]
    }
  ],
  "bundled": true
}