POST api/v{version}/season/overview
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
version | string |
None. |
Body Parameters
SeasonBasicViewModelName | Description | Type | Additional information |
---|---|---|---|
SeasonId | integer |
None. |
|
CompetitionId |
The related competition. |
integer |
None. |
OrganisationId | integer |
None. |
|
Title |
Name of the season. |
string |
None. |
Description |
Short description of the season. |
string |
None. |
DescriptionTranslations | Dictionary of string [key] and string [value] |
None. |
|
Notes |
Some internal notes |
string |
None. |
TotalNumberOfPlayers |
Total number of players |
integer |
None. |
Sponsor |
The main sponsor. |
string |
None. |
Edition |
Edition |
integer |
None. |
VenueId | integer |
None. |
|
Venue |
Location where the games are/where played. |
string |
None. |
Address |
Venue address |
string |
None. |
City |
City where the games are/where played. |
string |
None. |
Country |
Country where the games are/where played. |
string |
None. |
CountryCode |
Country code where the games are/where played. |
string |
None. |
StartDate |
Get or set the date the tournament is started. |
date |
None. |
EndDate |
Get or set the date the tournament is finished. |
date |
None. |
PrizeMoney |
Total prize money. |
string |
None. |
PrizeMoneyIndication |
Total prize money indication (without special prizes). |
string |
None. |
PrizeCurrency |
The prize currency. |
string |
None. |
OnTv |
Was the season broadcasted on television. |
boolean |
None. |
OnWeb |
Season is streamed on the web. |
boolean |
None. |
Status | string |
None. |
|
WithPairs |
Is this season played with Pairs. |
boolean |
None. |
Modified |
Last time the season is modified. |
date |
None. |
Request Formats
application/json, text/json
{ "SeasonId": 1, "CompetitionId": 2, "OrganisationId": 1, "Title": "sample string 3", "Description": "sample string 4", "DescriptionTranslations": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "Notes": "sample string 5", "TotalNumberOfPlayers": 1, "Sponsor": "sample string 6", "Edition": 1, "VenueId": 1, "Venue": "sample string 7", "Address": "sample string 8", "City": "sample string 9", "Country": "sample string 10", "CountryCode": "sample string 11", "StartDate": "2023-09-30T04:05:22.5650261+02:00", "EndDate": "2023-09-30T04:05:22.5650261+02:00", "PrizeMoney": "sample string 12", "PrizeMoneyIndication": "sample string 13", "PrizeCurrency": "sample string 14", "OnTv": true, "OnWeb": true, "Status": "sample string 17", "WithPairs": true, "Modified": "2023-09-30T04:05:22.5650261+02:00" }
application/xml, text/xml
<SeasonBasicViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DartStat.Web.Areas.Apiv2.Models"> <Address>sample string 8</Address> <City>sample string 9</City> <CompetitionId>2</CompetitionId> <Country>sample string 10</Country> <CountryCode>sample string 11</CountryCode> <Description>sample string 4</Description> <DescriptionTranslations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>sample string 1</d2p1:Key> <d2p1:Value>sample string 2</d2p1:Value> </d2p1:KeyValueOfstringstring> <d2p1:KeyValueOfstringstring> <d2p1:Key>sample string 3</d2p1:Key> <d2p1:Value>sample string 4</d2p1:Value> </d2p1:KeyValueOfstringstring> </DescriptionTranslations> <Edition>1</Edition> <EndDate>2023-09-30T04:05:22.5650261+02:00</EndDate> <Modified>2023-09-30T04:05:22.5650261+02:00</Modified> <Notes>sample string 5</Notes> <OnTv>true</OnTv> <OnWeb>true</OnWeb> <OrganisationId>1</OrganisationId> <PrizeCurrency>sample string 14</PrizeCurrency> <PrizeMoney>sample string 12</PrizeMoney> <PrizeMoneyIndication>sample string 13</PrizeMoneyIndication> <SeasonId>1</SeasonId> <Sponsor>sample string 6</Sponsor> <StartDate>2023-09-30T04:05:22.5650261+02:00</StartDate> <Status>sample string 17</Status> <Title>sample string 3</Title> <TotalNumberOfPlayers>1</TotalNumberOfPlayers> <Venue>sample string 7</Venue> <VenueId>1</VenueId> <WithPairs>true</WithPairs> </SeasonBasicViewModel>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
SeasonStatusResponseName | Description | Type | Additional information |
---|---|---|---|
Ok | boolean |
None. |
|
Reason | string |
None. |
Response Formats
application/json, text/json
{ "Ok": true, "Reason": "sample string 2" }
application/xml, text/xml
<SeasonStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DartStat.Web.Areas.Apiv2.Models"> <Ok>true</Ok> <Reason>sample string 2</Reason> </SeasonStatusResponse>