| GET | /uplift/history |
|---|
import 'package:servicestack/servicestack.dart';
class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo, IConvertible
{
/**
* The API Key required for authentication
*/
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
String? ApiKey;
/**
* Latitude of the user making this request
*/
// @ApiMember(DataType="double", Description="Latitude of the user making this request")
double? Latitude;
/**
* Longitude of the user making this request
*/
// @ApiMember(DataType="double", Description="Longitude of the user making this request")
double? Longitude;
ApiServiceRequest({this.ApiKey,this.Latitude,this.Longitude});
ApiServiceRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ApiKey = json['ApiKey'];
Latitude = JsonConverters.toDouble(json['Latitude']);
Longitude = JsonConverters.toDouble(json['Longitude']);
return this;
}
Map<String, dynamic> toJson() => {
'ApiKey': ApiKey,
'Latitude': Latitude,
'Longitude': Longitude
};
getTypeName() => "ApiServiceRequest";
TypeContext? context = _ctx;
}
class ApiServiceResponse implements IServiceResponse, IConvertible
{
/**
* Information about the response.
*/
// @ApiMember(Description="Information about the response.", IsRequired=true)
String? Description;
/**
* Heading or summary of the response.
*/
// @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
String? Heading;
/**
* Did the intended operation for this response complete successfully?
*/
// @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
bool? WasSuccessful;
ResponseStatus? ResponseStatus;
ApiServiceResponse({this.Description,this.Heading,this.WasSuccessful,this.ResponseStatus});
ApiServiceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Description = json['Description'];
Heading = json['Heading'];
WasSuccessful = json['WasSuccessful'];
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Description': Description,
'Heading': Heading,
'WasSuccessful': WasSuccessful,
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "ApiServiceResponse";
TypeContext? context = _ctx;
}
class UpliftHistoryItem implements IConvertible
{
String? PrincipleLogo;
String? PrincipleName;
String? OutletName;
String? AppointmentDate;
String? AppointmentDateFormatted;
String? SubmittedDate;
String? SubmittedDateFormatted;
String? UpliftNumber;
String? AntelScheduledDate;
String? AntelCompletedDate;
String? AntelSubmissionDocumentUrl;
String? AntelUpliftNumber;
UpliftHistoryItem({this.PrincipleLogo,this.PrincipleName,this.OutletName,this.AppointmentDate,this.AppointmentDateFormatted,this.SubmittedDate,this.SubmittedDateFormatted,this.UpliftNumber,this.AntelScheduledDate,this.AntelCompletedDate,this.AntelSubmissionDocumentUrl,this.AntelUpliftNumber});
UpliftHistoryItem.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
PrincipleLogo = json['PrincipleLogo'];
PrincipleName = json['PrincipleName'];
OutletName = json['OutletName'];
AppointmentDate = json['AppointmentDate'];
AppointmentDateFormatted = json['AppointmentDateFormatted'];
SubmittedDate = json['SubmittedDate'];
SubmittedDateFormatted = json['SubmittedDateFormatted'];
UpliftNumber = json['UpliftNumber'];
AntelScheduledDate = json['AntelScheduledDate'];
AntelCompletedDate = json['AntelCompletedDate'];
AntelSubmissionDocumentUrl = json['AntelSubmissionDocumentUrl'];
AntelUpliftNumber = json['AntelUpliftNumber'];
return this;
}
Map<String, dynamic> toJson() => {
'PrincipleLogo': PrincipleLogo,
'PrincipleName': PrincipleName,
'OutletName': OutletName,
'AppointmentDate': AppointmentDate,
'AppointmentDateFormatted': AppointmentDateFormatted,
'SubmittedDate': SubmittedDate,
'SubmittedDateFormatted': SubmittedDateFormatted,
'UpliftNumber': UpliftNumber,
'AntelScheduledDate': AntelScheduledDate,
'AntelCompletedDate': AntelCompletedDate,
'AntelSubmissionDocumentUrl': AntelSubmissionDocumentUrl,
'AntelUpliftNumber': AntelUpliftNumber
};
getTypeName() => "UpliftHistoryItem";
TypeContext? context = _ctx;
}
class UpliftHistoryResponse extends ApiServiceResponse implements IConvertible
{
List<UpliftHistoryItem>? Items;
UpliftHistoryResponse({this.Items});
UpliftHistoryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Items = JsonConverters.fromJson(json['Items'],'List<UpliftHistoryItem>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Items': JsonConverters.toJson(Items,'List<UpliftHistoryItem>',context!)
});
getTypeName() => "UpliftHistoryResponse";
TypeContext? context = _ctx;
}
class UpliftHistory extends ApiServiceRequest implements IConvertible
{
UpliftHistory();
UpliftHistory.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() => "UpliftHistory";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'returnit_api_dev.happen.zone', types: <String, TypeInfo> {
'ApiServiceRequest': TypeInfo(TypeOf.Class, create:() => ApiServiceRequest()),
'ApiServiceResponse': TypeInfo(TypeOf.Class, create:() => ApiServiceResponse()),
'UpliftHistoryItem': TypeInfo(TypeOf.Class, create:() => UpliftHistoryItem()),
'UpliftHistoryResponse': TypeInfo(TypeOf.Class, create:() => UpliftHistoryResponse()),
'List<UpliftHistoryItem>': TypeInfo(TypeOf.Class, create:() => <UpliftHistoryItem>[]),
'UpliftHistory': TypeInfo(TypeOf.Class, create:() => UpliftHistory()),
});
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 /uplift/history HTTP/1.1 Host: returnit-api-dev.happen.zone Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Items:
[
{
}
],
Description: String,
Heading: String,
WasSuccessful: False,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}