| GET | /api/ContractScheduledReturns |
|---|
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 ContractScheduledReturnInfo:
acct: int = 0
sub: int = 0
name: Optional[str] = None
address: Optional[str] = None
address2: Optional[str] = None
city: Optional[str] = None
student: Optional[str] = None
school: Optional[str] = None
district: Optional[str] = None
item: Optional[str] = None
employee: Optional[str] = None
returned_date: Optional[datetime.datetime] = None
scheduled_return_date: datetime.datetime = datetime.datetime(1, 1, 1)
stock_number: Optional[str] = None
serial: Optional[str] = None
return_option: Optional[str] = None
scheduled_returned_ref: Optional[str] = None
status: Optional[str] = None
auto_pay_hold_date: Optional[datetime.datetime] = None
mobile_returned_status: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContractScheduledReturnsResponse(BaseResponse):
contracts: Optional[List[ContractScheduledReturnInfo]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContractScheduledReturnsRequest(BaseSecureRequest):
"""
ContractScheduledReturnsRequires active-e Contracts Service.
"""
date_from: Optional[datetime.datetime] = None
date_to: Optional[datetime.datetime] = None
district_id: Optional[int] = None
school_id: Optional[int] = None
location_id: Optional[int] = None
status_id: Optional[int] = None
option_id: Optional[int] = None
include_returned: Optional[bool] = None
lan_id: Optional[str] = None
Python ContractScheduledReturnsRequest 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.
GET /api/ContractScheduledReturns HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ContractScheduledReturnsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<Status>
<DomainName>String</DomainName>
<ErrorCode>String</ErrorCode>
<ErrorDisplayText>String</ErrorDisplayText>
<ErrorMessage>String</ErrorMessage>
<IpAddress>String</IpAddress>
<Login>String</Login>
<StatusCode>String</StatusCode>
</Status>
<Contracts>
<ContractScheduledReturnInfo>
<Acct>0</Acct>
<Address>String</Address>
<Address2>String</Address2>
<AutoPayHoldDate>0001-01-01T00:00:00</AutoPayHoldDate>
<City>String</City>
<District>String</District>
<Employee>String</Employee>
<Item>String</Item>
<MobileReturnedStatus>false</MobileReturnedStatus>
<Name>String</Name>
<ReturnOption>String</ReturnOption>
<ReturnedDate>0001-01-01T00:00:00</ReturnedDate>
<ScheduledReturnDate>0001-01-01T00:00:00</ScheduledReturnDate>
<ScheduledReturnedRef>String</ScheduledReturnedRef>
<School>String</School>
<Serial>String</Serial>
<Status>String</Status>
<StockNumber>String</StockNumber>
<Student>String</Student>
<Sub>0</Sub>
</ContractScheduledReturnInfo>
</Contracts>
</ContractScheduledReturnsResponse>