| All Verbs | /api/permissions/{PermissionId}/reset | ||
|---|---|---|---|
| All Verbs | /api/permissions/reset |
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Namespace Global
Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
'''<Summary>
'''Reset a specified permission to the Perspective default or reset all permissions.
'''</Summary>
<Api(Description:="Reset a specified permission to the Perspective default or reset all permissions.")>
Public Partial Class ResetPermission
'''<Summary>
'''Set the permissionId if you wish to reset a selected permission. Leaving this blank will reset all permissions.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="Set the permissionId if you wish to reset a selected permission. Leaving this blank will reset all permissions.", Name:="PermissionId")>
Public Overridable Property PermissionId As Guid
'''<Summary>
'''If this is true then permissions for a licensee will be updated to match those for 'Perspective', adding new missing values where necessary (this includes removing any new permission values added by the licensee that 'Perspective' does not have a setting for). If this is false, then values for the licensee will not get updated, however any missing permission values will get created to match the 'Perspective' value.
'''</Summary>
<ApiMember(DataType:="bool", Description:="If this is true then permissions for a licensee will be updated to match those for 'Perspective', adding new missing values where necessary (this includes removing any new permission values added by the licensee that 'Perspective' does not have a setting for). If this is false, then values for the licensee will not get updated, however any missing permission values will get created to match the 'Perspective' value. ", Name:="Reinitialise")>
Public Overridable Property Reinitialise As Boolean
End Class
<ApiResponse(Description:="Returns a response status indicating success or not.")>
Public Partial Class ResetPermissionResponse
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/permissions/{PermissionId}/reset HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Reinitialise: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}