Antel API

<back to all web services

SealDetailsRequest

Requires Authentication
The following routes are available for this service:
POST/stock/seal/details
namespace WebService.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiServiceResponse() = 
        ///<summary>
        ///Information about the response.
        ///</summary>
        [<ApiMember(Description="Information about the response.", IsRequired=true)>]
        member val Description:String = null with get,set

        ///<summary>
        ///Heading or summary of the response.
        ///</summary>
        [<ApiMember(Description="Heading or summary of the response.", IsRequired=true)>]
        member val Heading:String = null with 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)>]
        member val WasSuccessful:Boolean = new Boolean() with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type FileDataItem() = 
        member val FileName:String = null with get,set
        member val FileUrl:String = null with get,set
        member val ThumbnailUrl:String = null with get,set
        member val FileId:Guid = new Guid() with get,set
        member val ThumbnailId:Guid = new Guid() with get,set
        member val LinkId:Int32 = new Int32() with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type SealOrderHistoryItem() = 
        member val CreatedDate:String = null with get,set
        member val OrderId:Int32 = new Int32() with get,set
        member val OrderNumber:String = null with get,set
        member val OrderRequestingOperator:String = null with get,set

    [<AllowNullLiteral>]
    type SealMovementHistoryItem() = 
        member val Id:Int64 = new Int64() with get,set
        member val EventDateTime:String = null with get,set
        member val ActionUserName:String = null with get,set
        member val ScannedDepotName:String = null with get,set
        member val AssignedBucketName:String = null with get,set
        member val AssignedOrderNumber:String = null with get,set
        member val AssignedOperatorName:String = null with get,set
        member val OrderDriverName:String = null with get,set
        member val OrderDriverCompanyName:String = null with get,set
        member val OrderDriverLicensePlate:String = null with get,set
        member val TargetWeight:Double = new Double() with get,set
        member val CurrentWeight:Double = new Double() with get,set
        member val HadWeightIssue:Boolean = new Boolean() with get,set
        member val HadUnknownUplift:Boolean = new Boolean() with get,set
        member val WasPaused:Boolean = new Boolean() with get,set
        member val PausedWasAwaitingAuth:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type SealDetailsResponse() = 
        inherit ApiServiceResponse()
        member val PrincipalName:String = null with get,set
        member val UpliftNumber:String = null with get,set
        member val OperatorName:String = null with get,set
        member val OutletName:String = null with get,set
        member val UpliftDate:String = null with get,set
        member val SealNumber:String = null with get,set
        member val CurrentWeight:String = null with get,set
        member val TargetWeight:String = null with get,set
        member val HasWeightIssue:Boolean = new Boolean() with get,set
        member val BucketName:String = null with get,set
        member val ClaimNumbers:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val JoinedClaimNumbers:String = null with get,set
        member val SealImages:ResizeArray<FileDataItem> = new ResizeArray<FileDataItem>() with get,set
        member val OrderHistory:ResizeArray<SealOrderHistoryItem> = new ResizeArray<SealOrderHistoryItem>() with get,set
        member val MovementHistory:ResizeArray<SealMovementHistoryItem> = new ResizeArray<SealMovementHistoryItem>() with get,set

    [<AllowNullLiteral>]
    type ApiServiceRequest() = 
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Latitude of the user making this request")>]
        member val Latitude:Double = new Double() with get,set

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Longitude of the user making this request")>]
        member val Longitude:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type SealDetailsRequest() = 
        inherit ApiServiceRequest()
        member val SealId:Int32 = new Int32() with get,set

F# SealDetailsRequest DTOs

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

HTTP + XML

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

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

<SealDetailsRequest 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>
  <SealId>0</SealId>
</SealDetailsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SealDetailsResponse 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>
  <BucketName>String</BucketName>
  <ClaimNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ClaimNumbers>
  <CurrentWeight>String</CurrentWeight>
  <HasWeightIssue>false</HasWeightIssue>
  <MovementHistory>
    <SealMovementHistoryItem>
      <ActionUserName>String</ActionUserName>
      <AssignedBucketName>String</AssignedBucketName>
      <AssignedOperatorName>String</AssignedOperatorName>
      <AssignedOrderNumber>String</AssignedOrderNumber>
      <CurrentWeight>0</CurrentWeight>
      <EventDateTime>String</EventDateTime>
      <HadUnknownUplift>false</HadUnknownUplift>
      <HadWeightIssue>false</HadWeightIssue>
      <Id>0</Id>
      <OrderDriverCompanyName>String</OrderDriverCompanyName>
      <OrderDriverLicensePlate>String</OrderDriverLicensePlate>
      <OrderDriverName>String</OrderDriverName>
      <PausedWasAwaitingAuth>false</PausedWasAwaitingAuth>
      <ScannedDepotName>String</ScannedDepotName>
      <TargetWeight>0</TargetWeight>
      <WasPaused>false</WasPaused>
    </SealMovementHistoryItem>
  </MovementHistory>
  <OperatorName>String</OperatorName>
  <OrderHistory>
    <SealOrderHistoryItem>
      <CreatedDate>String</CreatedDate>
      <OrderId>0</OrderId>
      <OrderNumber>String</OrderNumber>
      <OrderRequestingOperator>String</OrderRequestingOperator>
    </SealOrderHistoryItem>
  </OrderHistory>
  <OutletName>String</OutletName>
  <PrincipalName>String</PrincipalName>
  <SealImages xmlns:d2p1="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">
    <d2p1:FileDataItem>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:FileId>00000000-0000-0000-0000-000000000000</d2p1:FileId>
      <d2p1:FileName>String</d2p1:FileName>
      <d2p1:FileUrl>String</d2p1:FileUrl>
      <d2p1:LinkId>0</d2p1:LinkId>
      <d2p1:ThumbnailId>00000000-0000-0000-0000-000000000000</d2p1:ThumbnailId>
      <d2p1:ThumbnailUrl>String</d2p1:ThumbnailUrl>
    </d2p1:FileDataItem>
  </SealImages>
  <SealNumber>String</SealNumber>
  <TargetWeight>String</TargetWeight>
  <UpliftDate>String</UpliftDate>
  <UpliftNumber>String</UpliftNumber>
</SealDetailsResponse>