Antel Merchandiser App API

<back to all web services

IncompleteUpliftRequestList

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

public class dtos
{

    public static class IncompleteUpliftRequestList extends ApiServiceRequest
    {
        
    }

    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 IncompleteUpliftRequestListResponse extends ApiServiceResponse
    {
        public ArrayList<IncompleteUpliftRequestData> IncompleteUpliftRequests = null;
        public Boolean AllowLogin = null;
        public ArrayList<OutletData> AssignedOutlets = null;
        public Boolean Archived = null;
        
        public ArrayList<IncompleteUpliftRequestData> getIncompleteUpliftRequests() { return IncompleteUpliftRequests; }
        public IncompleteUpliftRequestListResponse setIncompleteUpliftRequests(ArrayList<IncompleteUpliftRequestData> value) { this.IncompleteUpliftRequests = value; return this; }
        public Boolean isAllowLogin() { return AllowLogin; }
        public IncompleteUpliftRequestListResponse setAllowLogin(Boolean value) { this.AllowLogin = value; return this; }
        public ArrayList<OutletData> getAssignedOutlets() { return AssignedOutlets; }
        public IncompleteUpliftRequestListResponse setAssignedOutlets(ArrayList<OutletData> value) { this.AssignedOutlets = value; return this; }
        public Boolean isArchived() { return Archived; }
        public IncompleteUpliftRequestListResponse setArchived(Boolean value) { this.Archived = 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 IncompleteUpliftRequestData
    {
        public Integer SystemUserId = null;
        public UUID IncompleteUpliftRequestId = null;
        public UUID UpliftRequestOnDeviceId = null;
        public Integer OutletId = null;
        public Date LastSynced = null;
        public Boolean IsSubmitted = null;
        public Boolean DeleteFromDevice = null;
        public String CreatedByMerchandiserName = null;
        
        public Integer getSystemUserId() { return SystemUserId; }
        public IncompleteUpliftRequestData setSystemUserId(Integer value) { this.SystemUserId = value; return this; }
        public UUID getIncompleteUpliftRequestId() { return IncompleteUpliftRequestId; }
        public IncompleteUpliftRequestData setIncompleteUpliftRequestId(UUID value) { this.IncompleteUpliftRequestId = value; return this; }
        public UUID getUpliftRequestOnDeviceId() { return UpliftRequestOnDeviceId; }
        public IncompleteUpliftRequestData setUpliftRequestOnDeviceId(UUID value) { this.UpliftRequestOnDeviceId = value; return this; }
        public Integer getOutletId() { return OutletId; }
        public IncompleteUpliftRequestData setOutletId(Integer value) { this.OutletId = value; return this; }
        public Date getLastSynced() { return LastSynced; }
        public IncompleteUpliftRequestData setLastSynced(Date value) { this.LastSynced = value; return this; }
        public Boolean getIsSubmitted() { return IsSubmitted; }
        public IncompleteUpliftRequestData setIsSubmitted(Boolean value) { this.IsSubmitted = value; return this; }
        public Boolean isDeleteFromDevice() { return DeleteFromDevice; }
        public IncompleteUpliftRequestData setDeleteFromDevice(Boolean value) { this.DeleteFromDevice = value; return this; }
        public String getCreatedByMerchandiserName() { return CreatedByMerchandiserName; }
        public IncompleteUpliftRequestData setCreatedByMerchandiserName(String value) { this.CreatedByMerchandiserName = value; return this; }
    }

    public static class OutletData
    {
        public Integer Id = null;
        public String Name = null;
        public String LastRequestedDate = null;
        public Boolean HasGeneralUpliftRequest = null;
        public Integer UpliftRequestCount = null;
        public ArrayList<Integer> AssignedPrincipalIds = null;
        public ArrayList<OutletRegionData> AssignedRegions = null;
        public String Channel = null;
        public String NextScheduledDate = null;
        
        public Integer getId() { return Id; }
        public OutletData setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public OutletData setName(String value) { this.Name = value; return this; }
        public String getLastRequestedDate() { return LastRequestedDate; }
        public OutletData setLastRequestedDate(String value) { this.LastRequestedDate = value; return this; }
        public Boolean isHasGeneralUpliftRequest() { return HasGeneralUpliftRequest; }
        public OutletData setHasGeneralUpliftRequest(Boolean value) { this.HasGeneralUpliftRequest = value; return this; }
        public Integer getUpliftRequestCount() { return UpliftRequestCount; }
        public OutletData setUpliftRequestCount(Integer value) { this.UpliftRequestCount = value; return this; }
        public ArrayList<Integer> getAssignedPrincipalIds() { return AssignedPrincipalIds; }
        public OutletData setAssignedPrincipalIds(ArrayList<Integer> value) { this.AssignedPrincipalIds = value; return this; }
        public ArrayList<OutletRegionData> getAssignedRegions() { return AssignedRegions; }
        public OutletData setAssignedRegions(ArrayList<OutletRegionData> value) { this.AssignedRegions = value; return this; }
        public String getChannel() { return Channel; }
        public OutletData setChannel(String value) { this.Channel = value; return this; }
        public String getNextScheduledDate() { return NextScheduledDate; }
        public OutletData setNextScheduledDate(String value) { this.NextScheduledDate = value; return this; }
    }

    public static class OutletRegionData
    {
        public Integer PrincipalId = null;
        public String Region = null;
        
        public Integer getPrincipalId() { return PrincipalId; }
        public OutletRegionData setPrincipalId(Integer value) { this.PrincipalId = value; return this; }
        public String getRegion() { return Region; }
        public OutletRegionData setRegion(String value) { this.Region = value; return this; }
    }

}

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

GET /sync/incompleteupliftrequests HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IncompleteUpliftRequests: 
	[
		{
			
		}
	],
	AllowLogin: False,
	AssignedOutlets: 
	[
		{
			
		}
	],
	Archived: False,
	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
		}
	}
}