PebblePad : API documentation

Qualification

Provides the methods for interacting with courses held in the Data Island. Each record has a unique Id that is provided by you and should to match those in your own systems.

Methods

Method HTTP request Description
Create POST https://v3.pebblepad.co.uk/api/1.1/di/Qualification/Create/ Adds a new Qualification to the Data Island.
Delete DELETE https://v3.pebblepad.co.uk/api/1.1/di/Qualification/Delete/ Deletes a Qualification from the Data Island.
Get GET https://v3.pebblepad.co.uk/api/1.1/di/Qualification/Get/{id} Gets a Qualification from the Data Island.
GetOnUsername GET https://v3.pebblepad.co.uk/api/1.1/di/Qualification/GetOnUsername/ Gets all Qualifications for a User from the Data Island.
Update POST https://v3.pebblepad.co.uk/api/1.1/di/Qualification/Update/ Updates a Qualification in the Data Island.

Methods

Create

Adds a new Qualification to the Data Island.

Scope Required

admin_qualifications:c

Request

POST https://v3.pebblepad.co.uk/api/1.1/di/Qualification/Create/

Example request

GET api/1.1/di/Qualification/Create HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx
{
  "id": "aa85e6f1-67d4-4892-9102-2ea2e7dd7495",
  "title": "Artistic Design for the Digital Platform",
  "previousgrade": "B",
  "predictedgrade": "A",
  "grade": "A",
  "awardingbody": "AQA",
  "studiedat": "South London College",
  "type": "A-Level",
  "awarddate": "2016-05-21T21:00:00.000Z",
  "username": "aa85e6f1"
} 

Response

HTTP / 1.1 200 (OK)
"aa85e6f1-67d4-4892-9102-2ea2e7dd7495" 

Example error response

HTTP/1.1 400 (Bad Request)
{
  "errormessage":"Id for the given Qualification is already being used",
  "erroritem":"aa85e6f1-67d4-4892-9102-2ea2e7dd7495"
} 

Delete

Deletes a Qualification from the Data Island.

Scope Required

admin_qualifications:d

Request

DELETE https://v3.pebblepad.co.uk/api/1.1/di/Qualification/Delete/

Example request

DELETE api/1.1/di/Qualification/Delete/aa85e6f1-67d4-4892-9102-2ea2e7dd7495 HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx 

Response

HTTP / 1.1 200 (OK)
"aa85e6f1-67d4-4892-9102-2ea2e7dd7495" 

Example error response

HTTP/1.1 400 (Bad Request)
{
  "errormessage":"No Qualification was found with the given Id",
  "erroritem":"aa85e6f1-67d4-4892-9102-2ea2e7dd7495"
} 

Get

Gets a Qualification from the Data Island.

Scope Required

admin_qualificiations:r

Request

GET https://v3.pebblepad.co.uk/api/1.1/di/Qualification/Get/{id}

Parameters

Parameter name Value Required Description
id string Yes Data Island Course Id

Example request

GET api/1.1/di/Qualification/Get/aa85e6f1-67d4-4892-9102-2ea2e7dd7495 HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx 

Response

HTTP / 1.1 200 (OK)
{
  "id": "aa85e6f1-67d4-4892-9102-2ea2e7dd7495",
  "title": "Artistic Design for the Digital Platform",
  "previousgrade": "B",
  "predictedgrade": "A",
  "grade": "A",
  "awardingbody": "AQA",
  "studiedat": "South London College",
  "type": "A-Level",
  "awarddate": "2016-05-21T21:00:00.000Z",
  "username": "aa85e6f1"
} 

Example error response

HTTP/1.1 400 (Bad Request)
{
  "errormessage":"No Qualification was found with the given Id",
  "erroritem":"aa85e6f1-67d4-4892-9102-2ea2e7dd7495"
} 

GetOnUsername

Gets all Qualifications for a User from the Data Island.

Scope Required

admin_qualifications:r

Request

GET https://v3.pebblepad.co.uk/api/1.1/di/Qualification/GetOnUsername/

Example request

GET api/1.1/di/Qualification/GetAllForUser/aa85e6f1 HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx 

Response

HTTP / 1.1 200 (OK)
[
  {
    "id": "aa85e6f1-67d4-4892-9102-2ea2e7dd7495",
    "title": "Artistic Design for the Digital Platform",
    "previousgrade": "B",
    "predictedgrade": "A",
    "grade": "A",
    "awardingbody": "AQA",
    "studiedat": "South London College",
    "type": "A-Level",
    "awarddate": "2016-05-21T21:00:00.000Z",
    "username": "aa85e6f1"
  },
  {
    "id": "ba85e6f1-67d4-4892-9102-2ea2e7dd7495",
    "title": "Designing for the Real World",
    "previousgrade": "C",
    "predictedgrade": "B",
    "grade": "C",
    "awardingbody": "AQA",
    "studiedat": "South London College",
    "type": "A-Level",
    "awarddate": "2016-05-21T21:00:00.000Z",
    "username": "aa85e6f1"
  }
] 

Example error response

Update

Updates a Qualification in the Data Island.

Scope Required

admin_qualifications:u

Request

POST https://v3.pebblepad.co.uk/api/1.1/di/Qualification/Update/

Example request

POST api/1.1/di/Qualification/Update/aa85e6f1-67d4-4892-9102-2ea2e7dd7495 HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx
{
  "id": "aa85e6f1-67d4-4892-9102-2ea2e7dd7495",
  "title": "Artistic Design for the Digital Platform",
  "previousgrade": "B",
  "predictedgrade": "A",
  "grade": "A",
  "awardingbody": "AQA",
  "studiedat": "South London College",
  "type": "A-Level",
  "awarddate": "2016-05-21T21:00:00.000Z",
  "username": "aa85e6f1"
} 

Response

HTTP / 1.1 200 (OK)
"aa85e6f1-67d4-4892-9102-2ea2e7dd7495" 

Example error response

HTTP/1.1 400 (Bad Request)
{
  "errormessage":"No Qualification was found with the given Id",
  "erroritem":"aa85e6f1-67d4-4892-9102-2ea2e7dd7495"
}