| POST | /upliftrequest |
|---|
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 SaveUpliftRequestResponse(ApiServiceResponse):
uplift_request_product_ids: Optional[List[int]] = None
auth_request_id: Optional[str] = None
uplift_request_id: Optional[int] = None
delete_from_device: Optional[bool] = None
image_ids: Optional[List[str]] = 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 SaveUpliftRequest(ApiServiceRequest):
uplift_request: Optional[UpliftRequestData] = None
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.
POST /upliftrequest HTTP/1.1
Host: returnit-api-dev.happen.zone
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SaveUpliftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models">
<ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">String</ApiKey>
<Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">0</Latitude>
<Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">0</Longitude>
<UpliftRequest>
<AdditionalNotes>String</AdditionalNotes>
<AuthRequestId>00000000-0000-0000-0000-000000000000</AuthRequestId>
<Authorised>false</Authorised>
<Cancelled>false</Cancelled>
<Confirmed>false</Confirmed>
<EndLatitude>0</EndLatitude>
<EndLongitude>0</EndLongitude>
<EndTime>String</EndTime>
<Id>00000000-0000-0000-0000-000000000000</Id>
<Images xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:anyType />
</Images>
<IncompleteUpliftRequestId>String</IncompleteUpliftRequestId>
<LastSynced>0001-01-01T00:00:00</LastSynced>
<LastUpdated>0001-01-01T00:00:00</LastUpdated>
<MerchandiserSignatureImage />
<OutletChannel>String</OutletChannel>
<OutletContactName>String</OutletContactName>
<OutletEmailAddress>String</OutletEmailAddress>
<OutletId>0</OutletId>
<OutletRegion>String</OutletRegion>
<PrincipalId>0</PrincipalId>
<Products>
<UpliftRequestProductData>
<BatchCode>String</BatchCode>
<Category>String</Category>
<Code>String</Code>
<ExpiryDate>String</ExpiryDate>
<Id>00000000-0000-0000-0000-000000000000</Id>
<Images xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:anyType />
</Images>
<Name>String</Name>
<PrincipalId>0</PrincipalId>
<PrincipalLogoUrl>String</PrincipalLogoUrl>
<PrincipalName>String</PrincipalName>
<ProductId>0</ProductId>
<ProductionDate>String</ProductionDate>
<Quantity>0</Quantity>
<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>
</Seal>
<SerialNumber>String</SerialNumber>
<StockStatusColor>String</StockStatusColor>
<StockStatusId>0</StockStatusId>
<StockStatusName>String</StockStatusName>
<UnitBarcode>String</UnitBarcode>
<UnitOfMeasureId>0</UnitOfMeasureId>
<UnitPrice>0</UnitPrice>
<UnitSize>String</UnitSize>
<UnitWeight>0</UnitWeight>
<UpliftRequestProductId>0</UpliftRequestProductId>
<Value>0</Value>
</UpliftRequestProductData>
</Products>
<Seals>
<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>
</SealData>
</Seals>
<StartLatitude>0</StartLatitude>
<StartLongitude>0</StartLongitude>
<StartTime>String</StartTime>
<SubmitImmediately>false</SubmitImmediately>
<UpliftRequestId>0</UpliftRequestId>
</UpliftRequest>
</SaveUpliftRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SaveUpliftRequestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models">
<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>
<AuthRequestId>00000000-0000-0000-0000-000000000000</AuthRequestId>
<DeleteFromDevice>false</DeleteFromDevice>
<ImageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ImageIds>
<UpliftRequestId>0</UpliftRequestId>
<UpliftRequestProductIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</UpliftRequestProductIds>
</SaveUpliftRequestResponse>