Antel Merchandiser App API

<back to all web services

SaveIncompleteUpliftRequest

The following routes are available for this service:
POST/sync/saveincompleteuplift
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class SaveIncompleteUpliftRequest extends ApiServiceRequest
    {
        public UUID IncompleteUpliftRequestId = null;
        public ArrayList<String> ImageIdsOnDevice = null;
        public UpliftRequestData UpliftRequestData = null;
        
        public UUID getIncompleteUpliftRequestId() { return IncompleteUpliftRequestId; }
        public SaveIncompleteUpliftRequest setIncompleteUpliftRequestId(UUID value) { this.IncompleteUpliftRequestId = value; return this; }
        public ArrayList<String> getImageIdsOnDevice() { return ImageIdsOnDevice; }
        public SaveIncompleteUpliftRequest setImageIdsOnDevice(ArrayList<String> value) { this.ImageIdsOnDevice = value; return this; }
        public UpliftRequestData getUpliftRequestData() { return UpliftRequestData; }
        public SaveIncompleteUpliftRequest setUpliftRequestData(UpliftRequestData value) { this.UpliftRequestData = 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 UpliftRequestData
    {
        public Integer UpliftRequestId = null;
        public UUID Id = null;
        public Integer OutletId = null;
        public ArrayList<UpliftRequestProductData> Products = null;
        public String OutletEmailAddress = null;
        public String OutletContactName = null;
        public String OutletChannel = null;
        public String OutletRegion = null;
        public String AdditionalNotes = null;
        public Object MerchandiserSignatureImage = null;
        public String StartTime = null;
        public Double StartLatitude = null;
        public Double StartLongitude = null;
        public String EndTime = null;
        public Double EndLatitude = null;
        public Double EndLongitude = null;
        public Date LastUpdated = null;
        public Date LastSynced = null;
        public String IncompleteUpliftRequestId = null;
        public UUID AuthRequestId = null;
        public Boolean Authorised = null;
        public Integer PrincipalId = null;
        public ArrayList<SealData> Seals = null;
        public Boolean Confirmed = null;
        public Boolean Cancelled = null;
        public ArrayList<Object> Images = null;
        public Boolean SubmitImmediately = null;
        
        public Integer getUpliftRequestId() { return UpliftRequestId; }
        public UpliftRequestData setUpliftRequestId(Integer value) { this.UpliftRequestId = value; return this; }
        public UUID getId() { return Id; }
        public UpliftRequestData setId(UUID value) { this.Id = value; return this; }
        public Integer getOutletId() { return OutletId; }
        public UpliftRequestData setOutletId(Integer value) { this.OutletId = value; return this; }
        public ArrayList<UpliftRequestProductData> getProducts() { return Products; }
        public UpliftRequestData setProducts(ArrayList<UpliftRequestProductData> value) { this.Products = value; return this; }
        public String getOutletEmailAddress() { return OutletEmailAddress; }
        public UpliftRequestData setOutletEmailAddress(String value) { this.OutletEmailAddress = value; return this; }
        public String getOutletContactName() { return OutletContactName; }
        public UpliftRequestData setOutletContactName(String value) { this.OutletContactName = value; return this; }
        public String getOutletChannel() { return OutletChannel; }
        public UpliftRequestData setOutletChannel(String value) { this.OutletChannel = value; return this; }
        public String getOutletRegion() { return OutletRegion; }
        public UpliftRequestData setOutletRegion(String value) { this.OutletRegion = value; return this; }
        public String getAdditionalNotes() { return AdditionalNotes; }
        public UpliftRequestData setAdditionalNotes(String value) { this.AdditionalNotes = value; return this; }
        public Object getMerchandiserSignatureImage() { return MerchandiserSignatureImage; }
        public UpliftRequestData setMerchandiserSignatureImage(Object value) { this.MerchandiserSignatureImage = value; return this; }
        public String getStartTime() { return StartTime; }
        public UpliftRequestData setStartTime(String value) { this.StartTime = value; return this; }
        public Double getStartLatitude() { return StartLatitude; }
        public UpliftRequestData setStartLatitude(Double value) { this.StartLatitude = value; return this; }
        public Double getStartLongitude() { return StartLongitude; }
        public UpliftRequestData setStartLongitude(Double value) { this.StartLongitude = value; return this; }
        public String getEndTime() { return EndTime; }
        public UpliftRequestData setEndTime(String value) { this.EndTime = value; return this; }
        public Double getEndLatitude() { return EndLatitude; }
        public UpliftRequestData setEndLatitude(Double value) { this.EndLatitude = value; return this; }
        public Double getEndLongitude() { return EndLongitude; }
        public UpliftRequestData setEndLongitude(Double value) { this.EndLongitude = value; return this; }
        public Date getLastUpdated() { return LastUpdated; }
        public UpliftRequestData setLastUpdated(Date value) { this.LastUpdated = value; return this; }
        public Date getLastSynced() { return LastSynced; }
        public UpliftRequestData setLastSynced(Date value) { this.LastSynced = value; return this; }
        public String getIncompleteUpliftRequestId() { return IncompleteUpliftRequestId; }
        public UpliftRequestData setIncompleteUpliftRequestId(String value) { this.IncompleteUpliftRequestId = value; return this; }
        public UUID getAuthRequestId() { return AuthRequestId; }
        public UpliftRequestData setAuthRequestId(UUID value) { this.AuthRequestId = value; return this; }
        public Boolean isAuthorised() { return Authorised; }
        public UpliftRequestData setAuthorised(Boolean value) { this.Authorised = value; return this; }
        public Integer getPrincipalId() { return PrincipalId; }
        public UpliftRequestData setPrincipalId(Integer value) { this.PrincipalId = value; return this; }
        public ArrayList<SealData> getSeals() { return Seals; }
        public UpliftRequestData setSeals(ArrayList<SealData> value) { this.Seals = value; return this; }
        public Boolean isConfirmed() { return Confirmed; }
        public UpliftRequestData setConfirmed(Boolean value) { this.Confirmed = value; return this; }
        public Boolean isCancelled() { return Cancelled; }
        public UpliftRequestData setCancelled(Boolean value) { this.Cancelled = value; return this; }
        public ArrayList<Object> getImages() { return Images; }
        public UpliftRequestData setImages(ArrayList<Object> value) { this.Images = value; return this; }
        public Boolean isSubmitImmediately() { return SubmitImmediately; }
        public UpliftRequestData setSubmitImmediately(Boolean value) { this.SubmitImmediately = value; return this; }
    }

    public static class UpliftRequestProductData
    {
        public UUID Id = null;
        public Integer UpliftRequestProductId = null;
        public Integer ProductId = null;
        public Integer PrincipalId = 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> Images = null;
        public Double Quantity = null;
        public BigDecimal Value = null;
        public String ProductionDate = null;
        public String ExpiryDate = null;
        public String BatchCode = null;
        public SealData Seal = null;
        public String SerialNumber = null;
        public Integer StockStatusId = null;
        public String PrincipalLogoUrl = null;
        public String PrincipalName = null;
        public String StockStatusName = null;
        public String StockStatusColor = null;
        public Integer UnitOfMeasureId = null;
        
        public UUID getId() { return Id; }
        public UpliftRequestProductData setId(UUID value) { this.Id = value; return this; }
        public Integer getUpliftRequestProductId() { return UpliftRequestProductId; }
        public UpliftRequestProductData setUpliftRequestProductId(Integer value) { this.UpliftRequestProductId = value; return this; }
        public Integer getProductId() { return ProductId; }
        public UpliftRequestProductData setProductId(Integer value) { this.ProductId = value; return this; }
        public Integer getPrincipalId() { return PrincipalId; }
        public UpliftRequestProductData setPrincipalId(Integer value) { this.PrincipalId = value; return this; }
        public BigDecimal getUnitPrice() { return UnitPrice; }
        public UpliftRequestProductData setUnitPrice(BigDecimal value) { this.UnitPrice = value; return this; }
        public String getName() { return Name; }
        public UpliftRequestProductData setName(String value) { this.Name = value; return this; }
        public String getCategory() { return Category; }
        public UpliftRequestProductData setCategory(String value) { this.Category = value; return this; }
        public String getUnitBarcode() { return UnitBarcode; }
        public UpliftRequestProductData setUnitBarcode(String value) { this.UnitBarcode = value; return this; }
        public String getUnitSize() { return UnitSize; }
        public UpliftRequestProductData setUnitSize(String value) { this.UnitSize = value; return this; }
        public BigDecimal getUnitWeight() { return UnitWeight; }
        public UpliftRequestProductData setUnitWeight(BigDecimal value) { this.UnitWeight = value; return this; }
        public String getCode() { return Code; }
        public UpliftRequestProductData setCode(String value) { this.Code = value; return this; }
        public ArrayList<Object> getImages() { return Images; }
        public UpliftRequestProductData setImages(ArrayList<Object> value) { this.Images = value; return this; }
        public Double getQuantity() { return Quantity; }
        public UpliftRequestProductData setQuantity(Double value) { this.Quantity = value; return this; }
        public BigDecimal getValue() { return Value; }
        public UpliftRequestProductData setValue(BigDecimal value) { this.Value = value; return this; }
        public String getProductionDate() { return ProductionDate; }
        public UpliftRequestProductData setProductionDate(String value) { this.ProductionDate = value; return this; }
        public String getExpiryDate() { return ExpiryDate; }
        public UpliftRequestProductData setExpiryDate(String value) { this.ExpiryDate = value; return this; }
        public String getBatchCode() { return BatchCode; }
        public UpliftRequestProductData setBatchCode(String value) { this.BatchCode = value; return this; }
        public SealData getSeal() { return Seal; }
        public UpliftRequestProductData setSeal(SealData value) { this.Seal = value; return this; }
        public String getSerialNumber() { return SerialNumber; }
        public UpliftRequestProductData setSerialNumber(String value) { this.SerialNumber = value; return this; }
        public Integer getStockStatusId() { return StockStatusId; }
        public UpliftRequestProductData setStockStatusId(Integer value) { this.StockStatusId = value; return this; }
        public String getPrincipalLogoUrl() { return PrincipalLogoUrl; }
        public UpliftRequestProductData setPrincipalLogoUrl(String value) { this.PrincipalLogoUrl = value; return this; }
        public String getPrincipalName() { return PrincipalName; }
        public UpliftRequestProductData setPrincipalName(String value) { this.PrincipalName = value; return this; }
        public String getStockStatusName() { return StockStatusName; }
        public UpliftRequestProductData setStockStatusName(String value) { this.StockStatusName = value; return this; }
        public String getStockStatusColor() { return StockStatusColor; }
        public UpliftRequestProductData setStockStatusColor(String value) { this.StockStatusColor = value; return this; }
        public Integer getUnitOfMeasureId() { return UnitOfMeasureId; }
        public UpliftRequestProductData setUnitOfMeasureId(Integer value) { this.UnitOfMeasureId = value; return this; }
    }

    public static class SealData extends Seal
    {
        
    }

    public static class Seal
    {
        public String Number = null;
        public Double Weight = null;
        
        public String getNumber() { return Number; }
        public Seal setNumber(String value) { this.Number = value; return this; }
        public Double getWeight() { return Weight; }
        public Seal setWeight(Double value) { this.Weight = value; return this; }
    }

    public static class SaveIncompleteUpliftRequestResponse extends ApiServiceResponse
    {
        public ArrayList<String> ImageIds = null;
        
        public ArrayList<String> getImageIds() { return ImageIds; }
        public SaveIncompleteUpliftRequestResponse setImageIds(ArrayList<String> value) { this.ImageIds = 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; }
    }

}

Java SaveIncompleteUpliftRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /sync/saveincompleteuplift HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ImageIdsOnDevice: 
	[
		String
	],
	UpliftRequestData: 
	{
		UpliftRequestId: 0,
		OutletId: 0,
		Products: 
		[
			{
				UpliftRequestProductId: 0,
				ProductId: 0,
				PrincipalId: 0,
				UnitPrice: 0,
				Name: String,
				Category: String,
				UnitBarcode: String,
				UnitSize: String,
				UnitWeight: 0,
				Code: String,
				Images: 
				[
					{
						
					}
				],
				Quantity: 0,
				Value: 0,
				ProductionDate: String,
				ExpiryDate: String,
				BatchCode: String,
				Seal: 
				{
					Number: String,
					Weight: 0
				},
				SerialNumber: String,
				StockStatusId: 0,
				PrincipalLogoUrl: String,
				PrincipalName: String,
				StockStatusName: String,
				StockStatusColor: String,
				UnitOfMeasureId: 0
			}
		],
		OutletEmailAddress: String,
		OutletContactName: String,
		OutletChannel: String,
		OutletRegion: String,
		AdditionalNotes: String,
		MerchandiserSignatureImage: {},
		StartTime: String,
		StartLatitude: 0,
		StartLongitude: 0,
		EndTime: String,
		EndLatitude: 0,
		EndLongitude: 0,
		LastUpdated: 0001-01-01,
		LastSynced: 0001-01-01,
		IncompleteUpliftRequestId: String,
		Authorised: False,
		PrincipalId: 0,
		Seals: 
		[
			{
				Number: String,
				Weight: 0
			}
		],
		Confirmed: False,
		Cancelled: False,
		Images: 
		[
			{
				
			}
		],
		SubmitImmediately: False
	},
	ApiKey: String,
	Latitude: 0,
	Longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ImageIds: 
	[
		String
	],
	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
		}
	}
}