Antel API

<back to all web services

CancelUpliftAuth

Requires Authentication
The following routes are available for this service:
POST/uplift/auth/cancel
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 AuthStatusDataAuthStatus
{
    static const AuthStatusDataAuthStatus Pending = const AuthStatusDataAuthStatus._(0);
    static const AuthStatusDataAuthStatus Cancelled = const AuthStatusDataAuthStatus._(1);
    static const AuthStatusDataAuthStatus Authorised = const AuthStatusDataAuthStatus._(2);

    final int _value;
    const AuthStatusDataAuthStatus._(this._value);
    int get value => _value;
    static List<AuthStatusDataAuthStatus> get values => const [Pending,Cancelled,Authorised];
}

class CancelUpliftAuthResponse extends ApiServiceResponse implements IConvertible
{
    AuthStatusDataAuthStatus? status;
    bool? statusChanged;

    CancelUpliftAuthResponse({this.status,this.statusChanged});
    CancelUpliftAuthResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'status': JsonConverters.toJson(status,'AuthStatusDataAuthStatus',context!),
        'statusChanged': statusChanged
    });

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

class CancelUpliftAuth extends ApiServiceRequest implements IConvertible
{
    String? upliftAuthRequestId;
    String? reason;

    CancelUpliftAuth({this.upliftAuthRequestId,this.reason});
    CancelUpliftAuth.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        upliftAuthRequestId = json['upliftAuthRequestId'];
        reason = json['reason'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'upliftAuthRequestId': upliftAuthRequestId,
        'reason': reason
    });

    getTypeName() => "CancelUpliftAuth";
    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()),
    'AuthStatusDataAuthStatus': TypeInfo(TypeOf.Enum, enumValues:AuthStatusDataAuthStatus.values),
    'CancelUpliftAuthResponse': TypeInfo(TypeOf.Class, create:() => CancelUpliftAuthResponse()),
    'CancelUpliftAuth': TypeInfo(TypeOf.Class, create:() => CancelUpliftAuth()),
});

Dart CancelUpliftAuth 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.

POST /uplift/auth/cancel HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	reason: String,
	apiKey: String,
	latitude: 0,
	longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	status: 0,
	statusChanged: False,
	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
		}
	}
}