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/
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<ApiResponse(Description="Returns a response status indicating success or not.")>]
    [<AllowNullLiteral>]
    type SavePermissionValueResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Save change to a Permission value.
    ///</summary>
    [<Api(Description="Save change to a Permission value.")>]
    [<AllowNullLiteral>]
    type 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")>]
        member val PermissionId:Guid = new Guid() with 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")>]
        member val ObjectId:Guid = new Guid() with 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")>]
        member val PermissionValue:Nullable<Boolean> = new Nullable<Boolean>() with get,set

F# 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"}}}