Platform API

<back to all web services

GetPermissionMatrix

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

import 'package:servicestack/servicestack.dart';

class PermissionLevelModel implements IConvertible
{
    String? PermissionValueId;
    String? ObjectId;
    String? ObjectName;
    String? ObjectGroup;
    int? ContactsAffected;
    bool? PermissionValue;

    PermissionLevelModel({this.PermissionValueId,this.ObjectId,this.ObjectName,this.ObjectGroup,this.ContactsAffected,this.PermissionValue});
    PermissionLevelModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        PermissionValueId = json['PermissionValueId'];
        ObjectId = json['ObjectId'];
        ObjectName = json['ObjectName'];
        ObjectGroup = json['ObjectGroup'];
        ContactsAffected = json['ContactsAffected'];
        PermissionValue = json['PermissionValue'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'PermissionValueId': PermissionValueId,
        'ObjectId': ObjectId,
        'ObjectName': ObjectName,
        'ObjectGroup': ObjectGroup,
        'ContactsAffected': ContactsAffected,
        'PermissionValue': PermissionValue
    };

    getTypeName() => "PermissionLevelModel";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="Returns the Permission Value for an object and the permission levels that make up the determination of the permission.")
class GetPermissionMatrixResponse implements IConvertible
{
    bool? PermissionLevelValue;
    List<PermissionLevelModel>? PermissionsMatrix;
    ResponseStatus? ResponseStatus;

    GetPermissionMatrixResponse({this.PermissionLevelValue,this.PermissionsMatrix,this.ResponseStatus});
    GetPermissionMatrixResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        PermissionLevelValue = json['PermissionLevelValue'];
        PermissionsMatrix = JsonConverters.fromJson(json['PermissionsMatrix'],'List<PermissionLevelModel>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'PermissionLevelValue': PermissionLevelValue,
        'PermissionsMatrix': JsonConverters.toJson(PermissionsMatrix,'List<PermissionLevelModel>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetPermissionMatrixResponse";
    TypeContext? context = _ctx;
}

/**
* 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.")
class GetPermissionMatrix implements IConvertible
{
    /**
    * Permission Id to retrieve matrix for.
    */
    // @ApiMember(DataType="Guid", Description="Permission Id to retrieve matrix for.", IsRequired=true, Name="PermissionId")
    String? PermissionId;

    /**
    * 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")
    String? ObjectId;

    GetPermissionMatrix({this.PermissionId,this.ObjectId});
    GetPermissionMatrix.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        PermissionId = json['PermissionId'];
        ObjectId = json['ObjectId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'PermissionId': PermissionId,
        'ObjectId': ObjectId
    };

    getTypeName() => "GetPermissionMatrix";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'PermissionLevelModel': TypeInfo(TypeOf.Class, create:() => PermissionLevelModel()),
    'GetPermissionMatrixResponse': TypeInfo(TypeOf.Class, create:() => GetPermissionMatrixResponse()),
    'List<PermissionLevelModel>': TypeInfo(TypeOf.Class, create:() => <PermissionLevelModel>[]),
    'GetPermissionMatrix': TypeInfo(TypeOf.Class, create:() => GetPermissionMatrix()),
});

Dart GetPermissionMatrix DTOs

POST /api/permissions/{PermissionId}/matrix/ HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetPermissionMatrix xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
  <PermissionId>00000000-0000-0000-0000-000000000000</PermissionId>
</GetPermissionMatrix>

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

<GetPermissionMatrixResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <PermissionLevelValue>false</PermissionLevelValue>
  <PermissionsMatrix xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.Models">
    <d2p1:PermissionLevelModel>
      <d2p1:ContactsAffected>0</d2p1:ContactsAffected>
      <d2p1:ObjectGroup>String</d2p1:ObjectGroup>
      <d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
      <d2p1:ObjectName>String</d2p1:ObjectName>
      <d2p1:PermissionValue>false</d2p1:PermissionValue>
      <d2p1:PermissionValueId>00000000-0000-0000-0000-000000000000</d2p1:PermissionValueId>
    </d2p1:PermissionLevelModel>
  </PermissionsMatrix>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetPermissionMatrixResponse>