POST api/Courses/retrieve_academy_courses

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Course

Name	Type	Additional 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": "dfc49ee6-dda4-4024-b4dd-724002942911",
    "Inserted": "2024-09-15T11:19:25.6459755+01:00",
    "Updated": "2024-09-15T11:19:25.6459755+01:00",
    "Deleted": "2024-09-15T11:19:25.6459755+01:00",
    "Content": "sample string 3",
    "Credit": 4,
    "Description": "sample string 5",
    "Finish": "2024-09-15T11:19:25.6459755+01:00",
    "Name": "sample string 6",
    "Start": "2024-09-15T11:19:25.6459755+01:00",
    "Totara": 1,
    "routes_available": 8,
    "Modules": [
      {
        "Identifier": "07a22396-aba3-4dec-ada8-20b3d0c4574c",
        "Inserted": "2024-09-15T11:19:25.6459755+01:00",
        "Updated": "2024-09-15T11:19:25.6459755+01:00",
        "Deleted": "2024-09-15T11:19:25.6459755+01:00",
        "Activation": true,
        "Content": "sample string 4",
        "Course": "dfc49ee6-dda4-4024-b4dd-724002942911",
        "Credit": 6,
        "Description": "sample string 7",
        "Mandatory": true,
        "Name": "sample string 9",
        "Totara": 1,
        "tier": 10,
        "routes": 11,
        "Sets": [
          {
            "Identifier": "0e8d5cbd-eff8-43a5-9f2e-31eada4f5d1c",
            "Inserted": "2024-09-15T11:19:25.6459755+01:00",
            "Updated": "2024-09-15T11:19:25.6459755+01:00",
            "Deleted": "2024-09-15T11:19:25.6459755+01:00",
            "Activation": true,
            "Country": "18fd8845-f0c1-4fba-acb3-1a5c363dcc11",
            "Enrolments": 5,
            "Finish": "2024-09-15T11:19:25.6459755+01:00",
            "Location": "sample string 6",
            "Maximum": 7,
            "Minimum": 8,
            "Module": "07a22396-aba3-4dec-ada8-20b3d0c4574c",
            "Start": "2024-09-15T11:19:25.6459755+01:00",
            "Totara": 1,
            "Workshops": 10
          }
        ],
        "Tutors": [
          {
            "Identifier": "6d0960ba-560b-4f4b-a573-9a6686371473",
            "Inserted": "2024-09-15T11:19:25.6459755+01:00",
            "Updated": "2024-09-15T11:19:25.6459755+01:00",
            "Deleted": "2024-09-15T11:19:25.6459755+01:00",
            "Activation": true,
            "Enrolments": 4,
            "Module": "07a22396-aba3-4dec-ada8-20b3d0c4574c",
            "Name": "sample string 6",
            "Totara": 1
          }
        ]
      }
    ]
  },
  {
    "Identifier": "dfc49ee6-dda4-4024-b4dd-724002942911",
    "Inserted": "2024-09-15T11:19:25.6459755+01:00",
    "Updated": "2024-09-15T11:19:25.6459755+01:00",
    "Deleted": "2024-09-15T11:19:25.6459755+01:00",
    "Content": "sample string 3",
    "Credit": 4,
    "Description": "sample string 5",
    "Finish": "2024-09-15T11:19:25.6459755+01:00",
    "Name": "sample string 6",
    "Start": "2024-09-15T11:19:25.6459755+01:00",
    "Totara": 1,
    "routes_available": 8,
    "Modules": [
      {
        "Identifier": "07a22396-aba3-4dec-ada8-20b3d0c4574c",
        "Inserted": "2024-09-15T11:19:25.6459755+01:00",
        "Updated": "2024-09-15T11:19:25.6459755+01:00",
        "Deleted": "2024-09-15T11:19:25.6459755+01:00",
        "Activation": true,
        "Content": "sample string 4",
        "Course": "dfc49ee6-dda4-4024-b4dd-724002942911",
        "Credit": 6,
        "Description": "sample string 7",
        "Mandatory": true,
        "Name": "sample string 9",
        "Totara": 1,
        "tier": 10,
        "routes": 11,
        "Sets": [
          {
            "Identifier": "0e8d5cbd-eff8-43a5-9f2e-31eada4f5d1c",
            "Inserted": "2024-09-15T11:19:25.6459755+01:00",
            "Updated": "2024-09-15T11:19:25.6459755+01:00",
            "Deleted": "2024-09-15T11:19:25.6459755+01:00",
            "Activation": true,
            "Country": "18fd8845-f0c1-4fba-acb3-1a5c363dcc11",
            "Enrolments": 5,
            "Finish": "2024-09-15T11:19:25.6459755+01:00",
            "Location": "sample string 6",
            "Maximum": 7,
            "Minimum": 8,
            "Module": "07a22396-aba3-4dec-ada8-20b3d0c4574c",
            "Start": "2024-09-15T11:19:25.6459755+01:00",
            "Totara": 1,
            "Workshops": 10
          }
        ],
        "Tutors": [
          {
            "Identifier": "6d0960ba-560b-4f4b-a573-9a6686371473",
            "Inserted": "2024-09-15T11:19:25.6459755+01:00",
            "Updated": "2024-09-15T11:19:25.6459755+01:00",
            "Deleted": "2024-09-15T11:19:25.6459755+01:00",
            "Activation": true,
            "Enrolments": 4,
            "Module": "07a22396-aba3-4dec-ada8-20b3d0c4574c",
            "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.