Difference between revisions of "API Get Schools"

From zFairs Contest Management
(Created page with "== Get Schools == Get a list of schools from our API. <syntaxhighlight lang="JavaScript" line> fetch('/api/data/schools', { method:'POST', headers:{'Content-Type': '...")
 
 
(3 intermediate revisions by 3 users not shown)
Line 8: Line 8:
 
     headers:{'Content-Type': 'application/json'},
 
     headers:{'Content-Type': 'application/json'},
 
     body: JSON.stringify({
 
     body: JSON.stringify({
             Username:'admin username',
+
             ApiKey:'<Private key>',
            Password: 'password',
 
 
             FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
 
             FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
             Body: {}
+
             Body: {
 +
                includePreloadedSchools: false, //true or false, This field is optional.
 +
            }
 
         })
 
         })
 
})
 
})
Line 19: Line 20:
  
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
 +
Notes:
 +
*includePreloadedSchools - when true it will return preloaded schools if enabled on your event.
 +
 +
<br/><br/><br/><br/>
 +
[[Category: API]]

Latest revision as of 14:29, 16 August 2024

Get Schools

Get a list of schools from our API.

fetch('/api/data/schools', {
    method:'POST',
    headers:{'Content-Type': 'application/json'},
    body: JSON.stringify({
            ApiKey:'<Private key>',
            FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
            Body: {
                includePreloadedSchools: false, //true or false, This field is optional.
            }
        })
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});


Notes:

  • includePreloadedSchools - when true it will return preloaded schools if enabled on your event.