| POST | /sync/saveincompleteuplift |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class SaveIncompleteUplift : ApiServiceRequest()
{
var incompleteUpliftId:UUID? = null
var imageIdsOnDevice:ArrayList<String> = ArrayList<String>()
var upliftData:UpliftData? = 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 UpliftData
{
var upliftId:Int? = null
var principleOutletId:Int? = null
var upliftScheduleId:Int? = null
var upliftSchedulePrincipleId:Int? = null
var authRequestId:UUID? = null
var delayedAuth:Boolean? = null
var appointmentPrincipleData:AppointmentPrincipleData? = null
var authCode:String? = null
var startTime:String? = null
var endTime:String? = null
var sequentialNumber:String? = null
var startLatitude:Double? = null
var startLongitude:Double? = null
var endLatitude:Double? = null
var endLongitude:Double? = null
var totalValue:BigDecimal? = null
var totalUnits:Double? = null
var comments:String? = null
var adhocEmailAddress:String? = null
var vatValue:BigDecimal? = null
var statusImages:HashMap<Int,ArrayList<Object>> = HashMap<Int,ArrayList<Object>>()
var damagedOkImages:ArrayList<Object> = ArrayList<Object>()
var damagedBadImages:ArrayList<Object> = ArrayList<Object>()
var expiredImages:ArrayList<Object> = ArrayList<Object>()
var recallImages:ArrayList<Object> = ArrayList<Object>()
var goodStockImages:ArrayList<Object> = ArrayList<Object>()
var derangedImages:ArrayList<Object> = ArrayList<Object>()
var overstockedImages:ArrayList<Object> = ArrayList<Object>()
var factoryFaultImages:ArrayList<Object> = ArrayList<Object>()
var outletContactName:String? = null
var outletContactNumber:String? = null
var outletLatitude:Double? = null
var outletLongitude:Double? = null
var maxSubmissionDistance:Double? = null
var actionOutsideMaxDistance:ActionOutsideMaxDistanceType? = null
var outletSignatureImage:Object? = null
var operatorSignatureImage:Object? = null
var operatorRegNumberImage:Object? = null
var seals:ArrayList<UpliftSealData> = ArrayList<UpliftSealData>()
var invalidAntelSeal:Boolean? = null
var unbaggedItems:UpliftSealData? = null
var authorised:Boolean? = null
var claims:ArrayList<UpliftClaimData> = ArrayList<UpliftClaimData>()
var lastUpdated:Date? = null
var lastSynced:Date? = null
var checkedOutDeviceId:UUID? = null
var checkedOutOperatorName:String? = null
var incompleteUpliftId:UUID? = null
var pauseReason:String? = null
var storeConfirmationDocumentUrl:String? = null
}
open class AppointmentPrincipleData
{
var principle:PrincipalData? = null
var scheduledDate:String? = null
var upliftScheduleId:Int? = null
var upliftSchedulePrincipleId:Int? = null
var principleOutletId:Int? = null
var verificationCode:String? = null
var goodsToCollect:Boolean? = null
var outletRegion:String? = null
var outletName:String? = null
var outletChannel:String? = null
var outletLatitude:Double? = null
var outletLongitude:Double? = null
var maxSubmissionDistance:Double? = null
var actionOutsideMaxDistance:ActionOutsideMaxDistanceType? = null
var completedDate:String? = null
var cancelled:Boolean? = null
var completed:Boolean? = null
var upliftTemplate:UpliftTemplateData? = null
var prePopulated:Boolean? = null
var allowedProductStockStatuses:ArrayList<StockStatusData> = ArrayList<StockStatusData>()
var noteToOperator:String? = null
var sealTemplate:SealTemplateData? = null
var prePopulatedWithSeals:Boolean? = null
var preAuthed:Boolean? = null
var operatorName:String? = null
var systemUserId:Int? = null
var productExceptions:ArrayList<ProductExceptionData> = ArrayList<ProductExceptionData>()
var storeConfirmationDocumentUrl:String? = null
}
open class PrincipalData
{
var principalId:Int? = null
var name:String? = null
var authLetterFileUrl:ArrayList<String> = ArrayList<String>()
var logoImageUrl:String? = null
var products:ArrayList<ProductDataCategory> = ArrayList<ProductDataCategory>()
var upliftPrefix:String? = null
var contactName:String? = null
var contactNumber:String? = null
var contactEmail:String? = null
var allowProductLookup:Boolean? = null
var hasLogo:Boolean? = null
var hasAuthLetter:Boolean? = null
var sealNetWeightMandatory:Boolean? = null
var allowBillableSeals:Boolean? = null
var captureSerialNumber:Boolean? = null
var batchCodesMandatory:Boolean? = null
var captureManufactureAndExpiryDate:Boolean? = null
var productExceptions:ArrayList<ProductExceptionData> = ArrayList<ProductExceptionData>()
var usesOwnSealNumbers:Boolean? = null
}
open class ProductDataCategory
{
var unitBarcode:String? = null
var products:ArrayList<ProductData> = ArrayList<ProductData>()
}
open class ProductData
{
var productId:Int? = null
var principalId:Int? = null
var name:String? = null
var category:String? = null
var productCode:String? = null
var unitBarcode:String? = null
var cartonQuantity:Int? = null
var shrinkQuantity:Int? = null
var unitQuantity:Int? = null
var cartonMeasurement:String? = null
var shrinkMeasurement:String? = null
var unitMeasurement:String? = null
var cartonWeight:Double? = null
var shrinkWeight:Double? = null
var unitWeight:BigDecimal? = null
var cartonPrice:BigDecimal? = null
var shrinkPrice:BigDecimal? = null
var unitPrice:BigDecimal? = null
var maxQuantity:Int? = null
var maxPrice:Int? = null
}
open class ProductExceptionData
{
var region:String? = null
var channel:String? = null
var productId:Int? = null
var stockStatusIds:ArrayList<Int> = ArrayList<Int>()
}
enum class ActionOutsideMaxDistanceType(val value:Int)
{
@SerializedName("0") Warn(0),
@SerializedName("1") Block(1),
}
open class UpliftTemplateData
{
var totalValue:BigDecimal? = null
var products:ArrayList<TemplateProductData> = ArrayList<TemplateProductData>()
var seals:ArrayList<UpliftRequestSealData> = ArrayList<UpliftRequestSealData>()
}
open class TemplateProductData
{
var name:String? = null
var productCode:String? = null
var barcode:String? = null
var statusQty:HashMap<Int,Int> = HashMap<Int,Int>()
var returnValue:BigDecimal? = null
}
open class UpliftRequestSealData
{
var number:String? = null
var weight:Double? = null
}
open class StockStatusData
{
var id:Int? = null
var name:String? = null
var photoRequired:Boolean? = null
var color:String? = null
}
open class SealTemplateData
{
var items:ArrayList<SealTemplateItemData> = ArrayList<SealTemplateItemData>()
}
open class SealTemplateItemData
{
var sealNumber:String? = null
var productStockStatus:Int? = null
var products:ArrayList<SealTemplateProduct> = ArrayList<SealTemplateProduct>()
}
open class SealTemplateProduct
{
var productId:Int? = null
var name:String? = null
var productStockStatusId:Int? = null
var quantity:Int? = null
var serialNumber:String? = null
}
open class UpliftSealData
{
var unbagged:Boolean? = null
var sealNumber:String? = null
var antelSealNumber:String? = null
var products:ArrayList<UpliftProductData> = ArrayList<UpliftProductData>()
var totalPrice:Double? = null
var totalQuantity:Double? = null
var netWeight:Double? = null
var grossWeight:Double? = null
var billableSeal:Boolean? = null
var invalidAntelSealNumber:Boolean? = null
}
open class UpliftProductData
{
var upliftProductId:Int? = null
var upliftId:Int? = null
var productId: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 upliftImages:ArrayList<Object> = ArrayList<Object>()
var quantity:Double? = null
var value:BigDecimal? = null
var priceOverMax:Boolean? = null
var quantityOverMax:Boolean? = null
var quantityOverRequirement:Boolean? = null
var serialNumber:String? = null
var batchCode:String? = null
var stockStatusId:Int? = null
var lotNumber:String? = null
var expiryDate:String? = null
var manufactureDate:String? = null
}
open class UpliftClaimData
{
var upliftClaimId:Int? = null
var claimUnits:Int? = null
var claimNumber:String? = null
var claimValue:BigDecimal? = null
var claimDocumentImages:ArrayList<Object> = ArrayList<Object>()
var returnOrderNumber:String? = null
var lineCount:Int? = null
}
open class SaveIncompleteUpliftResponse : ApiServiceResponse()
{
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
}
Kotlin SaveIncompleteUplift 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 /sync/saveincompleteuplift HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
imageIdsOnDevice:
[
String
],
upliftData:
{
upliftId: 0,
principleOutletId: 0,
upliftScheduleId: 0,
upliftSchedulePrincipleId: 0,
delayedAuth: False,
appointmentPrincipleData:
{
principle:
{
principalId: 0,
name: String,
authLetterFileUrl:
[
String
],
logoImageUrl: String,
products:
[
{
unitBarcode: String,
products:
[
{
productId: 0,
principalId: 0,
name: String,
category: String,
productCode: String,
unitBarcode: String,
cartonQuantity: 0,
shrinkQuantity: 0,
unitQuantity: 0,
cartonMeasurement: String,
shrinkMeasurement: String,
unitMeasurement: String,
cartonWeight: 0,
shrinkWeight: 0,
unitWeight: 0,
cartonPrice: 0,
shrinkPrice: 0,
unitPrice: 0,
maxQuantity: 0,
maxPrice: 0
}
]
}
],
upliftPrefix: String,
contactName: String,
contactNumber: String,
contactEmail: String,
allowProductLookup: False,
hasLogo: False,
hasAuthLetter: False,
sealNetWeightMandatory: False,
allowBillableSeals: False,
captureSerialNumber: False,
batchCodesMandatory: False,
captureManufactureAndExpiryDate: False,
productExceptions:
[
{
region: String,
channel: String,
productId: 0,
stockStatusIds:
[
0
]
}
],
usesOwnSealNumbers: False
},
scheduledDate: String,
upliftScheduleId: 0,
upliftSchedulePrincipleId: 0,
principleOutletId: 0,
verificationCode: String,
goodsToCollect: False,
outletRegion: String,
outletName: String,
outletChannel: String,
outletLatitude: 0,
outletLongitude: 0,
maxSubmissionDistance: 0,
actionOutsideMaxDistance: 0,
completedDate: String,
cancelled: False,
completed: False,
upliftTemplate:
{
totalValue: 0,
products:
[
{
name: String,
productCode: String,
barcode: String,
statusQty:
{
0: 0
},
returnValue: 0
}
],
seals:
[
{
number: String,
weight: 0
}
]
},
prePopulated: False,
allowedProductStockStatuses:
[
{
id: 0,
name: String,
photoRequired: False,
color: String
}
],
noteToOperator: String,
sealTemplate:
{
items:
[
{
sealNumber: String,
productStockStatus: 0,
products:
[
{
productId: 0,
name: String,
productStockStatusId: 0,
quantity: 0,
serialNumber: String
}
]
}
]
},
prePopulatedWithSeals: False,
preAuthed: False,
operatorName: String,
systemUserId: 0,
productExceptions:
[
{
region: String,
channel: String,
productId: 0,
stockStatusIds:
[
0
]
}
],
storeConfirmationDocumentUrl: String
},
authCode: String,
startTime: String,
endTime: String,
sequentialNumber: String,
startLatitude: 0,
startLongitude: 0,
endLatitude: 0,
endLongitude: 0,
totalValue: 0,
totalUnits: 0,
comments: String,
adhocEmailAddress: String,
vatValue: 0,
statusImages:
{
0:
[
{
}
]
},
damagedOkImages:
[
{
}
],
damagedBadImages:
[
{
}
],
expiredImages:
[
{
}
],
recallImages:
[
{
}
],
goodStockImages:
[
{
}
],
derangedImages:
[
{
}
],
overstockedImages:
[
{
}
],
factoryFaultImages:
[
{
}
],
outletContactName: String,
outletContactNumber: String,
outletLatitude: 0,
outletLongitude: 0,
maxSubmissionDistance: 0,
actionOutsideMaxDistance: 0,
outletSignatureImage: {},
operatorSignatureImage: {},
operatorRegNumberImage: {},
seals:
[
{
unbagged: False,
sealNumber: String,
antelSealNumber: String,
products:
[
{
upliftProductId: 0,
upliftId: 0,
productId: 0,
unitPrice: 0,
name: String,
category: String,
unitBarcode: String,
unitSize: String,
unitWeight: 0,
code: String,
upliftImages:
[
{
}
],
quantity: 0,
value: 0,
priceOverMax: False,
quantityOverMax: False,
quantityOverRequirement: False,
serialNumber: String,
batchCode: String,
stockStatusId: 0,
lotNumber: String,
expiryDate: String,
manufactureDate: String
}
],
totalPrice: 0,
totalQuantity: 0,
netWeight: 0,
grossWeight: 0,
billableSeal: False,
invalidAntelSealNumber: False
}
],
invalidAntelSeal: False,
unbaggedItems:
{
unbagged: False,
sealNumber: String,
antelSealNumber: String,
products:
[
{
upliftProductId: 0,
upliftId: 0,
productId: 0,
unitPrice: 0,
name: String,
category: String,
unitBarcode: String,
unitSize: String,
unitWeight: 0,
code: String,
upliftImages:
[
{
}
],
quantity: 0,
value: 0,
priceOverMax: False,
quantityOverMax: False,
quantityOverRequirement: False,
serialNumber: String,
batchCode: String,
stockStatusId: 0,
lotNumber: String,
expiryDate: String,
manufactureDate: String
}
],
totalPrice: 0,
totalQuantity: 0,
netWeight: 0,
grossWeight: 0,
billableSeal: False,
invalidAntelSealNumber: False
},
authorised: False,
claims:
[
{
upliftClaimId: 0,
claimUnits: 0,
claimNumber: String,
claimValue: 0,
claimDocumentImages:
[
{
}
],
returnOrderNumber: String,
lineCount: 0
}
],
lastUpdated: 0001-01-01,
lastSynced: 0001-01-01,
checkedOutOperatorName: String,
pauseReason: String,
storeConfirmationDocumentUrl: String
},
apiKey: String,
latitude: 0,
longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
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
}
}
}