Billiecart API

AssignRolesRequest

**Requires Authentication**
Requires the role:	manager

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

class UserAccountName implements IConvertible
{
    String? firstName;
    String? lastName;

    UserAccountName({this.firstName,this.lastName});
    UserAccountName.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        firstName = json['firstName'];
        lastName = json['lastName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'firstName': firstName,
        'lastName': lastName
    };

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

enum AccountStatus
{
    Shadowed,
    Registered,
}

class UserAccount implements IIdentifiableResource, IConvertible
{
    UserAccountName? name;
    String? displayName;
    String? email;
    List<String>? roles;
    AccountStatus? status;
    String? defaultOrganisationId;
    String? id;

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

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

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

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

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

    AssignRolesResponse({this.responseStatus,this.userAccount});
    AssignRolesResponse.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() => "AssignRolesResponse";
    TypeContext? context = _ctx;
}

class AssignRolesRequest extends PostOperationUnTenanted<AssignRolesResponse> implements IConvertible
{
    String? id;
    List<String>? roles;

    AssignRolesRequest({this.id,this.roles});
    AssignRolesRequest.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() => "AssignRolesRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'staging_api.billiecart.com.au', types: <String, TypeInfo> {
    'PostOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'UserAccountName': TypeInfo(TypeOf.Class, create:() => UserAccountName()),
    'AccountStatus': TypeInfo(TypeOf.Enum, enumValues:AccountStatus.values),
    'UserAccount': TypeInfo(TypeOf.Class, create:() => UserAccount()),
    'AssignRolesRequest': TypeInfo(TypeOf.Class, create:() => AssignRolesRequest()),
});

Dart AssignRolesRequest 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: staging-api.billiecart.com.au 
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: 
	{
		name: 
		{
			firstName: String,
			lastName: String
		},
		displayName: String,
		email: String,
		roles: 
		[
			String
		],
		status: Shadowed,
		defaultOrganisationId: String,
		id: String
	}
}