Antel Merchandiser App API

<back to all web services

UpliftHistory

Requires Authentication
The following routes are available for this service:
GET/uplift/history
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class UpliftHistory 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 UpliftHistoryResponse extends ApiServiceResponse
    {
        public ArrayList<UpliftHistoryItem> Items = null;
        
        public ArrayList<UpliftHistoryItem> getItems() { return Items; }
        public UpliftHistoryResponse setItems(ArrayList<UpliftHistoryItem> value) { this.Items = 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 UpliftHistoryItem
    {
        public String PrincipleLogo = null;
        public String PrincipleName = null;
        public String OutletName = null;
        public String AppointmentDate = null;
        public String AppointmentDateFormatted = null;
        public String SubmittedDate = null;
        public String SubmittedDateFormatted = null;
        public String UpliftNumber = null;
        public String AntelScheduledDate = null;
        public String AntelCompletedDate = null;
        public String AntelSubmissionDocumentUrl = null;
        public String AntelUpliftNumber = null;
        
        public String getPrincipleLogo() { return PrincipleLogo; }
        public UpliftHistoryItem setPrincipleLogo(String value) { this.PrincipleLogo = value; return this; }
        public String getPrincipleName() { return PrincipleName; }
        public UpliftHistoryItem setPrincipleName(String value) { this.PrincipleName = value; return this; }
        public String getOutletName() { return OutletName; }
        public UpliftHistoryItem setOutletName(String value) { this.OutletName = value; return this; }
        public String getAppointmentDate() { return AppointmentDate; }
        public UpliftHistoryItem setAppointmentDate(String value) { this.AppointmentDate = value; return this; }
        public String getAppointmentDateFormatted() { return AppointmentDateFormatted; }
        public UpliftHistoryItem setAppointmentDateFormatted(String value) { this.AppointmentDateFormatted = value; return this; }
        public String getSubmittedDate() { return SubmittedDate; }
        public UpliftHistoryItem setSubmittedDate(String value) { this.SubmittedDate = value; return this; }
        public String getSubmittedDateFormatted() { return SubmittedDateFormatted; }
        public UpliftHistoryItem setSubmittedDateFormatted(String value) { this.SubmittedDateFormatted = value; return this; }
        public String getUpliftNumber() { return UpliftNumber; }
        public UpliftHistoryItem setUpliftNumber(String value) { this.UpliftNumber = value; return this; }
        public String getAntelScheduledDate() { return AntelScheduledDate; }
        public UpliftHistoryItem setAntelScheduledDate(String value) { this.AntelScheduledDate = value; return this; }
        public String getAntelCompletedDate() { return AntelCompletedDate; }
        public UpliftHistoryItem setAntelCompletedDate(String value) { this.AntelCompletedDate = value; return this; }
        public String getAntelSubmissionDocumentUrl() { return AntelSubmissionDocumentUrl; }
        public UpliftHistoryItem setAntelSubmissionDocumentUrl(String value) { this.AntelSubmissionDocumentUrl = value; return this; }
        public String getAntelUpliftNumber() { return AntelUpliftNumber; }
        public UpliftHistoryItem setAntelUpliftNumber(String value) { this.AntelUpliftNumber = value; return this; }
    }

}

Java UpliftHistory DTOs

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

HTTP + CSV

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

GET /uplift/history HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Items":[{}],"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"}}}