Platform API

GetPermissionMatrix

Get a value for the current permission and object. Including the relevant data that affects the permission value outcome.

The following routes are available for this service:
All Verbs	/api/permissions/{PermissionId}/matrix/

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Subtle.Canvara.WebAPIModel.Models

Namespace Global

    Namespace Eros.Subtle.Canvara.WebAPIModel.Models

        Public Partial Class PermissionLevelModel
            Public Overridable Property PermissionValueId As Guid?
            Public Overridable Property ObjectId As Guid
            Public Overridable Property ObjectName As String
            Public Overridable Property ObjectGroup As String
            Public Overridable Property ContactsAffected As Integer
            Public Overridable Property PermissionValue As Boolean?
        End Class
    End Namespace

    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 Overridable Property PermissionId As Guid

            '''<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 Overridable Property ObjectId As Guid
        End Class

        <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 Overridable Property PermissionLevelValue As Boolean
            Public Overridable Property PermissionsMatrix As List(Of PermissionLevelModel)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET GetPermissionMatrix DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"PermissionId":"00000000-0000-0000-0000-000000000000","ObjectId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"PermissionLevelValue":false,"PermissionsMatrix":[{"PermissionValueId":"00000000000000000000000000000000","ObjectId":"00000000-0000-0000-0000-000000000000","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"}}}