Asdan Logo

Computing Vocational Taster - Sample API

Back to Resource List

Thi is an example of a remote API for use with the ASDAN Computing Vocational Taster course. The data it contains in not real, current, accurate or indicative of any live data used by ASDAN. The API is given as an academic example only and the data should not be relied upon by anyone for any purpose.

Successful requests will return a HTTP 200 response code. Errors will return a corresponding HTTP error code.

List All Courses

Endpoint: http://www.asdan-computing.org.uk/courses/list-all
Method: GET
Parameters:
Parameter Name Accepted Values Default Value Description
page any positive integer 1 When used in combination with count allows the record set to be split into smaller chunks.
count integer 1 - 50 10 When used in combination with count allows the record set to be split into smaller chunks.
format string 'json' or 'xml' json Defines the format of returned data
Example Response (JSON): 
{
  "records_this_page":2,
  "total_records":54,
  "current_page":1,
  "max_page":27,
  "records":[
    {
      "id":"86B9D1FA-40D4-BCA6-921E-7CE9258B675A",
      "course_name":"Activities and Peer Tutoring Short Course",
      "course_description":"Flexible 10-60 hour curriculum programme designed for ages 13-19+",
      "administrator_first_name":"Winifred",
      "administrator_last_name":"Nixon",
      "start_date":"Mon, 04 Aug 2014 12:17:21 +0100",
      "end_date":null,
      "is_active":0
    },
    {
      "id":"5FF23D90-2BED-0BEC-9843-699DA0AC24D6",
      "course_name":"Adult Literacy and Numeracy",
      "course_description":"10-60 hour curriculum programme designed for ages 13-19+",
      "administrator_first_name":"Thomas",
      "administrator_last_name":"Vincent",
      "start_date":"Sun, 31 Aug 2014 03:07:04 +0100",
      "end_date":null,
      "is_active":0
    }
  ]
}

Course Info

Endpoint: http://www.asdan-computing.org.uk/courses/info/**COURSE_ID**
Method: GET
Parameters:
Parameter Name Accepted Values Default Value Description
format string 'json' or 'xml' json Defines the format of returned data
Example Response (JSON): 
{
  "id":"86B9D1FA-40D4-BCA6-921E-7CE9258B675A",
  "course_name":"Activities and Peer Tutoring Short Course",
  "course_description":"Flexible 10-60 hour curriculum programme designed for ages 13-19+",
  "administrator_first_name":"Winifred",
  "administrator_last_name":"Nixon",
  "start_date":"Mon, 04 Aug 2014 12:17:21 +0100",
  "end_date":null,
  "is_active":0
}

Search

Endpoint: http://www.asdan-computing.org.uk/courses/search
Method: GET
Parameters:
Parameter Name Accepted Values Default Value Description
page any positive integer 1 When used in combination with count allows the record set to be split into smaller chunks.
count integer 1 - 50 10 When used in combination with count allows the record set to be split into smaller chunks.
format string 'json' or 'xml' json Defines the format of returned data
course_name | course_description | administrator_first_name | administrator_last_name string   Test to search against the specified field. The string will match any part of the field.
start_date_from | end_date_from datetime (YYYY-MM-DD HH:MM:SS)   Will match dates AFTER the specified datetime
start_date_to | end_date_to datetime (YYYY-MM-DD HH:MM:SS)   Will match dates BEFORE the specified datetime
Example Response (JSON): 
{
  "records_this_page": 2,
  "total_records": 2,
  "current_page": 1,
  "max_page": 1,
  "records": [
    {
      "id": "24F1C935-FBFA-498F-BEC4-0D4584E9B2F1",
      "course_name": "International Short Course",
      "course_description": "10-60 hour curriculum programme designed for ages 13-19+",
      "administrator_first_name": "Odysseus",
      "administrator_last_name": "York",
      "start_date": "Wed, 07 May 2014 09:24:59 +0100",
      "end_date": null,
      "is_active": 0
    },
    {
      "id": "CE31B48B-640A-9C3A-A022-88740E8E88A2",
      "course_name": "PSHE Short Course",
      "course_description": "10-60 hour curriculum programme designed for ages 13-19+",
      "administrator_first_name": "Lillith",
      "administrator_last_name": "Murray",
      "start_date": "Wed, 07 May 2014 14:35:41 +0100",
      "end_date": null,
      "is_active": 1
    }
  ]
}

©2015 ASDAN Education