| POST, GET | /api/SearchContactManagement |
|---|
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 AttributeValuePair:
name: Optional[str] = None
value: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactManagementRecord:
ref: Optional[str] = None
date_time: datetime.datetime = datetime.datetime(1, 1, 1)
contact: Optional[str] = None
cus_acct: int = 0
action_id: int = 0
status: Optional[str] = None
action_date: Optional[datetime.datetime] = None
pop_up: bool = False
topic_id: Optional[int] = None
topic: Optional[str] = None
closed: bool = False
closed_date: Optional[datetime.datetime] = None
color_value: int = 0
lan_id: Optional[str] = None
formatted_notes: bool = False
note1: Optional[str] = None
note2: Optional[str] = None
note3: Optional[str] = None
attributes: Optional[List[AttributeValuePair]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchContactManagementResponse(BaseResponse):
contact_management_records: Optional[List[ContactManagementRecord]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchContactManagementRequest(BaseSecureRequest):
"""
SearchContactManagement web service.
"""
formatted_notes: Optional[bool] = None
# @ApiMember(DataType="string", Description="If sent, all other search parameters will be ignored.", Name="Ref", ParameterType="query")
ref: Optional[str] = None
"""
If sent, all other search parameters will be ignored.
"""
acct: Optional[int] = None
date_from: Optional[datetime.datetime] = None
date_to: Optional[datetime.datetime] = None
include_closed: Optional[bool] = None
# @ApiMember(DataType="string", Description="", Name="SearchString", ParameterType="query")
search_string: Optional[str] = None
"""
"""
action_id: Optional[int] = None
Python SearchContactManagementRequest 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.
POST /api/SearchContactManagement HTTP/1.1
Host: active-ewebservice.biz
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"FormattedNotes":false,"Ref":"String","Acct":0,"DateFrom":"0001-01-01T00:00:00.0000000","DateTo":"0001-01-01T00:00:00.0000000","IncludeClosed":false,"SearchString":"String","ActionId":0,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ContactManagementRecords":[{"Ref":"String","Contact":"String","CusAcct":0,"ActionId":0,"Status":"String","ActionDate":"0001-01-01T00:00:00.0000000","PopUp":false,"TopicId":0,"Topic":"String","Closed":false,"ClosedDate":"0001-01-01T00:00:00.0000000","ColorValue":0,"LanId":"String","FormattedNotes":false,"Note1":"String","Note2":"String","Note3":"String","Attributes":[{"Name":"String","Value":"String"}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}