Skip to navigation

Get Recommendations

View as Markdown

The POST /api/user/recommendedendpoint is used to retrieve recommeded courses by a user based on the username.

Request

  • Method: POST

  • Base URL: {{baseUrl}}

  • Path: /api/user/recommended

  • Headers:

    • Content-Type: application/x-www-form-urlencoded
  • Body:

    • idst (text): User ID

    • auth (text): The authentication token

Response

  • The response will be in JSON format with the following structure:

    • success (boolean): Indicates the success of the request.

    • enrollment (array): An array of coursees enrolled in.

    • completed (array): An array of coursees completed.

    • recommended (array): An array of courses recommended.

      • recommend_by_course_name (string)

      • recommend_by_course_id (string)

      • courseList (array): Array of objects, each representing a course with the following properties

        • idCourse (string): The unique identifier for the course.

        • idCategory (string): The category ID the course belongs to.

        • code (string): The code associated with the course.

        • name (string): The name of the course.

        • description (string): The description of the course.

        • box_description (string): The box description of the course.

        • lang_code (string): The language code for the course.

        • status (string): The status of the course.

        • level_show_user (string)

        • subscribe_method (string): The method for subscribing to the course.

          • 0 - Only Admin can subscribe users to the course

          • 1 - Subscription requires admin approval

          • 2 - Subscription is free to all

        • linkSponsor (string)

        • imgSponsor (string)

        • img_course (string): The path/source to the course image

        • img_material (string)

        • img_othermaterial (string)

        • mediumTime (string)

        • permCloseLO (string)

        • userStatusOp (string)

        • show_rules (string): Indicates wether to display rules.

        • selling (string): The selling status of the course.

        • course_demo (string): The course demo.

        • create_date (string): The date the course was created.

        • course_edition (string): The course edition ID.

        • can_subscribe (string): The subscription availability status.

          • 0 - Subscription is closed

          • 1 - Subscription is open at all times

          • 2 - Subscription is open only when the current date is within the subscription start and end date set on the course (Key: sub_start_date sub_end_date

        • sub_start_date (string): The start date for subscription.

        • sub_end_date (string): The end date for subscription.

        • date_begin (string): The start date of the course.

        • date_end (string): The end date of the course.

        • prize (string): Course price

        • course_type (string): Course type

        • policy_point (string)

        • point_to_all (string)

        • course_edition (string) Course Edition

        • classrooms (array): Classrooms the course belongs to

        • certificates (string): Course certificates

        • security_code (string)

        • imported_from_connection (string)

        • course_quota (string0

        • used_space (string)

        • course_vote (string)

        • allow_overbooking (string)

        • direct_play (string)

        • use_logo_in_courselist (string)

        • show_result (string)

        • credits (string)

        • auto_unsubscribe (string)

        • unsubscribe_date_limit (string)

        • id_menucustom (string)

        • sendCalendar (string)

        • calendarId (string)

        • created_at (string)

        • updated_at (string)

        • escaped_name (string)

        • level_icon (boolean)

        • is_enrolled (boolean)

        • canEnter (boolean)

        • editions (boolean)

        • course_full (boolean)

        • in_cart (boolean)

        • waiting (boolean)

        • userCanUnsubscribe (boolean)

        • show_options (boolean)

        • courseBoxEnabled (boolean)

Request

This endpoint expects an object.
authstringRequired
idststringRequired

Response headers

Keep-AlivestringOptional
X-Powered-BystringOptional

Response

OK
successboolean
completedlist of any
enrollmentobject
recommendedobject