GET

studentinformation API

Retrieve and manage studentinformation records from the Apps4Edu sync database.

Endpoint Path

GET /api/studentinformation

CURL Example

curl "https://api.apps4education.co.uk/api/studentinformation?api_token=YOUR_TOKEN" \
-H "Accept: application/json"

Field Definitions

Field	Type
`studentID`	int
`numberOfPositiveEvents`	int
`numberOfNegativeEvents`	int
`numberOfNeutralEvents`	int
`isPregnantStudent`	tinyint
`isStudentPaidUniformAllowance`	tinyint
`familyStructureDescription`	text
`nationalCurriculumDescription`	text
`inYear`	tinyint
`laInYearText`	varchar
`twoYearOldFundTypeDescription`	text
`adoptedFromCareTypeName`	varchar
`adoptedFromCareTypeDescription`	text
`adoptedFromCareTypeID`	int
`pupilPremiumFlag`	varchar
`everFSM6Flag`	varchar
`mailingPoint`	tinyint
`startDate`	datetime
`endDate`	datetime
`schoolUniqueReferenceNumber`	varchar
`inCareFlag`	varchar
`homeLanguage`	varchar
`thirtyHourCode`	varchar
`hasDisabilityLivingAllowance`	varchar
`hasFreeEarlyEducation`	varchar
`hasContactWithCorrespondance`	varchar
`disabilityAccessFundIndicator`	varchar
`disadvantagedStudentsFlag`	varchar
`sumOfPositivePointsAllTime`	int
`sumOfNegativePointsAllTime`	int
`sumOfTotalPointsAllTime`	int
`sumOfPositivePointsYTD`	int
`sumOfNegativePointsYTD`	int
`sumOfTotalPointsYTD`	int
`englishAdditionalLanguage`	tinyint
`isMobile`	varchar
`standardAdmissionTime`	varchar
`standardLeavingTime`	varchar
`isChildInNeed`	varchar
`isChildProtectionPlan`	varchar
`newcomer`	varchar
`created_at`	timestamp
`updated_at`	timestamp
`school_id`	bigint

Response Body (Sample)

{
  "data": [
    {
      "studentID": 101,
      "numberOfPositiveEvents": "example_value",
      "numberOfNegativeEvents": "example_value",
      "numberOfNeutralEvents": "example_value",
      "isPregnantStudent": true,
      "isStudentPaidUniformAllowance": true,
      "familyStructureDescription": "example_value",
      "nationalCurriculumDescription": "example_value",
      "inYear": "example_value",
      "laInYearText": "example_value",
      "twoYearOldFundTypeDescription": "example_value",
      "adoptedFromCareTypeName": "example_value",
      "adoptedFromCareTypeDescription": "example_value",
      "adoptedFromCareTypeID": 101,
      "pupilPremiumFlag": "example_value",
      "everFSM6Flag": "example_value",
      "mailingPoint": "example_value",
      "startDate": "example_value",
      "endDate": "example_value",
      "schoolUniqueReferenceNumber": "example_value",
      "inCareFlag": "example_value",
      "homeLanguage": "example_value",
      "thirtyHourCode": "example_value",
      "hasDisabilityLivingAllowance": true,
      "hasFreeEarlyEducation": "example_value",
      "hasContactWithCorrespondance": "example_value",
      "disabilityAccessFundIndicator": true,
      "disadvantagedStudentsFlag": true,
      "sumOfPositivePointsAllTime": "example_value",
      "sumOfNegativePointsAllTime": "example_value",
      "sumOfTotalPointsAllTime": "example_value",
      "sumOfPositivePointsYTD": "example_value",
      "sumOfNegativePointsYTD": "example_value",
      "sumOfTotalPointsYTD": "example_value",
      "englishAdditionalLanguage": true,
      "isMobile": true,
      "standardAdmissionTime": true,
      "standardLeavingTime": "example_value",
      "isChildInNeed": true,
      "isChildProtectionPlan": true,
      "newcomer": "example_value",
      "created_at": "example_value",
      "updated_at": "example_value",
      "school_id": "example_value"
    }
  ]
}

Query Parameters

api_token

Required. Your unique API key must be passed as a query string parameter.

school

Optional. A Bromcom school ID to restrict rows to one school.

page

Optional. Defaults to 1. Used to navigate through paginated results.

per_page

Optional. Rows per page, up to 500 (the default). Follow next_page_url for the rest.