Antel API

<back to all web services

CloseOrderArrival

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class CloseOrderArrival extends ApiServiceRequest
    {
        public String orderNumber = null;
        
        public String getOrderNumber() { return orderNumber; }
        public CloseOrderArrival setOrderNumber(String value) { this.orderNumber = value; return this; }
    }

    public static class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
    {
        /**
        * The API Key required for authentication
        */
        @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
        public String apiKey = null;

        /**
        * Latitude of the user making this request
        */
        @ApiMember(DataType="double", Description="Latitude of the user making this request")
        public Double latitude = null;

        /**
        * Longitude of the user making this request
        */
        @ApiMember(DataType="double", Description="Longitude of the user making this request")
        public Double longitude = null;
        
        public String getApiKey() { return apiKey; }
        public ApiServiceRequest setApiKey(String value) { this.apiKey = value; return this; }
        public Double getLatitude() { return latitude; }
        public ApiServiceRequest setLatitude(Double value) { this.latitude = value; return this; }
        public Double getLongitude() { return longitude; }
        public ApiServiceRequest setLongitude(Double value) { this.longitude = value; return this; }
    }

    public static class CloseOrderArrivalResponse extends ApiServiceResponse
    {
        public String orderNumber = null;
        public String requestingOperatorName = null;
        public String operatorName = null;
        public String destinationDepot = null;
        public String driverName = null;
        public String companyName = null;
        public String licensePlate = null;
        public Integer orderId = null;
        public Integer estimatedSeals = null;
        public StockOperationSummary operationSummary = null;
        
        public String getOrderNumber() { return orderNumber; }
        public CloseOrderArrivalResponse setOrderNumber(String value) { this.orderNumber = value; return this; }
        public String getRequestingOperatorName() { return requestingOperatorName; }
        public CloseOrderArrivalResponse setRequestingOperatorName(String value) { this.requestingOperatorName = value; return this; }
        public String getOperatorName() { return operatorName; }
        public CloseOrderArrivalResponse setOperatorName(String value) { this.operatorName = value; return this; }
        public String getDestinationDepot() { return destinationDepot; }
        public CloseOrderArrivalResponse setDestinationDepot(String value) { this.destinationDepot = value; return this; }
        public String getDriverName() { return driverName; }
        public CloseOrderArrivalResponse setDriverName(String value) { this.driverName = value; return this; }
        public String getCompanyName() { return companyName; }
        public CloseOrderArrivalResponse setCompanyName(String value) { this.companyName = value; return this; }
        public String getLicensePlate() { return licensePlate; }
        public CloseOrderArrivalResponse setLicensePlate(String value) { this.licensePlate = value; return this; }
        public Integer getOrderId() { return orderId; }
        public CloseOrderArrivalResponse setOrderId(Integer value) { this.orderId = value; return this; }
        public Integer getEstimatedSeals() { return estimatedSeals; }
        public CloseOrderArrivalResponse setEstimatedSeals(Integer value) { this.estimatedSeals = value; return this; }
        public StockOperationSummary getOperationSummary() { return operationSummary; }
        public CloseOrderArrivalResponse setOperationSummary(StockOperationSummary value) { this.operationSummary = value; return this; }
    }

    public static class ApiServiceResponse implements IServiceResponse
    {
        /**
        * Information about the response.
        */
        @ApiMember(Description="Information about the response.", IsRequired=true)
        public String description = null;

        /**
        * Heading or summary of the response.
        */
        @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
        public String heading = null;

        /**
        * Did the intended operation for this response complete successfully?
        */
        @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
        public Boolean wasSuccessful = null;

        public ResponseStatus responseStatus = null;
        
        public String getDescription() { return description; }
        public ApiServiceResponse setDescription(String value) { this.description = value; return this; }
        public String getHeading() { return heading; }
        public ApiServiceResponse setHeading(String value) { this.heading = value; return this; }
        public Boolean isWasSuccessful() { return wasSuccessful; }
        public ApiServiceResponse setWasSuccessful(Boolean value) { this.wasSuccessful = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public ApiServiceResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    public static class StockOperationSummary
    {
        public ArrayList<StockOperationSealItem> scannedSeals = null;
        public ArrayList<StockOperationSealItem> missingSeals = null;
        public ArrayList<StockOperationSealItem> unknownUpliftSeals = null;
        public ArrayList<StockOperationSealItem> pausedSeals = null;
        public ArrayList<StockOperationSealItem> weightDifferenceSeals = null;
        public Boolean hasScannedSeals = null;
        public Boolean hasMissingSeals = null;
        public Boolean hasWeightDifferenceSeals = null;
        public Boolean hasUnknownUpliftSeals = null;
        public Boolean hasPausedSeals = null;
        public Boolean hasException = null;
        public Integer totalSealsCount = null;
        public Double totalSealsWeight = null;
        
        public ArrayList<StockOperationSealItem> getScannedSeals() { return scannedSeals; }
        public StockOperationSummary setScannedSeals(ArrayList<StockOperationSealItem> value) { this.scannedSeals = value; return this; }
        public ArrayList<StockOperationSealItem> getMissingSeals() { return missingSeals; }
        public StockOperationSummary setMissingSeals(ArrayList<StockOperationSealItem> value) { this.missingSeals = value; return this; }
        public ArrayList<StockOperationSealItem> getUnknownUpliftSeals() { return unknownUpliftSeals; }
        public StockOperationSummary setUnknownUpliftSeals(ArrayList<StockOperationSealItem> value) { this.unknownUpliftSeals = value; return this; }
        public ArrayList<StockOperationSealItem> getPausedSeals() { return pausedSeals; }
        public StockOperationSummary setPausedSeals(ArrayList<StockOperationSealItem> value) { this.pausedSeals = value; return this; }
        public ArrayList<StockOperationSealItem> getWeightDifferenceSeals() { return weightDifferenceSeals; }
        public StockOperationSummary setWeightDifferenceSeals(ArrayList<StockOperationSealItem> value) { this.weightDifferenceSeals = value; return this; }
        public Boolean isHasScannedSeals() { return hasScannedSeals; }
        public StockOperationSummary setHasScannedSeals(Boolean value) { this.hasScannedSeals = value; return this; }
        public Boolean isHasMissingSeals() { return hasMissingSeals; }
        public StockOperationSummary setHasMissingSeals(Boolean value) { this.hasMissingSeals = value; return this; }
        public Boolean isHasWeightDifferenceSeals() { return hasWeightDifferenceSeals; }
        public StockOperationSummary setHasWeightDifferenceSeals(Boolean value) { this.hasWeightDifferenceSeals = value; return this; }
        public Boolean isHasUnknownUpliftSeals() { return hasUnknownUpliftSeals; }
        public StockOperationSummary setHasUnknownUpliftSeals(Boolean value) { this.hasUnknownUpliftSeals = value; return this; }
        public Boolean isHasPausedSeals() { return hasPausedSeals; }
        public StockOperationSummary setHasPausedSeals(Boolean value) { this.hasPausedSeals = value; return this; }
        public Boolean isHasException() { return hasException; }
        public StockOperationSummary setHasException(Boolean value) { this.hasException = value; return this; }
        public Integer getTotalSealsCount() { return totalSealsCount; }
        public StockOperationSummary setTotalSealsCount(Integer value) { this.totalSealsCount = value; return this; }
        public Double getTotalSealsWeight() { return totalSealsWeight; }
        public StockOperationSummary setTotalSealsWeight(Double value) { this.totalSealsWeight = value; return this; }
    }

    public static class StockOperationSealItem
    {
        public String upliftNumber = null;
        public String sealNumber = null;
        public String principalName = null;
        public Double currentWeight = null;
        public Double weightDifference = null;
        public String operatorName = null;
        public String outletName = null;
        public String upliftDate = null;
        public Boolean pausedAwaitingAuth = null;
        public String upliftPdfLink = null;
        
        public String getUpliftNumber() { return upliftNumber; }
        public StockOperationSealItem setUpliftNumber(String value) { this.upliftNumber = value; return this; }
        public String getSealNumber() { return sealNumber; }
        public StockOperationSealItem setSealNumber(String value) { this.sealNumber = value; return this; }
        public String getPrincipalName() { return principalName; }
        public StockOperationSealItem setPrincipalName(String value) { this.principalName = value; return this; }
        public Double getCurrentWeight() { return currentWeight; }
        public StockOperationSealItem setCurrentWeight(Double value) { this.currentWeight = value; return this; }
        public Double getWeightDifference() { return weightDifference; }
        public StockOperationSealItem setWeightDifference(Double value) { this.weightDifference = value; return this; }
        public String getOperatorName() { return operatorName; }
        public StockOperationSealItem setOperatorName(String value) { this.operatorName = value; return this; }
        public String getOutletName() { return outletName; }
        public StockOperationSealItem setOutletName(String value) { this.outletName = value; return this; }
        public String getUpliftDate() { return upliftDate; }
        public StockOperationSealItem setUpliftDate(String value) { this.upliftDate = value; return this; }
        public Boolean isPausedAwaitingAuth() { return pausedAwaitingAuth; }
        public StockOperationSealItem setPausedAwaitingAuth(Boolean value) { this.pausedAwaitingAuth = value; return this; }
        public String getUpliftPdfLink() { return upliftPdfLink; }
        public StockOperationSealItem setUpliftPdfLink(String value) { this.upliftPdfLink = value; return this; }
    }

}

Java CloseOrderArrival DTOs

POST /stock/closeArrival/order HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CloseOrderArrival xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ApiKey>
  <Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Latitude>
  <Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Longitude>
  <OrderNumber>String</OrderNumber>
</CloseOrderArrival>

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

<CloseOrderArrivalResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Heading>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">false</WasSuccessful>
  <CompanyName>String</CompanyName>
  <DestinationDepot>String</DestinationDepot>
  <DriverName>String</DriverName>
  <EstimatedSeals>0</EstimatedSeals>
  <LicensePlate>String</LicensePlate>
  <OperationSummary>
    <MissingSeals>
      <StockOperationSealItem>
        <CurrentWeight>0</CurrentWeight>
        <OperatorName>String</OperatorName>
        <OutletName>String</OutletName>
        <PausedAwaitingAuth>false</PausedAwaitingAuth>
        <PrincipalName>String</PrincipalName>
        <SealNumber>String</SealNumber>
        <UpliftDate>String</UpliftDate>
        <UpliftNumber>String</UpliftNumber>
        <UpliftPdfLink>String</UpliftPdfLink>
        <WeightDifference>0</WeightDifference>
      </StockOperationSealItem>
    </MissingSeals>
    <PausedSeals>
      <StockOperationSealItem>
        <CurrentWeight>0</CurrentWeight>
        <OperatorName>String</OperatorName>
        <OutletName>String</OutletName>
        <PausedAwaitingAuth>false</PausedAwaitingAuth>
        <PrincipalName>String</PrincipalName>
        <SealNumber>String</SealNumber>
        <UpliftDate>String</UpliftDate>
        <UpliftNumber>String</UpliftNumber>
        <UpliftPdfLink>String</UpliftPdfLink>
        <WeightDifference>0</WeightDifference>
      </StockOperationSealItem>
    </PausedSeals>
    <ScannedSeals>
      <StockOperationSealItem>
        <CurrentWeight>0</CurrentWeight>
        <OperatorName>String</OperatorName>
        <OutletName>String</OutletName>
        <PausedAwaitingAuth>false</PausedAwaitingAuth>
        <PrincipalName>String</PrincipalName>
        <SealNumber>String</SealNumber>
        <UpliftDate>String</UpliftDate>
        <UpliftNumber>String</UpliftNumber>
        <UpliftPdfLink>String</UpliftPdfLink>
        <WeightDifference>0</WeightDifference>
      </StockOperationSealItem>
    </ScannedSeals>
    <UnknownUpliftSeals>
      <StockOperationSealItem>
        <CurrentWeight>0</CurrentWeight>
        <OperatorName>String</OperatorName>
        <OutletName>String</OutletName>
        <PausedAwaitingAuth>false</PausedAwaitingAuth>
        <PrincipalName>String</PrincipalName>
        <SealNumber>String</SealNumber>
        <UpliftDate>String</UpliftDate>
        <UpliftNumber>String</UpliftNumber>
        <UpliftPdfLink>String</UpliftPdfLink>
        <WeightDifference>0</WeightDifference>
      </StockOperationSealItem>
    </UnknownUpliftSeals>
    <WeightDifferenceSeals>
      <StockOperationSealItem>
        <CurrentWeight>0</CurrentWeight>
        <OperatorName>String</OperatorName>
        <OutletName>String</OutletName>
        <PausedAwaitingAuth>false</PausedAwaitingAuth>
        <PrincipalName>String</PrincipalName>
        <SealNumber>String</SealNumber>
        <UpliftDate>String</UpliftDate>
        <UpliftNumber>String</UpliftNumber>
        <UpliftPdfLink>String</UpliftPdfLink>
        <WeightDifference>0</WeightDifference>
      </StockOperationSealItem>
    </WeightDifferenceSeals>
  </OperationSummary>
  <OperatorName>String</OperatorName>
  <OrderId>0</OrderId>
  <OrderNumber>String</OrderNumber>
  <RequestingOperatorName>String</RequestingOperatorName>
</CloseOrderArrivalResponse>