Antel Merchandiser App API

<back to all web services

UpliftRequestAuthStatus

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

public class dtos
{

    public static class UpliftRequestAuthStatus extends ApiServiceRequest
    {
        public ArrayList<UUID> UpliftRequestAuthRequestIds = null;
        
        public ArrayList<UUID> getUpliftRequestAuthRequestIds() { return UpliftRequestAuthRequestIds; }
        public UpliftRequestAuthStatus setUpliftRequestAuthRequestIds(ArrayList<UUID> value) { this.UpliftRequestAuthRequestIds = 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 UpliftRequestAuthStatusResponse extends ApiServiceResponse
    {
        public ArrayList<AuthStatusData> UpliftRequestAuthStatuses = null;
        
        public ArrayList<AuthStatusData> getUpliftRequestAuthStatuses() { return UpliftRequestAuthStatuses; }
        public UpliftRequestAuthStatusResponse setUpliftRequestAuthStatuses(ArrayList<AuthStatusData> value) { this.UpliftRequestAuthStatuses = 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 AuthStatusData
    {
        public AuthStatusDataAuthStatus Status = null;
        public UUID UpliftRequestAuthRequestId = null;
        public Boolean Found = null;
        
        public AuthStatusDataAuthStatus getStatus() { return Status; }
        public AuthStatusData setStatus(AuthStatusDataAuthStatus value) { this.Status = value; return this; }
        public UUID getUpliftRequestAuthRequestId() { return UpliftRequestAuthRequestId; }
        public AuthStatusData setUpliftRequestAuthRequestId(UUID value) { this.UpliftRequestAuthRequestId = value; return this; }
        public Boolean isFound() { return Found; }
        public AuthStatusData setFound(Boolean value) { this.Found = value; return this; }
    }

    @Flags()
    public static enum AuthStatusDataAuthStatus
    {
        @SerializedName("0") Pending(0),
        @SerializedName("1") Cancelled(1),
        @SerializedName("2") Authorised(2);

        private final int value;
        AuthStatusDataAuthStatus(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

}

Java UpliftRequestAuthStatus 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 /upliftrequest/auth HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"UpliftRequestAuthStatuses":[{"Status":0,"Found":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"}}}