| GET, POST | /api/ServiceStatus |
|---|
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 ServiceStatus:
id: int = 0
status: Optional[str] = None
description: Optional[str] = None
code: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ServiceStatusResponse(BaseResponse):
statuses: Optional[List[ServiceStatus]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ServiceStatusRequest(BaseSecureRequest):
"""
ServiceStatusRequires active-e Service Tickets Service
"""
# @ApiMember(Description="List of Tickets to be updated. Only used for a POST request.", Name="Tickets", ParameterType="query")
tickets: Optional[List[str]] = None
"""
List of Tickets to be updated. Only used for a POST request.
"""
# @ApiMember(Description="New Status Id to be set to the tickets. Only used for a POST request. Send this or NewStatus.", Name="NewStatusId", ParameterType="query")
new_status_id: Optional[int] = None
"""
New Status Id to be set to the tickets. Only used for a POST request. Send this or NewStatus.
"""
# @ApiMember(Description="New Status to be set to the tickets. Only used for a POST request. Send this or NewStatus.", Name="NewStatus", ParameterType="query")
new_status: Optional[str] = None
"""
New Status to be set to the tickets. Only used for a POST request. Send this or NewStatus.
"""
# @ApiMember(Description="New Locator Id to be set to the tickets. Only used for a POST request. Send this or NewLocator.", Name="NewLocatorId", ParameterType="query")
new_locator_id: Optional[int] = None
"""
New Locator Id to be set to the tickets. Only used for a POST request. Send this or NewLocator.
"""
# @ApiMember(Description="New Locator to be set to the tickets. Only used for a POST request. Send this or NewLocatorId.", Name="NewLocator", ParameterType="query")
new_locator: Optional[str] = None
"""
New Locator to be set to the tickets. Only used for a POST request. Send this or NewLocatorId.
"""
# @ApiMember(Description="New Master Ticket # to be set to the tickets. Only used for a POST request.", Name="NewMasterTicket", ParameterType="query")
new_master_ticket: Optional[str] = None
"""
New Master Ticket # to be set to the tickets. Only used for a POST request.
"""
Python ServiceStatusRequest 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.
POST /api/ServiceStatus HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ServiceStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<ApiKey>String</ApiKey>
<OAuthToken>String</OAuthToken>
<AppId>String</AppId>
<DeviceId>String</DeviceId>
<Token>String</Token>
<NewLocator>String</NewLocator>
<NewLocatorId>0</NewLocatorId>
<NewMasterTicket>String</NewMasterTicket>
<NewStatus>String</NewStatus>
<NewStatusId>0</NewStatusId>
<Tickets xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Tickets>
</ServiceStatusRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ServiceStatusResponse 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>
<Statuses>
<ServiceStatusResponse.ServiceStatus>
<Code>String</Code>
<Description>String</Description>
<Id>0</Id>
<Status>String</Status>
</ServiceStatusResponse.ServiceStatus>
</Statuses>
</ServiceStatusResponse>