| All Verbs | /api/permissions/{PermissionId}/reset | ||
|---|---|---|---|
| All Verbs | /api/permissions/reset |
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<ApiResponse(Description="Returns a response status indicating success or not.")>]
[<AllowNullLiteral>]
type ResetPermissionResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
///<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.")>]
[<AllowNullLiteral>]
type 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")>]
member val PermissionId:Guid = new Guid() with get,set
///<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")>]
member val Reinitialise:Boolean = new Boolean() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<ResetPermission xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<PermissionId>00000000-0000-0000-0000-000000000000</PermissionId>
<Reinitialise>false</Reinitialise>
</ResetPermission>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ResetPermissionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</ResetPermissionResponse>