Platform API

GetPermissionMatrix

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

The following routes are available for this service:
All Verbs	/api/permissions/{PermissionId}/matrix/

**GetPermissionMatrix** Parameters:
Name	Parameter	Data Type	Required	Description
PermissionId	path	Guid	Yes	Permission Id to retrieve matrix for.
ObjectId	query	Guid	Yes	Object Id to retrieve permissions for. This will be either a contact, role list item or licensee contact.

**GetPermissionMatrixResponse** Parameters:
Name	Parameter	Data Type	Required
PermissionLevelValue	form	bool	No
PermissionsMatrix	form	List<PermissionLevelModel>	No
ResponseStatus	form	ResponseStatus	No

**PermissionLevelModel** Parameters:
Name	Parameter	Data Type	Required
PermissionValueId	form	Guid?	No
ObjectId	form	Guid	No
ObjectName	form	string	No
ObjectGroup	form	string	No
ContactsAffected	form	int	No
PermissionValue	form	bool?	No

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

HTTP + 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>