| POST | /upliftrequest |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class SaveUpliftRequest : ApiServiceRequest()
{
var UpliftRequest:UpliftRequestData? = 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
}
open class UpliftRequestData
{
var UpliftRequestId:Int? = null
var Id:UUID? = null
var OutletId:Int? = null
var Products:ArrayList<UpliftRequestProductData> = ArrayList<UpliftRequestProductData>()
var OutletEmailAddress:String? = null
var OutletContactName:String? = null
var OutletChannel:String? = null
var OutletRegion:String? = null
var AdditionalNotes:String? = null
var MerchandiserSignatureImage:Object? = null
var StartTime:String? = null
var StartLatitude:Double? = null
var StartLongitude:Double? = null
var EndTime:String? = null
var EndLatitude:Double? = null
var EndLongitude:Double? = null
var LastUpdated:Date? = null
var LastSynced:Date? = null
var IncompleteUpliftRequestId:String? = null
var AuthRequestId:UUID? = null
var Authorised:Boolean? = null
var PrincipalId:Int? = null
var Seals:ArrayList<SealData> = ArrayList<SealData>()
var Confirmed:Boolean? = null
var Cancelled:Boolean? = null
var Images:ArrayList<Object> = ArrayList<Object>()
var SubmitImmediately:Boolean? = null
}
open class UpliftRequestProductData
{
var Id:UUID? = null
var UpliftRequestProductId:Int? = null
var ProductId:Int? = null
var PrincipalId:Int? = null
var UnitPrice:BigDecimal? = null
var Name:String? = null
var Category:String? = null
var UnitBarcode:String? = null
var UnitSize:String? = null
var UnitWeight:BigDecimal? = null
var Code:String? = null
var Images:ArrayList<Object> = ArrayList<Object>()
var Quantity:Double? = null
var Value:BigDecimal? = null
var ProductionDate:String? = null
var ExpiryDate:String? = null
var BatchCode:String? = null
var Seal:SealData? = null
var SerialNumber:String? = null
var StockStatusId:Int? = null
var PrincipalLogoUrl:String? = null
var PrincipalName:String? = null
var StockStatusName:String? = null
var StockStatusColor:String? = null
var UnitOfMeasureId:Int? = null
}
open class SealData : Seal()
{
}
open class Seal
{
var Number:String? = null
var Weight:Double? = null
}
open class SaveUpliftRequestResponse : ApiServiceResponse()
{
var UpliftRequestProductIds:ArrayList<Int> = ArrayList<Int>()
var AuthRequestId:UUID? = null
var UpliftRequestId:Int? = null
var DeleteFromDevice:Boolean? = null
var ImageIds:ArrayList<String> = ArrayList<String>()
}
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
}
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /upliftrequest HTTP/1.1
Host: returnit-api-dev.happen.zone
Accept: application/json
Content-Type: application/json
Content-Length: length
{"UpliftRequest":{"UpliftRequestId":0,"OutletId":0,"Products":[{"UpliftRequestProductId":0,"ProductId":0,"PrincipalId":0,"UnitPrice":0,"Name":"String","Category":"String","UnitBarcode":"String","UnitSize":"String","UnitWeight":0,"Code":"String","Images":[{}],"Quantity":0,"Value":0,"ProductionDate":"String","ExpiryDate":"String","BatchCode":"String","Seal":{"Number":"String","Weight":0},"SerialNumber":"String","StockStatusId":0,"PrincipalLogoUrl":"String","PrincipalName":"String","StockStatusName":"String","StockStatusColor":"String","UnitOfMeasureId":0}],"OutletEmailAddress":"String","OutletContactName":"String","OutletChannel":"String","OutletRegion":"String","AdditionalNotes":"String","MerchandiserSignatureImage":{},"StartTime":"String","StartLatitude":0,"StartLongitude":0,"EndTime":"String","EndLatitude":0,"EndLongitude":0,"LastUpdated":"0001-01-01T00:00:00.0000000","LastSynced":"0001-01-01T00:00:00.0000000","IncompleteUpliftRequestId":"String","Authorised":false,"PrincipalId":0,"Seals":[{"Number":"String","Weight":0}],"Confirmed":false,"Cancelled":false,"Images":[{}],"SubmitImmediately":false},"ApiKey":"String","Latitude":0,"Longitude":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"UpliftRequestProductIds":[0],"UpliftRequestId":0,"DeleteFromDevice":false,"ImageIds":["String"],"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"}}}