Platform API

<back to all web services

SavePermissionValue

Save change to a Permission value.

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @ApiResponse(Description="Returns a response status indicating success or not.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SavePermissionValueResponse:
    response_status: Optional[ResponseStatus] = None


# @Api(Description="Save change to a Permission value.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SavePermissionValue:
    """
    Save change to a Permission value.
    """

    # @ApiMember(DataType="Guid", Description="A permission Id that we're saving the permission for.", IsRequired=true, Name="PermissionId")
    permission_id: Optional[str] = None
    """
    A permission Id that we're saving the permission for.
    """


    # @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")
    object_id: Optional[str] = None
    """
    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="bool?", Description="Value to set the permission to, may be true, false or null.", Name="PermissionValue")
    permission_value: Optional[bool] = None
    """
    Value to set the permission to, may be true, false or null.
    """

Python SavePermissionValue DTOs

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

{
	PermissionValue: False
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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