| POST, GET | /api/SearchContactManagement |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
// @DataContract
class BaseRequest implements JsonSerializable
{
public function __construct(
/** @description This is your AIM API Key provided by Tri-Tech */
// @DataMember
// @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
/** @var string */
public string $ApiKey='',
// @DataMember
// @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
/** @var string|null */
public ?string $OAuthToken=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ApiKey'])) $this->ApiKey = $o['ApiKey'];
if (isset($o['OAuthToken'])) $this->OAuthToken = $o['OAuthToken'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ApiKey)) $o['ApiKey'] = $this->ApiKey;
if (isset($this->OAuthToken)) $o['OAuthToken'] = $this->OAuthToken;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class BaseSecureRequest extends BaseRequest implements JsonSerializable
{
/**
* @param string $ApiKey
* @param string|null $OAuthToken
*/
public function __construct(
string $ApiKey='',
?string $OAuthToken=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
/** @var string|null */
public ?string $Token=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
/** @var string|null */
public ?string $DeviceId=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
/** @var string */
public string $AppId=''
) {
parent::__construct($ApiKey,$OAuthToken);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Token'])) $this->Token = $o['Token'];
if (isset($o['DeviceId'])) $this->DeviceId = $o['DeviceId'];
if (isset($o['AppId'])) $this->AppId = $o['AppId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Token)) $o['Token'] = $this->Token;
if (isset($this->DeviceId)) $o['DeviceId'] = $this->DeviceId;
if (isset($this->AppId)) $o['AppId'] = $this->AppId;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class BaseResponseResult implements JsonSerializable
{
public function __construct(
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
/** @var string|null */
public ?string $StatusCode=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
/** @var string|null */
public ?string $Login=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
/** @var string|null */
public ?string $ErrorCode=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
/** @var string|null */
public ?string $ErrorDisplayText=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
/** @var string|null */
public ?string $ErrorMessage=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
/** @var string|null */
public ?string $DomainName=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
/** @var string|null */
public ?string $IpAddress=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['StatusCode'])) $this->StatusCode = $o['StatusCode'];
if (isset($o['Login'])) $this->Login = $o['Login'];
if (isset($o['ErrorCode'])) $this->ErrorCode = $o['ErrorCode'];
if (isset($o['ErrorDisplayText'])) $this->ErrorDisplayText = $o['ErrorDisplayText'];
if (isset($o['ErrorMessage'])) $this->ErrorMessage = $o['ErrorMessage'];
if (isset($o['DomainName'])) $this->DomainName = $o['DomainName'];
if (isset($o['IpAddress'])) $this->IpAddress = $o['IpAddress'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->StatusCode)) $o['StatusCode'] = $this->StatusCode;
if (isset($this->Login)) $o['Login'] = $this->Login;
if (isset($this->ErrorCode)) $o['ErrorCode'] = $this->ErrorCode;
if (isset($this->ErrorDisplayText)) $o['ErrorDisplayText'] = $this->ErrorDisplayText;
if (isset($this->ErrorMessage)) $o['ErrorMessage'] = $this->ErrorMessage;
if (isset($this->DomainName)) $o['DomainName'] = $this->DomainName;
if (isset($this->IpAddress)) $o['IpAddress'] = $this->IpAddress;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class BaseResponse implements JsonSerializable
{
public function __construct(
/** @description */
// @DataMember
// @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
/** @var BaseResponseResult|null */
public ?BaseResponseResult $Status=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Status'])) $this->Status = JsonConverters::from('BaseResponseResult', $o['Status']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Status)) $o['Status'] = JsonConverters::to('BaseResponseResult', $this->Status);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class AttributeValuePair implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $Name=null,
// @DataMember
/** @var string|null */
public ?string $Value=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Value'])) $this->Value = $o['Value'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Value)) $o['Value'] = $this->Value;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class ContactManagementRecord implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $Ref=null,
// @DataMember
/** @var DateTime */
public DateTime $DateTime=new DateTime(),
// @DataMember
/** @var string|null */
public ?string $Contact=null,
// @DataMember
/** @var int */
public int $CusAcct=0,
// @DataMember
/** @var int */
public int $ActionId=0,
// @DataMember
/** @var string|null */
public ?string $Status=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $ActionDate=null,
// @DataMember
/** @var bool|null */
public ?bool $PopUp=null,
// @DataMember
/** @var int|null */
public ?int $TopicId=null,
// @DataMember
/** @var string|null */
public ?string $Topic=null,
// @DataMember
/** @var bool|null */
public ?bool $Closed=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $ClosedDate=null,
// @DataMember
/** @var int */
public int $ColorValue=0,
// @DataMember
/** @var string|null */
public ?string $LanId=null,
// @DataMember
/** @var bool|null */
public ?bool $FormattedNotes=null,
// @DataMember
/** @var string|null */
public ?string $Note1=null,
// @DataMember
/** @var string|null */
public ?string $Note2=null,
// @DataMember
/** @var string|null */
public ?string $Note3=null,
// @DataMember
/** @var array<AttributeValuePair>|null */
public ?array $Attributes=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Ref'])) $this->Ref = $o['Ref'];
if (isset($o['DateTime'])) $this->DateTime = JsonConverters::from('DateTime', $o['DateTime']);
if (isset($o['Contact'])) $this->Contact = $o['Contact'];
if (isset($o['CusAcct'])) $this->CusAcct = $o['CusAcct'];
if (isset($o['ActionId'])) $this->ActionId = $o['ActionId'];
if (isset($o['Status'])) $this->Status = $o['Status'];
if (isset($o['ActionDate'])) $this->ActionDate = JsonConverters::from('DateTime', $o['ActionDate']);
if (isset($o['PopUp'])) $this->PopUp = $o['PopUp'];
if (isset($o['TopicId'])) $this->TopicId = $o['TopicId'];
if (isset($o['Topic'])) $this->Topic = $o['Topic'];
if (isset($o['Closed'])) $this->Closed = $o['Closed'];
if (isset($o['ClosedDate'])) $this->ClosedDate = JsonConverters::from('DateTime', $o['ClosedDate']);
if (isset($o['ColorValue'])) $this->ColorValue = $o['ColorValue'];
if (isset($o['LanId'])) $this->LanId = $o['LanId'];
if (isset($o['FormattedNotes'])) $this->FormattedNotes = $o['FormattedNotes'];
if (isset($o['Note1'])) $this->Note1 = $o['Note1'];
if (isset($o['Note2'])) $this->Note2 = $o['Note2'];
if (isset($o['Note3'])) $this->Note3 = $o['Note3'];
if (isset($o['Attributes'])) $this->Attributes = JsonConverters::fromArray('AttributeValuePair', $o['Attributes']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Ref)) $o['Ref'] = $this->Ref;
if (isset($this->DateTime)) $o['DateTime'] = JsonConverters::to('DateTime', $this->DateTime);
if (isset($this->Contact)) $o['Contact'] = $this->Contact;
if (isset($this->CusAcct)) $o['CusAcct'] = $this->CusAcct;
if (isset($this->ActionId)) $o['ActionId'] = $this->ActionId;
if (isset($this->Status)) $o['Status'] = $this->Status;
if (isset($this->ActionDate)) $o['ActionDate'] = JsonConverters::to('DateTime', $this->ActionDate);
if (isset($this->PopUp)) $o['PopUp'] = $this->PopUp;
if (isset($this->TopicId)) $o['TopicId'] = $this->TopicId;
if (isset($this->Topic)) $o['Topic'] = $this->Topic;
if (isset($this->Closed)) $o['Closed'] = $this->Closed;
if (isset($this->ClosedDate)) $o['ClosedDate'] = JsonConverters::to('DateTime', $this->ClosedDate);
if (isset($this->ColorValue)) $o['ColorValue'] = $this->ColorValue;
if (isset($this->LanId)) $o['LanId'] = $this->LanId;
if (isset($this->FormattedNotes)) $o['FormattedNotes'] = $this->FormattedNotes;
if (isset($this->Note1)) $o['Note1'] = $this->Note1;
if (isset($this->Note2)) $o['Note2'] = $this->Note2;
if (isset($this->Note3)) $o['Note3'] = $this->Note3;
if (isset($this->Attributes)) $o['Attributes'] = JsonConverters::toArray('AttributeValuePair', $this->Attributes);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class SearchContactManagementResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null,
// @DataMember
/** @var array<ContactManagementRecord>|null */
public ?array $ContactManagementRecords=null
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['ContactManagementRecords'])) $this->ContactManagementRecords = JsonConverters::fromArray('ContactManagementRecord', $o['ContactManagementRecords']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->ContactManagementRecords)) $o['ContactManagementRecords'] = JsonConverters::toArray('ContactManagementRecord', $this->ContactManagementRecords);
return empty($o) ? new class(){} : $o;
}
}
/** @description SearchContactManagement web service. */
// @DataContract
class SearchContactManagementRequest extends BaseSecureRequest implements JsonSerializable
{
/**
* @param string $ApiKey
* @param string|null $OAuthToken
* @param string|null $Token
* @param string|null $DeviceId
* @param string $AppId
*/
public function __construct(
string $ApiKey='',
?string $OAuthToken=null,
?string $Token=null,
?string $DeviceId=null,
string $AppId='',
// @DataMember
/** @var bool|null */
public ?bool $FormattedNotes=null,
/** @description If sent, all other search parameters will be ignored. */
// @DataMember
// @ApiMember(DataType="string", Description="If sent, all other search parameters will be ignored.", Name="Ref", ParameterType="query")
/** @var string|null */
public ?string $Ref=null,
// @DataMember
/** @var int|null */
public ?int $Acct=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $DateFrom=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $DateTo=null,
// @DataMember
/** @var bool|null */
public ?bool $IncludeClosed=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="SearchString", ParameterType="query")
/** @var string|null */
public ?string $SearchString=null,
// @DataMember
/** @var int|null */
public ?int $ActionId=null
) {
parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['FormattedNotes'])) $this->FormattedNotes = $o['FormattedNotes'];
if (isset($o['Ref'])) $this->Ref = $o['Ref'];
if (isset($o['Acct'])) $this->Acct = $o['Acct'];
if (isset($o['DateFrom'])) $this->DateFrom = JsonConverters::from('DateTime', $o['DateFrom']);
if (isset($o['DateTo'])) $this->DateTo = JsonConverters::from('DateTime', $o['DateTo']);
if (isset($o['IncludeClosed'])) $this->IncludeClosed = $o['IncludeClosed'];
if (isset($o['SearchString'])) $this->SearchString = $o['SearchString'];
if (isset($o['ActionId'])) $this->ActionId = $o['ActionId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->FormattedNotes)) $o['FormattedNotes'] = $this->FormattedNotes;
if (isset($this->Ref)) $o['Ref'] = $this->Ref;
if (isset($this->Acct)) $o['Acct'] = $this->Acct;
if (isset($this->DateFrom)) $o['DateFrom'] = JsonConverters::to('DateTime', $this->DateFrom);
if (isset($this->DateTo)) $o['DateTo'] = JsonConverters::to('DateTime', $this->DateTo);
if (isset($this->IncludeClosed)) $o['IncludeClosed'] = $this->IncludeClosed;
if (isset($this->SearchString)) $o['SearchString'] = $this->SearchString;
if (isset($this->ActionId)) $o['ActionId'] = $this->ActionId;
return empty($o) ? new class(){} : $o;
}
}
PHP SearchContactManagementRequest 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/SearchContactManagement HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SearchContactManagementRequest 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>
<Acct>0</Acct>
<ActionId>0</ActionId>
<DateFrom>0001-01-01T00:00:00</DateFrom>
<DateTo>0001-01-01T00:00:00</DateTo>
<FormattedNotes>false</FormattedNotes>
<IncludeClosed>false</IncludeClosed>
<Ref>String</Ref>
<SearchString>String</SearchString>
</SearchContactManagementRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SearchContactManagementResponse 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>
<ContactManagementRecords xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
<d2p1:ContactManagementRecord>
<d2p1:ActionDate>0001-01-01T00:00:00</d2p1:ActionDate>
<d2p1:ActionId>0</d2p1:ActionId>
<d2p1:Attributes>
<d2p1:AttributeValuePair>
<d2p1:Name>String</d2p1:Name>
<d2p1:Value>String</d2p1:Value>
</d2p1:AttributeValuePair>
</d2p1:Attributes>
<d2p1:Closed>false</d2p1:Closed>
<d2p1:ClosedDate>0001-01-01T00:00:00</d2p1:ClosedDate>
<d2p1:ColorValue>0</d2p1:ColorValue>
<d2p1:Contact>String</d2p1:Contact>
<d2p1:CusAcct>0</d2p1:CusAcct>
<d2p1:DateTime>0001-01-01T00:00:00</d2p1:DateTime>
<d2p1:FormattedNotes>false</d2p1:FormattedNotes>
<d2p1:LanId>String</d2p1:LanId>
<d2p1:Note1>String</d2p1:Note1>
<d2p1:Note2>String</d2p1:Note2>
<d2p1:Note3>String</d2p1:Note3>
<d2p1:PopUp>false</d2p1:PopUp>
<d2p1:Ref>String</d2p1:Ref>
<d2p1:Status>String</d2p1:Status>
<d2p1:Topic>String</d2p1:Topic>
<d2p1:TopicId>0</d2p1:TopicId>
</d2p1:ContactManagementRecord>
</ContactManagementRecords>
</SearchContactManagementResponse>