Antel API

<back to all web services

CloseOrderArrival

Requires Authentication
The following routes are available for this service:
POST/stock/closeArrival/order
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 StockOperationSealItem implements IConvertible
{
    String? upliftNumber;
    String? sealNumber;
    String? principalName;
    double? currentWeight;
    double? weightDifference;
    String? operatorName;
    String? outletName;
    String? upliftDate;
    bool? pausedAwaitingAuth;
    String? upliftPdfLink;

    StockOperationSealItem({this.upliftNumber,this.sealNumber,this.principalName,this.currentWeight,this.weightDifference,this.operatorName,this.outletName,this.upliftDate,this.pausedAwaitingAuth,this.upliftPdfLink});
    StockOperationSealItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        upliftNumber = json['upliftNumber'];
        sealNumber = json['sealNumber'];
        principalName = json['principalName'];
        currentWeight = JsonConverters.toDouble(json['currentWeight']);
        weightDifference = JsonConverters.toDouble(json['weightDifference']);
        operatorName = json['operatorName'];
        outletName = json['outletName'];
        upliftDate = json['upliftDate'];
        pausedAwaitingAuth = json['pausedAwaitingAuth'];
        upliftPdfLink = json['upliftPdfLink'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'upliftNumber': upliftNumber,
        'sealNumber': sealNumber,
        'principalName': principalName,
        'currentWeight': currentWeight,
        'weightDifference': weightDifference,
        'operatorName': operatorName,
        'outletName': outletName,
        'upliftDate': upliftDate,
        'pausedAwaitingAuth': pausedAwaitingAuth,
        'upliftPdfLink': upliftPdfLink
    };

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

class StockOperationSummary implements IConvertible
{
    List<StockOperationSealItem>? scannedSeals;
    List<StockOperationSealItem>? missingSeals;
    List<StockOperationSealItem>? unknownUpliftSeals;
    List<StockOperationSealItem>? pausedSeals;
    List<StockOperationSealItem>? weightDifferenceSeals;
    bool? hasScannedSeals;
    bool? hasMissingSeals;
    bool? hasWeightDifferenceSeals;
    bool? hasUnknownUpliftSeals;
    bool? hasPausedSeals;
    bool? hasException;
    int? totalSealsCount;
    double? totalSealsWeight;

    StockOperationSummary({this.scannedSeals,this.missingSeals,this.unknownUpliftSeals,this.pausedSeals,this.weightDifferenceSeals,this.hasScannedSeals,this.hasMissingSeals,this.hasWeightDifferenceSeals,this.hasUnknownUpliftSeals,this.hasPausedSeals,this.hasException,this.totalSealsCount,this.totalSealsWeight});
    StockOperationSummary.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        scannedSeals = JsonConverters.fromJson(json['scannedSeals'],'List<StockOperationSealItem>',context!);
        missingSeals = JsonConverters.fromJson(json['missingSeals'],'List<StockOperationSealItem>',context!);
        unknownUpliftSeals = JsonConverters.fromJson(json['unknownUpliftSeals'],'List<StockOperationSealItem>',context!);
        pausedSeals = JsonConverters.fromJson(json['pausedSeals'],'List<StockOperationSealItem>',context!);
        weightDifferenceSeals = JsonConverters.fromJson(json['weightDifferenceSeals'],'List<StockOperationSealItem>',context!);
        hasScannedSeals = json['hasScannedSeals'];
        hasMissingSeals = json['hasMissingSeals'];
        hasWeightDifferenceSeals = json['hasWeightDifferenceSeals'];
        hasUnknownUpliftSeals = json['hasUnknownUpliftSeals'];
        hasPausedSeals = json['hasPausedSeals'];
        hasException = json['hasException'];
        totalSealsCount = json['totalSealsCount'];
        totalSealsWeight = JsonConverters.toDouble(json['totalSealsWeight']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'scannedSeals': JsonConverters.toJson(scannedSeals,'List<StockOperationSealItem>',context!),
        'missingSeals': JsonConverters.toJson(missingSeals,'List<StockOperationSealItem>',context!),
        'unknownUpliftSeals': JsonConverters.toJson(unknownUpliftSeals,'List<StockOperationSealItem>',context!),
        'pausedSeals': JsonConverters.toJson(pausedSeals,'List<StockOperationSealItem>',context!),
        'weightDifferenceSeals': JsonConverters.toJson(weightDifferenceSeals,'List<StockOperationSealItem>',context!),
        'hasScannedSeals': hasScannedSeals,
        'hasMissingSeals': hasMissingSeals,
        'hasWeightDifferenceSeals': hasWeightDifferenceSeals,
        'hasUnknownUpliftSeals': hasUnknownUpliftSeals,
        'hasPausedSeals': hasPausedSeals,
        'hasException': hasException,
        'totalSealsCount': totalSealsCount,
        'totalSealsWeight': totalSealsWeight
    };

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

class CloseOrderArrivalResponse extends ApiServiceResponse implements IConvertible
{
    String? orderNumber;
    String? requestingOperatorName;
    String? operatorName;
    String? destinationDepot;
    String? driverName;
    String? companyName;
    String? licensePlate;
    int? orderId;
    int? estimatedSeals;
    StockOperationSummary? operationSummary;

    CloseOrderArrivalResponse({this.orderNumber,this.requestingOperatorName,this.operatorName,this.destinationDepot,this.driverName,this.companyName,this.licensePlate,this.orderId,this.estimatedSeals,this.operationSummary});
    CloseOrderArrivalResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        orderNumber = json['orderNumber'];
        requestingOperatorName = json['requestingOperatorName'];
        operatorName = json['operatorName'];
        destinationDepot = json['destinationDepot'];
        driverName = json['driverName'];
        companyName = json['companyName'];
        licensePlate = json['licensePlate'];
        orderId = json['orderId'];
        estimatedSeals = json['estimatedSeals'];
        operationSummary = JsonConverters.fromJson(json['operationSummary'],'StockOperationSummary',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'orderNumber': orderNumber,
        'requestingOperatorName': requestingOperatorName,
        'operatorName': operatorName,
        'destinationDepot': destinationDepot,
        'driverName': driverName,
        'companyName': companyName,
        'licensePlate': licensePlate,
        'orderId': orderId,
        'estimatedSeals': estimatedSeals,
        'operationSummary': JsonConverters.toJson(operationSummary,'StockOperationSummary',context!)
    });

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

class CloseOrderArrival extends ApiServiceRequest implements IConvertible
{
    String? orderNumber;

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

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

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

    getTypeName() => "CloseOrderArrival";
    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()),
    'StockOperationSealItem': TypeInfo(TypeOf.Class, create:() => StockOperationSealItem()),
    'StockOperationSummary': TypeInfo(TypeOf.Class, create:() => StockOperationSummary()),
    'List<StockOperationSealItem>': TypeInfo(TypeOf.Class, create:() => <StockOperationSealItem>[]),
    'CloseOrderArrivalResponse': TypeInfo(TypeOf.Class, create:() => CloseOrderArrivalResponse()),
    'CloseOrderArrival': TypeInfo(TypeOf.Class, create:() => CloseOrderArrival()),
});

Dart CloseOrderArrival 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 /stock/closeArrival/order HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	orderNumber: String,
	requestingOperatorName: String,
	operatorName: String,
	destinationDepot: String,
	driverName: String,
	companyName: String,
	licensePlate: String,
	orderId: 0,
	estimatedSeals: 0,
	operationSummary: 
	{
		scannedSeals: 
		[
			{
				upliftNumber: String,
				sealNumber: String,
				principalName: String,
				currentWeight: 0,
				weightDifference: 0,
				operatorName: String,
				outletName: String,
				upliftDate: String,
				pausedAwaitingAuth: False,
				upliftPdfLink: String
			}
		],
		missingSeals: 
		[
			{
				upliftNumber: String,
				sealNumber: String,
				principalName: String,
				currentWeight: 0,
				weightDifference: 0,
				operatorName: String,
				outletName: String,
				upliftDate: String,
				pausedAwaitingAuth: False,
				upliftPdfLink: String
			}
		],
		unknownUpliftSeals: 
		[
			{
				upliftNumber: String,
				sealNumber: String,
				principalName: String,
				currentWeight: 0,
				weightDifference: 0,
				operatorName: String,
				outletName: String,
				upliftDate: String,
				pausedAwaitingAuth: False,
				upliftPdfLink: String
			}
		],
		pausedSeals: 
		[
			{
				upliftNumber: String,
				sealNumber: String,
				principalName: String,
				currentWeight: 0,
				weightDifference: 0,
				operatorName: String,
				outletName: String,
				upliftDate: String,
				pausedAwaitingAuth: False,
				upliftPdfLink: String
			}
		],
		weightDifferenceSeals: 
		[
			{
				upliftNumber: String,
				sealNumber: String,
				principalName: String,
				currentWeight: 0,
				weightDifference: 0,
				operatorName: String,
				outletName: String,
				upliftDate: String,
				pausedAwaitingAuth: False,
				upliftPdfLink: String
			}
		],
		hasScannedSeals: True,
		hasMissingSeals: True,
		hasWeightDifferenceSeals: True,
		hasUnknownUpliftSeals: True,
		hasPausedSeals: True,
		hasException: True,
		totalSealsCount: 4,
		totalSealsWeight: 0
	},
	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
		}
	}
}