Wonde API

https://docs.wonde.com/docs/api/sync
Admin
The Wonde API provides a programmatic way to manage school data within the Wonde cloud using...
Tokens:76,679
Snippets:321
Trust Score:9.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get Students API Response Example (Partial)

Source: https://docs.wonde.com/docs/api/sync/api/sync

This snippet shows a partial example JSON response for listing students from the Wonde API. It includes basic student information like ID, UPI, MIS ID, and names.

```json
{
  "data": [
    {
      "id": "A1749191433",
      "upi": "8d444684b7aa79bc97f8594a4aab7ce3",
      "mis_id": "9919",
      "initials": "RB",
      "title": "Ms",
      "surname": "Bennett",
      "forename": "Ruth",
      "middle_names": null,
      "legal_surname": "Bennett",
      "legal_forename": "Ruth",
      "gender": "FEMALE",
      "gender_identity": null
```

--------------------------------

### Get Doctors List Response Example

Source: https://docs.wonde.com/docs/api/sync/api/sync

An example JSON response showing a list of doctor objects returned from the API.

```JSON
{
  "data": [
    {
      "id": "A1139736963",
      "mis_id": "9920",
      "title": "Mrs",
      "forename": "Sally",
      "middle_name": null,
      "surname": "Smith",
      "practice_name": "Medical Centre",
      "telephone": "01623 123123",
      "building_number": "1",
      "building_name": null,
      "street": "High Street",
      "district": null,
      "town": "London",
      "county": null,
      "postcode": "W1 XYZ",
      "country": "United Kingdom",
      "created_at": {
        "date": "2015-10-29 14:53:44.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "updated_at": {
        "date": "2015-10-29 14:53:44.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    },
    {
      "id": "A1139736963",
      "mis_id": "9920",
      "title": "Mr",
      "forename": "John",
      "middle_name": "James",
      "surname": "Smith",
      "practice_name": "Medical Surgery",
      "telephone": "01623 987876",
      "building_number": null,
      "building_name": null,
      "street": "Main Street",
      "district": null,
      "town": "London",
      "county": null,
      "postcode": "W2 YUB",
      "country": "United Kingdom",
      "created_at": {
        "date": "2016-10-29 14:53:44.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "updated_at": {
        "date": "2016-10-29 14:53:44.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    }
  ]
}
```

--------------------------------

### Get Debtor Charge Category List Response Example

Source: https://docs.wonde.com/docs/api/sync/api/sync

An example JSON response showing a list of debtor charge category objects. This endpoint is currently available for Synergetic SIS school data only and requires `debtors-charge-category.read` permission.

```JSON
[
  {
    "id": "A1771812169",
    "description": "Charge Attribute Description",
    "code": "attributeCode2",
    "created_at": {
      "date": "2015-10-29 14:53:44.000000",
      "timezone_type": 3,
      "timezone": "UTC"
    },
    "updated_at": {
      "date": "2015-10-29 14:53:44.000000",
      "timezone_type": 3,
      "timezone": "UTC"
    }
  }
]
```

--------------------------------

### Get Photos API Response and Query Parameters

Source: https://docs.wonde.com/docs/api/sync/api/sync

This snippet shows an example JSON response for listing photos from the Wonde API, along with the available URL query parameters for filtering and pagination.

```json
{
  "data": [
    {
      "id": "A681203527",
      "content": "base64 encoded string",
      "person_id": "A2032141745",
      "person_mis_id": "1",
      "person_type": "STUDENT",
      "created_at": {
        "date": "2015-10-29 14:59:09.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "updated_at": {
        "date": "2015-10-29 14:59:09.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    },
    {
      "id": "A681203527",
      "content": "base64 encoded string",
      "person_id": "A2073136658",
      "person_mis_id": "2",
      "person_type": "EMPLOYEE",
      "created_at": {
        "date": "2015-10-29 14:59:15.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "updated_at": {
        "date": "2015-10-29 14:59:15.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    }
  ],
  "meta": {
    "pagination": {
      "next": "https://api.wonde.com/v1.0/schools/{school_id}/photos/?page=2",
      "previous": null,
      "more": true,
      "per_page": "2",
      "current_page": 1
    },
    "includes": []
  }
}
```

```APIDOC
Url parameters
| Name | type | Description |
| --- | --- | --- |
| updated_after | date | Return rows modified after date. |
| updated_before | date | Return rows modified before date. |
| per_page | int | Amount of rows to return. |
| include | string | Comma separated list of objects to include. |
```

--------------------------------

### Get Subjects: Response Body Example

Source: https://docs.wonde.com/docs/api/sync/api/sync

Example JSON response containing a list of subject objects, each with an ID, MIS ID, code, name, and active status.

```JSON
{
  "data": [
    {
      "id": "A1529934786",
      "mis_id": 519,
      "code": "Ar",
      "name": "Art",
      "active": true
    }
  ]
}
```

--------------------------------

### Get Rooms API Response and Query Parameters

Source: https://docs.wonde.com/docs/api/sync/api/sync

This snippet shows an example JSON response for listing rooms from the Wonde API, including pagination and included relationships, along with the available URL query parameters for filtering and pagination.

```json
{
  "data": [
    {
      "id": "A1329183376",
      "code": "A1",
      "name": "Art Room 1",
      "created_at": {
        "date": "2015-10-29 10:27:44.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "updated_at": {
        "date": "2015-10-29 10:27:44.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    },
    {
      "id": "A1161584171",
      "code": "A2",
      "name": "Art Room 2",
      "created_at": {
        "date": "2015-10-29 10:27:44.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "updated_at": {
        "date": "2015-10-29 10:27:44.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    }
  ],
  "meta": {
    "pagination": {
      "next": "https://api.wonde.com/v1.0/schools/{school_id}/rooms/?per_page=2&page=2",
      "previous": null,
      "more": true,
      "per_page": "2",
      "current_page": 1
    },
    "includes": [
      "lessons",
      "lessons.class",
      "lessons.class.subject",
      "lessons.period"
    ]
  }
}
```

```APIDOC
Url parameters
| Name | type | Description |
| --- | --- | --- |
| updated_after | date | Return rows modified after date. |
| updated_before | date | Return rows modified before date. |
| per_page | int | Amount of rows to return. |
| include | string | Comma separated list of objects to include. |
```

--------------------------------

### Wonde API Student Leavers List Response Example

Source: https://docs.wonde.com/docs/api/sync/api/sync

An example JSON response showing a paginated list of student leavers from the Wonde API, including metadata, pagination details, and an array of student leaver objects.

```APIDOC
{
  "data": [
    {
      "id": "A1749191433",
      "upi": "8d444684b7aa79bc97f8594a4aab7ce3",
      "mis_id": "9919",
      "initials": "TS",
      "title": "Mr",
      "surname": "Smith",
      "forename": "Tom",
      "middle_names": null,
      "legal_surname": "Smith",
      "legal_forename": "Tom",
      "gender": "MALE",
      "gender_identity": null,
      "date_of_birth": { "date": "2002-09-29 00:00:00.000000", "timezone_type": 3, "timezone": "Europe/London" },
      "restored_at": { "date": "2002-09-29 00:00:00.000000", "timezone_type": 3, "timezone": "Europe/London" },
      "created_at": { "date": "2016-07-14 10:26:12.000000", "timezone_type": 3, "timezone": "UTC" },
      "updated_at": { "date": "2016-07-15 09:59:05.000000", "timezone_type": 3, "timezone": "UTC" }
    },
    {
      "id": "A1749191434",
      "upi": "8d444684b7aa79bc97f8594a4aab7ce4",
      "mis_id": "9920",
      "initials": "JD",
      "title": "Ms",
      "surname": "Doe",
      "forename": "Jane",
      "middle_names": null,
      "legal_surname": "Doe",
      "legal_forename": "Jane",
      "gender": "FEMALE",
      "gender_identity": null,
      "date_of_birth": { "date": "2003-01-15 00:00:00.000000", "timezone_type": 3, "timezone": "Europe/London" },
      "restored_at": { "date": "2003-01-15 00:00:00.000000", "timezone_type": 3, "timezone": "Europe/London" },
      "created_at": { "date": "2015-10-22 20:11:20.000000", "timezone_type": 3, "timezone": "UTC" },
      "updated_at": { "date": "2015-10-22 20:11:20.000000", "timezone_type": 3, "timezone": "UTC" }
    }
  ],
  "meta": {
    "pagination": {
      "next": "https://api.wonde.com/v1.0/schools/{school_id}/students-leaver/?page=2",
      "previous": null,
      "more": true,
      "per_page": 50,
      "current_page": 1
    },
    "includes": [ "education_details", "contact_details", "extended_details", "permissions" ]
  }
}
```

--------------------------------

### Example Response Body for Get Detentions

Source: https://docs.wonde.com/docs/api/sync/api/sync

An example JSON structure returned when querying the Wonde Detentions API. It illustrates the typical data format for multiple detention records, including details like ID, type, timestamps, and associated employees, along with pagination metadata and included relationships.

```json
{
  "data": [
    {
      "id": "A1139736963",
      "mis_id": "1",
      "detention_type": "A1139736963",
      "comment": null,
      "room": "A688857193",
      "start_at": {
        "date": "2016-01-15 12:00:00.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "end_at": {
        "date": "2016-01-15 13:00:00.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "attended_by_employee": "A930902628",
      "created_at": {
        "date": "2023-05-15 15:18:47.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "updated_at": {
        "date": "2023-05-15 15:18:47.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    },
    {
      "id": "A1161584171",
      "mis_id": "2",
      "detention_type": "A1329183376",
      "comment": null,
      "room": "A688857193",
      "start_at": {
        "date": "2016-01-22 12:00:00.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "end_at": {
        "date": "2016-01-22 13:00:00.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "attended_by_employee": "A1299388415",
      "created_at": {
        "date": "2023-05-15 15:18:47.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "updated_at": {
        "date": "2023-05-15 15:18:47.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    }
  ],
  "meta": {
    "pagination": {
      "next": "https://api.wonde.com/v1.0/schools/A1329183376/detentions?page=2",
      "previous": null,
      "more": true,
      "per_page": "2",
      "current_page": 1
    },
    "includes": [
      "detention_type",
      "room",
      "attended_by_employee",
      "attendances",
      "attendances.student"
    ]
  }
}
```

--------------------------------

### Attendance Codes GET Response Body Example

Source: https://docs.wonde.com/docs/api/sync/api/sync

An example of the JSON structure returned when successfully retrieving attendance codes. Note: The provided content is truncated.

```json
{
  "data": [
    {
      "id": "A1329183376",
      "code": "/",
      "description": "Present (AM)",
      "type": "PRESENT",
      "parent_code": null,
      "government_code": "/"
    },
    {
      "id": "A1529934786",
      "code": "B",
      "description": ""
```

--------------------------------

### Example Employee Object Response

Source: https://docs.wonde.com/docs/api/sync/api/sync

An example JSON response body for the Employee object, showing typical fields and their values as returned by the Wonde API. This object requires 'employees read' permission for access.

```json
{
  "id": "A1749191433",
  "upi": "5cc4ab015f8f7870b581e30e0ef474fa",
  "mis_id": "9919",
  "title": "Mr",
  "initials": "TS",
  "surname": "Smith",
  "forename": "Tom",
  "middle_names": null,
  "legal_surname": "Smith",
  "legal_forename": "Tom",
  "gender": "male",
  "date_of_birth": {
    "date": "2002-09-29 00:00:00.000000",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "restored_at": {
    "date": "2016-07-14 10:26:12.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  },
  "created_at": {
    "date": "2016-07-14 10:26:12.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  },
  "updated_at": {
    "date": "2016-07-15 09:59:05.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  }
}
```

--------------------------------

### Retrieve Attendance Codes (GET)

Source: https://docs.wonde.com/docs/api/sync/api/sync

Example cURL command to fetch the list of available attendance codes from the Wonde API.

```bash
curl "https://api.wonde.com/v1.0/attendance-codes" -H "Authorization: Bearer API_ACCESS_TOKEN"
```

--------------------------------

### Lesson Attendance Object Example

Source: https://docs.wonde.com/docs/api/sync/api/sync

An example of the JSON structure for a single lesson attendance object.

```json
{
  "id": "A1964735203",
  "date": {
    "date": "2016-01-15 00:00:00.000000",
    "timezone_type": 3,
    "timezone": "Europe\/London"
  },
  "period_instance_id": 40735,
  "lesson_id": null,
  "comment": null,
  "attendance_code": "A1329183376",
  "student": "A1329183376"
}
```

--------------------------------

### Example JSON Response for Subject List

Source: https://docs.wonde.com/docs/api/sync/api/sync

This JSON snippet shows an example response when querying a list of subjects from the Wonde API. It includes subject details, pagination information, and a list of related objects that can be included.

```JSON
{
  "data": [
    {
      "id": "A1362597725",
      "mis_id": 520,
      "code": "Bi",
      "name": "Biology",
      "created_at": {
        "date": "2015-10-29 10:28:15.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "updated_at": {
        "date": "2015-10-29 10:28:15.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    },
    {
      "id": "A1362597725",
      "mis_id": 520,
      "code": "Bi",
      "name": "Biology",
      "created_at": {
        "date": "2015-10-29 10:28:15.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "updated_at": {
        "date": "2015-10-29 10:28:15.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    }
  ],
  "meta": {
    "pagination": {
      "next": "https://api.wonde.com/v1.0/schools/{school_id}/subjects/?page=2",
      "previous": null,
      "more": true,
      "per_page": "2",
      "current_page": 1
    },
    "includes": [
      "classes",
      "classes.lessons",
      "classes.lessons.period",
      "classes.lessons.room"
    ]
  }
}
```

--------------------------------

### Wonde API: Photos List Response Example (Partial)

Source: https://docs.wonde.com/docs/api/sync/api/sync

A partial example JSON response body for a list of photos from the Wonde API, demonstrating the `content` field which is base64 encoded.

```json
{ "data": [ { "id": "A1376464588", "content": "base64 encoded stri
```

--------------------------------

### Wonde API: Result Set Object Response Example

Source: https://docs.wonde.com/docs/api/sync/api/sync

Provides a concrete JSON example of a Result Set object, demonstrating the format and typical values for its attributes such as ID, name, and timestamps. Useful for parsing API responses.

```json
{
  "id": "A1843063594",
  "mis_id": 56,
  "name": "Year 11",
  "module": "Assessment Services",
  "source": "User-defined",
  "supplier": null,
  "external_id": "56",
  "locked": false,
  "start_date": null,
  "end_date": null,
  "created_at": {
    "date": "2016-07-06 14:32:40.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  },
  "updated_at": {
    "date": "2016-07-06 15:22:35.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  }
}
```

--------------------------------

### Wonde API: Assessment Object Response Example

Source: https://docs.wonde.com/docs/api/sync/api/sync

Illustrates a sample JSON response for the Assessment object, showing typical values for its properties. This example helps in understanding the data format returned by the API.

```json
{
  "id": "A1843063594",
  "mis_id": 56,
  "name": "Year 11",
  "module": "Assessment Services",
  "source": "User-defined",
  "supplier": null,
  "external_id": "56",
  "locked": false,
  "start_date": null,
  "end_date": null,
  "created_at": {
    "date": "2016-07-06 14:32:40.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  },
  "updated_at": {
    "date": "2016-07-06 15:22:35.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  }
}
```

--------------------------------

### Example JSON Response for Writeback Object

Source: https://docs.wonde.com/docs/api/sync/api/sync

This JSON snippet shows an example response when retrieving a single writeback object from the Wonde API. It details the writeback's ID, type, current status, and timestamps for attempts and creation/update.

```JSON
{
  "data": {
    "id": "A1529934786",
    "type": "ACHIEVEMENT",
    "status": "FAILED",
    "last_attempt": null,
    "next_attempt": null,
    "created_at": {
      "date": "2015-10-29 10:28:15.000000",
      "timezone_type": 3,
      "timezone": "UTC"
    },
    "updated_at": {
      "date": "2015-10-29 10:28:15.000000",
      "timezone_type": 3,
      "timezone": "UTC"
    }
  }
}
```

--------------------------------

### Example Wonde Class Object JSON

Source: https://docs.wonde.com/docs/api/sync/api/sync

An example JSON representation of a Wonde Class object, showing typical fields and their values. This object requires 'classes read' permission to view.

```JSON
{
  "id": "A1139736963",
  "mis_id": "9920",
  "name": "10A/En1",
  "code": "10A/En1",
  "description": null,
  "subject": {
    "id": "A1139736963",
    "mis_id": "9920",
    "name": "English",
    "code": "EN",
    "created_at": {
      "date": "2015-10-29 14:53:59.000000",
      "timezone_type": 3,
      "timezone": "UTC"
    },
    "updated_at": {
      "date": "2015-10-29 14:53:59.000000",
      "timezone_type": 3,
      "timezone": "UTC"
    }
  },
  "alternative": false,
  "priority": false,
  "academic_year": 2023,
  "year_group": "10",
  "restored_at": {
    "date": "2015-10-29 14:53:59.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  },
  "created_at": {
    "date": "2015-10-29 14:53:59.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  },
  "updated_at": {
    "date": "2015-10-29 14:53:59.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  }
}
```

--------------------------------

### Example Employment Details Object Response

Source: https://docs.wonde.com/docs/api/sync/api/sync

An example JSON response body for the Employment Details object, providing specific information about an employee's work status and history. This object requires 'employees read' permission for access.

```json
{
  "teaching_staff": true,
  "current": true,
  "teacher_number": "84/82693",
  "teacher_category": "Qualified Teacher",
  "staff_code": "AA",
  "primary_location": "0810",
  "employment_start_date": {
    "date": "1988-09-01 00:00:00.000000",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "employment_end_date": null,
  "local_authority_start_date": {
    "date": "1988-09-01 00:00:00.000000",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "employee_payroll_number": "8372CGT",
  "role_text": "Teacher",
  "qualified_teacher_status": "Qualified",
  "qualified_teacher_status_route": "Annual College Exit - Post graduate course",
  "higher_level_teaching_assistant_status": "F"
}
```

--------------------------------

### Wonde API GET Behaviours Endpoint

Source: https://docs.wonde.com/docs/api/sync/api/sync

Demonstrates how to retrieve behaviour records from the Wonde API, including examples for fetching all behaviours and a specific behaviour by ID. It also details the expected response structure and available URL query parameters for filtering and inclusion.

```Curl
curl "https://api.wonde.com/v1.0/schools/{school_id}/behaviours" -H "Authorization: Bearer API_ACCESS_TOKEN"
curl "https://api.wonde.com/v1.0/schools/{school_id}/behaviours/{behaviour_id}" -H "Authorization: Bearer API_ACCESS_TOKEN"
```

```JSON
{
  "data": [
    {
      "id": "A1329183376",
      "mis_id": "263",
      "type": "Homework Issue",
      "location": "Science",
      "subject": "Science",
      "class": "7A/Science",
      "status": "Resolved",
      "action": "Lunchtime Detention",
      "points": 1,
      "total_points": 10,
      "comment": "Despite previous warnings, one of five students who still have significant homework from two weeks ago still outstanding.",
      "parents_notified": false,
      "bullying_type": "Bullying-Intimidation",
      "incident_date": {
        "date": "2009-04-29 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
      },
      "action_date": {
        "date": "2009-05-01 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
      },
      "recorded_date": {
        "date": "2009-04-29 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
      },
      "created_at": {
        "date": "2016-03-15 11:08:55.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "updated_at": {
        "date": "2016-03-15 11:08:55.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    },
    {
      "id": "A1161584171",
      "mis_id": "264",
      "type": "Disruptive Behaviour in Class",
      "location": "Art",
      "subject": "Art",
      "class": "7A/Art",
      "status": "Resolved",
      "action": "Written Punishment",
      "points": 1,
      "comment": "Repeatedly off task and talking in class.",
      "parents_notified": false,
      "bullying_type": "Bullying-Intimidation",
      "incident_date": {
        "date": "2009-05-06 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
      },
      "action_date": {
        "date": "2009-05-06 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
      },
      "recorded_date": {
        "date": "2009-05-06 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
      },
      "created_at": {
        "date": "2016-03-15 11:08:55.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "updated_at": {
        "date": "2016-03-15 11:08:55.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    }
  ],
  "meta": {
    "pagination": {
      "next": "https://api.wonde.com/v1.0/schools/A1329183376/behaviours?page=2",
      "previous": null,
      "more": true,
      "per_page": 50,
      "current_page": 1
    },
    "includes": [
      "students",
      "employees"
    ]
  }
}
```

```APIDOC
URL Parameters:
  incident_date_before: date - Return entries before date.
  incident_date_after: date - Return entries after date.
  updated_after: date - Return rows modified after date.
  updated_before: date - Return rows modified before date.
  per_page: int - Amount of rows to return.
  include: string - Comma separated list of objects to include.
  has_students: string - Only return records that have students attached.
  has_employees: string - Only return records that have employees attached.
  mis_id: string int - Return records with the provided MIS_ID.

Related Objects:
  students: many - [student-object]
  employees: many - [employee-object]
```

--------------------------------

### GET Attendance Summaries API Reference

Source: https://docs.wonde.com/docs/api/sync/api/sync

Comprehensive documentation for retrieving attendance summaries. This section includes Curl request examples, sample JSON responses, URL parameters, related objects, and the detailed schema for the Attendance Summary object.

```bash
curl "https://api.wonde.com/v1.0/schools/{school_id}/attendance-summaries" -H "Authorization: Bearer API_ACCESS_TOKEN"
curl "https://api.wonde.com/v1.0/schools/{school_id}/attendance-summaries/{summary_id}" -H "Authorization: Bearer API_ACCESS_TOKEN"
```

```json
{
  "data": [
    {
      "id
```

--------------------------------

### Wonde API: Periods List Response Example

Source: https://docs.wonde.com/docs/api/sync/api/sync

An example JSON response body for a list of periods from the Wonde API, including pagination metadata and a list of related objects that can be included.

```json
{ "data": [ { "id": "A1329183376", "start_time": "09:05:00", "end_time": "09:45:00", "name": "Mon 1", "day": "monday", "day_number": 1, "description": "Monday 1st", "created_at": { "date": "2015-10-29 10:32:22.000000", "timezone_type": 3, "timezone": "UTC" }, "updated_at": { "date": "2015-10-29 10:32:22.000000", "timezone_type": 3, "timezone": "UTC" } }, { "id": "A1161584171", "start_time": "09:15:00", "end_time": "10:15:00", "name": "Mon:1", "day": "monday", "day_number": 1, "description": "Monday 1st", "created_at": { "date": "2015-10-29 10:32:22.000000", "timezone_type": 3, "timezone": "UTC" }, "updated_at": { "date": "2015-10-29 10:32:22.000000", "timezone_type": 3, "timezone": "UTC" } } ], "meta": { "pagination": { "next": "https://api.wonde.com/v1.0/schools/{school_id}/periods/?page=2", "previous": null, "more": true, "per_page": "2", "current_page": 1 }, "includes": [ "cycle", "lessons", "lessons.room", "lessons.class", "lessons.class.subject" ] } }
```

--------------------------------

### Lesson Attendance POST Request Body Example

Source: https://docs.wonde.com/docs/api/sync/api/sync

An example of the JSON structure required in the request body when submitting lesson attendance marks via a POST request.

```json
{
  "attendance": [
    {
      "student_id": "A1905879176",
      "lesson_id": "A1052845378",
      "attendance_code_id": "A1329183376"
    },
    {
      "student_id": "A1905879176",
      "lesson_id": "A312724695",
      "attendance_code_id": "A1964735203"
    }
  ]
}
```

--------------------------------

### Wonde API: Session Attendance Response Example

Source: https://docs.wonde.com/docs/api/sync/api/sync

Provides a sample JSON response for the GET Session Attendance endpoint, showing an array of attendance records with details like ID, date, session, and associated student. Includes pagination metadata for navigating through results.

```json
{
  "data": [
    {
      "id": "A475458937",
      "date": {
        "date": "2015-10-29 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
      },
      "session": "PM",
      "comment": null,
      "employee": null,
      "attendance_code": "A930902628",
      "student": "A1307078120"
    },
    {
      "id": "A106056174",
      "date": {
        "date": "2015-10-29 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
      },
      "session": "PM",
      "comment": "Student was ill",
      "employee": null,
      "attendance_code": "A930902628",
      "student": "A938854481"
    }
  ],
  "meta": {
    "pagination": {
      "next": "https://api.wonde.com/v1.0/schools/{school_id}/attendance/session/?page=2",
      "previous": null,
      "more": true,
      "per_page": "2",
      "current_page": 1
    },
    "includes": []
  }
}
```

--------------------------------

### API Response Example: Behaviour Attributes List

Source: https://docs.wonde.com/docs/api/sync/api/sync

An example JSON response body containing a list of behaviour attributes. This demonstrates the structure and typical values for attribute definitions, including pagination metadata for navigating results.

```JSON
{
  "data": [
    {
      "id": "A587541588",
      "mis_id": "26",
      "type": "BEHAVIOUR_TYPE",
      "code": "BULL",
      "active": true,
      "points": 50,
      "description": "Bullying",
      "bullying_type_enabled": true,
      "created_at": { "date": "2016-03-16 15:23:42.000000", "timezone_type": 3, "timezone": "UTC" },
      "updated_at": { "date": "2016-03-24 09:39:11.000000", "timezone_type": 3, "timezone": "UTC" }
    },
    {
      "id": "A1346550315",
      "mis_id": "22",
      "type": "EVENT_SUBJECT",
      "code": "SCI",
      "active": true,
      "points": null,
      "description": "Science",
      "bullying_type_enabled": false,
      "created_at": { "date": "2016-03-16 15:23:42.000000", "timezone_type": 3, "timezone": "UTC" },
      "updated_at": { "date": "2016-03-17 15:01:40.000000", "timezone_type": 3, "timezone": "UTC" }
    }
  ],
  "meta": {
    "pagination": {
      "next": "https://api.wonde.com/v1.0/schools/{school_id}/behaviours/attributes?page=2",

```

--------------------------------

### Example JSON Response for Offline Schools

Source: https://docs.wonde.com/docs/api/sync/api/sync

An illustrative JSON object showing the typical data structure returned by the Wonde API's GET /schools/offline endpoint. It includes an array of school objects with detailed information like ID, name, address, and extended properties, along with pagination metadata.

```json
{
    "data": [
        {
            "id": "A1329183376",
            "name": "Sir John Cass's Foundation Primary School",
            "establishment_number": "3614",
            "urn": 10000,
            "phase_of_education": "PRIMARY",
            "la_code": "201",
            "timezone": null,
            "mis": null,
            "address": {
                "address_line_1": "St James's Passage",
                "address_line_2": "Duke's Place",
                "address_town": "London",
                "address_postcode": "EC3A 5DE",
                "address_country": {
                    "code": "GBR",
                    "name": "United Kingdom"
                }
            },
            "extended": {
                "allows_writeback": true,
                "has_timetables": false,
                "has_lesson_attendance": false
            },
            "region": {
                "code": "GBR",
                "domain": "api.wonde.com",
                "school_url": "https://api.wonde.com/v1.0/schools/A1300691890",
                "identifiers": {
                    "la_code": "201",
                    "establishment_number": "3614",
                    "urn": 10000
                }
            }
        },
        {
            "id": "A1161584171",
            "name": "City of London School for Girls",
            "establishment_number": 6005,
            "urn": 10001,
            "phase_of_education": "NOT APPLICABLE",
            "la_code": 201,
            "timezone": null,
            "mis": null,
            "address": {
                "address_line_1": "St Giles' Terrace",
                "address_line_2": "Barbican",
                "address_town": "London",
                "address_postcode": "EC2Y 8BB",
                "address_country": {
                    "code": "GBR",
                    "name": "United Kingdom"
                }
            },
            "extended": {
                "allows_writeback": true,
                "has_timetables": false,
                "has_lesson_attendance": false
            },
            "region": {
                "code": "GBR",
                "domain": "api.wonde.com",
                "school_url": "https://api.wonde.com/v1.0/schools/A1300691890",
                "identifiers": {
                    "la_code": 201,
                    "establishment_number": 6005,
                    "urn": 10001
                }
            }
        }
    ],
    "meta": {
        "pagination": {
            "next": "https://api.wonde.com/v1.0/schools?page=2",
            "previous": null,
            "more": true,
            "per_page": 50,
            "current_page": 1
        }
    }
}
```

--------------------------------

### Debtor Charge Attribute Object Example

Source: https://docs.wonde.com/docs/api/sync/api/sync

An example JSON object representing a single debtor charge attribute. This object requires `debtors charge category read` permission to view.

```JSON
{
  "id": "A1771812169",
  "description": "Charge Attribute Description",
  "code": "attributeCode2",
  "created_at": {
    "date": "2015-10-29 14:53:44.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  },
  "updated_at": {
    "date": "2015-10-29 14:53:44.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  }
}
```

--------------------------------

### Lesson Attendance POST Response Body Example

Source: https://docs.wonde.com/docs/api/sync/api/sync

An example of the JSON structure returned after a successful POST request to submit lesson attendance. A 'writeback_id' is provided to check the status of the operation.

```json
{
  "writeback_id": "A18002453"
}
```

--------------------------------

### Session Attendance Writeback Request Body Example

Source: https://docs.wonde.com/docs/api/sync/api/sync

A JSON example of the request body required for the POST /v1.0/schools/{school_id}/attendance/session endpoint. It demonstrates how to structure attendance entries for multiple students and sessions.

```JSON
{ "attendance": [ { "student_id": "A960618364", "date": "2015-12-14", "session": "AM", "attendance_code_id": "A1329183376" }, { "student_id": "A960618364", "date": "2015-12-14", "session": "PM", "attendance_code_id": "A1161584171" } ] }
```

--------------------------------

### Session Attendance Object Structure Example

Source: https://docs.wonde.com/docs/api/sync/api/sync

A JSON example illustrating the structure of a single session attendance object returned by the Wonde API. It shows key fields such as ID, date, session, and associated student and attendance code.

```JSON
{ "id": "A106056174", "date": { "date": "2015-10-29 00:00:00.000000", "timezone_type": 3, "timezone": "Europe/London" }, "session": "PM", "employee": null, "attendance_code": "A930902628", "student": "A938854481" }
```

--------------------------------

### Example Response Body for Lessons List

Source: https://docs.wonde.com/docs/api/sync/api/sync

Illustrates the structure of the JSON response when retrieving a list of lessons, including individual lesson details, pagination metadata, and available includes.

```json
{
  "data": [
    {
      "id": "A749126774",
      "room": "A1161584171",
      "period": "A1161584171",
      "period_instance_id": "40860",
      "employee": null,
      "start_at": {
        "date": "2016-02-22 09:15:00.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "end_at": {
        "date": "2016-02-22 10:15:00.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "created_at": {
        "date": "2016-02-08 11:25:28.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "updated_at": {
        "date": "2016-02-08 11:25:28.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    }
  ],
  "meta": {
    "pagination": {
      "next": "https://api.wonde.com/v1.0/schools/A1329183376/lessons?page=2",
      "previous": null,
      "more": true,
      "per_page": 50,
      "current_page": 1
    },
    "includes": [
      "class",
      "employee",
      "employees",
      "period",
      "room"
    ]
  }
}
```

--------------------------------

### Get Doctors API Curl Examples

Source: https://docs.wonde.com/docs/api/sync/api/sync

Curl command examples for retrieving a list of doctors or a specific doctor by ID from the Wonde API.

```Curl
curl "https://api.wonde.com/v1.0/schools/{school_id}/doctors" -H "Authorization: Bearer API_ACCESS_TOKEN"
curl "https://api.wonde.com/v1.0/schools/{school_id}/doctors/{doctor_id}" -H "Authorization: Bearer API_ACCESS_TOKEN"
```

--------------------------------

### Example Response Body for Single Lesson Object

Source: https://docs.wonde.com/docs/api/sync/api/sync

Shows the JSON structure for a single lesson object, detailing its properties like ID, associated room and period, employee ID, and various timestamps.

```json
{
  "id": "A473090460",
  "room": "A1529934786",
  "period": "A1299388415",
  "employee_id": "A1656263924",
  "period_instance_id": "40716",
  "alternative": false,
  "start_at": {
    "date": "2015-12-16 09:15:00.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  },
  "end_at": {
    "date": "2015-12-16 10:15:00.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  },
  "created_at": {
    "date": "2015-12-03 19:11:55.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  },
  "updated_at": {
    "date": "2015-12-03 19:11:55.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  }
}
```

--------------------------------

### Example Wonde API Response for Single Pre-admission Student

Source: https://docs.wonde.com/docs/api/sync/api/sync

This JSON snippet provides an example of a single pre-admission student object returned by the Wonde API, showcasing its structure and typical data fields. Note that specific permissions are required to view this object.

```JSON
{
  "id": "A1749191433",
  "upi": "8d444684b7aa79bc97f8594a4aab7ce3",
  "mis_id": "9919",
  "initials": "TS",
  "title": "Mr",
  "surname": "Smith",
  "forename": "Tom",
  "middle_names": null,
  "legal_surname": "Smith",
  "legal_forename": "Tom",
  "gender": "MALE",
  "gender_identity": null,
  "date_of_birth": { "date": "2002-09-29 00:00:00.000000", "timezone_type": 3, "timezone": "Europe/London" },
  "restored_at": { "date": "2016-07-14 10:26:12.000000", "timezone_type": 3, "timezone": "UTC" },
  "created_at": { "date": "2016-07-14 10:26:12.000000", "timezone_type": 3, "timezone": "UTC" },
  "updated_at": { "date": "2016-07-15 09:59:05.000000", "timezone_type": 3, "timezone": "UTC" }
}
```
Tokens:
Raw