| All Verbs | /api/permissions/{PermissionId}/matrix/ |
|---|
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
[<AllowNullLiteral>]
type PermissionLevelModel() =
member val PermissionValueId:Nullable<Guid> = new Nullable<Guid>() with get,set
member val ObjectId:Guid = new Guid() with get,set
member val ObjectName:String = null with get,set
member val ObjectGroup:String = null with get,set
member val ContactsAffected:Int32 = new Int32() with get,set
member val PermissionValue:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<ApiResponse(Description="Returns the Permission Value for an object and the permission levels that make up the determination of the permission.")>]
[<AllowNullLiteral>]
type GetPermissionMatrixResponse() =
member val PermissionLevelValue:Boolean = new Boolean() with get,set
member val PermissionsMatrix:ResizeArray<PermissionLevelModel> = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Get a value for the current permission and object. Including the relevant data that affects the permission value outcome.
///</summary>
[<Api(Description="Get a value for the current permission and object. Including the relevant data that affects the permission value outcome.")>]
[<AllowNullLiteral>]
type GetPermissionMatrix() =
///<summary>
///Permission Id to retrieve matrix for.
///</summary>
[<ApiMember(DataType="Guid", Description="Permission Id to retrieve matrix for.", IsRequired=true, Name="PermissionId")>]
member val PermissionId:Guid = new Guid() with get,set
///<summary>
///Object Id to retrieve permissions for. This will be either a contact, role list item or licensee contact.
///</summary>
[<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")>]
member val ObjectId:Guid = new Guid() with get,set
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
}
}
}