Billiecart API

GetContributionRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
GET	/contributions/{Id}

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

class Contribution implements IIdentifiableResource, IConvertible
{
    String? employerId;
    String? employerName;
    double? amount;
    DateTime? paymentDate;
    bool? distributed;
    String? id;

    Contribution({this.employerId,this.employerName,this.amount,this.paymentDate,this.distributed,this.id});
    Contribution.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        employerId = json['employerId'];
        employerName = json['employerName'];
        amount = JsonConverters.toDouble(json['amount']);
        paymentDate = JsonConverters.fromJson(json['paymentDate'],'DateTime',context!);
        distributed = json['distributed'];
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'employerId': employerId,
        'employerName': employerName,
        'amount': amount,
        'paymentDate': JsonConverters.toJson(paymentDate,'DateTime',context!),
        'distributed': distributed,
        'id': id
    };

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

class GetContributionResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    Contribution? contribution;

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

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

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

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

class GetContributionRequest extends GetOperationTenanted<GetContributionResponse> implements IConvertible
{
    String? id;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'staging_api.billiecart.com.au', types: <String, TypeInfo> {
    'GetOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'GetOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'Contribution': TypeInfo(TypeOf.Class, create:() => Contribution()),
    'GetContributionResponse': TypeInfo(TypeOf.Class, create:() => GetContributionResponse()),
    'GetContributionRequest': TypeInfo(TypeOf.Class, create:() => GetContributionRequest()),
});

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

GET /contributions/{Id} 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
		}
	},
	contribution: 
	{
		employerId: String,
		employerName: String,
		amount: 0,
		distributed: False,
		id: String
	}
}