| GET | /upliftscedule |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceRequest(IServiceRequest, IHasApiKey, IHasDeviceInfo):
# @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
api_key: Optional[str] = None
"""
The API Key required for authentication
"""
# @ApiMember(DataType="double", Description="Latitude of the user making this request")
latitude: float = 0.0
"""
Latitude of the user making this request
"""
# @ApiMember(DataType="double", Description="Longitude of the user making this request")
longitude: float = 0.0
"""
Longitude of the user making this request
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceResponse(IServiceResponse):
# @ApiMember(Description="Information about the response.", IsRequired=true)
description: Optional[str] = None
"""
Information about the response.
"""
# @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
heading: Optional[str] = None
"""
Heading or summary of the response.
"""
# @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
was_successful: bool = False
"""
Did the intended operation for this response complete successfully?
"""
response_status: Optional[ResponseStatus] = None
class UpliftScheduleStatus(IntEnum):
UNCONFIRMED = 0
CONFIRMED = 1
PORTAL_CANCELLED = 4
USER_CANCELLED = 5
NO_OPERATOR_ASSIGNED = 6
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductData:
product_id: int = 0
principal_id: int = 0
name: Optional[str] = None
category: Optional[str] = None
product_code: Optional[str] = None
unit_barcode: Optional[str] = None
carton_quantity: int = 0
shrink_quantity: int = 0
unit_quantity: int = 0
carton_measurement: Optional[str] = None
shrink_measurement: Optional[str] = None
unit_measurement: Optional[str] = None
carton_weight: float = 0.0
shrink_weight: float = 0.0
unit_weight: Decimal = decimal.Decimal(0)
carton_price: Decimal = decimal.Decimal(0)
shrink_price: Decimal = decimal.Decimal(0)
unit_price: Decimal = decimal.Decimal(0)
max_quantity: int = 0
max_price: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductDataCategory:
unit_barcode: Optional[str] = None
products: Optional[List[ProductData]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductExceptionData:
region: Optional[str] = None
channel: Optional[str] = None
product_id: int = 0
stock_status_ids: Optional[List[int]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PrincipalData:
principal_id: int = 0
name: Optional[str] = None
auth_letter_file_url: Optional[List[str]] = None
logo_image_url: Optional[str] = None
products: Optional[List[ProductDataCategory]] = None
uplift_prefix: Optional[str] = None
contact_name: Optional[str] = None
contact_number: Optional[str] = None
contact_email: Optional[str] = None
allow_product_lookup: bool = False
has_logo: bool = False
has_auth_letter: bool = False
seal_net_weight_mandatory: bool = False
allow_billable_seals: bool = False
capture_serial_number: bool = False
batch_codes_mandatory: bool = False
capture_manufacture_and_expiry_date: bool = False
product_exceptions: Optional[List[ProductExceptionData]] = None
uses_own_seal_numbers: bool = False
class ActionOutsideMaxDistanceType(IntEnum):
WARN = 0
BLOCK = 1
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TemplateProductData:
name: Optional[str] = None
product_code: Optional[str] = None
barcode: Optional[str] = None
status_qty: Optional[Dict[int, int]] = None
return_value: Decimal = decimal.Decimal(0)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpliftRequestSealData:
number: Optional[str] = None
weight: float = 0.0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpliftTemplateData:
total_value: Decimal = decimal.Decimal(0)
products: Optional[List[TemplateProductData]] = None
seals: Optional[List[UpliftRequestSealData]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StockStatusData:
id: int = 0
name: Optional[str] = None
photo_required: bool = False
color: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SealTemplateProduct:
product_id: int = 0
name: Optional[str] = None
product_stock_status_id: int = 0
quantity: int = 0
serial_number: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SealTemplateItemData:
seal_number: Optional[str] = None
product_stock_status: int = 0
products: Optional[List[SealTemplateProduct]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SealTemplateData:
items: Optional[List[SealTemplateItemData]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AppointmentPrincipleData:
principle: Optional[PrincipalData] = None
scheduled_date: Optional[str] = None
uplift_schedule_id: int = 0
uplift_schedule_principle_id: int = 0
principle_outlet_id: int = 0
verification_code: Optional[str] = None
goods_to_collect: bool = False
outlet_region: Optional[str] = None
outlet_name: Optional[str] = None
outlet_channel: Optional[str] = None
outlet_latitude: float = 0.0
outlet_longitude: float = 0.0
max_submission_distance: float = 0.0
action_outside_max_distance: Optional[ActionOutsideMaxDistanceType] = None
completed_date: Optional[str] = None
cancelled: bool = False
completed: bool = False
uplift_template: Optional[UpliftTemplateData] = None
pre_populated: bool = False
allowed_product_stock_statuses: Optional[List[StockStatusData]] = None
note_to_operator: Optional[str] = None
seal_template: Optional[SealTemplateData] = None
pre_populated_with_seals: bool = False
pre_authed: bool = False
operator_name: Optional[str] = None
system_user_id: int = 0
product_exceptions: Optional[List[ProductExceptionData]] = None
store_confirmation_document_url: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AppointmentData:
schedule_id: int = 0
appointment_date: Optional[str] = None
outlet_name: Optional[str] = None
outlet_channel: Optional[str] = None
uplift_status: Optional[UpliftScheduleStatus] = None
is_complete: bool = False
in_progress: bool = False
is_late: bool = False
good_to_collect_status: bool = False
principles_with_goods_to_collect: Optional[str] = None
principle_appointments: Optional[List[AppointmentPrincipleData]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetUpliftScheduleResponse(ApiServiceResponse):
appointments: Optional[List[AppointmentData]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetUpliftSchedule(ApiServiceRequest):
pass
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
}
}
}