POST api/Courses/retrieve_academy_course_modules

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Module
NameDescriptionTypeAdditional 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.

Sets

Collection of Set

None.

Tutors

Collection of Tutor

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Identifier": "59776195-d8d1-46d5-b142-e91a71f27d7a",
    "Inserted": "2017-09-25T16:20:01.860276+01:00",
    "Updated": "2017-09-25T16:20:01.860276+01:00",
    "Deleted": "2017-09-25T16:20:01.860276+01:00",
    "Activation": true,
    "Content": "sample string 4",
    "Course": "862d6e4d-203e-4965-8dfc-d0f5bfe2f995",
    "Credit": 6,
    "Description": "sample string 7",
    "Mandatory": true,
    "Name": "sample string 9",
    "Totara": 1,
    "Sets": [
      {
        "Identifier": "8741f412-e530-443e-9cd8-56e280fabb37",
        "Inserted": "2017-09-25T16:20:01.860276+01:00",
        "Updated": "2017-09-25T16:20:01.860276+01:00",
        "Deleted": "2017-09-25T16:20:01.860276+01:00",
        "Activation": true,
        "Country": "2e90a960-e352-4885-9620-18afb5ea0d89",
        "Enrolments": 5,
        "Finish": "2017-09-25T16:20:01.8759012+01:00",
        "Location": "sample string 6",
        "Maximum": 7,
        "Minimum": 8,
        "Module": "59776195-d8d1-46d5-b142-e91a71f27d7a",
        "Start": "2017-09-25T16:20:01.8759012+01:00",
        "Totara": 1,
        "Workshops": 10
      }
    ],
    "Tutors": [
      {
        "Identifier": "ace1c940-9a5e-4497-8383-e48a2cf5d9e6",
        "Inserted": "2017-09-25T16:20:01.8759012+01:00",
        "Updated": "2017-09-25T16:20:01.8759012+01:00",
        "Deleted": "2017-09-25T16:20:01.8759012+01:00",
        "Activation": true,
        "Enrolments": 4,
        "Module": "59776195-d8d1-46d5-b142-e91a71f27d7a",
        "Name": "sample string 6",
        "Totara": 1
      }
    ]
  },
  {
    "Identifier": "59776195-d8d1-46d5-b142-e91a71f27d7a",
    "Inserted": "2017-09-25T16:20:01.860276+01:00",
    "Updated": "2017-09-25T16:20:01.860276+01:00",
    "Deleted": "2017-09-25T16:20:01.860276+01:00",
    "Activation": true,
    "Content": "sample string 4",
    "Course": "862d6e4d-203e-4965-8dfc-d0f5bfe2f995",
    "Credit": 6,
    "Description": "sample string 7",
    "Mandatory": true,
    "Name": "sample string 9",
    "Totara": 1,
    "Sets": [
      {
        "Identifier": "8741f412-e530-443e-9cd8-56e280fabb37",
        "Inserted": "2017-09-25T16:20:01.860276+01:00",
        "Updated": "2017-09-25T16:20:01.860276+01:00",
        "Deleted": "2017-09-25T16:20:01.860276+01:00",
        "Activation": true,
        "Country": "2e90a960-e352-4885-9620-18afb5ea0d89",
        "Enrolments": 5,
        "Finish": "2017-09-25T16:20:01.8759012+01:00",
        "Location": "sample string 6",
        "Maximum": 7,
        "Minimum": 8,
        "Module": "59776195-d8d1-46d5-b142-e91a71f27d7a",
        "Start": "2017-09-25T16:20:01.8759012+01:00",
        "Totara": 1,
        "Workshops": 10
      }
    ],
    "Tutors": [
      {
        "Identifier": "ace1c940-9a5e-4497-8383-e48a2cf5d9e6",
        "Inserted": "2017-09-25T16:20:01.8759012+01:00",
        "Updated": "2017-09-25T16:20:01.8759012+01:00",
        "Deleted": "2017-09-25T16:20:01.8759012+01:00",
        "Activation": true,
        "Enrolments": 4,
        "Module": "59776195-d8d1-46d5-b142-e91a71f27d7a",
        "Name": "sample string 6",
        "Totara": 1
      }
    ]
  }
]

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 'System.Data.Linq.EntitySet`1[[Totara.WEBAPI.Set, Totara.WEBAPI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' 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 'System.Data.Linq.EntitySet`1[[Totara.WEBAPI.Set, Totara.WEBAPI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.