SOCS Co-curricular XML Feeds

Modified on Tue, 9 Jun at 3:37 PM

There are 2 main XML feeds for co-curricular data:


1. The activity club list for all terms in the current academic year

2. The activity club events list for the current date or a specified date range. This also includes the pupils for each event for the previous 7 and next 14 days.


Activity Club List


The activity clubs feed contains the list of clubs for the current and next term. Every term a new activity club is created, so for example the Debating club will have a different ClubID each term.


The following options can be added to the URL for the activity club list:


1. &notes=1 to include the "notes" field for the club

2. &planning=1 to include the default venue and the day time planning information for the club (the time that the club takes place each day)

3. &pupils=1 to include the pupils for the club

4. &staff=1 to include the staff for the club


Example URL to include everything:


[feedurl]&notes=1&planning=1&pupils=1&staff=1


Event List


This includes all events for the current date by default. A date range can be used by adding "startdate" and "enddate" querystrings to the URL as follows:


&startdate=1 Sep 2026&enddate=1 Oct 2026


Events will only be included for activity clubs for the current term and next term.


The "pupils" field will only be included by default for events which occur within the previous 7 and next 14 days. 


The "staff" field will only be included if "&staff=1" is added to the url. Staff will only appear for events which occur within the previous 7 and next 14 days.


Example URL:


[feedurl]&startdate=1 Sep 2026&enddate=1 Oct 2026&staff=1


Registers


This includes all event registers for the current date by default. A date range can be specified by adding "startdate" querystring to the URL as follows:


&startdate=1 Sep 2026


This feed must be used in conjunction with the "Events List" feed above.


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article