Permission Resource
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.