| POST | /uplift/auth |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class UpliftAuthRequest extends ApiServiceRequest
{
public Integer upliftSchedulePrincipleId = null;
public BigDecimal totalValue = null;
public Double totalUnits = null;
public String region = null;
public String channel = null;
public ArrayList<UpliftSealData> seals = null;
public UpliftSealData unbaggedItems = null;
public Integer getUpliftSchedulePrincipleId() { return upliftSchedulePrincipleId; }
public UpliftAuthRequest setUpliftSchedulePrincipleId(Integer value) { this.upliftSchedulePrincipleId = value; return this; }
public BigDecimal getTotalValue() { return totalValue; }
public UpliftAuthRequest setTotalValue(BigDecimal value) { this.totalValue = value; return this; }
public Double getTotalUnits() { return totalUnits; }
public UpliftAuthRequest setTotalUnits(Double value) { this.totalUnits = value; return this; }
public String getRegion() { return region; }
public UpliftAuthRequest setRegion(String value) { this.region = value; return this; }
public String getChannel() { return channel; }
public UpliftAuthRequest setChannel(String value) { this.channel = value; return this; }
public ArrayList<UpliftSealData> getSeals() { return seals; }
public UpliftAuthRequest setSeals(ArrayList<UpliftSealData> value) { this.seals = value; return this; }
public UpliftSealData getUnbaggedItems() { return unbaggedItems; }
public UpliftAuthRequest setUnbaggedItems(UpliftSealData value) { this.unbaggedItems = 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 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 UpliftAuthRequestResponse extends ApiServiceResponse
{
public UUID upliftAuthRequestId = null;
public UUID getUpliftAuthRequestId() { return upliftAuthRequestId; }
public UpliftAuthRequestResponse setUpliftAuthRequestId(UUID value) { this.upliftAuthRequestId = 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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /uplift/auth HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
upliftSchedulePrincipleId: 0,
totalValue: 0,
totalUnits: 0,
region: String,
channel: String,
seals:
[
{
unbagged: False,
sealNumber: String,
antelSealNumber: String,
products:
[
{
upliftProductId: 0,
upliftId: 0,
productId: 0,
unitPrice: 0,
name: String,
category: String,
unitBarcode: String,
unitSize: String,
unitWeight: 0,
code: String,
upliftImages:
[
{
}
],
quantity: 0,
value: 0,
priceOverMax: False,
quantityOverMax: False,
quantityOverRequirement: False,
serialNumber: String,
batchCode: String,
stockStatusId: 0,
lotNumber: String,
expiryDate: String,
manufactureDate: String
}
],
totalPrice: 0,
totalQuantity: 0,
netWeight: 0,
grossWeight: 0,
billableSeal: False,
invalidAntelSealNumber: False
}
],
unbaggedItems:
{
unbagged: False,
sealNumber: String,
antelSealNumber: String,
products:
[
{
upliftProductId: 0,
upliftId: 0,
productId: 0,
unitPrice: 0,
name: String,
category: String,
unitBarcode: String,
unitSize: String,
unitWeight: 0,
code: String,
upliftImages:
[
{
}
],
quantity: 0,
value: 0,
priceOverMax: False,
quantityOverMax: False,
quantityOverRequirement: False,
serialNumber: String,
batchCode: String,
stockStatusId: 0,
lotNumber: String,
expiryDate: String,
manufactureDate: String
}
],
totalPrice: 0,
totalQuantity: 0,
netWeight: 0,
grossWeight: 0,
billableSeal: False,
invalidAntelSealNumber: False
},
apiKey: String,
latitude: 0,
longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
description: String,
heading: String,
wasSuccessful: False,
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}