Antel API

GetUpliftSchedule

The following routes are available for this service:
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
}

Kotlin GetUpliftSchedule DTOs

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

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetUpliftScheduleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Heading>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">false</WasSuccessful>
  <Appointments>
    <AppointmentData>
      <AppointmentDate>String</AppointmentDate>
      <GoodToCollectStatus>false</GoodToCollectStatus>
      <InProgress>false</InProgress>
      <IsComplete>false</IsComplete>
      <IsLate>false</IsLate>
      <OutletChannel>String</OutletChannel>
      <OutletName>String</OutletName>
      <PrincipleAppointments>
        <AppointmentPrincipleData>
          <ActionOutsideMaxDistance>Warn</ActionOutsideMaxDistance>
          <AllowedProductStockStatuses>
            <StockStatusData>
              <Color>String</Color>
              <Id>0</Id>
              <Name>String</Name>
              <PhotoRequired>false</PhotoRequired>
            </StockStatusData>
          </AllowedProductStockStatuses>
          <Cancelled>false</Cancelled>
          <Completed>false</Completed>
          <CompletedDate>String</CompletedDate>
          <GoodsToCollect>false</GoodsToCollect>
          <MaxSubmissionDistance>0</MaxSubmissionDistance>
          <NoteToOperator>String</NoteToOperator>
          <OperatorName>String</OperatorName>
          <OutletChannel>String</OutletChannel>
          <OutletLatitude>0</OutletLatitude>
          <OutletLongitude>0</OutletLongitude>
          <OutletName>String</OutletName>
          <OutletRegion>String</OutletRegion>
          <PreAuthed>false</PreAuthed>
          <PrePopulated>false</PrePopulated>
          <PrePopulatedWithSeals>false</PrePopulatedWithSeals>
          <Principle>
            <AllowBillableSeals>false</AllowBillableSeals>
            <AllowProductLookup>false</AllowProductLookup>
            <AuthLetterFileUrl xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </AuthLetterFileUrl>
            <BatchCodesMandatory>false</BatchCodesMandatory>
            <CaptureManufactureAndExpiryDate>false</CaptureManufactureAndExpiryDate>
            <CaptureSerialNumber>false</CaptureSerialNumber>
            <ContactEmail>String</ContactEmail>
            <ContactName>String</ContactName>
            <ContactNumber>String</ContactNumber>
            <HasAuthLetter>false</HasAuthLetter>
            <HasLogo>false</HasLogo>
            <LogoImageUrl>String</LogoImageUrl>
            <Name>String</Name>
            <PrincipalId>0</PrincipalId>
            <ProductExceptions>
              <ProductExceptionData>
                <Channel>String</Channel>
                <ProductId>0</ProductId>
                <Region>String</Region>
                <StockStatusIds xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:int>0</d9p1:int>
                </StockStatusIds>
              </ProductExceptionData>
            </ProductExceptions>
            <Products>
              <ProductDataCategory>
                <Products>
                  <ProductData>
                    <CartonMeasurement>String</CartonMeasurement>
                    <CartonPrice>0</CartonPrice>
                    <CartonQuantity>0</CartonQuantity>
                    <CartonWeight>0</CartonWeight>
                    <Category>String</Category>
                    <MaxPrice>0</MaxPrice>
                    <MaxQuantity>0</MaxQuantity>
                    <Name>String</Name>
                    <PrincipalId>0</PrincipalId>
                    <ProductCode>String</ProductCode>
                    <ProductId>0</ProductId>
                    <ShrinkMeasurement>String</ShrinkMeasurement>
                    <ShrinkPrice>0</ShrinkPrice>
                    <ShrinkQuantity>0</ShrinkQuantity>
                    <ShrinkWeight>0</ShrinkWeight>
                    <UnitBarcode>String</UnitBarcode>
                    <UnitMeasurement>String</UnitMeasurement>
                    <UnitPrice>0</UnitPrice>
                    <UnitQuantity>0</UnitQuantity>
                    <UnitWeight>0</UnitWeight>
                  </ProductData>
                </Products>
                <UnitBarcode>String</UnitBarcode>
              </ProductDataCategory>
            </Products>
            <SealNetWeightMandatory>false</SealNetWeightMandatory>
            <UpliftPrefix>String</UpliftPrefix>
            <UsesOwnSealNumbers>false</UsesOwnSealNumbers>
          </Principle>
          <PrincipleOutletId>0</PrincipleOutletId>
          <ProductExceptions>
            <ProductExceptionData>
              <Channel>String</Channel>
              <ProductId>0</ProductId>
              <Region>String</Region>
              <StockStatusIds xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>0</d8p1:int>
              </StockStatusIds>
            </ProductExceptionData>
          </ProductExceptions>
          <ScheduledDate>String</ScheduledDate>
          <SealTemplate>
            <Items>
              <SealTemplateData.SealTemplateItemData>
                <ProductStockStatus>0</ProductStockStatus>
                <Products xmlns:d9p1="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">
                  <d9p1:SealTemplateProduct>
                    <d9p1:Name>String</d9p1:Name>
                    <d9p1:ProductId>0</d9p1:ProductId>
                    <d9p1:ProductStockStatusId>0</d9p1:ProductStockStatusId>
                    <d9p1:Quantity>0</d9p1:Quantity>
                    <d9p1:SerialNumber>String</d9p1:SerialNumber>
                  </d9p1:SealTemplateProduct>
                </Products>
                <SealNumber>String</SealNumber>
              </SealTemplateData.SealTemplateItemData>
            </Items>
          </SealTemplate>
          <StoreConfirmationDocumentUrl>String</StoreConfirmationDocumentUrl>
          <SystemUserId>0</SystemUserId>
          <UpliftScheduleId>0</UpliftScheduleId>
          <UpliftSchedulePrincipleId>0</UpliftSchedulePrincipleId>
          <UpliftTemplate>
            <Products>
              <UpliftTemplateData.TemplateProductData>
                <Barcode>String</Barcode>
                <Name>String</Name>
                <ProductCode>String</ProductCode>
                <ReturnValue>0</ReturnValue>
                <StatusQty xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:KeyValueOfintint>
                    <d9p1:Key>0</d9p1:Key>
                    <d9p1:Value>0</d9p1:Value>
                  </d9p1:KeyValueOfintint>
                </StatusQty>
              </UpliftTemplateData.TemplateProductData>
            </Products>
            <Seals xmlns:d7p1="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">
              <d7p1:UpliftRequestSealData>
                <d7p1:Number>String</d7p1:Number>
                <d7p1:Weight>0</d7p1:Weight>
              </d7p1:UpliftRequestSealData>
            </Seals>
            <TotalValue>0</TotalValue>
          </UpliftTemplate>
          <VerificationCode>String</VerificationCode>
        </AppointmentPrincipleData>
      </PrincipleAppointments>
      <ScheduleId>0</ScheduleId>
      <UpliftStatus>Unconfirmed</UpliftStatus>
    </AppointmentData>
  </Appointments>
</GetUpliftScheduleResponse>