PebblePad : API documentation

ApplicationReference

Provides the methods for interacting with application references 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/ApplicationReference/Create/ Adds a new application reference to the Data Island.
Delete DELETE https://v3.pebblepad.co.uk/api/1.1/di/ApplicationReference/Delete/ Deletes an application reference from the Data Island.
Get GET https://v3.pebblepad.co.uk/api/1.1/di/ApplicationReference/Get/{id} Gets an application reference from the Data Island.
GetOnApplicationId GET https://v3.pebblepad.co.uk/api/1.1/di/ApplicationReference/GetOnApplicationId/ Gets all application references from the Data Island for a specific application.
Update POST https://v3.pebblepad.co.uk/api/1.1/di/ApplicationReference/Update/ Updates an application reference in the Data Island.

Methods

Create

Adds a new application reference to the Data Island.

Scope Required

admin_applications:c

Request

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

Example request

POST api/1.1/di/ApplicationReference/Create HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx
{
  "id":"c29affe5-e0dc-4e4c-a8d4-b95a59aab34d",
  "applicationid":"19023019-d473-4f3a-9d0c-a704c3cd44a2",
  "name":"Joe Bloggs",
  "organisation":"Fake Referees Ltd",
  "post":"Head referee",
  "statement":"The applicant is almost entirely suitable"
} 

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 reference."
} 

Delete

Deletes an application reference from the Data Island.

Scope Required

admin_applications:d

Request

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

Example request

DELETE api/1.1/di/ApplicationReference/Delete/c29affe5-e0dc-4e4c-a8d4-b95a59aab34d 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 reference not found"
} 

Get

Gets an application reference from the Data Island.

Scope Required

admin_applications:r

Request

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

Parameters

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

Example request

GET api/1.1/di/ApplicationReference/Get/c29affe5-e0dc-4e4c-a8d4-b95a59aab34d HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx 

Response

HTTP / 1.1 200 (OK)
{
  "id":"c29affe5-e0dc-4e4c-a8d4-b95a59aab34d",
  "applicationid":"19023019-d473-4f3a-9d0c-a704c3cd44a2",
  "name":"Joe Bloggs",
  "organisation":"Fake Referees Ltd",
  "post":"Head referee",
  "statement":"The applicant is almost entirely suitable"
} 

Example error response

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

GetOnApplicationId

Gets all application references from the Data Island for a specific application.

Scope Required

admin_applications:r

Request

GET https://v3.pebblepad.co.uk/api/1.1/di/ApplicationReference/GetOnApplicationId/

Example request

Response

Example error response

Update

Updates an application reference in the Data Island.

Scope Required

admin_applications:u

Request

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

Example request

POST api/1.1/di/ApplicationReference/Update/c29affe5-e0dc-4e4c-a8d4-b95a59aab34d HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx
{
  "id":"c29affe5-e0dc-4e4c-a8d4-b95a59aab34d",
  "applicationid":"19023019-d473-4f3a-9d0c-a704c3cd44a2",
  "name":"Joe Bloggs II",
  "organisation":"Fake Referees Ltd",
  "post":"Head referee",
  "statement":"The applicant is really rather grand. Updated."
} 

Response

HTTP / 1.1 200 (OK) 

Example error response

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