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 'package:servicestack/servicestack.dart';

// @ApiResponse(Description="Returns a response status indicating success or not.")
class SavePermissionValueResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;

    SavePermissionValueResponse({this.ResponseStatus});
    SavePermissionValueResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "SavePermissionValueResponse";
    TypeContext? context = _ctx;
}

/**
* Save change to a Permission value.
*/
// @Api(Description="Save change to a Permission value.")
class SavePermissionValue implements IConvertible
{
    /**
    * 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")
    String? PermissionId;

    /**
    * 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")
    String? ObjectId;

    /**
    * 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")
    bool? PermissionValue;

    SavePermissionValue({this.PermissionId,this.ObjectId,this.PermissionValue});
    SavePermissionValue.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        PermissionId = json['PermissionId'];
        ObjectId = json['ObjectId'];
        PermissionValue = json['PermissionValue'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'PermissionId': PermissionId,
        'ObjectId': ObjectId,
        'PermissionValue': PermissionValue
    };

    getTypeName() => "SavePermissionValue";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'SavePermissionValueResponse': TypeInfo(TypeOf.Class, create:() => SavePermissionValueResponse()),
    'SavePermissionValue': TypeInfo(TypeOf.Class, create:() => SavePermissionValue()),
});

Dart 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"}}}