| GET | /principal/get |
|---|
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 ProductData:
product_id: Optional[int] = None
principal_id: Optional[int] = None
principal_prefix: Optional[str] = None
name: Optional[str] = None
category: Optional[str] = None
product_code: Optional[str] = None
unit_barcode: Optional[str] = None
carton_quantity: Optional[int] = None
shrink_quantity: Optional[int] = None
unit_quantity: Optional[int] = None
carton_measurement: Optional[str] = None
shrink_measurement: Optional[str] = None
unit_measurement: Optional[str] = None
carton_weight: Optional[float] = None
shrink_weight: Optional[float] = None
unit_weight: Optional[Decimal] = None
carton_price: Optional[Decimal] = None
shrink_price: Optional[Decimal] = None
unit_price: Optional[Decimal] = None
unit_of_measure_id: Optional[int] = None
@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 StockStatusData:
id: Optional[int] = None
name: Optional[str] = None
photo_required: Optional[bool] = None
batch_code_mandatory: Optional[bool] = None
color: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PrincipalData:
principal_id: Optional[int] = None
name: Optional[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
has_logo: Optional[bool] = None
allow_product_lookup: Optional[bool] = None
capture_serial_number: Optional[bool] = None
show_production_date: Optional[bool] = None
show_expiry_date: Optional[bool] = None
show_batch_code: Optional[bool] = None
seal_number_per_product: Optional[bool] = None
allowed_product_stock_statuses: Optional[List[StockStatusData]] = None
enabled: Optional[bool] = None
show_seal_number: Optional[bool] = None
show_seal_weight: Optional[bool] = None
consolidation_enabled: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPrincipalResponse(ApiServiceResponse):
data: Optional[PrincipalData] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPrincipal(ApiServiceRequest):
principal_id: Optional[int] = 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.
GET /principal/get HTTP/1.1 Host: returnit-api-dev.happen.zone Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetPrincipalResponse 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>
<Data>
<AllowProductLookup>false</AllowProductLookup>
<AllowedProductStockStatuses>
<StockStatusData>
<BatchCodeMandatory>false</BatchCodeMandatory>
<Color>String</Color>
<Id>0</Id>
<Name>String</Name>
<PhotoRequired>false</PhotoRequired>
</StockStatusData>
</AllowedProductStockStatuses>
<CaptureSerialNumber>false</CaptureSerialNumber>
<ConsolidationEnabled>false</ConsolidationEnabled>
<ContactEmail>String</ContactEmail>
<ContactName>String</ContactName>
<ContactNumber>String</ContactNumber>
<Enabled>false</Enabled>
<HasLogo>false</HasLogo>
<LogoImageUrl>String</LogoImageUrl>
<Name>String</Name>
<PrincipalId>0</PrincipalId>
<Products>
<ProductDataCategory>
<Products>
<ProductData>
<CartonMeasurement>String</CartonMeasurement>
<CartonPrice>0</CartonPrice>
<CartonQuantity>0</CartonQuantity>
<CartonWeight>0</CartonWeight>
<Category>String</Category>
<Name>String</Name>
<PrincipalId>0</PrincipalId>
<PrincipalPrefix>String</PrincipalPrefix>
<ProductCode>String</ProductCode>
<ProductId>0</ProductId>
<ShrinkMeasurement>String</ShrinkMeasurement>
<ShrinkPrice>0</ShrinkPrice>
<ShrinkQuantity>0</ShrinkQuantity>
<ShrinkWeight>0</ShrinkWeight>
<UnitBarcode>String</UnitBarcode>
<UnitMeasurement>String</UnitMeasurement>
<UnitOfMeasureId>0</UnitOfMeasureId>
<UnitPrice>0</UnitPrice>
<UnitQuantity>0</UnitQuantity>
<UnitWeight>0</UnitWeight>
</ProductData>
</Products>
<UnitBarcode>String</UnitBarcode>
</ProductDataCategory>
</Products>
<SealNumberPerProduct>false</SealNumberPerProduct>
<ShowBatchCode>false</ShowBatchCode>
<ShowExpiryDate>false</ShowExpiryDate>
<ShowProductionDate>false</ShowProductionDate>
<ShowSealNumber>false</ShowSealNumber>
<ShowSealWeight>false</ShowSealWeight>
<UpliftPrefix>String</UpliftPrefix>
</Data>
</GetPrincipalResponse>