| All Verbs | /api/permissions/{PermissionId}/matrix/ |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Get a value for the current permission and object. Including the relevant data that affects the permission value outcome.
*/
@Api(Description="Get a value for the current permission and object. Including the relevant data that affects the permission value outcome.")
open class GetPermissionMatrix
{
/**
* Permission Id to retrieve matrix for.
*/
@ApiMember(DataType="Guid", Description="Permission Id to retrieve matrix for.", IsRequired=true, Name="PermissionId")
open var PermissionId:UUID? = null
/**
* Object Id to retrieve permissions for. This will be either a contact, role list item or licensee contact.
*/
@ApiMember(DataType="Guid", Description="Object Id to retrieve permissions for. This will be either a contact, role list item or licensee contact.", IsRequired=true, Name="ObjectId")
open var ObjectId:UUID? = null
}
@ApiResponse(Description="Returns the Permission Value for an object and the permission levels that make up the determination of the permission.")
open class GetPermissionMatrixResponse
{
open var PermissionLevelValue:Boolean? = null
open var PermissionsMatrix:ArrayList<PermissionLevelModel>? = null
open var ResponseStatus:ResponseStatus? = null
}
open class PermissionLevelModel
{
open var PermissionValueId:UUID? = null
open var ObjectId:UUID? = null
open var ObjectName:String? = null
open var ObjectGroup:String? = null
open var ContactsAffected:Int? = null
open var PermissionValue:Boolean? = null
}
Kotlin GetPermissionMatrix DTOs
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}/matrix/ HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
PermissionLevelValue: False,
PermissionsMatrix:
[
{
PermissionValueId: 00000000000000000000000000000000,
ObjectName: String,
ObjectGroup: String,
ContactsAffected: 0,
PermissionValue: False
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}