Foundry API

AddUserToBlockListRequest

The following routes are available for this service:
POST	/organisations/{Id}/blocklist

import 'package:servicestack/servicestack.dart';

abstract class PostOperationUnTenanted<TResponse> implements IPost
{
    PostOperationUnTenanted();
    PostOperationUnTenanted.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "PostOperationUnTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

class OrganisationNotificationSettings implements IIdentifiableResource, IConvertible
{
    List<String>? warningNotificationRoles;
    List<String>? jobFinishedNotificationRoles;
    List<String>? userIdBlockList;
    String? id;

    OrganisationNotificationSettings({this.warningNotificationRoles,this.jobFinishedNotificationRoles,this.userIdBlockList,this.id});
    OrganisationNotificationSettings.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'warningNotificationRoles': JsonConverters.toJson(warningNotificationRoles,'List<String>',context!),
        'jobFinishedNotificationRoles': JsonConverters.toJson(jobFinishedNotificationRoles,'List<String>',context!),
        'userIdBlockList': JsonConverters.toJson(userIdBlockList,'List<String>',context!),
        'id': id
    };

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

class BlockListResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    OrganisationNotificationSettings? notificationSettings;

    BlockListResponse({this.responseStatus,this.notificationSettings});
    BlockListResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class AddUserToBlockListRequest extends PostOperationUnTenanted<BlockListResponse> implements IConvertible
{
    String? id;
    String? userId;

    AddUserToBlockListRequest({this.id,this.userId});
    AddUserToBlockListRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        id = json['id'];
        userId = json['userId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'id': id,
        'userId': userId
    });

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

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'PostOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'OrganisationNotificationSettings': TypeInfo(TypeOf.Class, create:() => OrganisationNotificationSettings()),
    'BlockListResponse': TypeInfo(TypeOf.Class, create:() => BlockListResponse()),
    'AddUserToBlockListRequest': TypeInfo(TypeOf.Class, create:() => AddUserToBlockListRequest()),
});

Dart AddUserToBlockListRequest 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 /organisations/{Id}/blocklist HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":"String","userId":"String"}

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"}},"notificationSettings":{"warningNotificationRoles":["String"],"jobFinishedNotificationRoles":["String"],"userIdBlockList":["String"],"id":"String"}}