| POST | /uplift/conclude |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class ConcludeUplift extends ApiServiceRequest
{
public Integer upliftSchedulePrincipleId = null;
public UUID incompleteUpliftId = null;
public String comments = null;
public Integer getUpliftSchedulePrincipleId() { return upliftSchedulePrincipleId; }
public ConcludeUplift setUpliftSchedulePrincipleId(Integer value) { this.upliftSchedulePrincipleId = value; return this; }
public UUID getIncompleteUpliftId() { return incompleteUpliftId; }
public ConcludeUplift setIncompleteUpliftId(UUID value) { this.incompleteUpliftId = value; return this; }
public String getComments() { return comments; }
public ConcludeUplift setComments(String value) { this.comments = 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 SaveUpliftResponse extends ApiServiceResponse
{
public Integer upliftId = null;
public UUID upliftAuthRequestId = null;
public ArrayList<UpliftSealData> seals = null;
public UpliftSealData unbaggedItems = null;
public ArrayList<UpliftClaimData> claims = null;
public Boolean deleteFromDevice = null;
public ArrayList<String> imageIds = null;
public Boolean invalidAntelSeal = null;
public Integer getUpliftId() { return upliftId; }
public SaveUpliftResponse setUpliftId(Integer value) { this.upliftId = value; return this; }
public UUID getUpliftAuthRequestId() { return upliftAuthRequestId; }
public SaveUpliftResponse setUpliftAuthRequestId(UUID value) { this.upliftAuthRequestId = value; return this; }
public ArrayList<UpliftSealData> getSeals() { return seals; }
public SaveUpliftResponse setSeals(ArrayList<UpliftSealData> value) { this.seals = value; return this; }
public UpliftSealData getUnbaggedItems() { return unbaggedItems; }
public SaveUpliftResponse setUnbaggedItems(UpliftSealData value) { this.unbaggedItems = value; return this; }
public ArrayList<UpliftClaimData> getClaims() { return claims; }
public SaveUpliftResponse setClaims(ArrayList<UpliftClaimData> value) { this.claims = value; return this; }
public Boolean isDeleteFromDevice() { return deleteFromDevice; }
public SaveUpliftResponse setDeleteFromDevice(Boolean value) { this.deleteFromDevice = value; return this; }
public ArrayList<String> getImageIds() { return imageIds; }
public SaveUpliftResponse setImageIds(ArrayList<String> value) { this.imageIds = value; return this; }
public Boolean isInvalidAntelSeal() { return invalidAntelSeal; }
public SaveUpliftResponse setInvalidAntelSeal(Boolean value) { this.invalidAntelSeal = 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 UpliftSealData
{
public Boolean unbagged = null;
public String sealNumber = null;
public String antelSealNumber = null;
public ArrayList<UpliftProductData> products = null;
public Double totalPrice = null;
public Double totalQuantity = null;
public Double netWeight = null;
public Double grossWeight = null;
public Boolean billableSeal = null;
public Boolean invalidAntelSealNumber = null;
public Boolean isUnbagged() { return unbagged; }
public UpliftSealData setUnbagged(Boolean value) { this.unbagged = value; return this; }
public String getSealNumber() { return sealNumber; }
public UpliftSealData setSealNumber(String value) { this.sealNumber = value; return this; }
public String getAntelSealNumber() { return antelSealNumber; }
public UpliftSealData setAntelSealNumber(String value) { this.antelSealNumber = value; return this; }
public ArrayList<UpliftProductData> getProducts() { return products; }
public UpliftSealData setProducts(ArrayList<UpliftProductData> value) { this.products = value; return this; }
public Double getTotalPrice() { return totalPrice; }
public UpliftSealData setTotalPrice(Double value) { this.totalPrice = value; return this; }
public Double getTotalQuantity() { return totalQuantity; }
public UpliftSealData setTotalQuantity(Double value) { this.totalQuantity = value; return this; }
public Double getNetWeight() { return netWeight; }
public UpliftSealData setNetWeight(Double value) { this.netWeight = value; return this; }
public Double getGrossWeight() { return grossWeight; }
public UpliftSealData setGrossWeight(Double value) { this.grossWeight = value; return this; }
public Boolean isBillableSeal() { return billableSeal; }
public UpliftSealData setBillableSeal(Boolean value) { this.billableSeal = value; return this; }
public Boolean isInvalidAntelSealNumber() { return invalidAntelSealNumber; }
public UpliftSealData setInvalidAntelSealNumber(Boolean value) { this.invalidAntelSealNumber = value; return this; }
}
public static class UpliftProductData
{
public Integer upliftProductId = null;
public Integer upliftId = null;
public Integer productId = null;
public BigDecimal unitPrice = null;
public String name = null;
public String category = null;
public String unitBarcode = null;
public String unitSize = null;
public BigDecimal unitWeight = null;
public String code = null;
public ArrayList<Object> upliftImages = null;
public Double quantity = null;
public BigDecimal value = null;
public Boolean priceOverMax = null;
public Boolean quantityOverMax = null;
public Boolean quantityOverRequirement = null;
public String serialNumber = null;
public String batchCode = null;
public Integer stockStatusId = null;
public String lotNumber = null;
public String expiryDate = null;
public String manufactureDate = null;
public Integer getUpliftProductId() { return upliftProductId; }
public UpliftProductData setUpliftProductId(Integer value) { this.upliftProductId = value; return this; }
public Integer getUpliftId() { return upliftId; }
public UpliftProductData setUpliftId(Integer value) { this.upliftId = value; return this; }
public Integer getProductId() { return productId; }
public UpliftProductData setProductId(Integer value) { this.productId = value; return this; }
public BigDecimal getUnitPrice() { return unitPrice; }
public UpliftProductData setUnitPrice(BigDecimal value) { this.unitPrice = value; return this; }
public String getName() { return name; }
public UpliftProductData setName(String value) { this.name = value; return this; }
public String getCategory() { return category; }
public UpliftProductData setCategory(String value) { this.category = value; return this; }
public String getUnitBarcode() { return unitBarcode; }
public UpliftProductData setUnitBarcode(String value) { this.unitBarcode = value; return this; }
public String getUnitSize() { return unitSize; }
public UpliftProductData setUnitSize(String value) { this.unitSize = value; return this; }
public BigDecimal getUnitWeight() { return unitWeight; }
public UpliftProductData setUnitWeight(BigDecimal value) { this.unitWeight = value; return this; }
public String getCode() { return code; }
public UpliftProductData setCode(String value) { this.code = value; return this; }
public ArrayList<Object> getUpliftImages() { return upliftImages; }
public UpliftProductData setUpliftImages(ArrayList<Object> value) { this.upliftImages = value; return this; }
public Double getQuantity() { return quantity; }
public UpliftProductData setQuantity(Double value) { this.quantity = value; return this; }
public BigDecimal getValue() { return value; }
public UpliftProductData setValue(BigDecimal value) { this.value = value; return this; }
public Boolean isPriceOverMax() { return priceOverMax; }
public UpliftProductData setPriceOverMax(Boolean value) { this.priceOverMax = value; return this; }
public Boolean isQuantityOverMax() { return quantityOverMax; }
public UpliftProductData setQuantityOverMax(Boolean value) { this.quantityOverMax = value; return this; }
public Boolean isQuantityOverRequirement() { return quantityOverRequirement; }
public UpliftProductData setQuantityOverRequirement(Boolean value) { this.quantityOverRequirement = value; return this; }
public String getSerialNumber() { return serialNumber; }
public UpliftProductData setSerialNumber(String value) { this.serialNumber = value; return this; }
public String getBatchCode() { return batchCode; }
public UpliftProductData setBatchCode(String value) { this.batchCode = value; return this; }
public Integer getStockStatusId() { return stockStatusId; }
public UpliftProductData setStockStatusId(Integer value) { this.stockStatusId = value; return this; }
public String getLotNumber() { return lotNumber; }
public UpliftProductData setLotNumber(String value) { this.lotNumber = value; return this; }
public String getExpiryDate() { return expiryDate; }
public UpliftProductData setExpiryDate(String value) { this.expiryDate = value; return this; }
public String getManufactureDate() { return manufactureDate; }
public UpliftProductData setManufactureDate(String value) { this.manufactureDate = value; return this; }
}
public static class UpliftClaimData
{
public Integer upliftClaimId = null;
public Integer claimUnits = null;
public String claimNumber = null;
public BigDecimal claimValue = null;
public ArrayList<Object> claimDocumentImages = null;
public String returnOrderNumber = null;
public Integer lineCount = null;
public Integer getUpliftClaimId() { return upliftClaimId; }
public UpliftClaimData setUpliftClaimId(Integer value) { this.upliftClaimId = value; return this; }
public Integer getClaimUnits() { return claimUnits; }
public UpliftClaimData setClaimUnits(Integer value) { this.claimUnits = value; return this; }
public String getClaimNumber() { return claimNumber; }
public UpliftClaimData setClaimNumber(String value) { this.claimNumber = value; return this; }
public BigDecimal getClaimValue() { return claimValue; }
public UpliftClaimData setClaimValue(BigDecimal value) { this.claimValue = value; return this; }
public ArrayList<Object> getClaimDocumentImages() { return claimDocumentImages; }
public UpliftClaimData setClaimDocumentImages(ArrayList<Object> value) { this.claimDocumentImages = value; return this; }
public String getReturnOrderNumber() { return returnOrderNumber; }
public UpliftClaimData setReturnOrderNumber(String value) { this.returnOrderNumber = value; return this; }
public Integer getLineCount() { return lineCount; }
public UpliftClaimData setLineCount(Integer value) { this.lineCount = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /uplift/conclude HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ConcludeUplift 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>
<Comments>String</Comments>
<IncompleteUpliftId>00000000-0000-0000-0000-000000000000</IncompleteUpliftId>
<UpliftSchedulePrincipleId>0</UpliftSchedulePrincipleId>
</ConcludeUplift>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SaveUpliftResponse 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>
<Claims>
<UpliftClaimData>
<ClaimDocumentImages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:anyType />
</ClaimDocumentImages>
<ClaimNumber>String</ClaimNumber>
<ClaimUnits>0</ClaimUnits>
<ClaimValue>0</ClaimValue>
<LineCount>0</LineCount>
<ReturnOrderNumber>String</ReturnOrderNumber>
<UpliftClaimId>0</UpliftClaimId>
</UpliftClaimData>
</Claims>
<DeleteFromDevice>false</DeleteFromDevice>
<ImageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ImageIds>
<Seals>
<UpliftSealData>
<AntelSealNumber>String</AntelSealNumber>
<BillableSeal>false</BillableSeal>
<GrossWeight>0</GrossWeight>
<InvalidAntelSealNumber>false</InvalidAntelSealNumber>
<NetWeight>0</NetWeight>
<Products>
<UpliftProductData>
<BatchCode>String</BatchCode>
<Category>String</Category>
<Code>String</Code>
<ExpiryDate>String</ExpiryDate>
<LotNumber>String</LotNumber>
<ManufactureDate>String</ManufactureDate>
<Name>String</Name>
<PriceOverMax>false</PriceOverMax>
<ProductId>0</ProductId>
<Quantity>0</Quantity>
<QuantityOverMax>false</QuantityOverMax>
<QuantityOverRequirement>false</QuantityOverRequirement>
<SerialNumber>String</SerialNumber>
<StockStatusId>0</StockStatusId>
<UnitBarcode>String</UnitBarcode>
<UnitPrice>0</UnitPrice>
<UnitSize>String</UnitSize>
<UnitWeight>0</UnitWeight>
<UpliftId>0</UpliftId>
<UpliftImages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:anyType />
</UpliftImages>
<UpliftProductId>0</UpliftProductId>
<Value>0</Value>
</UpliftProductData>
</Products>
<SealNumber>String</SealNumber>
<TotalPrice>0</TotalPrice>
<TotalQuantity>0</TotalQuantity>
<Unbagged>false</Unbagged>
</UpliftSealData>
</Seals>
<UnbaggedItems>
<AntelSealNumber>String</AntelSealNumber>
<BillableSeal>false</BillableSeal>
<GrossWeight>0</GrossWeight>
<InvalidAntelSealNumber>false</InvalidAntelSealNumber>
<NetWeight>0</NetWeight>
<Products>
<UpliftProductData>
<BatchCode>String</BatchCode>
<Category>String</Category>
<Code>String</Code>
<ExpiryDate>String</ExpiryDate>
<LotNumber>String</LotNumber>
<ManufactureDate>String</ManufactureDate>
<Name>String</Name>
<PriceOverMax>false</PriceOverMax>
<ProductId>0</ProductId>
<Quantity>0</Quantity>
<QuantityOverMax>false</QuantityOverMax>
<QuantityOverRequirement>false</QuantityOverRequirement>
<SerialNumber>String</SerialNumber>
<StockStatusId>0</StockStatusId>
<UnitBarcode>String</UnitBarcode>
<UnitPrice>0</UnitPrice>
<UnitSize>String</UnitSize>
<UnitWeight>0</UnitWeight>
<UpliftId>0</UpliftId>
<UpliftImages xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:anyType />
</UpliftImages>
<UpliftProductId>0</UpliftProductId>
<Value>0</Value>
</UpliftProductData>
</Products>
<SealNumber>String</SealNumber>
<TotalPrice>0</TotalPrice>
<TotalQuantity>0</TotalQuantity>
<Unbagged>false</Unbagged>
</UnbaggedItems>
<UpliftAuthRequestId>00000000-0000-0000-0000-000000000000</UpliftAuthRequestId>
<UpliftId>0</UpliftId>
</SaveUpliftResponse>