GET v{version}/yeargroup/{id}
Gets year group by Id
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
integer |
integer |
Required |
| version | string |
None. |
Body Parameters
None.
Response Information
Resource Description
The year group if found
YearGroupViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| YearGroupId | integer |
None. |
|
| StudentId | integer |
None. |
|
| SeasonId | integer |
None. |
|
| SchoolId | integer |
None. |
|
| YearGroupNumber | string |
None. |
|
| YearGroupPostfix | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"YearGroupId": 1,
"StudentId": 2,
"SeasonId": 3,
"SchoolId": 4,
"YearGroupNumber": "sample string 5",
"YearGroupPostfix": "sample string 6"
}
application/xml, text/xml
Sample:
<YearGroupViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpeedadminApi.ViewModels"> <SchoolId>4</SchoolId> <SeasonId>3</SeasonId> <StudentId>2</StudentId> <YearGroupId>1</YearGroupId> <YearGroupNumber>sample string 5</YearGroupNumber> <YearGroupPostfix>sample string 6</YearGroupPostfix> </YearGroupViewModel>