Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
openapi: 3.2.0
info:
title: Open edX User Tours API
description: APIs for access to Open edX information
contact:
email: contact@academy.dhis2.org
version: v1
servers:
- url: https://academy.dhis2.org/api
security:
- Basic: []
tags:
- name: user_tours
paths:
/user_tours/discussion_tours/{tour_id}/:
parameters:
- name: tour_id
in: path
required: true
schema:
type: string
get:
operationId: user_tours_discussion_tours_read
description: Return a list of all tours in the database.
responses:
'200':
description: ''
tags:
- user_tours
summary: User tours discussion tours read
x-summary-source: derived
put:
operationId: user_tours_discussion_tours_update
description: Update an existing tour with the data in the request body.
responses:
'200':
description: ''
tags:
- user_tours
summary: User tours discussion tours update
x-summary-source: derived
/user_tours/v1/{username}:
parameters:
- name: username
in: path
required: true
schema:
type: string
get:
operationId: user_tours_v1_read
summary: Retrieve the User Tour for the given username
description: 'Allows staff users to retrieve any user''s User Tour.
Returns
200 with the following fields:
course_home_tour_status (str): one of UserTour.CourseHomeChoices
show_courseware_tour (bool): indicates if courseware tour should be shown.
400 if there is a not allowed request (requesting a user you don''t have access to)
401 if unauthorized request
403 if tours are disabled
404 if the UserTour does not exist (shouldn''t happen, but safety first)'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UserTour'
tags:
- user_tours
put:
operationId: user_tours_v1_update
description: Unsupported method.
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UserTour'
tags:
- user_tours
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserTour'
required: true
summary: User tours v1 update
x-summary-source: derived
patch:
operationId: user_tours_v1_partial_update
summary: Patch the User Tour for the request.user
description: Supports updating the `course_home_tour_status` and `show_courseware_tour` fields.
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UserTour'
tags:
- user_tours
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserTour'
required: true
components:
schemas:
UserTour:
type: object
properties:
course_home_tour_status:
title: Course home tour status
type: string
enum:
- show-existing-user-tour
- show-new-user-tour
- no-tour
show_courseware_tour:
title: Show courseware tour
type: boolean
securitySchemes:
Basic:
type: http
scheme: basic