Antel API

<back to all web services

SealDetailsRequest

Requires Authentication
The following routes are available for this service:
POST/stock/seal/details
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;
using CommonService.Api.Models.Base;

namespace CommonService.Api.Models.Base
{
    public partial class FileDataItem
    {
        public virtual string FileName { get; set; }
        public virtual string FileUrl { get; set; }
        public virtual string ThumbnailUrl { get; set; }
        public virtual Guid FileId { get; set; }
        public virtual Guid ThumbnailId { get; set; }
        public virtual int LinkId { get; set; }
        public virtual DateTime CreatedDate { get; set; }
    }

}

namespace WebService.ServiceModel
{
    public partial class SealDetailsRequest
        : ApiServiceRequest
    {
        public virtual int SealId { get; set; }
    }

    public partial class SealDetailsResponse
        : ApiServiceResponse
    {
        public SealDetailsResponse()
        {
            ClaimNumbers = new List<string>{};
            SealImages = new List<FileDataItem>{};
            OrderHistory = new List<SealOrderHistoryItem>{};
            MovementHistory = new List<SealMovementHistoryItem>{};
        }

        public virtual string PrincipalName { get; set; }
        public virtual string UpliftNumber { get; set; }
        public virtual string OperatorName { get; set; }
        public virtual string OutletName { get; set; }
        public virtual string UpliftDate { get; set; }
        public virtual string SealNumber { get; set; }
        public virtual string CurrentWeight { get; set; }
        public virtual string TargetWeight { get; set; }
        public virtual bool HasWeightIssue { get; set; }
        public virtual string BucketName { get; set; }
        public virtual List<string> ClaimNumbers { get; set; }
        public virtual string JoinedClaimNumbers { get; set; }
        public virtual List<FileDataItem> SealImages { get; set; }
        public virtual List<SealOrderHistoryItem> OrderHistory { get; set; }
        public virtual List<SealMovementHistoryItem> MovementHistory { get; set; }
    }

    public partial class SealMovementHistoryItem
    {
        public virtual long Id { get; set; }
        public virtual string EventDateTime { get; set; }
        public virtual string ActionUserName { get; set; }
        public virtual string ScannedDepotName { get; set; }
        public virtual string AssignedBucketName { get; set; }
        public virtual string AssignedOrderNumber { get; set; }
        public virtual string AssignedOperatorName { get; set; }
        public virtual string OrderDriverName { get; set; }
        public virtual string OrderDriverCompanyName { get; set; }
        public virtual string OrderDriverLicensePlate { get; set; }
        public virtual double TargetWeight { get; set; }
        public virtual double CurrentWeight { get; set; }
        public virtual bool HadWeightIssue { get; set; }
        public virtual bool HadUnknownUplift { get; set; }
        public virtual bool WasPaused { get; set; }
        public virtual bool PausedWasAwaitingAuth { get; set; }
    }

    public partial class SealOrderHistoryItem
    {
        public virtual string CreatedDate { get; set; }
        public virtual int OrderId { get; set; }
        public virtual string OrderNumber { get; set; }
        public virtual string OrderRequestingOperator { 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# 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>