Antel Merchandiser App API

<back to all web services

UpliftRequestCompleted

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class UpliftRequestCompleted extends ApiServiceRequest
    {
        public Integer ReturnItUpliftRequestId = null;
        public Date CompletedDate = null;
        public String SubmissionDocumentUrl = null;
        public String UpliftNumber = null;
        public Double TotalUnits = null;
        public Double TotalWeight = null;
        
        public Integer getReturnItUpliftRequestId() { return ReturnItUpliftRequestId; }
        public UpliftRequestCompleted setReturnItUpliftRequestId(Integer value) { this.ReturnItUpliftRequestId = value; return this; }
        public Date getCompletedDate() { return CompletedDate; }
        public UpliftRequestCompleted setCompletedDate(Date value) { this.CompletedDate = value; return this; }
        public String getSubmissionDocumentUrl() { return SubmissionDocumentUrl; }
        public UpliftRequestCompleted setSubmissionDocumentUrl(String value) { this.SubmissionDocumentUrl = value; return this; }
        public String getUpliftNumber() { return UpliftNumber; }
        public UpliftRequestCompleted setUpliftNumber(String value) { this.UpliftNumber = value; return this; }
        public Double getTotalUnits() { return TotalUnits; }
        public UpliftRequestCompleted setTotalUnits(Double value) { this.TotalUnits = value; return this; }
        public Double getTotalWeight() { return TotalWeight; }
        public UpliftRequestCompleted setTotalWeight(Double value) { this.TotalWeight = 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 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 UpliftRequestCompleted DTOs

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

{
	ReturnItUpliftRequestId: 0,
	CompletedDate: 0001-01-01,
	SubmissionDocumentUrl: String,
	UpliftNumber: String,
	TotalUnits: 0,
	TotalWeight: 0,
	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
		}
	}
}