| GET | /uplift/auth |
|---|
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 AuthStatusData implements IConvertible
{
AuthStatusDataAuthStatus? status;
String? upliftAuthRequestId;
bool? found;
AuthStatusData({this.status,this.upliftAuthRequestId,this.found});
AuthStatusData.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
status = JsonConverters.fromJson(json['status'],'AuthStatusDataAuthStatus',context!);
upliftAuthRequestId = json['upliftAuthRequestId'];
found = json['found'];
return this;
}
Map<String, dynamic> toJson() => {
'status': JsonConverters.toJson(status,'AuthStatusDataAuthStatus',context!),
'upliftAuthRequestId': upliftAuthRequestId,
'found': found
};
getTypeName() => "AuthStatusData";
TypeContext? context = _ctx;
}
class UpliftAuthStatusResponse extends ApiServiceResponse implements IConvertible
{
List<AuthStatusData>? upliftAuthStatuses;
UpliftAuthStatusResponse({this.upliftAuthStatuses});
UpliftAuthStatusResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
upliftAuthStatuses = JsonConverters.fromJson(json['upliftAuthStatuses'],'List<AuthStatusData>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'upliftAuthStatuses': JsonConverters.toJson(upliftAuthStatuses,'List<AuthStatusData>',context!)
});
getTypeName() => "UpliftAuthStatusResponse";
TypeContext? context = _ctx;
}
class UpliftAuthStatus extends ApiServiceRequest implements IConvertible
{
List<String>? upliftAuthRequestIds;
UpliftAuthStatus({this.upliftAuthRequestIds});
UpliftAuthStatus.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
upliftAuthRequestIds = JsonConverters.fromJson(json['upliftAuthRequestIds'],'List<String>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'upliftAuthRequestIds': JsonConverters.toJson(upliftAuthRequestIds,'List<String>',context!)
});
getTypeName() => "UpliftAuthStatus";
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),
'AuthStatusData': TypeInfo(TypeOf.Class, create:() => AuthStatusData()),
'UpliftAuthStatusResponse': TypeInfo(TypeOf.Class, create:() => UpliftAuthStatusResponse()),
'List<AuthStatusData>': TypeInfo(TypeOf.Class, create:() => <AuthStatusData>[]),
'UpliftAuthStatus': TypeInfo(TypeOf.Class, create:() => UpliftAuthStatus()),
});
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/auth HTTP/1.1 Host: antel.api.dev.86degrees.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
upliftAuthStatuses:
[
{
status: 0,
found: 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
}
}
}