GET api/Courses/{CourseId}

Returns a Course.

Request Information

URI Parameters

Name	Description	Type	Additional information
CourseId	Application identifier for the Course	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Course object for the specified CourseId

Course

Name	Description	Type	Additional information
CourseUid	The user identifier for the Course.	string	None.
StatePrId	The StatePrId for the Course.	string	None.
Description	The description for the Course.	string	None.
MaxStudents	The default maximum number of Students allowed to enroll for the Course. This can be overridden in the Section.	integer	None.
NumberOfPeriods	The default number of Periods taught for the Course. The Section will specify the Periods taught.	integer	None.
Length	The default number of Sessions taught for the Course. The Section will specify the Sessions taught.	integer	None.
BeginGradeUid	The begin Grade user identifier for the Course.	string	None.
EndGradeUid	The end Grade user identifier for the Course.	string	None.
SIFRefId	The SIFRefId for the Course.	globally unique identifier	None.
Id	The application identifier for the object. This cannot be changed by the user.	globally unique identifier	None.
DataVersion	The version of the API data	string	None.
ApiName	The name of the object without the Api suffix	string	None.

Response Formats

application/json, text/json

Sample:

{
  "CourseUid": "sample string 1",
  "StatePrId": "sample string 2",
  "Description": "sample string 3",
  "MaxStudents": 4,
  "NumberOfPeriods": 5,
  "Length": 6,
  "BeginGradeUid": "sample string 7",
  "EndGradeUid": "sample string 8",
  "SIFRefId": "b4890438-a86e-4c61-b7f1-fc87a9e8ee11",
  "Id": "7a4fa279-a6df-4185-a8c8-b86df18449ff",
  "DataVersion": "sample string 11",
  "ApiName": ""
}

application/xml, text/xml

Sample:

<Course xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi.v1">
  <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 11</DataVersion>
  <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">7a4fa279-a6df-4185-a8c8-b86df18449ff</Id>
  <BeginGradeUid>sample string 7</BeginGradeUid>
  <CourseUid>sample string 1</CourseUid>
  <Description>sample string 3</Description>
  <EndGradeUid>sample string 8</EndGradeUid>
  <Length>6</Length>
  <MaxStudents>4</MaxStudents>
  <NumberOfPeriods>5</NumberOfPeriods>
  <SIFRefId>b4890438-a86e-4c61-b7f1-fc87a9e8ee11</SIFRefId>
  <StatePrId>sample string 2</StatePrId>
</Course>