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.*


open class OrderDetail : ApiServiceRequest()
{
    var orderNumber:String? = null
    var forOperator:Boolean? = null
}

open class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /**
    * The API Key required for authentication
    */
    @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    var apiKey:String? = null

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

    /**
    * Longitude of the user making this request
    */
    @ApiMember(DataType="double", Description="Longitude of the user making this request")
    var longitude:Double? = null
}

open class OrderDetailResponse : ApiServiceResponse()
{
    var orderId:Int? = null
    var operatorName:String? = null
    var driverName:String? = null
    var companyName:String? = null
    var licensePlate:String? = null
    var orderNumber:String? = null
    var destinationDepot:String? = null
    var canClose:Boolean? = null
    var canScan:Boolean? = null
    var estimatedSeals:Int? = null
    var scannedSeals:Long? = null
    var status:String? = null
}

open class ApiServiceResponse : IServiceResponse
{
    /**
    * Information about the response.
    */
    @ApiMember(Description="Information about the response.", IsRequired=true)
    var description:String? = null

    /**
    * Heading or summary of the response.
    */
    @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    var heading:String? = 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)
    var wasSuccessful:Boolean? = null

    var responseStatus:ResponseStatus? = null
}

Kotlin OrderDetail DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"orderNumber":"String","forOperator":false,"apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}