POST v{version}/yeargroup

Gets year groups

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

YearGroupLimiter

Name	Type	Additional information
Take	integer	Range: inclusive between 0 and 200
Skip	integer	Range: inclusive between 0 and 2147483647
Sort	string	None.
GetFormattetAndMappedSortString	Collection of string	None.
SeasonId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Take": 1,
  "Skip": 2,
  "Sort": "sample string 3",
  "SeasonId": 4
}

application/xml, text/xml

Sample:

<YearGroupLimiter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpeedadminApi.ViewModels">
  <GetFormattetAndMappedSortString xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <SeasonId>4</SeasonId>
  <Skip>2</Skip>
  <Sort>sample string 3</Sort>
  <Take>1</Take>
</YearGroupLimiter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of YearGroupViewModel

Name	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"
  },
  {
    "YearGroupId": 1,
    "StudentId": 2,
    "SeasonId": 3,
    "SchoolId": 4,
    "YearGroupNumber": "sample string 5",
    "YearGroupPostfix": "sample string 6"
  }
]

application/xml, text/xml

Sample:

<ArrayOfYearGroupViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpeedadminApi.ViewModels">
  <YearGroupViewModel>
    <SchoolId>4</SchoolId>
    <SeasonId>3</SeasonId>
    <StudentId>2</StudentId>
    <YearGroupId>1</YearGroupId>
    <YearGroupNumber>sample string 5</YearGroupNumber>
    <YearGroupPostfix>sample string 6</YearGroupPostfix>
  </YearGroupViewModel>
  <YearGroupViewModel>
    <SchoolId>4</SchoolId>
    <SeasonId>3</SeasonId>
    <StudentId>2</StudentId>
    <YearGroupId>1</YearGroupId>
    <YearGroupNumber>sample string 5</YearGroupNumber>
    <YearGroupPostfix>sample string 6</YearGroupPostfix>
  </YearGroupViewModel>
</ArrayOfYearGroupViewModel>