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/
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Save change to a Permission value.
    ///</summary>
    [Api(Description="Save change to a Permission value.")]
    public partial class SavePermissionValue
    {
        ///<summary>
        ///A permission Id that we're saving the permission for.
        ///</summary>
        [ApiMember(DataType="Guid", Description="A permission Id that we're saving the permission for.", IsRequired=true, Name="PermissionId")]
        public virtual Guid PermissionId { get; set; }

        ///<summary>
        ///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.
        ///</summary>
        [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 virtual Guid ObjectId { get; set; }

        ///<summary>
        ///Value to set the permission to, may be true, false or null.
        ///</summary>
        [ApiMember(DataType="bool?", Description="Value to set the permission to, may be true, false or null.", Name="PermissionValue")]
        public virtual bool? PermissionValue { get; set; }
    }

    [ApiResponse(Description="Returns a response status indicating success or not.")]
    public partial class SavePermissionValueResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# SavePermissionValue 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

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

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

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