PebblePad : API documentation

Application

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

Methods

Method HTTP request Description
Create POST https://v3.pebblepad.co.uk/api/1.1/di/Application/Create/ Adds a new application to the Data Island.
Delete DELETE https://v3.pebblepad.co.uk/api/1.1/di/Application/Delete/ Deletes an application from the Data Island.
Get GET https://v3.pebblepad.co.uk/api/1.1/di/Application/Get/{id} Gets an application from the Data Island.
GetAll GET https://v3.pebblepad.co.uk/api/1.1/di/Application/GetAll/ Gets all applications from the Data Island.
GetOnCourseId GET https://v3.pebblepad.co.uk/api/1.1/di/Application/GetOnCourseId/ Gets all applications from the Data Island for a specific course.
GetOnUsername GET https://v3.pebblepad.co.uk/api/1.1/di/Application/GetOnUsername/ Gets all applications from the Data Island for a specific user.
Update POST https://v3.pebblepad.co.uk/api/1.1/di/Application/Update/ Updates an application in the Data Island.
UpdateStatus POST https://v3.pebblepad.co.uk/api/1.1/di/Application/UpdateStatus/ Updates an application's status in the Data Island.

Methods

Create

Adds a new application to the Data Island.

Scope Required

admin_applications:c

Request

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

Example request

POST api/1.1/di/Application/Create HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx
{
  "id":"19023019-d473-4f3a-9d0c-a704c3cd44a2",
  "courseid":"aa85e6f1-67d4-4892-9102-2ea2e7dd7495",
  "username":"john-d",
  "personalstatement":"This is my personal statement. I am a super applicant.",
  "applicationdate":"2015-07-29T21:00:00.000Z",
  "entryyear":1,
  "complete":false,
  "status":"New",
  "progressioncode":"ProgressStarted",
  "deadline":"2015-08-29T21:00:00.000Z"
} 

Response

HTTP / 1.1 200 (OK) 

Example error response

HTTP/1.1 400 (Bad Request)
{
  "errormessage":"The 'Id' field value is used for another application."
} 

Delete

Deletes an application from the Data Island.

Scope Required

admin_applications:d

Request

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

Example request

DELETE api/1.1/di/Application/Delete/19023019-d473-4f3a-9d0c-a704c3cd44a2 HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx 

Response

HTTP / 1.1 200 (OK) 

Example error response

HTTP/1.1 400 (Bad Request)
{
  "errormessage":"Application not found"
} 

Get

Gets an application from the Data Island.

Scope Required

admin_applications:r

Request

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

Parameters

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

Example request

GET api/1.1/di/Application/Get/19023019-d473-4f3a-9d0c-a704c3cd44a2 HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx 

Response

HTTP / 1.1 200 (OK)
{
  "id":"19023019-d473-4f3a-9d0c-a704c3cd44a2",
  "courseid":"aa85e6f1-67d4-4892-9102-2ea2e7dd7495",
  "username":"john-d",
  "personalstatement":"This is my personal statement. I am a super applicant.",
  "applicationdate":"2015-07-29T21:00:00.000Z",
  "entryYear":1,
  "complete":false,
  "status":"New",
  "progressioncode":"ProgressStarted",
  "deadline":"2015-08-29T21:00:00.000Z"
} 

Example error response

HTTP/1.1 400 (Bad Request)
{
  "errormessage":"Application not found"
} 

GetAll

Gets all applications from the Data Island.

Scope Required

admin_applications:r

Request

GET https://v3.pebblepad.co.uk/api/1.1/di/Application/GetAll/

Example request

GET api/1.1/di/Application/GetAll HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx 

Response

HTTP / 1.1 200 (OK)
[
{
  "id":"19023019-d473-4f3a-9d0c-a704c3cd44a2",
  "courseid":"aa85e6f1-67d4-4892-9102-2ea2e7dd7495",
  "username":"john-d",
  "personalstatement":"This is my personal statement. I am a super applicant.",
  "applicationdate":"2015-07-29T21:00:00.000Z",
  "entryYear":1,
  "complete":false,
  "status":"New",
  "progressioncode":"ProgressStarted",
  "deadline":"2015-08-29T21:00:00.000Z"
},
{
  "id":"e13a4973-c0f6-494c-a65c-526a12beb45a",
  "courseid":"dc4421e8-c096-447f-ad7a-e420e1bcc837",
  "username":"jane-d",
  "personalstatement":"This is my personal statement. I am a super applicant.",
  "applicationdate":"2015-07-23T10:00:00.000Z",
  "entryyear":1,
  "complete":false,
  "status":"With Mentor",
  "progressioncode":"ProgressStarted",
  "deadline":"2015-08-29T21:00:00.000Z"
},
{
  "id":"273ccb26-91a8-43d1-b9da-0558c178da94",
  "courseid":"dc4421e8-c096-447f-ad7a-e420e1bcc837",
  "username":"jack-d",
  "personalstatement":"This is my personal statement. I am an average applicant.",
  "applicationdate":"2015-06-13T21:00:00.000Z",
  "entryyear":2,
  "complete":false,
  "status":"New",
  "progressioncode":"ProgressStarted",
  "deadline":"P3311DT15H10M21.15S"
}
] 

Example error response

GetOnCourseId

Gets all applications from the Data Island for a specific course.

Scope Required

admin_applications:r

Request

GET https://v3.pebblepad.co.uk/api/1.1/di/Application/GetOnCourseId/

Example request

Response

Example error response

GetOnUsername

Gets all applications from the Data Island for a specific user.

Scope Required

admin_applications:r

Request

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

Example request

GET api/1.1/di/Application/GetOnUsername/john-d HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx 

Response

HTTP / 1.1 200 (OK)
[
{
  "id":"19023019-d473-4f3a-9d0c-a704c3cd44a2",
  "courseid":"aa85e6f1-67d4-4892-9102-2ea2e7dd7495",
  "username":"john-d",
  "personalstatement":"This is my personal statement. I am a super applicant.",
  "applicationDate":"2015-07-29T21:00:00.000Z",
  "entryyear":1,
  "complete":false,
  "status":"New",
  "progressioncode":"ProgressStarted",
  "deadline":"2015-08-29T21:00:00.000Z"
},
{
  "id":"e13a4973-c0f6-494c-a65c-526a12beb45a",
  "courseid":"dc4421e8-c096-447f-ad7a-e420e1bcc837",
  "username":"john-d",
  "personalstatement":"This is my personal statement. I am a super applicant.",
  "applicationDate":"2015-07-23T10:00:00.000Z",
  "entryyear":1,
  "complete":false,
  "status":"WithMentor",
  "progressioncode":"ProgressStarted",
  "deadline":"2015-08-29T21:00:00.000Z"
}
] 

Example error response

Update

Updates an application in the Data Island.

Scope Required

admin_applications:u

Request

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

Example request

POST api/1.1/di/Application/Update/19023019-d473-4f3a-9d0c-a704c3cd44a2 HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx
{
  "id":"19023019-d473-4f3a-9d0c-a704c3cd44a2",
  "courseid":"aa85e6f1-67d4-4892-9102-2ea2e7dd7495",
  "username":"john-d",
  "personalstatement":"This is my personal statement. I am a super applicant.",
  "applicationdate":"2015-07-29T21:00:00.000Z",
  "entryyear":1,
  "complete":false,
  "status":"WithMentor",
  "progressioncode":"ProgressStarted",
  "deadline":"2015-08-29T21:00:00.000Z"
} 

Response

HTTP / 1.1 200 (OK) 

Example error response

HTTP/1.1 400 (Bad Request)
{
  "errormessage":"Application not found"
} 

UpdateStatus

Updates an application's status in the Data Island.

Scope Required

admin_applications:u

Request

POST https://v3.pebblepad.co.uk/api/1.1/di/Application/UpdateStatus/

Example request

POST api/1.1/di/Application/UpdateStatus HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx
{
  "applicationid":"19023019-d473-4f3a-9d0c-a704c3cd44a2"
  "status":"withdrawn"
} 

Response

HTTP / 1.1 200 (OK)
19023019-d473-4f3a-9d0c-a704c3cd44a2 

Example error response

HTTP/1.1 400 (Bad Request)
{
  "errormessage":"Application not found"
}