| All Verbs | /api/permissions/{PermissionId}/matrix/ |
|---|
export class PermissionLevelModel
{
public PermissionValueId?: string;
public ObjectId: string;
public ObjectName: string;
public ObjectGroup: string;
public ContactsAffected: number;
public PermissionValue?: boolean;
public constructor(init?: Partial<PermissionLevelModel>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="Returns the Permission Value for an object and the permission levels that make up the determination of the permission.")
export class GetPermissionMatrixResponse
{
public PermissionLevelValue: boolean;
public PermissionsMatrix: PermissionLevelModel[];
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<GetPermissionMatrixResponse>) { (Object as any).assign(this, init); }
}
/** @description 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.")
export class GetPermissionMatrix
{
/** @description Permission Id to retrieve matrix for. */
// @ApiMember(DataType="Guid", Description="Permission Id to retrieve matrix for.", IsRequired=true, Name="PermissionId")
public PermissionId: string;
/** @description 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 ObjectId: string;
public constructor(init?: Partial<GetPermissionMatrix>) { (Object as any).assign(this, init); }
}
TypeScript 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"}}}