Antel API

<back to all web services

UpliftAuthStatus

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

public class dtos
{

    public static class UpliftAuthStatus extends ApiServiceRequest
    {
        public ArrayList<UUID> upliftAuthRequestIds = null;
        
        public ArrayList<UUID> getUpliftAuthRequestIds() { return upliftAuthRequestIds; }
        public UpliftAuthStatus setUpliftAuthRequestIds(ArrayList<UUID> value) { this.upliftAuthRequestIds = 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 UpliftAuthStatusResponse extends ApiServiceResponse
    {
        public ArrayList<AuthStatusData> upliftAuthStatuses = null;
        
        public ArrayList<AuthStatusData> getUpliftAuthStatuses() { return upliftAuthStatuses; }
        public UpliftAuthStatusResponse setUpliftAuthStatuses(ArrayList<AuthStatusData> value) { this.upliftAuthStatuses = 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 upliftAuthRequestId = null;
        public Boolean found = null;
        
        public AuthStatusDataAuthStatus getStatus() { return status; }
        public AuthStatusData setStatus(AuthStatusDataAuthStatus value) { this.status = value; return this; }
        public UUID getUpliftAuthRequestId() { return upliftAuthRequestId; }
        public AuthStatusData setUpliftAuthRequestId(UUID value) { this.upliftAuthRequestId = value; return this; }
        public Boolean isFound() { return found; }
        public AuthStatusData setFound(Boolean value) { this.found = value; return this; }
    }

    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 UpliftAuthStatus DTOs

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

HTTP + XML

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

GET /uplift/auth HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpliftAuthStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Heading>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">false</WasSuccessful>
  <UpliftAuthStatuses>
    <AuthStatusData>
      <Found>false</Found>
      <Status>Pending</Status>
      <UpliftAuthRequestId>00000000-0000-0000-0000-000000000000</UpliftAuthRequestId>
    </AuthStatusData>
  </UpliftAuthStatuses>
</UpliftAuthStatusResponse>