Billiecart API

<back to all web services

RemoveOrganisationMemberRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
DELETE/organisations/{Id}/members/{UserAccountId}
import 'package:servicestack/servicestack.dart';

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

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

class Organisation implements IIdentifiableResource, IConvertible
{
    String? displayName;
    List<String>? owners;
    bool? isDefault;
    String? id;

    Organisation({this.displayName,this.owners,this.isDefault,this.id});
    Organisation.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'displayName': displayName,
        'owners': JsonConverters.toJson(owners,'List<String>',context!),
        'isDefault': isDefault,
        'id': id
    };

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

class RemoveOrganisationMemberResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    Organisation? organisation;

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

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

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

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

class RemoveOrganisationMemberRequest extends DeleteOperationUnTenanted<RemoveOrganisationMemberResponse> implements IConvertible
{
    String? id;
    String? userAccountId;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'staging_api.billiecart.com.au', types: <String, TypeInfo> {
    'DeleteOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'Organisation': TypeInfo(TypeOf.Class, create:() => Organisation()),
    'RemoveOrganisationMemberResponse': TypeInfo(TypeOf.Class, create:() => RemoveOrganisationMemberResponse()),
    'RemoveOrganisationMemberRequest': TypeInfo(TypeOf.Class, create:() => RemoveOrganisationMemberRequest()),
});

Dart RemoveOrganisationMemberRequest 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.

DELETE /organisations/{Id}/members/{UserAccountId} HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
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
		}
	},
	organisation: 
	{
		displayName: String,
		owners: 
		[
			String
		],
		isDefault: False,
		id: String
	}
}