Antel API

<back to all web services

StartSaveUpliftProductImages

Requires Authentication
The following routes are available for this service:
POST/uplift/product/startimage
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class StartSaveUpliftProductImages : ApiServiceRequest()
{
    @SerializedName("type") var Type:UpliftImageType? = null
    var upliftId:Int? = null
}

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
}

enum class UpliftImageType(val value:Int)
{
    @SerializedName("0") ClaimDoc(0),
    @SerializedName("1") DamagedOk(1),
    @SerializedName("2") DamagedBad(2),
    @SerializedName("3") Expired(3),
    @SerializedName("4") Recall(4),
    @SerializedName("5") Product(5),
    @SerializedName("6") OperatorSignature(6),
    @SerializedName("7") OperatorRegistration(7),
    @SerializedName("8") OutletSignature(8),
    @SerializedName("9") GoodStock(9),
    @SerializedName("10") Deranged(10),
    @SerializedName("11") Overstocked(11),
    @SerializedName("12") FactoryFault(12),
    @SerializedName("13") Status(13),
}

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
}

Kotlin StartSaveUpliftProductImages DTOs

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

HTTP + JSV

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

POST /uplift/product/startimage HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	type: 0,
	upliftId: 0,
	apiKey: String,
	latitude: 0,
	longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	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
		}
	}
}