Difference between revisions of "API Add Round"

From zFairs Contest Management
(Document add/update judging round)
(Remove username/password API auth; ApiKey only)
 
Line 9: Line 9:
 
! Field !! Required !! Description
 
! Field !! Required !! Description
 
|-
 
|-
| <code>ApiKey</code> || Yes* || Private API key for your site. Prefer this over username/password.
+
| <code>ApiKey</code> || Yes || Private API key for your site.
|-
 
| <code>Username</code> / <code>Password</code> || Yes* || Alternate auth if not using ApiKey.
 
 
|-
 
|-
 
| <code>FairId</code> || Yes || Fair GUID from the site URL (<code>f</code> query parameter).
 
| <code>FairId</code> || Yes || Fair GUID from the site URL (<code>f</code> query parameter).
Line 18: Line 16:
 
|}
 
|}
  
* Provide '''either''' <code>ApiKey</code> '''or''' <code>Username</code>+<code>Password</code>.
 
  
 
Calls must be run '''server-side''' — do not expose your API key in a browser.
 
Calls must be run '''server-side''' — do not expose your API key in a browser.

Latest revision as of 12:55, 25 July 2026

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.
FairId Yes Fair GUID from the site URL (f query parameter).
Body Depends Request payload. Use {} when no body fields are needed.


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 InfoRounds.


Related APIs