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.

Requires Authentication
The following routes are available for this service:
All Verbs/api/permissions/{PermissionId}/matrix/
"use strict";
export class PermissionLevelModel {
    /** @param {{PermissionValueId?:string,ObjectId?:string,ObjectName?:string,ObjectGroup?:string,ContactsAffected?:number,PermissionValue?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    PermissionValueId;
    /** @type {string} */
    ObjectId;
    /** @type {string} */
    ObjectName;
    /** @type {string} */
    ObjectGroup;
    /** @type {number} */
    ContactsAffected;
    /** @type {?boolean} */
    PermissionValue;
}
export class GetPermissionMatrixResponse {
    /** @param {{PermissionLevelValue?:boolean,PermissionsMatrix?:PermissionLevelModel[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    PermissionLevelValue;
    /** @type {PermissionLevelModel[]} */
    PermissionsMatrix;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetPermissionMatrix {
    /** @param {{PermissionId?:string,ObjectId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Permission Id to retrieve matrix for. */
    PermissionId;
    /**
     * @type {string}
     * @description Object Id to retrieve permissions for. This will be either a contact, role list item or licensee contact. */
    ObjectId;
}

JavaScript GetPermissionMatrix DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}