Antel API

<back to all web services

SealDetailsRequest

"use strict";
export class ApiServiceRequest {
    /** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API Key required for authentication */
    apiKey;
    /**
     * @type {number}
     * @description Latitude of the user making this request */
    latitude;
    /**
     * @type {number}
     * @description Longitude of the user making this request */
    longitude;
}
export class ApiServiceResponse {
    /** @param {{description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Information about the response. */
    description;
    /**
     * @type {string}
     * @description Heading or summary of the response. */
    heading;
    /**
     * @type {boolean}
     * @description Did the intended operation for this response complete successfully? */
    wasSuccessful;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class FileDataItem {
    /** @param {{fileName?:string,fileUrl?:string,thumbnailUrl?:string,fileId?:string,thumbnailId?:string,linkId?:number,createdDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    fileName;
    /** @type {string} */
    fileUrl;
    /** @type {string} */
    thumbnailUrl;
    /** @type {string} */
    fileId;
    /** @type {string} */
    thumbnailId;
    /** @type {number} */
    linkId;
    /** @type {string} */
    createdDate;
}
export class SealOrderHistoryItem {
    /** @param {{createdDate?:string,orderId?:number,orderNumber?:string,orderRequestingOperator?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    createdDate;
    /** @type {number} */
    orderId;
    /** @type {string} */
    orderNumber;
    /** @type {string} */
    orderRequestingOperator;
}
export class SealMovementHistoryItem {
    /** @param {{id?:number,eventDateTime?:string,actionUserName?:string,scannedDepotName?:string,assignedBucketName?:string,assignedOrderNumber?:string,assignedOperatorName?:string,orderDriverName?:string,orderDriverCompanyName?:string,orderDriverLicensePlate?:string,targetWeight?:number,currentWeight?:number,hadWeightIssue?:boolean,hadUnknownUplift?:boolean,wasPaused?:boolean,pausedWasAwaitingAuth?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    eventDateTime;
    /** @type {string} */
    actionUserName;
    /** @type {string} */
    scannedDepotName;
    /** @type {string} */
    assignedBucketName;
    /** @type {string} */
    assignedOrderNumber;
    /** @type {string} */
    assignedOperatorName;
    /** @type {string} */
    orderDriverName;
    /** @type {string} */
    orderDriverCompanyName;
    /** @type {string} */
    orderDriverLicensePlate;
    /** @type {number} */
    targetWeight;
    /** @type {number} */
    currentWeight;
    /** @type {boolean} */
    hadWeightIssue;
    /** @type {boolean} */
    hadUnknownUplift;
    /** @type {boolean} */
    wasPaused;
    /** @type {boolean} */
    pausedWasAwaitingAuth;
}
export class SealDetailsResponse extends ApiServiceResponse {
    /** @param {{principalName?:string,upliftNumber?:string,operatorName?:string,outletName?:string,upliftDate?:string,sealNumber?:string,currentWeight?:string,targetWeight?:string,hasWeightIssue?:boolean,bucketName?:string,claimNumbers?:string[],joinedClaimNumbers?:string,sealImages?:FileDataItem[],orderHistory?:SealOrderHistoryItem[],movementHistory?:SealMovementHistoryItem[],description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    principalName;
    /** @type {string} */
    upliftNumber;
    /** @type {string} */
    operatorName;
    /** @type {string} */
    outletName;
    /** @type {string} */
    upliftDate;
    /** @type {string} */
    sealNumber;
    /** @type {string} */
    currentWeight;
    /** @type {string} */
    targetWeight;
    /** @type {boolean} */
    hasWeightIssue;
    /** @type {string} */
    bucketName;
    /** @type {string[]} */
    claimNumbers;
    /** @type {string} */
    joinedClaimNumbers;
    /** @type {FileDataItem[]} */
    sealImages;
    /** @type {SealOrderHistoryItem[]} */
    orderHistory;
    /** @type {SealMovementHistoryItem[]} */
    movementHistory;
}
export class SealDetailsRequest extends ApiServiceRequest {
    /** @param {{sealId?:number,apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    sealId;
}

JavaScript SealDetailsRequest DTOs

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>