| All Verbs | /api/permissions/{PermissionId}/matrix/ |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PermissionLevelModel:
permission_value_id: Optional[str] = None
object_id: Optional[str] = None
object_name: Optional[str] = None
object_group: Optional[str] = None
contacts_affected: int = 0
permission_value: Optional[bool] = None
# @ApiResponse(Description="Returns the Permission Value for an object and the permission levels that make up the determination of the permission.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPermissionMatrixResponse:
permission_level_value: bool = False
permissions_matrix: Optional[List[PermissionLevelModel]] = None
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get a value for the current permission and object. Including the relevant data that affects the permission value outcome.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPermissionMatrix:
"""
Get a value for the current permission and object. Including the relevant data that affects the permission value outcome.
"""
# @ApiMember(DataType="Guid", Description="Permission Id to retrieve matrix for.", IsRequired=true, Name="PermissionId")
permission_id: Optional[str] = None
"""
Permission Id to retrieve matrix for.
"""
# @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")
object_id: Optional[str] = None
"""
Object Id to retrieve permissions for. This will be either a contact, role list item or licensee contact.
"""
Python 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
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"}}}