Antel 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> upliftHistoryItems = null;
        
        public ArrayList<UpliftHistoryItem> getUpliftHistoryItems() { return upliftHistoryItems; }
        public UpliftHistoryResponse setUpliftHistoryItems(ArrayList<UpliftHistoryItem> value) { this.upliftHistoryItems = 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 submissionDocument = 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 getSubmissionDocument() { return submissionDocument; }
        public UpliftHistoryItem setSubmissionDocument(String value) { this.submissionDocument = 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: antel.api.dev.86degrees.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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