Antel API

<back to all web services

FinishOrderAssignment

Requires Authentication
The following routes are available for this service:
POST/stock/order/assignment/finish
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;

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

    public partial class FinishOrderAssignmentResponse
        : ApiServiceResponse
    {
        public virtual int OrderId { get; set; }
        public virtual int EstimatedSeals { get; set; }
        public virtual StockOperationSummary OperationSummary { get; set; }
    }

    public partial class StockOperationSealItem
    {
        public virtual string UpliftNumber { get; set; }
        public virtual string SealNumber { get; set; }
        public virtual string PrincipalName { get; set; }
        public virtual double CurrentWeight { get; set; }
        public virtual double WeightDifference { get; set; }
        public virtual string OperatorName { get; set; }
        public virtual string OutletName { get; set; }
        public virtual string UpliftDate { get; set; }
        public virtual bool PausedAwaitingAuth { get; set; }
        public virtual string UpliftPdfLink { get; set; }
    }

    public partial class StockOperationSummary
    {
        public StockOperationSummary()
        {
            ScannedSeals = new List<StockOperationSealItem>{};
            MissingSeals = new List<StockOperationSealItem>{};
            UnknownUpliftSeals = new List<StockOperationSealItem>{};
            PausedSeals = new List<StockOperationSealItem>{};
            WeightDifferenceSeals = new List<StockOperationSealItem>{};
        }

        public virtual List<StockOperationSealItem> ScannedSeals { get; set; }
        public virtual List<StockOperationSealItem> MissingSeals { get; set; }
        public virtual List<StockOperationSealItem> UnknownUpliftSeals { get; set; }
        public virtual List<StockOperationSealItem> PausedSeals { get; set; }
        public virtual List<StockOperationSealItem> WeightDifferenceSeals { get; set; }
        public virtual bool HasScannedSeals { get; set; }
        public virtual bool HasMissingSeals { get; set; }
        public virtual bool HasWeightDifferenceSeals { get; set; }
        public virtual bool HasUnknownUpliftSeals { get; set; }
        public virtual bool HasPausedSeals { get; set; }
        public virtual bool HasException { get; set; }
        public virtual int TotalSealsCount { get; set; }
        public virtual double TotalSealsWeight { 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# FinishOrderAssignment 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/order/assignment/finish HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<FinishOrderAssignmentResponse 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>
  <EstimatedSeals>0</EstimatedSeals>
  <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>
  <OrderId>0</OrderId>
</FinishOrderAssignmentResponse>