Antel API

DepotDropOff

The following routes are available for this service:
POST	/stock/depotDropoff

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 AntelSealData implements IConvertible
{
    String? sealNumber;
    String? principalName;
    int? sealId;
    String? operatorName;
    String? outletName;
    String? upliftDate;
    bool? sealExists;
    bool? isPaused;
    bool? pausedAwaitingAuth;

    AntelSealData({this.sealNumber,this.principalName,this.sealId,this.operatorName,this.outletName,this.upliftDate,this.sealExists,this.isPaused,this.pausedAwaitingAuth});
    AntelSealData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        sealNumber = json['sealNumber'];
        principalName = json['principalName'];
        sealId = json['sealId'];
        operatorName = json['operatorName'];
        outletName = json['outletName'];
        upliftDate = json['upliftDate'];
        sealExists = json['sealExists'];
        isPaused = json['isPaused'];
        pausedAwaitingAuth = json['pausedAwaitingAuth'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'sealNumber': sealNumber,
        'principalName': principalName,
        'sealId': sealId,
        'operatorName': operatorName,
        'outletName': outletName,
        'upliftDate': upliftDate,
        'sealExists': sealExists,
        'isPaused': isPaused,
        'pausedAwaitingAuth': pausedAwaitingAuth
    };

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

class DepotDropOffResponse extends ApiServiceResponse implements IConvertible
{
    AntelSealData? sealData;
    bool? weightRequired;
    bool? atDepot;
    bool? skipConfirm;

    DepotDropOffResponse({this.sealData,this.weightRequired,this.atDepot,this.skipConfirm});
    DepotDropOffResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        sealData = JsonConverters.fromJson(json['sealData'],'AntelSealData',context!);
        weightRequired = json['weightRequired'];
        atDepot = json['atDepot'];
        skipConfirm = json['skipConfirm'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'sealData': JsonConverters.toJson(sealData,'AntelSealData',context!),
        'weightRequired': weightRequired,
        'atDepot': atDepot,
        'skipConfirm': skipConfirm
    });

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

class DepotDropOff extends ApiServiceRequest implements IConvertible
{
    String? sealNumber;

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

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

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

    getTypeName() => "DepotDropOff";
    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()),
    'AntelSealData': TypeInfo(TypeOf.Class, create:() => AntelSealData()),
    'DepotDropOffResponse': TypeInfo(TypeOf.Class, create:() => DepotDropOffResponse()),
    'DepotDropOff': TypeInfo(TypeOf.Class, create:() => DepotDropOff()),
});

Dart DepotDropOff DTOs

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

HTTP + OTHER

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

POST /stock/depotDropoff HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"sealNumber":"String","apiKey":"String","latitude":0,"longitude":0}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"sealData":{"sealNumber":"String","principalName":"String","sealId":0,"operatorName":"String","outletName":"String","upliftDate":"String","sealExists":false,"isPaused":false,"pausedAwaitingAuth":false},"weightRequired":false,"atDepot":false,"skipConfirm":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"}}}