| GET | /upliftscedule |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class GetUpliftSchedule : ApiServiceRequest()
{
}
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 GetUpliftScheduleResponse : ApiServiceResponse()
{
var appointments:ArrayList<AppointmentData> = ArrayList<AppointmentData>()
}
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 AppointmentData
{
var scheduleId:Int? = null
var appointmentDate:String? = null
var outletName:String? = null
var outletChannel:String? = null
var upliftStatus:UpliftScheduleStatus? = null
var isComplete:Boolean? = null
var inProgress:Boolean? = null
var isLate:Boolean? = null
var goodToCollectStatus:Boolean? = null
var principlesWithGoodsToCollect:String? = null
var principleAppointments:ArrayList<AppointmentPrincipleData> = ArrayList<AppointmentPrincipleData>()
}
enum class UpliftScheduleStatus(val value:Int)
{
@SerializedName("0") Unconfirmed(0),
@SerializedName("1") Confirmed(1),
@SerializedName("4") PortalCancelled(4),
@SerializedName("5") UserCancelled(5),
@SerializedName("6") NoOperatorAssigned(6),
}
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
}
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.
GET /upliftscedule HTTP/1.1 Host: antel.api.dev.86degrees.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"appointments":[{"scheduleId":0,"appointmentDate":"String","outletName":"String","outletChannel":"String","upliftStatus":0,"isComplete":false,"inProgress":false,"isLate":false,"goodToCollectStatus":false,"principlesWithGoodsToCollect":"","principleAppointments":[{"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"}]}],"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"}}}