| POST | /stock/seal/details |
|---|
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
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FileDataItem:
file_name: Optional[str] = None
file_url: Optional[str] = None
thumbnail_url: Optional[str] = None
file_id: Optional[str] = None
thumbnail_id: Optional[str] = None
link_id: int = 0
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SealOrderHistoryItem:
created_date: Optional[str] = None
order_id: int = 0
order_number: Optional[str] = None
order_requesting_operator: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SealMovementHistoryItem:
id: int = 0
event_date_time: Optional[str] = None
action_user_name: Optional[str] = None
scanned_depot_name: Optional[str] = None
assigned_bucket_name: Optional[str] = None
assigned_order_number: Optional[str] = None
assigned_operator_name: Optional[str] = None
order_driver_name: Optional[str] = None
order_driver_company_name: Optional[str] = None
order_driver_license_plate: Optional[str] = None
target_weight: float = 0.0
current_weight: float = 0.0
had_weight_issue: bool = False
had_unknown_uplift: bool = False
was_paused: bool = False
paused_was_awaiting_auth: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SealDetailsResponse(ApiServiceResponse):
principal_name: Optional[str] = None
uplift_number: Optional[str] = None
operator_name: Optional[str] = None
outlet_name: Optional[str] = None
uplift_date: Optional[str] = None
seal_number: Optional[str] = None
current_weight: Optional[str] = None
target_weight: Optional[str] = None
has_weight_issue: bool = False
bucket_name: Optional[str] = None
claim_numbers: Optional[List[str]] = None
joined_claim_numbers: Optional[str] = None
seal_images: Optional[List[FileDataItem]] = None
order_history: Optional[List[SealOrderHistoryItem]] = None
movement_history: Optional[List[SealMovementHistoryItem]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SealDetailsRequest(ApiServiceRequest):
seal_id: int = 0
Python SealDetailsRequest 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.
POST /stock/seal/details HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SealDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
<ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ApiKey>
<Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Latitude>
<Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Longitude>
<SealId>0</SealId>
</SealDetailsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SealDetailsResponse 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.ServiceModel.Base">String</Description>
<Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Heading>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.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.ServiceModel.Base">false</WasSuccessful>
<BucketName>String</BucketName>
<ClaimNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ClaimNumbers>
<CurrentWeight>String</CurrentWeight>
<HasWeightIssue>false</HasWeightIssue>
<MovementHistory>
<SealMovementHistoryItem>
<ActionUserName>String</ActionUserName>
<AssignedBucketName>String</AssignedBucketName>
<AssignedOperatorName>String</AssignedOperatorName>
<AssignedOrderNumber>String</AssignedOrderNumber>
<CurrentWeight>0</CurrentWeight>
<EventDateTime>String</EventDateTime>
<HadUnknownUplift>false</HadUnknownUplift>
<HadWeightIssue>false</HadWeightIssue>
<Id>0</Id>
<OrderDriverCompanyName>String</OrderDriverCompanyName>
<OrderDriverLicensePlate>String</OrderDriverLicensePlate>
<OrderDriverName>String</OrderDriverName>
<PausedWasAwaitingAuth>false</PausedWasAwaitingAuth>
<ScannedDepotName>String</ScannedDepotName>
<TargetWeight>0</TargetWeight>
<WasPaused>false</WasPaused>
</SealMovementHistoryItem>
</MovementHistory>
<OperatorName>String</OperatorName>
<OrderHistory>
<SealOrderHistoryItem>
<CreatedDate>String</CreatedDate>
<OrderId>0</OrderId>
<OrderNumber>String</OrderNumber>
<OrderRequestingOperator>String</OrderRequestingOperator>
</SealOrderHistoryItem>
</OrderHistory>
<OutletName>String</OutletName>
<PrincipalName>String</PrincipalName>
<SealImages xmlns:d2p1="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">
<d2p1:FileDataItem>
<d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
<d2p1:FileId>00000000-0000-0000-0000-000000000000</d2p1:FileId>
<d2p1:FileName>String</d2p1:FileName>
<d2p1:FileUrl>String</d2p1:FileUrl>
<d2p1:LinkId>0</d2p1:LinkId>
<d2p1:ThumbnailId>00000000-0000-0000-0000-000000000000</d2p1:ThumbnailId>
<d2p1:ThumbnailUrl>String</d2p1:ThumbnailUrl>
</d2p1:FileDataItem>
</SealImages>
<SealNumber>String</SealNumber>
<TargetWeight>String</TargetWeight>
<UpliftDate>String</UpliftDate>
<UpliftNumber>String</UpliftNumber>
</SealDetailsResponse>