Antel API

<back to all web services

OrderDetail

Requires Authentication
The following routes are available for this service:
POST/stock/orderDetail
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class OrderDetail extends ApiServiceRequest
    {
        public String orderNumber = null;
        public Boolean forOperator = null;
        
        public String getOrderNumber() { return orderNumber; }
        public OrderDetail setOrderNumber(String value) { this.orderNumber = value; return this; }
        public Boolean isForOperator() { return forOperator; }
        public OrderDetail setForOperator(Boolean value) { this.forOperator = 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 OrderDetailResponse extends ApiServiceResponse
    {
        public Integer orderId = null;
        public String operatorName = null;
        public String driverName = null;
        public String companyName = null;
        public String licensePlate = null;
        public String orderNumber = null;
        public String destinationDepot = null;
        public Boolean canClose = null;
        public Boolean canScan = null;
        public Integer estimatedSeals = null;
        public Long scannedSeals = null;
        public String status = null;
        
        public Integer getOrderId() { return orderId; }
        public OrderDetailResponse setOrderId(Integer value) { this.orderId = value; return this; }
        public String getOperatorName() { return operatorName; }
        public OrderDetailResponse setOperatorName(String value) { this.operatorName = value; return this; }
        public String getDriverName() { return driverName; }
        public OrderDetailResponse setDriverName(String value) { this.driverName = value; return this; }
        public String getCompanyName() { return companyName; }
        public OrderDetailResponse setCompanyName(String value) { this.companyName = value; return this; }
        public String getLicensePlate() { return licensePlate; }
        public OrderDetailResponse setLicensePlate(String value) { this.licensePlate = value; return this; }
        public String getOrderNumber() { return orderNumber; }
        public OrderDetailResponse setOrderNumber(String value) { this.orderNumber = value; return this; }
        public String getDestinationDepot() { return destinationDepot; }
        public OrderDetailResponse setDestinationDepot(String value) { this.destinationDepot = value; return this; }
        public Boolean isCanClose() { return canClose; }
        public OrderDetailResponse setCanClose(Boolean value) { this.canClose = value; return this; }
        public Boolean isCanScan() { return canScan; }
        public OrderDetailResponse setCanScan(Boolean value) { this.canScan = value; return this; }
        public Integer getEstimatedSeals() { return estimatedSeals; }
        public OrderDetailResponse setEstimatedSeals(Integer value) { this.estimatedSeals = value; return this; }
        public Long getScannedSeals() { return scannedSeals; }
        public OrderDetailResponse setScannedSeals(Long value) { this.scannedSeals = value; return this; }
        public String getStatus() { return status; }
        public OrderDetailResponse setStatus(String value) { this.status = 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; }
    }

}

Java OrderDetail DTOs

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

HTTP + CSV

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

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

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

{"orderId":0,"operatorName":"String","driverName":"String","companyName":"String","licensePlate":"String","orderNumber":"String","destinationDepot":"String","canClose":false,"canScan":false,"estimatedSeals":0,"scannedSeals":0,"status":"String","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"}}}