Antel Merchandiser App API

UpliftRequestAuthStatus

The following routes are available for this service:
GET	/upliftrequest/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;
}

// @Flags()
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? UpliftRequestAuthRequestId;
    bool? Found;

    AuthStatusData({this.Status,this.UpliftRequestAuthRequestId,this.Found});
    AuthStatusData.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'Status': JsonConverters.toJson(Status,'AuthStatusDataAuthStatus',context!),
        'UpliftRequestAuthRequestId': UpliftRequestAuthRequestId,
        'Found': Found
    };

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

class UpliftRequestAuthStatusResponse extends ApiServiceResponse implements IConvertible
{
    List<AuthStatusData>? UpliftRequestAuthStatuses;

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

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'UpliftRequestAuthStatuses': JsonConverters.toJson(UpliftRequestAuthStatuses,'List<AuthStatusData>',context!)
    });

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

class UpliftRequestAuthStatus extends ApiServiceRequest implements IConvertible
{
    List<String>? UpliftRequestAuthRequestIds;

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

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

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

    getTypeName() => "UpliftRequestAuthStatus";
    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()),
    'AuthStatusDataAuthStatus': TypeInfo(TypeOf.Enum, enumValues:AuthStatusDataAuthStatus.values),
    'AuthStatusData': TypeInfo(TypeOf.Class, create:() => AuthStatusData()),
    'UpliftRequestAuthStatusResponse': TypeInfo(TypeOf.Class, create:() => UpliftRequestAuthStatusResponse()),
    'List<AuthStatusData>': TypeInfo(TypeOf.Class, create:() => <AuthStatusData>[]),
    'UpliftRequestAuthStatus': TypeInfo(TypeOf.Class, create:() => UpliftRequestAuthStatus()),
});

Dart UpliftRequestAuthStatus DTOs

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /upliftrequest/auth HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"UpliftRequestAuthStatuses":[{"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"}}}