Difference between revisions of "API Add Category"
From zFairs Contest Management
Line 10: | Line 10: | ||
Username:'admin username', | Username:'admin username', | ||
Password: 'password', | Password: 'password', | ||
+ | FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f | ||
Body: { | Body: { | ||
Name: "Category Name", | Name: "Category Name", | ||
NameShort: "Category Abbreviation", | NameShort: "Category Abbreviation", | ||
Description: "", | Description: "", | ||
− | Grades: [9,10,11,12] //optional, use 0 for kindergarten. If not set category will be open to all grades | + | Grades: [9,10,11,12], //optional, use 0 for kindergarten. If not set category will be open to all grades |
Id: 123 //optional, this will cause the category at this id to be updated | Id: 123 //optional, this will cause the category at this id to be updated | ||
} | } | ||
Line 36: | Line 37: | ||
Username:'admin username', | Username:'admin username', | ||
Password: 'password', | Password: 'password', | ||
+ | FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f | ||
Body: { | Body: { | ||
Id: 123 //optional, this will cause the category at this id to be updated | Id: 123 //optional, this will cause the category at this id to be updated |
Revision as of 13:49, 7 November 2020
Add Category
You can use our api to add categories to your contest. To do this you need to POST a message to your site. Below is an example of what needs to be posted.
fetch('/api/data/category', {
method:'POST',
headers:{'Content-Type': 'application/json'},
body: JSON.stringify({
Username:'admin username',
Password: 'password',
FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
Body: {
Name: "Category Name",
NameShort: "Category Abbreviation",
Description: "",
Grades: [9,10,11,12], //optional, use 0 for kindergarten. If not set category will be open to all grades
Id: 123 //optional, this will cause the category at this id to be updated
}
})
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});
Remove Category
fetch('/api/data/category/remove', {
method:'POST',
headers:{'Content-Type': 'application/json'},
body: JSON.stringify({
Username:'admin username',
Password: 'password',
FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
Body: {
Id: 123 //optional, this will cause the category at this id to be updated
}
})
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});