| GET | /api/C2BGetUnfinishedContracts |
|---|
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 BaseRequest:
# @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
api_key: Optional[str] = None
"""
This is your AIM API Key provided by Tri-Tech
"""
# @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
o_auth_token: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseSecureRequest(BaseRequest):
# @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
token: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
device_id: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
app_id: Optional[str] = None
"""
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponseResult:
# @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
status_code: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
login: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
error_code: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
error_display_text: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
error_message: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
domain_name: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
ip_address: Optional[str] = None
"""
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse:
# @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
status: Optional[BaseResponseResult] = None
"""
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LocationInfo:
id: int = 0
desc: Optional[str] = None
short_desc: Optional[str] = None
region: Optional[str] = None
latitude: Decimal = decimal.Decimal(0)
longitude: Decimal = decimal.Decimal(0)
in_store_pickup: Optional[str] = None
active: bool = False
cash_sale_acct: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class C2BAccessory:
id: int = 0
description: Optional[str] = None
price: Decimal = decimal.Decimal(0)
type: Optional[str] = None
sku: Optional[str] = None
category: Optional[int] = None
delivered: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UnfinishedContract:
customer_name: Optional[str] = None
customer_acct: int = 0
student_name: Optional[str] = None
ref: Optional[str] = None
date_time: datetime.datetime = datetime.datetime(1, 1, 1)
location: Optional[LocationInfo] = None
district: Optional[str] = None
school: Optional[str] = None
teacher: Optional[str] = None
instrument: Optional[str] = None
status: Optional[str] = None
notes: Optional[str] = None
locked_by: Optional[str] = None
instrument_grade: Optional[str] = None
serial: Optional[str] = None
salesperson: Optional[str] = None
web_notes: Optional[str] = None
email: Optional[str] = None
phone: Optional[str] = None
delivery_date: Optional[datetime.datetime] = None
first_due: Optional[datetime.datetime] = None
accessories: Optional[List[C2BAccessory]] = None
down_pay: Decimal = decimal.Decimal(0)
monthly_pay: Decimal = decimal.Decimal(0)
down_maint: Decimal = decimal.Decimal(0)
monthly_maint: Decimal = decimal.Decimal(0)
down_lease: Decimal = decimal.Decimal(0)
monthly_lease: Decimal = decimal.Decimal(0)
down_total: Decimal = decimal.Decimal(0)
address: Optional[str] = None
address2: Optional[str] = None
city: Optional[str] = None
state: Optional[str] = None
zip: Optional[str] = None
country: Optional[str] = None
invoice_created: bool = False
contract_created: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class C2BGetUnfinishedContractsResponse(BaseResponse):
unfinished_contracts: Optional[List[UnfinishedContract]] = None
topic: Optional[str] = None
base_url: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class C2BGetUnfinishedContractsRequest(BaseSecureRequest):
"""
C2BGetUnfinishedContractsRequires active-e Contracts Service.
"""
type: Optional[str] = None
start_offset: Optional[int] = None
record_count: Optional[int] = None
search_str: Optional[str] = None
include_contracts_entered_by_other_users: bool = False
district_id: Optional[int] = None
school_id: Optional[int] = None
teacher_id: Optional[int] = None
delivery_desc: Optional[str] = None
status: Optional[str] = None
Python C2BGetUnfinishedContractsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/C2BGetUnfinishedContracts HTTP/1.1 Host: active-ewebservice.biz Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"UnfinishedContracts":[{"CustomerName":"String","CustomerAcct":0,"StudentName":"String","Ref":"String","Location":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"District":"String","School":"String","Teacher":"String","Instrument":"String","Status":"String","Notes":"String","LockedBy":"String","InstrumentGrade":"String","Serial":"String","Salesperson":"String","WebNotes":"String","Email":"String","Phone":"String","DeliveryDate":"0001-01-01T00:00:00.0000000","FirstDue":"0001-01-01T00:00:00.0000000","Accessories":[{"Id":0,"Description":"String","Price":0,"Type":"String","Sku":"String","Category":0,"Delivered":false}],"DownPay":0,"MonthlyPay":0,"DownMaint":0,"MonthlyMaint":0,"DownLease":0,"MonthlyLease":0,"DownTotal":0,"Address":"String","Address2":"String","City":"String","State":"String","Zip":"String","Country":"String","InvoiceCreated":false,"ContractCreated":false}],"Topic":"String","BaseUrl":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}