| Requires the role: | manager |
| GET | /packages |
|---|
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 SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
{
String? distinct;
int? limit;
int? offset;
String? sort;
String? filter;
String? search;
SearchOperationUnTenanted({this.distinct,this.limit,this.offset,this.sort,this.filter,this.search});
SearchOperationUnTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
distinct = json['distinct'];
limit = json['limit'];
offset = json['offset'];
sort = json['sort'];
filter = json['filter'];
search = json['search'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'distinct': distinct,
'limit': limit,
'offset': offset,
'sort': sort,
'filter': filter,
'search': search
});
getTypeName() => "SearchOperationUnTenanted<$TResponse>";
TypeContext? context = _ctx;
}
abstract class SearchOperationTenanted<TResponse> extends SearchOperationUnTenanted<TResponse> implements ITenantedRequest
{
String? organisationId;
SearchOperationTenanted({this.organisationId});
SearchOperationTenanted.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() => "SearchOperationTenanted<$TResponse>";
TypeContext? context = _ctx;
}
enum SortDirection
{
Ascending,
Descending,
}
class Sorting implements IConvertible
{
String? by;
SortDirection? direction;
Sorting({this.by,this.direction});
Sorting.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
by = json['by'];
direction = JsonConverters.fromJson(json['direction'],'SortDirection',context!);
return this;
}
Map<String, dynamic> toJson() => {
'by': by,
'direction': JsonConverters.toJson(direction,'SortDirection',context!)
};
getTypeName() => "Sorting";
TypeContext? context = _ctx;
}
class Filtering implements IConvertible
{
List<String>? fields;
String? search;
Filtering({this.fields,this.search});
Filtering.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
fields = JsonConverters.fromJson(json['fields'],'List<String>',context!);
search = json['search'];
return this;
}
Map<String, dynamic> toJson() => {
'fields': JsonConverters.toJson(fields,'List<String>',context!),
'search': search
};
getTypeName() => "Filtering";
TypeContext? context = _ctx;
}
class SearchMetadata implements IConvertible
{
int? total;
int? limit;
int? offset;
Sorting? sort;
Filtering? filter;
SearchMetadata({this.total,this.limit,this.offset,this.sort,this.filter});
SearchMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
total = json['total'];
limit = json['limit'];
offset = json['offset'];
sort = JsonConverters.fromJson(json['sort'],'Sorting',context!);
filter = JsonConverters.fromJson(json['filter'],'Filtering',context!);
return this;
}
Map<String, dynamic> toJson() => {
'total': total,
'limit': limit,
'offset': offset,
'sort': JsonConverters.toJson(sort,'Sorting',context!),
'filter': JsonConverters.toJson(filter,'Filtering',context!)
};
getTypeName() => "SearchMetadata";
TypeContext? context = _ctx;
}
abstract class SearchOperationResponse
{
SearchMetadata? metadata;
SearchOperationResponse({this.metadata});
SearchOperationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
metadata = JsonConverters.fromJson(json['metadata'],'SearchMetadata',context!);
return this;
}
Map<String, dynamic> toJson() => {
'metadata': JsonConverters.toJson(metadata,'SearchMetadata',context!)
};
getTypeName() => "SearchOperationResponse";
TypeContext? context = _ctx;
}
class SalaryPackageSummary implements IIdentifiableResource, IConvertible
{
String? customerId;
String? customerFirstName;
String? customerLastName;
String? employerName;
String? vehicleLicensePlate;
double? salarySacrificeAmount;
double? currentBalance;
double? preTaxDeduction;
double? postTaxDeduction;
int? leaseTerm;
String? employerId;
String? status;
String? id;
SalaryPackageSummary({this.customerId,this.customerFirstName,this.customerLastName,this.employerName,this.vehicleLicensePlate,this.salarySacrificeAmount,this.currentBalance,this.preTaxDeduction,this.postTaxDeduction,this.leaseTerm,this.employerId,this.status,this.id});
SalaryPackageSummary.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
customerId = json['customerId'];
customerFirstName = json['customerFirstName'];
customerLastName = json['customerLastName'];
employerName = json['employerName'];
vehicleLicensePlate = json['vehicleLicensePlate'];
salarySacrificeAmount = JsonConverters.toDouble(json['salarySacrificeAmount']);
currentBalance = JsonConverters.toDouble(json['currentBalance']);
preTaxDeduction = JsonConverters.toDouble(json['preTaxDeduction']);
postTaxDeduction = JsonConverters.toDouble(json['postTaxDeduction']);
leaseTerm = json['leaseTerm'];
employerId = json['employerId'];
status = json['status'];
id = json['id'];
return this;
}
Map<String, dynamic> toJson() => {
'customerId': customerId,
'customerFirstName': customerFirstName,
'customerLastName': customerLastName,
'employerName': employerName,
'vehicleLicensePlate': vehicleLicensePlate,
'salarySacrificeAmount': salarySacrificeAmount,
'currentBalance': currentBalance,
'preTaxDeduction': preTaxDeduction,
'postTaxDeduction': postTaxDeduction,
'leaseTerm': leaseTerm,
'employerId': employerId,
'status': status,
'id': id
};
getTypeName() => "SalaryPackageSummary";
TypeContext? context = _ctx;
}
class SearchAllSalaryPackagesResponse extends SearchOperationResponse implements IConvertible
{
ResponseStatus? responseStatus;
List<SalaryPackageSummary>? salaryPackages;
SearchAllSalaryPackagesResponse({this.responseStatus,this.salaryPackages});
SearchAllSalaryPackagesResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
salaryPackages = JsonConverters.fromJson(json['salaryPackages'],'List<SalaryPackageSummary>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
'salaryPackages': JsonConverters.toJson(salaryPackages,'List<SalaryPackageSummary>',context!)
});
getTypeName() => "SearchAllSalaryPackagesResponse";
TypeContext? context = _ctx;
}
class SearchAllSalaryPackagesRequest extends SearchOperationTenanted<SearchAllSalaryPackagesResponse> implements IConvertible
{
String? employerId;
SearchAllSalaryPackagesRequest({this.employerId});
SearchAllSalaryPackagesRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
employerId = json['employerId'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'employerId': employerId
});
getTypeName() => "SearchAllSalaryPackagesRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'staging_api.billiecart.com.au', types: <String, TypeInfo> {
'GetOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'SearchOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'SearchOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'SortDirection': TypeInfo(TypeOf.Enum, enumValues:SortDirection.values),
'Sorting': TypeInfo(TypeOf.Class, create:() => Sorting()),
'Filtering': TypeInfo(TypeOf.Class, create:() => Filtering()),
'SearchMetadata': TypeInfo(TypeOf.Class, create:() => SearchMetadata()),
'SearchOperationResponse': TypeInfo(TypeOf.AbstractClass),
'SalaryPackageSummary': TypeInfo(TypeOf.Class, create:() => SalaryPackageSummary()),
'SearchAllSalaryPackagesResponse': TypeInfo(TypeOf.Class, create:() => SearchAllSalaryPackagesResponse()),
'List<SalaryPackageSummary>': TypeInfo(TypeOf.Class, create:() => <SalaryPackageSummary>[]),
'SearchAllSalaryPackagesRequest': TypeInfo(TypeOf.Class, create:() => SearchAllSalaryPackagesRequest()),
});
Dart SearchAllSalaryPackagesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /packages 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
}
},
salaryPackages:
[
{
customerId: String,
customerFirstName: String,
customerLastName: String,
employerName: String,
vehicleLicensePlate: String,
salarySacrificeAmount: 0,
currentBalance: 0,
preTaxDeduction: 0,
postTaxDeduction: 0,
leaseTerm: 0,
employerId: String,
status: String,
id: String
}
],
metadata:
{
total: 0,
limit: 0,
offset: 0,
sort:
{
by: String,
direction: Ascending
},
filter:
{
fields:
[
String
],
search: String
}
}
}