Foundry API

<back to all web services

GetOrganisationMembershipRequest

import 'package:servicestack/servicestack.dart';

abstract class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
    String? embed;

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

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

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

    getTypeName() => "GetOperationUnTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

abstract class GetOperationTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements ITenantedRequest
{
    String? organisationId;

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

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

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

    getTypeName() => "GetOperationTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

enum AccountType
{
    Person,
    Machine,
}

class OrganisationMembership implements IIdentifiableResource, IConvertible
{
    String? userEmailAddress;
    String? userId;
    String? organisationId;
    AccountType? accountType;
    bool? isOwner;
    bool? isConfirmed;
    List<String>? roles;
    String? id;

    OrganisationMembership({this.userEmailAddress,this.userId,this.organisationId,this.accountType,this.isOwner,this.isConfirmed,this.roles,this.id});
    OrganisationMembership.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        userEmailAddress = json['userEmailAddress'];
        userId = json['userId'];
        organisationId = json['organisationId'];
        accountType = JsonConverters.fromJson(json['accountType'],'AccountType',context!);
        isOwner = json['isOwner'];
        isConfirmed = json['isConfirmed'];
        roles = JsonConverters.fromJson(json['roles'],'List<String>',context!);
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'userEmailAddress': userEmailAddress,
        'userId': userId,
        'organisationId': organisationId,
        'accountType': JsonConverters.toJson(accountType,'AccountType',context!),
        'isOwner': isOwner,
        'isConfirmed': isConfirmed,
        'roles': JsonConverters.toJson(roles,'List<String>',context!),
        'id': id
    };

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

class GetOrganisationMembershipResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    OrganisationMembership? membership;

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

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

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

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

class GetOrganisationMembershipRequest extends GetOperationTenanted<GetOrganisationMembershipResponse> implements IConvertible
{
    String? userId;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'GetOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'GetOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'AccountType': TypeInfo(TypeOf.Enum, enumValues:AccountType.values),
    'OrganisationMembership': TypeInfo(TypeOf.Class, create:() => OrganisationMembership()),
    'GetOrganisationMembershipResponse': TypeInfo(TypeOf.Class, create:() => GetOrganisationMembershipResponse()),
    'GetOrganisationMembershipRequest': TypeInfo(TypeOf.Class, create:() => GetOrganisationMembershipRequest()),
});

Dart GetOrganisationMembershipRequest DTOs

GET /organisations/{OrganisationId}/{UserId} HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
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
		}
	},
	membership: 
	{
		userEmailAddress: String,
		userId: String,
		organisationId: String,
		accountType: Person,
		isOwner: False,
		isConfirmed: False,
		roles: 
		[
			String
		],
		id: String
	}
}