| Requires the role: | manager |
| GET | /customers |
|---|
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;
}
class BankAccount implements IConvertible
{
String? bsbNumber;
String? accountNumber;
BankAccount({this.bsbNumber,this.accountNumber});
BankAccount.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
bsbNumber = json['bsbNumber'];
accountNumber = json['accountNumber'];
return this;
}
Map<String, dynamic> toJson() => {
'bsbNumber': bsbNumber,
'accountNumber': accountNumber
};
getTypeName() => "BankAccount";
TypeContext? context = _ctx;
}
class Customer implements IIdentifiableResource, IConvertible
{
String? id;
String? firstName;
String? lastName;
DateTime? dateOfBirth;
String? driversLicenceNo;
String? email;
String? phone;
String? preferredContactMethod;
String? addressLine1;
String? addressLine2;
String? suburb;
String? stateTerritory;
String? postcode;
BankAccount? bankAccount;
String? userAccountId;
Customer({this.id,this.firstName,this.lastName,this.dateOfBirth,this.driversLicenceNo,this.email,this.phone,this.preferredContactMethod,this.addressLine1,this.addressLine2,this.suburb,this.stateTerritory,this.postcode,this.bankAccount,this.userAccountId});
Customer.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
firstName = json['firstName'];
lastName = json['lastName'];
dateOfBirth = JsonConverters.fromJson(json['dateOfBirth'],'DateTime',context!);
driversLicenceNo = json['driversLicenceNo'];
email = json['email'];
phone = json['phone'];
preferredContactMethod = json['preferredContactMethod'];
addressLine1 = json['addressLine1'];
addressLine2 = json['addressLine2'];
suburb = json['suburb'];
stateTerritory = json['stateTerritory'];
postcode = json['postcode'];
bankAccount = JsonConverters.fromJson(json['bankAccount'],'BankAccount',context!);
userAccountId = json['userAccountId'];
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'firstName': firstName,
'lastName': lastName,
'dateOfBirth': JsonConverters.toJson(dateOfBirth,'DateTime',context!),
'driversLicenceNo': driversLicenceNo,
'email': email,
'phone': phone,
'preferredContactMethod': preferredContactMethod,
'addressLine1': addressLine1,
'addressLine2': addressLine2,
'suburb': suburb,
'stateTerritory': stateTerritory,
'postcode': postcode,
'bankAccount': JsonConverters.toJson(bankAccount,'BankAccount',context!),
'userAccountId': userAccountId
};
getTypeName() => "Customer";
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;
}
class SearchAllCustomersResponse implements IConvertible
{
ResponseStatus? responseStatus;
List<Customer>? customers;
SearchMetadata? metadata;
SearchAllCustomersResponse({this.responseStatus,this.customers,this.metadata});
SearchAllCustomersResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
customers = JsonConverters.fromJson(json['customers'],'List<Customer>',context!);
metadata = JsonConverters.fromJson(json['metadata'],'SearchMetadata',context!);
return this;
}
Map<String, dynamic> toJson() => {
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
'customers': JsonConverters.toJson(customers,'List<Customer>',context!),
'metadata': JsonConverters.toJson(metadata,'SearchMetadata',context!)
};
getTypeName() => "SearchAllCustomersResponse";
TypeContext? context = _ctx;
}
class SearchAllCustomersRequest extends SearchOperationTenanted<SearchAllCustomersResponse> implements IConvertible
{
SearchAllCustomersRequest();
SearchAllCustomersRequest.fromJson(Map<String, dynamic> json) : super.fromJson(json);
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
return this;
}
Map<String, dynamic> toJson() => super.toJson();
getTypeName() => "SearchAllCustomersRequest";
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),
'BankAccount': TypeInfo(TypeOf.Class, create:() => BankAccount()),
'Customer': TypeInfo(TypeOf.Class, create:() => Customer()),
'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()),
'SearchAllCustomersResponse': TypeInfo(TypeOf.Class, create:() => SearchAllCustomersResponse()),
'List<Customer>': TypeInfo(TypeOf.Class, create:() => <Customer>[]),
'SearchAllCustomersRequest': TypeInfo(TypeOf.Class, create:() => SearchAllCustomersRequest()),
});
Dart SearchAllCustomersRequest 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 /customers 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
}
},
customers:
[
{
id: String,
firstName: String,
lastName: String,
driversLicenceNo: String,
email: String,
phone: String,
preferredContactMethod: String,
addressLine1: String,
addressLine2: String,
suburb: String,
stateTerritory: String,
postcode: String,
bankAccount:
{
bsbNumber: String,
accountNumber: String
},
userAccountId: String
}
],
metadata:
{
total: 0,
limit: 0,
offset: 0,
sort:
{
by: String,
direction: Ascending
},
filter:
{
fields:
[
String
],
search: String
}
}
}