| 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 .xml suffix or ?format=xml
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/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>