Requires the role: | manager |
GET | /customers/{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 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;
}
class GetCustomerResponse implements IConvertible
{
ResponseStatus? responseStatus;
Customer? customer;
GetCustomerResponse({this.responseStatus,this.customer});
GetCustomerResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
customer = JsonConverters.fromJson(json['customer'],'Customer',context!);
return this;
}
Map<String, dynamic> toJson() => {
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
'customer': JsonConverters.toJson(customer,'Customer',context!)
};
getTypeName() => "GetCustomerResponse";
TypeContext? context = _ctx;
}
class GetCustomerRequest extends GetOperationTenanted<GetCustomerResponse> implements IConvertible
{
String? id;
GetCustomerRequest({this.id});
GetCustomerRequest.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() => "GetCustomerRequest";
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),
'BankAccount': TypeInfo(TypeOf.Class, create:() => BankAccount()),
'Customer': TypeInfo(TypeOf.Class, create:() => Customer()),
'GetCustomerResponse': TypeInfo(TypeOf.Class, create:() => GetCustomerResponse()),
'GetCustomerRequest': TypeInfo(TypeOf.Class, create:() => GetCustomerRequest()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /customers/{Id} HTTP/1.1 Host: staging-api.billiecart.com.au Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"customer":{"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"}}