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/
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Save change to a Permission value.
    */
    @Api(Description="Save change to a Permission value.")
    public static class SavePermissionValue
    {
        /**
        * A permission Id that we're saving the permission for.
        */
        @ApiMember(DataType="Guid", Description="A permission Id that we're saving the permission for.", IsRequired=true, Name="PermissionId")
        public UUID PermissionId = null;

        /**
        * 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.
        */
        @ApiMember(DataType="Guid", 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.", Name="ObjectId")
        public UUID ObjectId = null;

        /**
        * Value to set the permission to, may be true, false or null.
        */
        @ApiMember(DataType="bool?", Description="Value to set the permission to, may be true, false or null.", Name="PermissionValue")
        public Boolean PermissionValue = null;
        
        public UUID getPermissionId() { return PermissionId; }
        public SavePermissionValue setPermissionId(UUID value) { this.PermissionId = value; return this; }
        public UUID getObjectId() { return ObjectId; }
        public SavePermissionValue setObjectId(UUID value) { this.ObjectId = value; return this; }
        public Boolean isPermissionValue() { return PermissionValue; }
        public SavePermissionValue setPermissionValue(Boolean value) { this.PermissionValue = value; return this; }
    }

    @ApiResponse(Description="Returns a response status indicating success or not.")
    public static class SavePermissionValueResponse
    {
        public ResponseStatus ResponseStatus = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public SavePermissionValueResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java SavePermissionValue 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}/licensee/ 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","PermissionValue":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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