PebblePad : API documentation

Group

Provides the methods for interacting with groups. Each record has a unique Id that is maintained internally by PebblePad's systems. This is not configurable. In every record type, it is the "Id" Guid field, and will be described as "PebblePad's xxxx Id", or similar. There is another field: "CustomId". This is a string in all records. You can use this to match records in PebblePad to those in your own systems. This field will normally be described as "Your Custom Id" or similar.

Methods

Method HTTP request Description
AddMembers PUT https://v3.pebblepad.co.uk/api/1.1/Group/AddMembers/{id} Adds an array of users to a group.
AddMembersOnCustomId PUT https://v3.pebblepad.co.uk/api/1.1/Group/AddMembersOnCustomId/{id} Adds an array of users to a group. Uses your "custom" Id.
Create POST https://v3.pebblepad.co.uk/api/1.1/Group/Create/ Adds a single group.
Delete DELETE https://v3.pebblepad.co.uk/api/1.1/Group/Delete/{id} Deletes a group, but not objects within the group.
DeleteOnCustomId DELETE https://v3.pebblepad.co.uk/api/1.1/Group/DeleteOnCustomId/{id} Deletes a group, but not objects within the group. Uses your "custom" Id.
GetMembers GET https://v3.pebblepad.co.uk/api/1.1/Group/GetMembers/{id} Returns an array of members in the group.
GetMembersOnCustomId GET https://v3.pebblepad.co.uk/api/1.1/Group/GetMembersOnCustomId/{id} Returns the members of a group. Uses your "custom" Id.
RemoveMembers PUT https://v3.pebblepad.co.uk/api/1.1/Group/RemoveMembers/{id} Removes an array of users from a group.
RemoveMembersOnCustomId PUT https://v3.pebblepad.co.uk/api/1.1/Group/RemoveMembersOnCustomId/ Removes an array of users from a group. Uses your "custom" Id.
Update PUT https://v3.pebblepad.co.uk/api/1.1/Group/Update/{id} Updates a group.
UpdateOnCustomId PUT https://v3.pebblepad.co.uk/api/1.1/Group/UpdateOnCustomId/{id} Updates a group. Uses your "custom" Id.

Methods

AddMembers

Adds an array of users to a group.

Scope Required

admin_usermanagement:u

Request

PUT https://v3.pebblepad.co.uk/api/1.1/Group/AddMembers/{id}

Parameters

Parameter name Value Required Description
id GUID Yes Id associated with the group to add members to.
accountIds GUID[] No An array of GUID.

Example request

PUT api/1.1/Group/AddMembers/aa85e6f1-67d4-4892-9102-2ea2e7dd7495 HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx
[
  "2ea2e7dd7495-67d4-4892-9102-aa85e6f1",
  "4ea2e7dd7495-67d4-4892-9102-aa45e6f1"
] 

Response

HTTP / 1.1 200 (OK) 

Example error response

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

AddMembersOnCustomId

Adds an array of users to a group. Uses your "custom" Id.

Scope Required

admin_usermanagement:u

Request

PUT https://v3.pebblepad.co.uk/api/1.1/Group/AddMembersOnCustomId/{id}

Parameters

Parameter name Value Required Description
id string Yes Custom Id associated with the group to add members to.
customAccountIds string[] Yes An array of GUID.

Example request

PUT api/1.1/Group/AddMembersOnCustomId/Idaa85e6f1-67d4 HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx
[
  "Idaa85e6f1",
  "Idaa852fe3"
] 

Response

HTTP / 1.1 200 (OK) 

Example error response

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

Create

Adds a single group.

Scope Required

admin_usermanagement:c

Request

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

Parameters

Parameter name Value Required Description
group groupinfo Yes GroupInfo object, the group to be added. The name property is required

Example request

POST api/1.1/Group/Create HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx

{
  "customid":"Id432dfs9890",
  "name":"Nursing 2015-1",
  "description":"Nursing year 1 students 2015"
} 

Response

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

Example error response

HTTP/1.1 400 (Bad Request)
{
  "errormessage":"'Description' field is too long: max length 255 characters."
} 

Delete

Deletes a group, but not objects within the group.

Scope Required

admin_usermanagement:d

Request

DELETE https://v3.pebblepad.co.uk/api/1.1/Group/Delete/{id}

Parameters

Parameter name Value Required Description
id GUID Yes Id associated with the group to delete.

Example request

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

Response

HTTP 200 (OK) 

Example error response

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

DeleteOnCustomId

Deletes a group, but not objects within the group. Uses your "custom" Id.

Scope Required

admin_usermanagement:d

Request

DELETE https://v3.pebblepad.co.uk/api/1.1/Group/DeleteOnCustomId/{id}

Parameters

Parameter name Value Required Description
id string Yes Custom Id associated with the group to delete.

Example request

DELETE api/1.1/Group/DeleteOnCustomId/Idaa85e6f1-67d4 HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx 

Response

HTTP 200 (OK) 

Example error response

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

GetMembers

Returns an array of members in the group.

Scope Required

admin_usermanagement:r

Request

GET https://v3.pebblepad.co.uk/api/1.1/Group/GetMembers/{id}

Parameters

Parameter name Value Required Description
id GUID Yes Id of the group.

Example request

GET api/1.1/Group/GetMembers/968f13b7-a5f5-4e77-89ee-9f44373ddcf5 HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx 

Response

HTTP 200 (OK)
[
  {
    "id":"aa85e6f1-67d4-4892-9102-2ea2e7dd7495",
    "customid":"mathewe",
    "username":"mathew.e",
    "forename":"Mathew",
    "surname":"Evans",
    "email":"mathew.e@pebblepad.co.uk",
    "password":null,
    "notes":null,
    "status":"MarkedForDeletion"
  }
] 

Example error response

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

GetMembersOnCustomId

Returns the members of a group. Uses your "custom" Id.

Scope Required

admin_usermanagement:r

Request

GET https://v3.pebblepad.co.uk/api/1.1/Group/GetMembersOnCustomId/{id}

Parameters

Parameter name Value Required Description
id string Yes Custom Id associated with the group.

Example request

GET api/1.1/Group/GetMembersOnCustomId/Id9f44373ddcf5 HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx 

Response

HTTP 200 (OK)
[
  {
    "id":"aa85e6f1-67d4-4892-9102-2ea2e7dd7495",
    "customid":"mathewe",
    "username":"mathew.e",
    "forename":"Mathew",
    "surname":"Evans",
    "email":"mathew.e@pebblepad.co.uk",
    "password":null,
    "notes":null,
    "status":"MarkedForDeletion"
  }
] 

Example error response

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

RemoveMembers

Removes an array of users from a group.

Scope Required

admin_usermanagement:u

Request

PUT https://v3.pebblepad.co.uk/api/1.1/Group/RemoveMembers/{id}

Parameters

Parameter name Value Required Description
id GUID Yes Id associated with the group to remove members from.
accountIds GUID[] No An array of GUID.

Example request

PUT api/1.1/Group/RemoveMembersOnCustomId/aa85e6f1-67d4-4892-9102-2ea2e7dd7495 HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx
[
  "Idaa85e6f1",
  "Idaa852fe3"
] 

Response

HTTP / 1.1 200 (OK) 

Example error response

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

RemoveMembersOnCustomId

Removes an array of users from a group. Uses your "custom" Id.

Scope Required

admin_usermanagement:u

Request

PUT https://v3.pebblepad.co.uk/api/1.1/Group/RemoveMembersOnCustomId/

Parameters

Parameter name Value Required Description
id string Yes Custom Id associated with the group to remove members from.
customAccountIds string[] Yes An array of the custom Ids associated with users to be removed.

Example request

PUT api/1.1/Group/RemoveMembersOnCustomId/Idaa85e6f1-67d4 HTTP/1.1
Host: https://v3.pebblepad.co.uk/
Authorization: Bearer xxxxxxxxxxxxxxxx
[
  "Idaa85e6f1",
  "Idaa852fe3"
] 

Response

HTTP / 1.1 200 (OK) 

Example error response

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

Update

Updates a group.

Scope Required

admin_usermanagement:u

Request

PUT https://v3.pebblepad.co.uk/api/1.1/Group/Update/{id}

Parameters

Parameter name Value Required Description
id GUID Yes Id associated with the group to update.
groupInfo groupinfo No

Example request

      POST api/1.1/Group/Update/aa85e6f1-67d4-4892-9102-2ea2e7dd7495 HTTP/1.1
      Host: https://v3.pebblepad.co.uk/
      Authorization: Bearer xxxxxxxxxxxxxxxx

      {
       "name":"Nursing 2015-1",
       "description":"Nursing year 1 students 2015"
      } 

Response

HTTP 200 (OK) 

Example error response

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

UpdateOnCustomId

Updates a group. Uses your "custom" Id.

Scope Required

admin_usermanagement:u

Request

PUT https://v3.pebblepad.co.uk/api/1.1/Group/UpdateOnCustomId/{id}

Parameters

Parameter name Value Required Description
id string Yes Custom Id associated with group to update.
groupInfo groupinfo Yes GroupInfo object to update.

Example request

      POST api/1.1/Group/UpdateOnCustomId/Idaa85e6f1-67d4-4892 HTTP/1.1
      Host: https://v3.pebblepad.co.uk/
      Authorization: Bearer xxxxxxxxxxxxxxxx

      {
       "name":"Nursing 2015-1",
       "description":"Nursing year 1 students 2015"
      } 

Response

HTTP 200 (OK) 

Example error response

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