Platform API

<back to all web services

SavePermissionValue

Save change to a Permission value.

Requires Authentication
The following routes are available for this service:
All Verbs/api/permissions/{PermissionId}/licensee/
All Verbs/api/permissions/{PermissionId}/role/
All Verbs/api/permissions/{PermissionId}/contact/
"use strict";
export class SavePermissionValueResponse {
    /** @param {{ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class SavePermissionValue {
    /** @param {{PermissionId?:string,ObjectId?:string,PermissionValue?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description A permission Id that we're saving the permission for. */
    PermissionId;
    /**
     * @type {string}
     * @description The object to save a permission for. This will either be a contact or role list item. Leave this blank if we're saving for the licensee. */
    ObjectId;
    /**
     * @type {?boolean}
     * @description Value to set the permission to, may be true, false or null. */
    PermissionValue;
}

JavaScript SavePermissionValue DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/permissions/{PermissionId}/licensee/ HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"PermissionId":"00000000-0000-0000-0000-000000000000","ObjectId":"00000000-0000-0000-0000-000000000000","PermissionValue":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}