| GET | /galaxy/vehicle/list | Retrieve a list of a user's vehicles. |
|---|
import 'package:servicestack/servicestack.dart';
class ApiServiceRequest implements IServiceRequest, IHasApiKey, IConvertible
{
/**
* The API Key required for authentication
*/
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
String? ApiKey;
ApiServiceRequest({this.ApiKey});
ApiServiceRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ApiKey = json['ApiKey'];
return this;
}
Map<String, dynamic> toJson() => {
'ApiKey': ApiKey
};
getTypeName() => "ApiServiceRequest";
TypeContext? context = _ctx;
}
class ApiServiceResponse implements IServiceResponse, IConvertible
{
String? Description;
String? Heading;
bool? WasSuccessful;
dynamic? ModelState;
ApiServiceResponse({this.Description,this.Heading,this.WasSuccessful,this.ModelState});
ApiServiceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Description = json['Description'];
Heading = json['Heading'];
WasSuccessful = json['WasSuccessful'];
ModelState = JsonConverters.fromJson(json['ModelState'],'dynamic',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Description': Description,
'Heading': Heading,
'WasSuccessful': WasSuccessful,
'ModelState': JsonConverters.toJson(ModelState,'dynamic',context!)
};
getTypeName() => "ApiServiceResponse";
TypeContext? context = _ctx;
}
class VehicleData implements IConvertible
{
/**
* The ID of the vehicle.
*/
// @ApiMember(Description="The ID of the vehicle.")
int? Id;
/**
* Whether the vehicle has license disk information.
*/
// @ApiMember(Description="Whether the vehicle has license disk information.")
bool? HasLicense;
/**
* The vehicle license number.
*/
// @ApiMember(Description="The vehicle license number.")
String? LicenseNumber;
/**
* The vehicle registration number.
*/
// @ApiMember(Description="The vehicle registration number.")
String? RegistrationNumber;
/**
* The vehicle VIN number.
*/
// @ApiMember(Description="The vehicle VIN number.")
String? Vin;
/**
* The vehicle make.
*/
// @ApiMember(Description="The vehicle make.")
String? Make;
/**
* The vehicle series.
*/
// @ApiMember(Description="The vehicle series.")
String? Series;
/**
* The vehicle colour.
*/
// @ApiMember(Description="The vehicle colour.")
String? Colour;
/**
* The vehicle license expiry date in ISO 8601 format.
*/
// @ApiMember(Description="The vehicle license expiry date in ISO 8601 format.")
String? Expiry;
/**
* True if this vehicle's licence expiring soon.
*/
// @ApiMember(Description="True if this vehicle's licence expiring soon.")
bool? ExpiresSoon;
/**
* True if this vehicle's license expired.
*/
// @ApiMember(Description="True if this vehicle's license expired.")
bool? Expired;
VehicleData({this.Id,this.HasLicense,this.LicenseNumber,this.RegistrationNumber,this.Vin,this.Make,this.Series,this.Colour,this.Expiry,this.ExpiresSoon,this.Expired});
VehicleData.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
HasLicense = json['HasLicense'];
LicenseNumber = json['LicenseNumber'];
RegistrationNumber = json['RegistrationNumber'];
Vin = json['Vin'];
Make = json['Make'];
Series = json['Series'];
Colour = json['Colour'];
Expiry = json['Expiry'];
ExpiresSoon = json['ExpiresSoon'];
Expired = json['Expired'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'HasLicense': HasLicense,
'LicenseNumber': LicenseNumber,
'RegistrationNumber': RegistrationNumber,
'Vin': Vin,
'Make': Make,
'Series': Series,
'Colour': Colour,
'Expiry': Expiry,
'ExpiresSoon': ExpiresSoon,
'Expired': Expired
};
getTypeName() => "VehicleData";
TypeContext? context = _ctx;
}
class VehicleListResponse extends ApiServiceResponse implements IConvertible
{
List<VehicleData>? Vehicles;
VehicleListResponse({this.Vehicles});
VehicleListResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Vehicles = JsonConverters.fromJson(json['Vehicles'],'List<VehicleData>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Vehicles': JsonConverters.toJson(Vehicles,'List<VehicleData>',context!)
});
getTypeName() => "VehicleListResponse";
TypeContext? context = _ctx;
}
class GetVehicleList extends ApiServiceRequest implements IConvertible
{
/**
* ID Number of the user making this request.
*/
// @ApiMember(Description="ID Number of the user making this request.", IsRequired=true)
String? IdNumber;
GetVehicleList({this.IdNumber});
GetVehicleList.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
IdNumber = json['IdNumber'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'IdNumber': IdNumber
});
getTypeName() => "GetVehicleList";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'galaxymobile.api.client.prod.86degrees.com', types: <String, TypeInfo> {
'ApiServiceRequest': TypeInfo(TypeOf.Class, create:() => ApiServiceRequest()),
'ApiServiceResponse': TypeInfo(TypeOf.Class, create:() => ApiServiceResponse()),
'VehicleData': TypeInfo(TypeOf.Class, create:() => VehicleData()),
'VehicleListResponse': TypeInfo(TypeOf.Class, create:() => VehicleListResponse()),
'List<VehicleData>': TypeInfo(TypeOf.Class, create:() => <VehicleData>[]),
'GetVehicleList': TypeInfo(TypeOf.Class, create:() => GetVehicleList()),
});
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 /galaxy/vehicle/list HTTP/1.1 Host: galaxymobile.api.client.prod.86degrees.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}