Antel API

<back to all web services

UpliftHistory

Requires Authentication
The following routes are available for this service:
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? submissionDocument;

    UpliftHistoryItem({this.principleLogo,this.principleName,this.outletName,this.appointmentDate,this.appointmentDateFormatted,this.submittedDate,this.submittedDateFormatted,this.upliftNumber,this.submissionDocument});
    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'];
        submissionDocument = json['submissionDocument'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'principleLogo': principleLogo,
        'principleName': principleName,
        'outletName': outletName,
        'appointmentDate': appointmentDate,
        'appointmentDateFormatted': appointmentDateFormatted,
        'submittedDate': submittedDate,
        'submittedDateFormatted': submittedDateFormatted,
        'upliftNumber': upliftNumber,
        'submissionDocument': submissionDocument
    };

    getTypeName() => "UpliftHistoryItem";
    TypeContext? context = _ctx;
}

class UpliftHistoryResponse extends ApiServiceResponse implements IConvertible
{
    List<UpliftHistoryItem>? upliftHistoryItems;

    UpliftHistoryResponse({this.upliftHistoryItems});
    UpliftHistoryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        upliftHistoryItems = JsonConverters.fromJson(json['upliftHistoryItems'],'List<UpliftHistoryItem>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'upliftHistoryItems': JsonConverters.toJson(upliftHistoryItems,'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: 'antel.api.dev.86degrees.com', 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()),
});

Dart UpliftHistory DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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: antel.api.dev.86degrees.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	upliftHistoryItems: 
	[
		{
			
		}
	],
	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
		}
	}
}