Skip to navigation

Assigned Course List

View as Markdown

The POST /api/user/userdetailsbyuserid endpoint is used to retrieve user assigned courses based on the user ID.

Request

  • Method: POST

  • Base URL: {{baseUrl}}

  • Path: /api/user/userCourses

  • Headers:

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

    • idst (text): The user ID for which details are to be retrieved.

    • auth (text): The authentication token for the request.

Response

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

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

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

      • course_info (object): Information about the course.

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

        • course_id (string): The ID of the course.

        • course_type (string): The type of the course.

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

        • course_image (string): The image of the course.

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

        • course_link (string): The link to the course.

        • user_status (string): The status of the user in the course.

        • waiting (string): The waiting status.

        • enrolled (number): The number of users enrolled in the course.

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

        • can_enter (object): Information about user’s access to the course.

          • can (boolean): Indicates if the user can enter the course.

          • reason (string): The reason for access denial.

          • expiring_in (boolean): Indicates if the access is expiring soon.

        • date_subscribed (string): The date of subscription to the course.

        • date_first_access (string): The date of the first access to the course.

        • course_stats (object): Statistics about the course.

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

          • date_first_access (string): The date of the first access to the course.

          • date_complete (string): The date of course completion.

        • dates (array): An array of dates related to the course.

Request

This endpoint expects an object.
authstringRequired
idststringRequired

Response headers

Keep-AlivestringOptional
X-Powered-BystringOptional

Response

OK
courseslist of objects
successboolean