POST api/Courses/retrieve_academy_courses

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Course
NameDescriptionTypeAdditional information
Identifier

globally unique identifier

None.

Inserted

date

None.

Updated

date

None.

Deleted

date

None.

Content

string

None.

Credit

integer

None.

Description

string

None.

Finish

date

None.

Name

string

None.

Start

date

None.

Totara

integer

None.

routes_available

integer

None.

Modules

Collection of Module

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Identifier": "0f51afd7-55c2-40a4-86aa-a0fa14b2837b",
    "Inserted": "2024-06-17T08:21:46.3487527+01:00",
    "Updated": "2024-06-17T08:21:46.3487527+01:00",
    "Deleted": "2024-06-17T08:21:46.3487527+01:00",
    "Content": "sample string 3",
    "Credit": 4,
    "Description": "sample string 5",
    "Finish": "2024-06-17T08:21:46.3487527+01:00",
    "Name": "sample string 6",
    "Start": "2024-06-17T08:21:46.3487527+01:00",
    "Totara": 1,
    "routes_available": 8,
    "Modules": [
      {
        "Identifier": "0d026667-2178-49af-bf6f-243e75776fc1",
        "Inserted": "2024-06-17T08:21:46.36435+01:00",
        "Updated": "2024-06-17T08:21:46.36435+01:00",
        "Deleted": "2024-06-17T08:21:46.36435+01:00",
        "Activation": true,
        "Content": "sample string 4",
        "Course": "0f51afd7-55c2-40a4-86aa-a0fa14b2837b",
        "Credit": 6,
        "Description": "sample string 7",
        "Mandatory": true,
        "Name": "sample string 9",
        "Totara": 1,
        "tier": 10,
        "routes": 11,
        "Sets": [
          {
            "Identifier": "667bb2e2-0bb8-4df4-9ccf-9daf947c9cef",
            "Inserted": "2024-06-17T08:21:46.36435+01:00",
            "Updated": "2024-06-17T08:21:46.36435+01:00",
            "Deleted": "2024-06-17T08:21:46.36435+01:00",
            "Activation": true,
            "Country": "e42a6a90-8996-4f8a-ac97-59706a172395",
            "Enrolments": 5,
            "Finish": "2024-06-17T08:21:46.36435+01:00",
            "Location": "sample string 6",
            "Maximum": 7,
            "Minimum": 8,
            "Module": "0d026667-2178-49af-bf6f-243e75776fc1",
            "Start": "2024-06-17T08:21:46.36435+01:00",
            "Totara": 1,
            "Workshops": 10
          }
        ],
        "Tutors": [
          {
            "Identifier": "e9bed453-8a3d-4055-82a8-87b21b7f1d54",
            "Inserted": "2024-06-17T08:21:46.36435+01:00",
            "Updated": "2024-06-17T08:21:46.36435+01:00",
            "Deleted": "2024-06-17T08:21:46.36435+01:00",
            "Activation": true,
            "Enrolments": 4,
            "Module": "0d026667-2178-49af-bf6f-243e75776fc1",
            "Name": "sample string 6",
            "Totara": 1
          }
        ]
      }
    ]
  },
  {
    "Identifier": "0f51afd7-55c2-40a4-86aa-a0fa14b2837b",
    "Inserted": "2024-06-17T08:21:46.3487527+01:00",
    "Updated": "2024-06-17T08:21:46.3487527+01:00",
    "Deleted": "2024-06-17T08:21:46.3487527+01:00",
    "Content": "sample string 3",
    "Credit": 4,
    "Description": "sample string 5",
    "Finish": "2024-06-17T08:21:46.3487527+01:00",
    "Name": "sample string 6",
    "Start": "2024-06-17T08:21:46.3487527+01:00",
    "Totara": 1,
    "routes_available": 8,
    "Modules": [
      {
        "Identifier": "0d026667-2178-49af-bf6f-243e75776fc1",
        "Inserted": "2024-06-17T08:21:46.36435+01:00",
        "Updated": "2024-06-17T08:21:46.36435+01:00",
        "Deleted": "2024-06-17T08:21:46.36435+01:00",
        "Activation": true,
        "Content": "sample string 4",
        "Course": "0f51afd7-55c2-40a4-86aa-a0fa14b2837b",
        "Credit": 6,
        "Description": "sample string 7",
        "Mandatory": true,
        "Name": "sample string 9",
        "Totara": 1,
        "tier": 10,
        "routes": 11,
        "Sets": [
          {
            "Identifier": "667bb2e2-0bb8-4df4-9ccf-9daf947c9cef",
            "Inserted": "2024-06-17T08:21:46.36435+01:00",
            "Updated": "2024-06-17T08:21:46.36435+01:00",
            "Deleted": "2024-06-17T08:21:46.36435+01:00",
            "Activation": true,
            "Country": "e42a6a90-8996-4f8a-ac97-59706a172395",
            "Enrolments": 5,
            "Finish": "2024-06-17T08:21:46.36435+01:00",
            "Location": "sample string 6",
            "Maximum": 7,
            "Minimum": 8,
            "Module": "0d026667-2178-49af-bf6f-243e75776fc1",
            "Start": "2024-06-17T08:21:46.36435+01:00",
            "Totara": 1,
            "Workshops": 10
          }
        ],
        "Tutors": [
          {
            "Identifier": "e9bed453-8a3d-4055-82a8-87b21b7f1d54",
            "Inserted": "2024-06-17T08:21:46.36435+01:00",
            "Updated": "2024-06-17T08:21:46.36435+01:00",
            "Deleted": "2024-06-17T08:21:46.36435+01:00",
            "Activation": true,
            "Enrolments": 4,
            "Module": "0d026667-2178-49af-bf6f-243e75776fc1",
            "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.Module, 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.Module, Totara.WEBAPI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.