| All Verbs | /api/permissions/{PermissionId}/matrix/ |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Subtle.Canvara.WebAPIModel.Models;
namespace Eros.Subtle.Canvara.WebAPIModel.Models
{
public partial class PermissionLevelModel
{
public virtual Guid? PermissionValueId { get; set; }
public virtual Guid ObjectId { get; set; }
public virtual string ObjectName { get; set; }
public virtual string ObjectGroup { get; set; }
public virtual int ContactsAffected { get; set; }
public virtual bool? PermissionValue { get; set; }
}
}
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
///<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.")]
public partial class GetPermissionMatrix
{
///<summary>
///Permission Id to retrieve matrix for.
///</summary>
[ApiMember(DataType="Guid", Description="Permission Id to retrieve matrix for.", IsRequired=true, Name="PermissionId")]
public virtual Guid PermissionId { 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")]
public virtual Guid ObjectId { get; set; }
}
[ApiResponse(Description="Returns the Permission Value for an object and the permission levels that make up the determination of the permission.")]
public partial class GetPermissionMatrixResponse
{
public virtual bool PermissionLevelValue { get; set; }
public virtual List<PermissionLevelModel> PermissionsMatrix { get; set; }
public virtual ResponseStatus ResponseStatus { 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
}
}
}