Permission Resource

← Developer Portal: API v2
Using the Surpass API, it is possible to retrieve a list of all the permission types that are available in Surpass. This information can then be used to assign the relevant permissions to your users in Surpass by calling subsequent methods.

Permission Resource

Below we have listed the operations, HTTP verbs and an example URL for the permission resource within the Surpass API. 
Operation HTTP Verb Example URL
List GET https://...surpass.com/api/v2/Permission

Attributes for the Permission Resource

Within the table below we have provided all of the attributes included in the permission resource. This includes the attribute name, data type, if the attribute is orderable when requesting the GET method and if the attribute is available to filter when requesting the GET method.
Attribute Name Type Description Order (GET) Filter (GET) Available Operators (GET) Unique Identifier
id int Unique identifier for the permission in Surpass. X
name String The permission name in Surpass.

GET Request and Return

The Permission resource can be called directly by browsing to the URL. Below we have provided examples of JSON and XML responses that would be returned from the Surpass API when requesting the GET method for the Permission resource. It is important to remember that the return information will be included within the response object that forms part of the standard GET response. This is detailed in the page understanding the Surpass API.

Example GET request and response (JSON)
Example GET request and response (XML)


Required Permissions

To successfully call the Permission method, the user specified in the header of the request must have the ‘Manage Users’ permission in Surpass.

Developer Portal: API v2

  1. Surpass API v2 - Introduction
  2. Using the Surpass API
  3. Centre Resource
  4. Subject Resource
  5. User Resource
  6. Candidate Resource
  7. TestSchedule Resource
  8. Result Resource
  9. TestSession Resource
  10. Exporting Candidate Interactions
  11. Exporting System Specification for Test Delivery machines
  12. SummaryResult Resource
  13. Report Resource
  14. Token Resource
  15. Permission Resource
  16. UserPermission Resource
  17. CentreSubjectAssociation Resource
  18. TagCategory Resource
  19. TagGroup Resource
  20. TagValue Resource
  21. ItemTagValue Resource
  22. Media Resource
  23. Folder Resource
  24. Item Resource
  25. Item List Resource
  26. BasicPage Resource
  27. TestProfile Resource
  28. Test Resource
  29. AnalyticsResult Resource
  30. HistoricalResult Resource
  31. Item Response Resource
  32. RescoringRule Resource
  33. Scale Score Mapping Resources
  34. ItemSet Resource
  35. Country Resource
  36. County Resource
  37. Task Resource
  38. MediaGroup Resource
  39. Surpass API v2 - Error Codes
  40. Extended Matching Item Resource
  41. GET/{id} - Item Extended Matching - JSON Example
  42. GET/{id} - Item Extended Matching - XML Example

Feedback and Knowledge Base

(thinking…)