| GET | /sync/incompleteupliftrequest |
|---|
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: Optional[float] = None
"""
Latitude of the user making this request
"""
# @ApiMember(DataType="double", Description="Longitude of the user making this request")
longitude: Optional[float] = None
"""
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
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Seal:
number: Optional[str] = None
weight: Optional[float] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SealData(Seal):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpliftRequestProductData:
id: Optional[str] = None
uplift_request_product_id: Optional[int] = None
product_id: Optional[int] = None
principal_id: Optional[int] = None
unit_price: Optional[Decimal] = None
name: Optional[str] = None
category: Optional[str] = None
unit_barcode: Optional[str] = None
unit_size: Optional[str] = None
unit_weight: Optional[Decimal] = None
code: Optional[str] = None
images: Optional[List[Object]] = None
quantity: Optional[float] = None
value: Optional[Decimal] = None
production_date: Optional[str] = None
expiry_date: Optional[str] = None
batch_code: Optional[str] = None
seal: Optional[SealData] = None
serial_number: Optional[str] = None
stock_status_id: Optional[int] = None
principal_logo_url: Optional[str] = None
principal_name: Optional[str] = None
stock_status_name: Optional[str] = None
stock_status_color: Optional[str] = None
unit_of_measure_id: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpliftRequestData:
uplift_request_id: Optional[int] = None
id: Optional[str] = None
outlet_id: Optional[int] = None
products: Optional[List[UpliftRequestProductData]] = None
outlet_email_address: Optional[str] = None
outlet_contact_name: Optional[str] = None
outlet_channel: Optional[str] = None
outlet_region: Optional[str] = None
additional_notes: Optional[str] = None
merchandiser_signature_image: Optional[Object] = None
start_time: Optional[str] = None
start_latitude: Optional[float] = None
start_longitude: Optional[float] = None
end_time: Optional[str] = None
end_latitude: Optional[float] = None
end_longitude: Optional[float] = None
last_updated: Optional[datetime.datetime] = None
last_synced: Optional[datetime.datetime] = None
incomplete_uplift_request_id: Optional[str] = None
auth_request_id: Optional[str] = None
authorised: Optional[bool] = None
principal_id: Optional[int] = None
seals: Optional[List[SealData]] = None
confirmed: Optional[bool] = None
cancelled: Optional[bool] = None
images: Optional[List[Object]] = None
submit_immediately: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IncompleteUpliftRequestFromServerResponse(ApiServiceResponse):
uplift_request_data: Optional[UpliftRequestData] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IncompleteUpliftRequestFromServer(ApiServiceRequest):
incomplete_uplift_request_id: Optional[str] = None
Python IncompleteUpliftRequestFromServer 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.
GET /sync/incompleteupliftrequest HTTP/1.1 Host: returnit-api-dev.happen.zone Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
UpliftRequestData:
{
UpliftRequestId: 0,
OutletId: 0,
Products:
[
{
UpliftRequestProductId: 0,
ProductId: 0,
PrincipalId: 0,
UnitPrice: 0,
Name: String,
Category: String,
UnitBarcode: String,
UnitSize: String,
UnitWeight: 0,
Code: String,
Images:
[
{
}
],
Quantity: 0,
Value: 0,
ProductionDate: String,
ExpiryDate: String,
BatchCode: String,
Seal:
{
Number: String,
Weight: 0
},
SerialNumber: String,
StockStatusId: 0,
PrincipalLogoUrl: String,
PrincipalName: String,
StockStatusName: String,
StockStatusColor: String,
UnitOfMeasureId: 0
}
],
OutletEmailAddress: String,
OutletContactName: String,
OutletChannel: String,
OutletRegion: String,
AdditionalNotes: String,
MerchandiserSignatureImage: {},
StartTime: String,
StartLatitude: 0,
StartLongitude: 0,
EndTime: String,
EndLatitude: 0,
EndLongitude: 0,
LastUpdated: 0001-01-01,
LastSynced: 0001-01-01,
IncompleteUpliftRequestId: String,
Authorised: False,
PrincipalId: 0,
Seals:
[
{
Number: String,
Weight: 0
}
],
Confirmed: False,
Cancelled: False,
Images:
[
{
}
],
SubmitImmediately: False
},
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
}
}
}