API Add Round

Add Round

Creates or updates a judging round for the fair.

Authentication

All data API calls are POST (unless noted) with JSON body:

Field	Required	Description
ApiKey	Yes*	Private API key for your site. Prefer this over username/password.
Username / Password	Yes*	Alternate auth if not using ApiKey.
FairId	Yes	Fair GUID from the site URL (f query parameter).
Body	Depends	Request payload. Use {} when no body fields are needed.

• Provide either ApiKey or Username+Password.

Calls must be run server-side — do not expose your API key in a browser.

Response envelope

Most endpoints return:

{
  Success: true,
  Message: null,   // error text when Success is false
  Body: { ... }    // endpoint-specific payload
}

Request

fetch('/api/data/round', {
    method:'POST',
    headers:{'Content-Type': 'application/json'},
    body: JSON.stringify({
            ApiKey:'<Private key>',
            FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', // value of f in your URL
            Body: {
				Id: 0,              // 0 for new round
				RoundName: "Round One",  // required
				RoundValue: 100,    // optional, default 100
				IsSubround: false   // optional, default false
			}
        })
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});

Response

On success:

{
  Success: true,
  Message: null,
  Body: { Id: 2, RoundName: "Round One", RoundValue: 100, IsSubround: false }
}

If name is missing:

{ Success: false, Message: "Round name not set." }

Field notes

• Round Id is required by judging assignment and score APIs.
• List existing rounds via API Get Info → Rounds.

Related APIs

• API Get Info
• API Set Judging Assignments
• API Judging Scores / API Upload Judging Score