| POST | /upliftrequest/auth |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class UpliftRequestAuthRequest : ApiServiceRequest()
{
var UpliftRequestOnDeviceId:UUID? = null
var OutletId:Int? = null
var PrincipalId:Int? = null
var TotalValue:BigDecimal? = null
var TotalUnits:Double? = null
var Region:String? = null
var Channel:String? = null
var Products:ArrayList<UpliftRequestProductData> = ArrayList<UpliftRequestProductData>()
}
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 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 UpliftRequestAuthRequestResponse : ApiServiceResponse()
{
var UpliftRequestAuthRequestId:UUID? = null
}
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 UpliftRequestAuthRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /upliftrequest/auth HTTP/1.1
Host: returnit-api-dev.happen.zone
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
OutletId: 0,
PrincipalId: 0,
TotalValue: 0,
TotalUnits: 0,
Region: String,
Channel: String,
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
}
],
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
}
}
}