POST api/Courses/retrieve_academy_course_modules

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Module

Name	Type	Additional information
Identifier	globally unique identifier	None.
Inserted	date	None.
Updated	date	None.
Deleted	date	None.
Activation	boolean	None.
Content	string	None.
Course	globally unique identifier	None.
Credit	integer	None.
Description	string	None.
Mandatory	boolean	None.
Name	string	None.
Totara	integer	None.
tier	integer	None.
routes	integer	None.
Sets	Collection of Set	None.
Tutors	Collection of Tutor	None.
Course1	Course	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Identifier": "a22a837d-a262-4dc9-82a6-e351abb5cb4b",
    "Inserted": "2025-03-26T14:56:07.4081103+00:00",
    "Updated": "2025-03-26T14:56:07.4081103+00:00",
    "Deleted": "2025-03-26T14:56:07.4081103+00:00",
    "Activation": true,
    "Content": "sample string 4",
    "Course": "10a40a46-9e47-428c-aee6-acfa284a1db5",
    "Credit": 6,
    "Description": "sample string 7",
    "Mandatory": true,
    "Name": "sample string 9",
    "Totara": 1,
    "tier": 10,
    "routes": 11,
    "Sets": [
      {
        "Identifier": "0843ce0d-c138-4fb8-9386-d19687732e97",
        "Inserted": "2025-03-26T14:56:07.4081103+00:00",
        "Updated": "2025-03-26T14:56:07.4081103+00:00",
        "Deleted": "2025-03-26T14:56:07.4081103+00:00",
        "Activation": true,
        "Country": "7cbe3632-4b5b-4519-b969-96582a830aec",
        "Enrolments": 5,
        "Finish": "2025-03-26T14:56:07.4081103+00:00",
        "Location": "sample string 6",
        "Maximum": 7,
        "Minimum": 8,
        "Module": "a22a837d-a262-4dc9-82a6-e351abb5cb4b",
        "Start": "2025-03-26T14:56:07.4081103+00:00",
        "Totara": 1,
        "Workshops": 10
      }
    ],
    "Tutors": [
      {
        "Identifier": "6e362d8d-e17f-493d-b769-5a4b95e0ec62",
        "Inserted": "2025-03-26T14:56:07.4081103+00:00",
        "Updated": "2025-03-26T14:56:07.4081103+00:00",
        "Deleted": "2025-03-26T14:56:07.4081103+00:00",
        "Activation": true,
        "Enrolments": 4,
        "Module": "a22a837d-a262-4dc9-82a6-e351abb5cb4b",
        "Name": "sample string 6",
        "Totara": 1
      }
    ],
    "Course1": {
      "Identifier": "10a40a46-9e47-428c-aee6-acfa284a1db5",
      "Inserted": "2025-03-26T14:56:07.4081103+00:00",
      "Updated": "2025-03-26T14:56:07.4081103+00:00",
      "Deleted": "2025-03-26T14:56:07.4081103+00:00",
      "Content": "sample string 3",
      "Credit": 4,
      "Description": "sample string 5",
      "Finish": "2025-03-26T14:56:07.4081103+00:00",
      "Name": "sample string 6",
      "Start": "2025-03-26T14:56:07.4081103+00:00",
      "Totara": 1,
      "routes_available": 8,
      "Modules": []
    }
  },
  {
    "Identifier": "a22a837d-a262-4dc9-82a6-e351abb5cb4b",
    "Inserted": "2025-03-26T14:56:07.4081103+00:00",
    "Updated": "2025-03-26T14:56:07.4081103+00:00",
    "Deleted": "2025-03-26T14:56:07.4081103+00:00",
    "Activation": true,
    "Content": "sample string 4",
    "Course": "10a40a46-9e47-428c-aee6-acfa284a1db5",
    "Credit": 6,
    "Description": "sample string 7",
    "Mandatory": true,
    "Name": "sample string 9",
    "Totara": 1,
    "tier": 10,
    "routes": 11,
    "Sets": [
      {
        "Identifier": "0843ce0d-c138-4fb8-9386-d19687732e97",
        "Inserted": "2025-03-26T14:56:07.4081103+00:00",
        "Updated": "2025-03-26T14:56:07.4081103+00:00",
        "Deleted": "2025-03-26T14:56:07.4081103+00:00",
        "Activation": true,
        "Country": "7cbe3632-4b5b-4519-b969-96582a830aec",
        "Enrolments": 5,
        "Finish": "2025-03-26T14:56:07.4081103+00:00",
        "Location": "sample string 6",
        "Maximum": 7,
        "Minimum": 8,
        "Module": "a22a837d-a262-4dc9-82a6-e351abb5cb4b",
        "Start": "2025-03-26T14:56:07.4081103+00:00",
        "Totara": 1,
        "Workshops": 10
      }
    ],
    "Tutors": [
      {
        "Identifier": "6e362d8d-e17f-493d-b769-5a4b95e0ec62",
        "Inserted": "2025-03-26T14:56:07.4081103+00:00",
        "Updated": "2025-03-26T14:56:07.4081103+00:00",
        "Deleted": "2025-03-26T14:56:07.4081103+00:00",
        "Activation": true,
        "Enrolments": 4,
        "Module": "a22a837d-a262-4dc9-82a6-e351abb5cb4b",
        "Name": "sample string 6",
        "Totara": 1
      }
    ],
    "Course1": {
      "Identifier": "10a40a46-9e47-428c-aee6-acfa284a1db5",
      "Inserted": "2025-03-26T14:56:07.4081103+00:00",
      "Updated": "2025-03-26T14:56:07.4081103+00:00",
      "Deleted": "2025-03-26T14:56:07.4081103+00:00",
      "Content": "sample string 3",
      "Credit": 4,
      "Description": "sample string 5",
      "Finish": "2025-03-26T14:56:07.4081103+00:00",
      "Name": "sample string 6",
      "Start": "2025-03-26T14:56:07.4081103+00:00",
      "Totara": 1,
      "routes_available": 8,
      "Modules": []
    }
  }
]

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'Totara.WEBAPI.Course' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'Totara.WEBAPI.Course' contains cycles and cannot be serialized if reference tracking is disabled.