| GET | /upliftscedule |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.ServiceModel
Imports WebService.ServiceModel.Base
Imports BusinessLogic.Entities
Namespace Global
Namespace BusinessLogic.Entities
Public Enum ActionOutsideMaxDistanceType
Warn = 0
Block = 1
End Enum
Public Partial Class SealTemplateProduct
Public Overridable Property ProductId As Integer
Public Overridable Property Name As String
Public Overridable Property ProductStockStatusId As Integer
Public Overridable Property Quantity As Integer
Public Overridable Property SerialNumber As String
End Class
Public Partial Class UpliftRequestSealData
Public Overridable Property Number As String
Public Overridable Property Weight As Double
End Class
Public Enum UpliftScheduleStatus
Unconfirmed = 0
Confirmed = 1
PortalCancelled = 4
UserCancelled = 5
NoOperatorAssigned = 6
End Enum
End Namespace
Namespace WebService.ServiceModel
Public Partial Class AppointmentData
Public Sub New()
PrincipleAppointments = New List(Of AppointmentPrincipleData)
End Sub
Public Overridable Property ScheduleId As Integer
Public Overridable Property AppointmentDate As String
Public Overridable Property OutletName As String
Public Overridable Property OutletChannel As String
Public Overridable Property UpliftStatus As UpliftScheduleStatus
Public Overridable Property IsComplete As Boolean
Public Overridable Property InProgress As Boolean
Public Overridable Property IsLate As Boolean
Public Overridable Property GoodToCollectStatus As Boolean
Public Overridable Property PrinciplesWithGoodsToCollect As String
Public Overridable Property PrincipleAppointments As List(Of AppointmentPrincipleData)
End Class
Public Partial Class AppointmentPrincipleData
Public Sub New()
AllowedProductStockStatuses = New List(Of StockStatusData)
ProductExceptions = New List(Of ProductExceptionData)
End Sub
Public Overridable Property Principle As PrincipalData
Public Overridable Property ScheduledDate As String
Public Overridable Property UpliftScheduleId As Integer
Public Overridable Property UpliftSchedulePrincipleId As Integer
Public Overridable Property PrincipleOutletId As Integer
Public Overridable Property VerificationCode As String
Public Overridable Property GoodsToCollect As Boolean
Public Overridable Property OutletRegion As String
Public Overridable Property OutletName As String
Public Overridable Property OutletChannel As String
Public Overridable Property OutletLatitude As Double
Public Overridable Property OutletLongitude As Double
Public Overridable Property MaxSubmissionDistance As Double
Public Overridable Property ActionOutsideMaxDistance As ActionOutsideMaxDistanceType
Public Overridable Property CompletedDate As String
Public Overridable Property Cancelled As Boolean
Public Overridable Property Completed As Boolean
Public Overridable Property UpliftTemplate As UpliftTemplateData
Public Overridable Property PrePopulated As Boolean
Public Overridable Property AllowedProductStockStatuses As List(Of StockStatusData)
Public Overridable Property NoteToOperator As String
Public Overridable Property SealTemplate As SealTemplateData
Public Overridable Property PrePopulatedWithSeals As Boolean
Public Overridable Property PreAuthed As Boolean
Public Overridable Property OperatorName As String
Public Overridable Property SystemUserId As Integer
Public Overridable Property ProductExceptions As List(Of ProductExceptionData)
Public Overridable Property StoreConfirmationDocumentUrl As String
End Class
Public Partial Class GetUpliftSchedule
Inherits ApiServiceRequest
End Class
Public Partial Class GetUpliftScheduleResponse
Inherits ApiServiceResponse
Public Sub New()
Appointments = New List(Of AppointmentData)
End Sub
Public Overridable Property Appointments As List(Of AppointmentData)
End Class
Public Partial Class PrincipalData
Public Sub New()
AuthLetterFileUrl = New List(Of String)
Products = New List(Of ProductDataCategory)
ProductExceptions = New List(Of ProductExceptionData)
End Sub
Public Overridable Property PrincipalId As Integer
Public Overridable Property Name As String
Public Overridable Property AuthLetterFileUrl As List(Of String)
Public Overridable Property LogoImageUrl As String
Public Overridable Property Products As List(Of ProductDataCategory)
Public Overridable Property UpliftPrefix As String
Public Overridable Property ContactName As String
Public Overridable Property ContactNumber As String
Public Overridable Property ContactEmail As String
Public Overridable Property AllowProductLookup As Boolean
Public Overridable Property HasLogo As Boolean
Public Overridable Property HasAuthLetter As Boolean
Public Overridable Property SealNetWeightMandatory As Boolean
Public Overridable Property AllowBillableSeals As Boolean
Public Overridable Property CaptureSerialNumber As Boolean
Public Overridable Property BatchCodesMandatory As Boolean
Public Overridable Property CaptureManufactureAndExpiryDate As Boolean
Public Overridable Property ProductExceptions As List(Of ProductExceptionData)
Public Overridable Property UsesOwnSealNumbers As Boolean
End Class
Public Partial Class ProductData
Public Overridable Property ProductId As Integer
Public Overridable Property PrincipalId As Integer
Public Overridable Property Name As String
Public Overridable Property Category As String
Public Overridable Property ProductCode As String
Public Overridable Property UnitBarcode As String
Public Overridable Property CartonQuantity As Integer
Public Overridable Property ShrinkQuantity As Integer
Public Overridable Property UnitQuantity As Integer
Public Overridable Property CartonMeasurement As String
Public Overridable Property ShrinkMeasurement As String
Public Overridable Property UnitMeasurement As String
Public Overridable Property CartonWeight As Double
Public Overridable Property ShrinkWeight As Double
Public Overridable Property UnitWeight As Decimal
Public Overridable Property CartonPrice As Decimal
Public Overridable Property ShrinkPrice As Decimal
Public Overridable Property UnitPrice As Decimal
Public Overridable Property MaxQuantity As Integer
Public Overridable Property MaxPrice As Integer
End Class
Public Partial Class ProductDataCategory
Public Sub New()
Products = New List(Of ProductData)
End Sub
Public Overridable Property UnitBarcode As String
Public Overridable Property Products As List(Of ProductData)
End Class
Public Partial Class ProductExceptionData
Public Sub New()
StockStatusIds = New List(Of Integer)
End Sub
Public Overridable Property Region As String
Public Overridable Property Channel As String
Public Overridable Property ProductId As Integer
Public Overridable Property StockStatusIds As List(Of Integer)
End Class
Public Partial Class SealTemplateData
Public Sub New()
Items = New List(Of SealTemplateItemData)
End Sub
Public Overridable Property Items As List(Of SealTemplateItemData)
Public Partial Class SealTemplateItemData
Public Sub New()
Products = New List(Of SealTemplateProduct)
End Sub
Public Overridable Property SealNumber As String
Public Overridable Property ProductStockStatus As Integer
Public Overridable Property Products As List(Of SealTemplateProduct)
End Class
End Class
Public Partial Class StockStatusData
Public Overridable Property Id As Integer
Public Overridable Property Name As String
Public Overridable Property PhotoRequired As Boolean
Public Overridable Property Color As String
End Class
Public Partial Class UpliftTemplateData
Public Sub New()
Products = New List(Of TemplateProductData)
Seals = New List(Of UpliftRequestSealData)
End Sub
Public Overridable Property TotalValue As Decimal
Public Overridable Property Products As List(Of TemplateProductData)
Public Overridable Property Seals As List(Of UpliftRequestSealData)
Public Partial Class TemplateProductData
Public Sub New()
StatusQty = New Dictionary(Of Integer, Integer)
End Sub
Public Overridable Property Name As String
Public Overridable Property ProductCode As String
Public Overridable Property Barcode As String
Public Overridable Property StatusQty As Dictionary(Of Integer, Integer)
Public Overridable Property ReturnValue As Decimal
End Class
End Class
End Namespace
Namespace WebService.ServiceModel.Base
Public Partial Class ApiServiceRequest
Implements IServiceRequest
Implements IHasApiKey
Implements IHasDeviceInfo
'''<Summary>
'''The API Key required for authentication
'''</Summary>
<ApiMember(DataType:="string", Description:="The API Key required for authentication", IsRequired:=true)>
Public Overridable Property ApiKey As String
'''<Summary>
'''Latitude of the user making this request
'''</Summary>
<ApiMember(DataType:="double", Description:="Latitude of the user making this request")>
Public Overridable Property Latitude As Double
'''<Summary>
'''Longitude of the user making this request
'''</Summary>
<ApiMember(DataType:="double", Description:="Longitude of the user making this request")>
Public Overridable Property Longitude As Double
End Class
Public Partial Class ApiServiceResponse
Implements IServiceResponse
'''<Summary>
'''Information about the response.
'''</Summary>
<ApiMember(Description:="Information about the response.", IsRequired:=true)>
Public Overridable Property Description As String
'''<Summary>
'''Heading or summary of the response.
'''</Summary>
<ApiMember(Description:="Heading or summary of the response.", IsRequired:=true)>
Public Overridable Property Heading As String
'''<Summary>
'''Did the intended operation for this response complete successfully?
'''</Summary>
<ApiMember(DataType:="boolean", Description:="Did the intended operation for this response complete successfully?", IsRequired:=true)>
Public Overridable Property WasSuccessful As Boolean
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
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.
GET /upliftscedule HTTP/1.1 Host: antel.api.dev.86degrees.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}