Antel API

<back to all web services

SealDetailsRequest

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

public class dtos
{

    public static class SealDetailsRequest extends ApiServiceRequest
    {
        public Integer sealId = null;
        
        public Integer getSealId() { return sealId; }
        public SealDetailsRequest setSealId(Integer value) { this.sealId = 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 SealDetailsResponse extends ApiServiceResponse
    {
        public String principalName = null;
        public String upliftNumber = null;
        public String operatorName = null;
        public String outletName = null;
        public String upliftDate = null;
        public String sealNumber = null;
        public String currentWeight = null;
        public String targetWeight = null;
        public Boolean hasWeightIssue = null;
        public String bucketName = null;
        public ArrayList<String> claimNumbers = null;
        public String joinedClaimNumbers = null;
        public ArrayList<FileDataItem> sealImages = null;
        public ArrayList<SealOrderHistoryItem> orderHistory = null;
        public ArrayList<SealMovementHistoryItem> movementHistory = null;
        
        public String getPrincipalName() { return principalName; }
        public SealDetailsResponse setPrincipalName(String value) { this.principalName = value; return this; }
        public String getUpliftNumber() { return upliftNumber; }
        public SealDetailsResponse setUpliftNumber(String value) { this.upliftNumber = value; return this; }
        public String getOperatorName() { return operatorName; }
        public SealDetailsResponse setOperatorName(String value) { this.operatorName = value; return this; }
        public String getOutletName() { return outletName; }
        public SealDetailsResponse setOutletName(String value) { this.outletName = value; return this; }
        public String getUpliftDate() { return upliftDate; }
        public SealDetailsResponse setUpliftDate(String value) { this.upliftDate = value; return this; }
        public String getSealNumber() { return sealNumber; }
        public SealDetailsResponse setSealNumber(String value) { this.sealNumber = value; return this; }
        public String getCurrentWeight() { return currentWeight; }
        public SealDetailsResponse setCurrentWeight(String value) { this.currentWeight = value; return this; }
        public String getTargetWeight() { return targetWeight; }
        public SealDetailsResponse setTargetWeight(String value) { this.targetWeight = value; return this; }
        public Boolean isHasWeightIssue() { return hasWeightIssue; }
        public SealDetailsResponse setHasWeightIssue(Boolean value) { this.hasWeightIssue = value; return this; }
        public String getBucketName() { return bucketName; }
        public SealDetailsResponse setBucketName(String value) { this.bucketName = value; return this; }
        public ArrayList<String> getClaimNumbers() { return claimNumbers; }
        public SealDetailsResponse setClaimNumbers(ArrayList<String> value) { this.claimNumbers = value; return this; }
        public String getJoinedClaimNumbers() { return joinedClaimNumbers; }
        public SealDetailsResponse setJoinedClaimNumbers(String value) { this.joinedClaimNumbers = value; return this; }
        public ArrayList<FileDataItem> getSealImages() { return sealImages; }
        public SealDetailsResponse setSealImages(ArrayList<FileDataItem> value) { this.sealImages = value; return this; }
        public ArrayList<SealOrderHistoryItem> getOrderHistory() { return orderHistory; }
        public SealDetailsResponse setOrderHistory(ArrayList<SealOrderHistoryItem> value) { this.orderHistory = value; return this; }
        public ArrayList<SealMovementHistoryItem> getMovementHistory() { return movementHistory; }
        public SealDetailsResponse setMovementHistory(ArrayList<SealMovementHistoryItem> value) { this.movementHistory = 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; }
    }

    public static class FileDataItem
    {
        public String fileName = null;
        public String fileUrl = null;
        public String thumbnailUrl = null;
        public UUID fileId = null;
        public UUID thumbnailId = null;
        public Integer linkId = null;
        public Date createdDate = null;
        
        public String getFileName() { return fileName; }
        public FileDataItem setFileName(String value) { this.fileName = value; return this; }
        public String getFileUrl() { return fileUrl; }
        public FileDataItem setFileUrl(String value) { this.fileUrl = value; return this; }
        public String getThumbnailUrl() { return thumbnailUrl; }
        public FileDataItem setThumbnailUrl(String value) { this.thumbnailUrl = value; return this; }
        public UUID getFileId() { return fileId; }
        public FileDataItem setFileId(UUID value) { this.fileId = value; return this; }
        public UUID getThumbnailId() { return thumbnailId; }
        public FileDataItem setThumbnailId(UUID value) { this.thumbnailId = value; return this; }
        public Integer getLinkId() { return linkId; }
        public FileDataItem setLinkId(Integer value) { this.linkId = value; return this; }
        public Date getCreatedDate() { return createdDate; }
        public FileDataItem setCreatedDate(Date value) { this.createdDate = value; return this; }
    }

    public static class SealOrderHistoryItem
    {
        public String createdDate = null;
        public Integer orderId = null;
        public String orderNumber = null;
        public String orderRequestingOperator = null;
        
        public String getCreatedDate() { return createdDate; }
        public SealOrderHistoryItem setCreatedDate(String value) { this.createdDate = value; return this; }
        public Integer getOrderId() { return orderId; }
        public SealOrderHistoryItem setOrderId(Integer value) { this.orderId = value; return this; }
        public String getOrderNumber() { return orderNumber; }
        public SealOrderHistoryItem setOrderNumber(String value) { this.orderNumber = value; return this; }
        public String getOrderRequestingOperator() { return orderRequestingOperator; }
        public SealOrderHistoryItem setOrderRequestingOperator(String value) { this.orderRequestingOperator = value; return this; }
    }

    public static class SealMovementHistoryItem
    {
        public Long id = null;
        public String eventDateTime = null;
        public String actionUserName = null;
        public String scannedDepotName = null;
        public String assignedBucketName = null;
        public String assignedOrderNumber = null;
        public String assignedOperatorName = null;
        public String orderDriverName = null;
        public String orderDriverCompanyName = null;
        public String orderDriverLicensePlate = null;
        public Double targetWeight = null;
        public Double currentWeight = null;
        public Boolean hadWeightIssue = null;
        public Boolean hadUnknownUplift = null;
        public Boolean wasPaused = null;
        public Boolean pausedWasAwaitingAuth = null;
        
        public Long getId() { return id; }
        public SealMovementHistoryItem setId(Long value) { this.id = value; return this; }
        public String getEventDateTime() { return eventDateTime; }
        public SealMovementHistoryItem setEventDateTime(String value) { this.eventDateTime = value; return this; }
        public String getActionUserName() { return actionUserName; }
        public SealMovementHistoryItem setActionUserName(String value) { this.actionUserName = value; return this; }
        public String getScannedDepotName() { return scannedDepotName; }
        public SealMovementHistoryItem setScannedDepotName(String value) { this.scannedDepotName = value; return this; }
        public String getAssignedBucketName() { return assignedBucketName; }
        public SealMovementHistoryItem setAssignedBucketName(String value) { this.assignedBucketName = value; return this; }
        public String getAssignedOrderNumber() { return assignedOrderNumber; }
        public SealMovementHistoryItem setAssignedOrderNumber(String value) { this.assignedOrderNumber = value; return this; }
        public String getAssignedOperatorName() { return assignedOperatorName; }
        public SealMovementHistoryItem setAssignedOperatorName(String value) { this.assignedOperatorName = value; return this; }
        public String getOrderDriverName() { return orderDriverName; }
        public SealMovementHistoryItem setOrderDriverName(String value) { this.orderDriverName = value; return this; }
        public String getOrderDriverCompanyName() { return orderDriverCompanyName; }
        public SealMovementHistoryItem setOrderDriverCompanyName(String value) { this.orderDriverCompanyName = value; return this; }
        public String getOrderDriverLicensePlate() { return orderDriverLicensePlate; }
        public SealMovementHistoryItem setOrderDriverLicensePlate(String value) { this.orderDriverLicensePlate = value; return this; }
        public Double getTargetWeight() { return targetWeight; }
        public SealMovementHistoryItem setTargetWeight(Double value) { this.targetWeight = value; return this; }
        public Double getCurrentWeight() { return currentWeight; }
        public SealMovementHistoryItem setCurrentWeight(Double value) { this.currentWeight = value; return this; }
        public Boolean isHadWeightIssue() { return hadWeightIssue; }
        public SealMovementHistoryItem setHadWeightIssue(Boolean value) { this.hadWeightIssue = value; return this; }
        public Boolean isHadUnknownUplift() { return hadUnknownUplift; }
        public SealMovementHistoryItem setHadUnknownUplift(Boolean value) { this.hadUnknownUplift = value; return this; }
        public Boolean isWasPaused() { return wasPaused; }
        public SealMovementHistoryItem setWasPaused(Boolean value) { this.wasPaused = value; return this; }
        public Boolean isPausedWasAwaitingAuth() { return pausedWasAwaitingAuth; }
        public SealMovementHistoryItem setPausedWasAwaitingAuth(Boolean value) { this.pausedWasAwaitingAuth = value; return this; }
    }

}

Java 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>