GET

sims/behaviours API

Retrieve and manage sims/behaviours records from the Apps4Edu sync database.

Endpoint Path

GET /api/sims/behaviours

CURL Example

curl "https://api.apps4education.co.uk/api/sims/behaviours?api_token=YOUR_TOKEN&school=WONDE_SCHOOL_ID" \
-H "Accept: application/json"
    

Field Definitions

Field Type
school_id bigint
id varchar
mis_id varchar
type varchar
action varchar
class varchar
subject varchar
points int
total_points int
comment text
parents_notified tinyint
student_ids text
employee_ids text
action_date datetime
recorded_date datetime
mis_created_at datetime
mis_updated_at datetime
created_at timestamp
updated_at timestamp
location varchar
status varchar
bullying_type varchar
incident_date datetime

Response Body (Sample)

{
  "data": [
    {
      "school_id": "example_value",
      "id": 101,
      "mis_id": true,
      "type": "example_value",
      "action": "example_value",
      "class": "example_value",
      "subject": "example_value",
      "points": "example_value",
      "total_points": "example_value",
      "comment": "example_value",
      "parents_notified": "example_value",
      "student_ids": "example_value",
      "employee_ids": "example_value",
      "action_date": "example_value",
      "recorded_date": "example_value",
      "mis_created_at": true,
      "mis_updated_at": true,
      "created_at": "example_value",
      "updated_at": "example_value",
      "location": "example_value",
      "status": "example_value",
      "bullying_type": "example_value",
      "incident_date": "example_value"
    }
  ]
}
                    

Query Parameters

api_token

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

school

Required. The Wonde school ID; rows from other schools are never returned.

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.