Misc

Misc

Get School Instance

Request

GET request to https://appgateway.fireflysolutions.co.uk/appgateway/school/{ School Code }

• School Code - String - Code for the Firefly instance provided by the school. Needed to login to the app. Typically all capital letters.

Response (XML)

<?xml version="1.0" encoding="utf-8"?>
<response exists="{{ Exists }}" enabled="{{ Enabled }}">
	<name>{ School Name }</name>
	<address ssl="{ SSL }">{ Host }</address>
	<installationId>{ Installation ID }</installationId>
</response>

• Exists - Boolean - Whether the school code exists
• Enabled - Boolean - Whether the instance is enabled
• School Name - String - Name of the school
• SSL - Boolean - Whether the host supports SSL
• Host - String - The host / base API endpoint
• Installation ID - Integer - The ID of the installation

Get API Version

Request

GET request to /login/api/version

Response (XML)

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<version firefly6="{ Using Firefly 6 }">
	<majorVersion>{ Major Version }</majorVersion>
	<minorVersion>{ Minor Version }</minorVersion>
	<incrementVersion>{ Increment Version }</incrementVersion>
</version>

• Using Firefly 6 - String (yes/no) - Whether the instance uses Firefly version 6
• Major Version - Integer - The major version of the instance (i.e. X.x.x)
• Minor Version - Integer - The minor version of the instance (i.e. x.X.x)
• Increment Version - Integer - The increment version of the instance (i.e. x.x.X )