Platform API

<back to all web services

ResetPermission

Reset a specified permission to the Perspective default or reset all permissions.

// @ApiResponse(Description="Returns a response status indicating success or not.")
export class ResetPermissionResponse
{
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<ResetPermissionResponse>) { (Object as any).assign(this, init); }
}

/** @description 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.")
export class ResetPermission
{
    /** @description 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")
    public PermissionId: string;

    /** @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.  */
    // @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 Reinitialise: boolean;

    public constructor(init?: Partial<ResetPermission>) { (Object as any).assign(this, init); }
}

TypeScript ResetPermission DTOs

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
		}
	}
}