Foundry API

AssignUserRolesRequest

The following routes are available for this service:
POST	/users/{Id}/roles/assign

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;
}

enum AccountStatus
{
    Shadowed,
    Registered,
}

enum AccountType
{
    Person,
    Machine,
}

class UserAccount implements IIdentifiableResource, IConvertible
{
    List<String>? roles;
    AccountStatus? status;
    String? defaultOrganisationId;
    AccountType? type;
    String? id;

    UserAccount({this.roles,this.status,this.defaultOrganisationId,this.type,this.id});
    UserAccount.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        roles = JsonConverters.fromJson(json['roles'],'List<String>',context!);
        status = JsonConverters.fromJson(json['status'],'AccountStatus',context!);
        defaultOrganisationId = json['defaultOrganisationId'];
        type = JsonConverters.fromJson(json['type'],'AccountType',context!);
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'roles': JsonConverters.toJson(roles,'List<String>',context!),
        'status': JsonConverters.toJson(status,'AccountStatus',context!),
        'defaultOrganisationId': defaultOrganisationId,
        'type': JsonConverters.toJson(type,'AccountType',context!),
        'id': id
    };

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

class AssignUserRolesResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    UserAccount? userAccount;

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

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

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

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

class AssignUserRolesRequest extends PostOperationUnTenanted<AssignUserRolesResponse> implements IConvertible
{
    String? id;
    List<String>? roles;

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

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'id': id,
        'roles': JsonConverters.toJson(roles,'List<String>',context!)
    });

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

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'PostOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'AccountStatus': TypeInfo(TypeOf.Enum, enumValues:AccountStatus.values),
    'AccountType': TypeInfo(TypeOf.Enum, enumValues:AccountType.values),
    'UserAccount': TypeInfo(TypeOf.Class, create:() => UserAccount()),
    'AssignUserRolesResponse': TypeInfo(TypeOf.Class, create:() => AssignUserRolesResponse()),
    'AssignUserRolesRequest': TypeInfo(TypeOf.Class, create:() => AssignUserRolesRequest()),
});

Dart AssignUserRolesRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /users/{Id}/roles/assign HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	roles: 
	[
		String
	]
}

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
		}
	},
	userAccount: 
	{
		roles: 
		[
			String
		],
		status: Shadowed,
		defaultOrganisationId: String,
		type: Person,
		id: String
	}
}