| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<IncompleteUpliftRequestFromServerResponse 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.AppApi.Models.Base">String</Description>
<Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">String</Heading>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.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.AppApi.Models.Base">false</WasSuccessful>
<UpliftRequestData xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models">
<d2p1:AdditionalNotes>String</d2p1:AdditionalNotes>
<d2p1:AuthRequestId>00000000-0000-0000-0000-000000000000</d2p1:AuthRequestId>
<d2p1:Authorised>false</d2p1:Authorised>
<d2p1:Cancelled>false</d2p1:Cancelled>
<d2p1:Confirmed>false</d2p1:Confirmed>
<d2p1:EndLatitude>0</d2p1:EndLatitude>
<d2p1:EndLongitude>0</d2p1:EndLongitude>
<d2p1:EndTime>String</d2p1:EndTime>
<d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
<d2p1:Images xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:anyType />
</d2p1:Images>
<d2p1:IncompleteUpliftRequestId>String</d2p1:IncompleteUpliftRequestId>
<d2p1:LastSynced>0001-01-01T00:00:00</d2p1:LastSynced>
<d2p1:LastUpdated>0001-01-01T00:00:00</d2p1:LastUpdated>
<d2p1:MerchandiserSignatureImage />
<d2p1:OutletChannel>String</d2p1:OutletChannel>
<d2p1:OutletContactName>String</d2p1:OutletContactName>
<d2p1:OutletEmailAddress>String</d2p1:OutletEmailAddress>
<d2p1:OutletId>0</d2p1:OutletId>
<d2p1:OutletRegion>String</d2p1:OutletRegion>
<d2p1:PrincipalId>0</d2p1:PrincipalId>
<d2p1:Products>
<d2p1:UpliftRequestProductData>
<d2p1:BatchCode>String</d2p1:BatchCode>
<d2p1:Category>String</d2p1:Category>
<d2p1:Code>String</d2p1:Code>
<d2p1:ExpiryDate>String</d2p1:ExpiryDate>
<d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
<d2p1:Images xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:anyType />
</d2p1:Images>
<d2p1:Name>String</d2p1:Name>
<d2p1:PrincipalId>0</d2p1:PrincipalId>
<d2p1:PrincipalLogoUrl>String</d2p1:PrincipalLogoUrl>
<d2p1:PrincipalName>String</d2p1:PrincipalName>
<d2p1:ProductId>0</d2p1:ProductId>
<d2p1:ProductionDate>String</d2p1:ProductionDate>
<d2p1:Quantity>0</d2p1:Quantity>
<d2p1:Seal>
<Number xmlns="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">String</Number>
<Weight xmlns="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">0</Weight>
</d2p1:Seal>
<d2p1:SerialNumber>String</d2p1:SerialNumber>
<d2p1:StockStatusColor>String</d2p1:StockStatusColor>
<d2p1:StockStatusId>0</d2p1:StockStatusId>
<d2p1:StockStatusName>String</d2p1:StockStatusName>
<d2p1:UnitBarcode>String</d2p1:UnitBarcode>
<d2p1:UnitOfMeasureId>0</d2p1:UnitOfMeasureId>
<d2p1:UnitPrice>0</d2p1:UnitPrice>
<d2p1:UnitSize>String</d2p1:UnitSize>
<d2p1:UnitWeight>0</d2p1:UnitWeight>
<d2p1:UpliftRequestProductId>0</d2p1:UpliftRequestProductId>
<d2p1:Value>0</d2p1:Value>
</d2p1:UpliftRequestProductData>
</d2p1:Products>
<d2p1:Seals>
<d2p1:SealData>
<Number xmlns="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">String</Number>
<Weight xmlns="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">0</Weight>
</d2p1:SealData>
</d2p1:Seals>
<d2p1:StartLatitude>0</d2p1:StartLatitude>
<d2p1:StartLongitude>0</d2p1:StartLongitude>
<d2p1:StartTime>String</d2p1:StartTime>
<d2p1:SubmitImmediately>false</d2p1:SubmitImmediately>
<d2p1:UpliftRequestId>0</d2p1:UpliftRequestId>
</UpliftRequestData>
</IncompleteUpliftRequestFromServerResponse>