Difference between revisions of "API Add Category"
From zFairs Contest Management
(Document add/update category fields) |
(Remove username/password API auth; ApiKey only) |
||
| Line 9: | Line 9: | ||
! Field !! Required !! Description | ! Field !! Required !! Description | ||
|- | |- | ||
| − | | <code>ApiKey</code> || Yes | + | | <code>ApiKey</code> || Yes || Private API key for your site. |
| − | |||
| − | |||
|- | |- | ||
| <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: | ||
|} | |} | ||
| − | |||
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
Contents
Add Category
Creates or updates a project category 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/category', {
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
Name: "Biology",
NameShort: "BIO",
Description: "Life sciences",
Grades: [6,7,8,9,10,11,12], // optional grade filter
DoNotShowInOnlineJudging: false,
DoNotAllowTeams: false,
MaxTeamSize: 3,
EntryTypeId: 1 // optional, from Get Info EntryTypes
}
})
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});Response
On success Body is the category with Id set:
{
Success: true,
Message: null,
Body: { Id: 12, Name: "Biology", NameShort: "BIO", ... }
}
Field notes
- Use returned
IdasCategoryIdwhen adding/updating projects. Gradesis stored as a category grade filter when provided.- Categories can be listed via API Get Info →
Categories.
Related APIs