| All Verbs | /api/permissions/{PermissionId}/matrix/ |
|---|
import Foundation
import ServiceStack
/**
* 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.")
public class GetPermissionMatrix : Codable
{
/**
* Permission Id to retrieve matrix for.
*/
// @ApiMember(DataType="Guid", Description="Permission Id to retrieve matrix for.", IsRequired=true, Name="PermissionId")
public var permissionId:String
/**
* 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")
public var objectId:String
required public init(){}
}
// @ApiResponse(Description="Returns the Permission Value for an object and the permission levels that make up the determination of the permission.")
public class GetPermissionMatrixResponse : Codable
{
public var permissionLevelValue:Bool
public var permissionsMatrix:[PermissionLevelModel]
public var responseStatus:ResponseStatus
required public init(){}
}
public class PermissionLevelModel : Codable
{
public var permissionValueId:String?
public var objectId:String
public var objectName:String
public var objectGroup:String
public var contactsAffected:Int
public var permissionValue:Bool?
required public init(){}
}
Swift GetPermissionMatrix DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"PermissionId":"00000000-0000-0000-0000-000000000000","ObjectId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}