| All Verbs | /api/permissions/{PermissionId}/reset | ||
|---|---|---|---|
| All Verbs | /api/permissions/reset |
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Reset a specified permission to the Perspective default or reset all permissions.
*/
@Api(Description="Reset a specified permission to the Perspective default or reset all permissions.")
open class ResetPermission
{
/**
* Set the permissionId if you wish to reset a selected permission. Leaving this blank will reset all permissions.
*/
@ApiMember(DataType="Guid", Description="Set the permissionId if you wish to reset a selected permission. Leaving this blank will reset all permissions.", Name="PermissionId")
open var PermissionId:UUID? = null
/**
* 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.
*/
@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")
open var Reinitialise:Boolean? = null
}
@ApiResponse(Description="Returns a response status indicating success or not.")
open class ResetPermissionResponse
{
open var ResponseStatus:ResponseStatus? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"PermissionId":"00000000-0000-0000-0000-000000000000","Reinitialise":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}