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

Namespace Global

    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 Overridable Property PermissionId As Guid

            '''<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 Overridable Property ObjectId As Guid

            '''<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 Overridable Property PermissionValue As Boolean?
        End Class

        <ApiResponse(Description:="Returns a response status indicating success or not.")>
        Public Partial Class SavePermissionValueResponse
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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"}}}