Antel API

CloseOrderArrival

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ServiceModel;
using WebService.ServiceModel.Base;

namespace WebService.ServiceModel
{
    public partial class CloseOrderArrival
        : ApiServiceRequest
    {
        public virtual string OrderNumber { get; set; }
    }

    public partial class CloseOrderArrivalResponse
        : ApiServiceResponse
    {
        public virtual string OrderNumber { get; set; }
        public virtual string RequestingOperatorName { get; set; }
        public virtual string OperatorName { get; set; }
        public virtual string DestinationDepot { get; set; }
        public virtual string DriverName { get; set; }
        public virtual string CompanyName { get; set; }
        public virtual string LicensePlate { get; set; }
        public virtual int OrderId { get; set; }
        public virtual int EstimatedSeals { get; set; }
        public virtual StockOperationSummary OperationSummary { get; set; }
    }

    public partial class StockOperationSealItem
    {
        public virtual string UpliftNumber { get; set; }
        public virtual string SealNumber { get; set; }
        public virtual string PrincipalName { get; set; }
        public virtual double CurrentWeight { get; set; }
        public virtual double WeightDifference { get; set; }
        public virtual string OperatorName { get; set; }
        public virtual string OutletName { get; set; }
        public virtual string UpliftDate { get; set; }
        public virtual bool PausedAwaitingAuth { get; set; }
        public virtual string UpliftPdfLink { get; set; }
    }

    public partial class StockOperationSummary
    {
        public StockOperationSummary()
        {
            ScannedSeals = new List<StockOperationSealItem>{};
            MissingSeals = new List<StockOperationSealItem>{};
            UnknownUpliftSeals = new List<StockOperationSealItem>{};
            PausedSeals = new List<StockOperationSealItem>{};
            WeightDifferenceSeals = new List<StockOperationSealItem>{};
        }

        public virtual List<StockOperationSealItem> ScannedSeals { get; set; }
        public virtual List<StockOperationSealItem> MissingSeals { get; set; }
        public virtual List<StockOperationSealItem> UnknownUpliftSeals { get; set; }
        public virtual List<StockOperationSealItem> PausedSeals { get; set; }
        public virtual List<StockOperationSealItem> WeightDifferenceSeals { get; set; }
        public virtual bool HasScannedSeals { get; set; }
        public virtual bool HasMissingSeals { get; set; }
        public virtual bool HasWeightDifferenceSeals { get; set; }
        public virtual bool HasUnknownUpliftSeals { get; set; }
        public virtual bool HasPausedSeals { get; set; }
        public virtual bool HasException { get; set; }
        public virtual int TotalSealsCount { get; set; }
        public virtual double TotalSealsWeight { get; set; }
    }

}

namespace WebService.ServiceModel.Base
{
    public partial class ApiServiceRequest
        : IServiceRequest, IHasApiKey, IHasDeviceInfo
    {
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Latitude of the user making this request")]
        public virtual double Latitude { get; set; }

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Longitude of the user making this request")]
        public virtual double Longitude { get; set; }
    }

    public partial class ApiServiceResponse
        : IServiceResponse
    {
        ///<summary>
        ///Information about the response.
        ///</summary>
        [ApiMember(Description="Information about the response.", IsRequired=true)]
        public virtual string Description { get; set; }

        ///<summary>
        ///Heading or summary of the response.
        ///</summary>
        [ApiMember(Description="Heading or summary of the response.", IsRequired=true)]
        public virtual string Heading { get; set; }

        ///<summary>
        ///Did the intended operation for this response complete successfully?
        ///</summary>
        [ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)]
        public virtual bool WasSuccessful { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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
		}
	}
}