Billiecart API

<back to all web services

DeleteAdjustmentRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
DELETE/packages/{SalaryPackageId}/adjustments/{Id}
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;
}

abstract class DeleteOperationTenanted<TResponse> extends DeleteOperationUnTenanted<TResponse> implements ITenantedRequest
{
    String? organisationId;

    DeleteOperationTenanted({this.organisationId});
    DeleteOperationTenanted.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() => "DeleteOperationTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

class DeleteAdjustmentResponse implements IConvertible
{
    ResponseStatus? responseStatus;

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

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

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

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

class DeleteAdjustmentRequest extends DeleteOperationTenanted<DeleteAdjustmentResponse> implements IConvertible
{
    String? salaryPackageId;
    String? id;

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

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

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

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

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

Dart DeleteAdjustmentRequest 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 /packages/{SalaryPackageId}/adjustments/{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
		}
	}
}