| POST | /api/Security | ||
|---|---|---|---|
| POST | /api/Security/{token} |
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 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 UserDetail:
firstname: Optional[str] = None
last_name: Optional[str] = None
email: Optional[str] = None
type: Optional[str] = None
location: Optional[str] = None
location_name: Optional[str] = None
account_number: Optional[int] = None
tax_authority: Optional[str] = None
tax_authority_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AccountDetail:
acct: int = 0
acct_type: Optional[str] = None
name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SecurityResponse(BaseResponse):
token: Optional[str] = None
o_auth_token: Optional[str] = None
domain: Optional[str] = None
is_admin: bool = False
user_details: Optional[UserDetail] = None
account_details: Optional[List[AccountDetail]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SecurityRequest(BaseRequest):
"""
Login Service
"""
# @ApiMember(DataType="string", Description="Employee ID or Customer Email", IsRequired=true, Name="Username", ParameterType="query")
username: Optional[str] = None
"""
Employee ID or Customer Email
"""
# @ApiMember(DataType="string", Description="Existing Token", Name="Token", ParameterType="query")
token: Optional[str] = None
"""
Existing Token
"""
# @ApiMember(DataType="string", Description="Password of Employee or User", IsRequired=true, Name="Password", ParameterType="query")
password: Optional[str] = None
"""
Password of Employee or User
"""
# @ApiMember(DataType="string", Description="", IsRequired=true, Name="DeviceID", ParameterType="query")
device_id: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppID", ParameterType="query")
app_id: Optional[str] = None
"""
"""
# @ApiMember(DataType="int", Description="", Name="Acct", ParameterType="query")
acct: Optional[int] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="DeviceName", ParameterType="query")
device_name: Optional[str] = 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.
POST /api/Security HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SecurityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<ApiKey>String</ApiKey>
<OAuthToken>String</OAuthToken>
<Acct>0</Acct>
<AppID>String</AppID>
<DeviceID>String</DeviceID>
<DeviceName>String</DeviceName>
<Password>String</Password>
<Token>String</Token>
<Username>String</Username>
</SecurityRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SecurityResponse 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>
<AccountDetails>
<AccountDetail>
<Acct>0</Acct>
<AcctType>String</AcctType>
<Name>String</Name>
</AccountDetail>
</AccountDetails>
<Domain>String</Domain>
<IsAdmin>false</IsAdmin>
<OAuthToken>String</OAuthToken>
<Token>String</Token>
<UserDetails>
<AccountNumber>0</AccountNumber>
<Email>String</Email>
<Firstname>String</Firstname>
<LastName>String</LastName>
<Location>String</Location>
<LocationName>String</LocationName>
<TaxAuthority>String</TaxAuthority>
<TaxAuthorityName>String</TaxAuthorityName>
<Type>String</Type>
</UserDetails>
</SecurityResponse>