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.*


open class UpliftRequestAuthStatus : ApiServiceRequest()
{
    var UpliftRequestAuthRequestIds:ArrayList<UUID> = ArrayList<UUID>()
}

open class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /**
    * The API Key required for authentication
    */
    @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    var ApiKey:String? = null

    /**
    * Latitude of the user making this request
    */
    @ApiMember(DataType="double", Description="Latitude of the user making this request")
    var Latitude:Double? = null

    /**
    * Longitude of the user making this request
    */
    @ApiMember(DataType="double", Description="Longitude of the user making this request")
    var Longitude:Double? = null
}

open class UpliftRequestAuthStatusResponse : ApiServiceResponse()
{
    var UpliftRequestAuthStatuses:ArrayList<AuthStatusData> = ArrayList<AuthStatusData>()
}

open class ApiServiceResponse : IServiceResponse
{
    /**
    * Information about the response.
    */
    @ApiMember(Description="Information about the response.", IsRequired=true)
    var Description:String? = null

    /**
    * Heading or summary of the response.
    */
    @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    var Heading:String? = 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)
    var WasSuccessful:Boolean? = null

    var ResponseStatus:ResponseStatus? = null
}

open class AuthStatusData
{
    var Status:AuthStatusDataAuthStatus? = null
    var UpliftRequestAuthRequestId:UUID? = null
    var Found:Boolean? = null
}

@Flags()
enum class AuthStatusDataAuthStatus(val value:Int)
{
    @SerializedName("0") Pending(0),
    @SerializedName("1") Cancelled(1),
    @SerializedName("2") Authorised(2),
}

Kotlin UpliftRequestAuthStatus DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}