| GET | /api/ServiceTicketFullDetails |
|---|
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 PartInfo:
description: Optional[str] = None
quantity: Decimal = decimal.Decimal(0)
price: Decimal = decimal.Decimal(0)
discount: Decimal = decimal.Decimal(0)
total: Decimal = decimal.Decimal(0)
notes: Optional[str] = None
category: int = 0
category_description: Optional[str] = None
sku: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ServiceInfo:
id: int = 0
parts: Optional[List[PartInfo]] = None
description: Optional[str] = None
quantity: Decimal = decimal.Decimal(0)
rate: Decimal = decimal.Decimal(0)
discount: Decimal = decimal.Decimal(0)
total: Decimal = decimal.Decimal(0)
time: Decimal = decimal.Decimal(0)
completed: bool = False
completed_date: datetime.datetime = datetime.datetime(1, 1, 1)
technician: Optional[str] = None
notes: Optional[str] = None
category: int = 0
category_description: Optional[str] = None
timer_active: bool = False
timer_start_time: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DepositInfo:
original_amount: Decimal = decimal.Decimal(0)
amount: Decimal = decimal.Decimal(0)
ref_number: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TicketInfo:
terms: int = 0
po_number: Optional[str] = None
return_authorization_number: Optional[str] = None
status: Optional[str] = None
approved_amount: Decimal = decimal.Decimal(0)
total_due: Decimal = decimal.Decimal(0)
subtotal: Decimal = decimal.Decimal(0)
tax1: Decimal = decimal.Decimal(0)
tax2: Decimal = decimal.Decimal(0)
approved_date: datetime.datetime = datetime.datetime(1, 1, 1)
billed_date: datetime.datetime = datetime.datetime(1, 1, 1)
contact: Optional[str] = None
category: int = 0
services: Optional[List[ServiceInfo]] = None
category_description: Optional[str] = None
sub_category: int = 0
sub_category_description: Optional[str] = None
item: Optional[str] = None
item_description: Optional[str] = None
manufacturer: Optional[str] = None
notes: Optional[str] = None
timestamp: datetime.datetime = datetime.datetime(1, 1, 1)
sold_to_customer_acct: int = 0
bill_to_customer_acct: int = 0
model: Optional[str] = None
st_loc: Optional[str] = None
tax_loc: Optional[str] = None
ref_number: Optional[str] = None
master_number: Optional[str] = None
invoiced: bool = False
deposits: Optional[List[DepositInfo]] = None
sold_to_customer_name: Optional[str] = None
bill_to_customer_name: Optional[str] = None
ship_to_name: Optional[str] = None
ship_to_id: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ServiceTicketFullDetailsResponse(BaseResponse):
tickets: Optional[List[TicketInfo]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ServiceTicketFullDetailsRequest(BaseSecureRequest):
"""
ServiceTicketFullDetailsRequires active-e Service Tickets Service
"""
acct: Optional[int] = None
ref_number: Optional[str] = None
changed_date: Optional[datetime.datetime] = None
Python ServiceTicketFullDetailsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/ServiceTicketFullDetails HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Tickets":[{"Terms":0,"PoNumber":"String","ReturnAuthorizationNumber":"String","Status":"String","ApprovedAmount":0,"TotalDue":0,"Subtotal":0,"Tax1":0,"Tax2":0,"Contact":"String","Category":0,"Services":[{"Id":0,"Parts":[{"Description":"String","Quantity":0,"Price":0,"Discount":0,"Total":0,"Notes":"String","Category":0,"CategoryDescription":"String","Sku":"String"}],"Description":"String","Quantity":0,"Rate":0,"Discount":0,"Total":0,"Time":0,"Completed":false,"Technician":"String","Notes":"String","Category":0,"CategoryDescription":"String","TimerActive":false,"TimerStartTime":"0001-01-01T00:00:00.0000000"}],"CategoryDescription":"String","SubCategory":0,"SubCategoryDescription":"String","Item":"String","ItemDescription":"String","Manufacturer":"String","Notes":"String","SoldToCustomerAcct":0,"BillToCustomerAcct":0,"Model":"String","StLoc":"String","TaxLoc":"String","RefNumber":"String","MasterNumber":"String","Invoiced":false,"Deposits":[{"OriginalAmount":0,"Amount":0,"RefNumber":"String"}],"SoldToCustomerName":"String","BillToCustomerName":"String","ShipToName":"String","ShipToId":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}