| POST | /api/PostServiceTicket |
|---|
<?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 PostServiceTicketResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null,
// @DataMember
/** @var string|null */
public ?string $WebRef=null
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['WebRef'])) $this->WebRef = $o['WebRef'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->WebRef)) $o['WebRef'] = $this->WebRef;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract(Name="CustomerInfo")
class CustomerInfo implements JsonSerializable
{
public function __construct(
/** @description The WebId of the customer. Optional. */
// @DataMember
// @ApiMember(DataType="integer", Description="The WebId of the customer. Optional.", Format="int32", IsRequired=true, Name="WebId", ParameterType="query")
/** @var int */
public int $WebId=0,
/** @description Name of the customer. */
// @DataMember
// @ApiMember(DataType="string", Description="Name of the customer.", IsRequired=true, Name="Name", ParameterType="query")
/** @var string */
public string $Name='',
/** @description Address line 1 of the customer */
// @DataMember
// @ApiMember(DataType="string", Description="Address line 1 of the customer", Name="Addr1", ParameterType="query")
/** @var string|null */
public ?string $Addr1=null,
/** @description Address line 2 of the customer */
// @DataMember
// @ApiMember(DataType="string", Description="Address line 2 of the customer", Name="Addr2", ParameterType="query")
/** @var string|null */
public ?string $Addr2=null,
/** @description City of the customer */
// @DataMember
// @ApiMember(DataType="string", Description="City of the customer", Name="City", ParameterType="query")
/** @var string|null */
public ?string $City=null,
/** @description State/Province of the customer */
// @DataMember
// @ApiMember(DataType="string", Description="State/Province of the customer", Name="St", ParameterType="query")
/** @var string|null */
public ?string $St=null,
/** @description Zip code of the customer */
// @DataMember
// @ApiMember(DataType="string", Description="Zip code of the customer", Name="Zip", ParameterType="query")
/** @var string|null */
public ?string $Zip=null,
/** @description Country of the customer */
// @DataMember
// @ApiMember(DataType="string", Description="Country of the customer", Name="Country", ParameterType="query")
/** @var string|null */
public ?string $Country=null,
/** @description Phone number of the customer */
// @DataMember
// @ApiMember(DataType="string", Description="Phone number of the customer", Name="Phone", ParameterType="query")
/** @var string|null */
public ?string $Phone=null,
/** @description Email address of the customer. Required. */
// @DataMember
// @ApiMember(DataType="string", Description="Email address of the customer. Required.", IsRequired=true, Name="Email", ParameterType="query")
/** @var string */
public string $Email=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['WebId'])) $this->WebId = $o['WebId'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Addr1'])) $this->Addr1 = $o['Addr1'];
if (isset($o['Addr2'])) $this->Addr2 = $o['Addr2'];
if (isset($o['City'])) $this->City = $o['City'];
if (isset($o['St'])) $this->St = $o['St'];
if (isset($o['Zip'])) $this->Zip = $o['Zip'];
if (isset($o['Country'])) $this->Country = $o['Country'];
if (isset($o['Phone'])) $this->Phone = $o['Phone'];
if (isset($o['Email'])) $this->Email = $o['Email'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->WebId)) $o['WebId'] = $this->WebId;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Addr1)) $o['Addr1'] = $this->Addr1;
if (isset($this->Addr2)) $o['Addr2'] = $this->Addr2;
if (isset($this->City)) $o['City'] = $this->City;
if (isset($this->St)) $o['St'] = $this->St;
if (isset($this->Zip)) $o['Zip'] = $this->Zip;
if (isset($this->Country)) $o['Country'] = $this->Country;
if (isset($this->Phone)) $o['Phone'] = $this->Phone;
if (isset($this->Email)) $o['Email'] = $this->Email;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract(Name="FormInput")
class FormInput implements JsonSerializable
{
public function __construct(
/** @description Field Name of the Input Field */
// @DataMember
// @ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query")
/** @var string */
public string $Key='',
/** @description Value of the Input Field. */
// @DataMember
// @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
/** @var string */
public string $Value='',
/** @description Whether or not the field is encryped with the C2B encryption key. */
// @DataMember
// @ApiMember(DataType="boolean", Description="Whether or not the field is encryped with the C2B encryption key.", IsRequired=true, Name="Encrypted", ParameterType="query")
/** @var bool|null */
public ?bool $Encrypted=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Key'])) $this->Key = $o['Key'];
if (isset($o['Value'])) $this->Value = $o['Value'];
if (isset($o['Encrypted'])) $this->Encrypted = $o['Encrypted'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Key)) $o['Key'] = $this->Key;
if (isset($this->Value)) $o['Value'] = $this->Value;
if (isset($this->Encrypted)) $o['Encrypted'] = $this->Encrypted;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract(Name="CCInfo")
class CcInfo implements JsonSerializable
{
public function __construct(
/** @description Token returned from processor */
// @DataMember
// @ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")
/** @var string */
public string $TokenStr='',
/** @description Card Type (VISA, MCARD, AMEX, DSCVR) */
// @DataMember
// @ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")
/** @var string */
public string $CardType='',
/** @description Last four of the card */
// @DataMember
// @ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")
/** @var string */
public string $LastFour='',
/** @description Expiration Date of the Card. (MM/YY) */
// @DataMember
// @ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")
/** @var string|null */
public ?string $Expiration=null,
/** @description Reason the card is on file. */
// @DataMember
// @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
/** @var string|null */
public ?string $ReasonOnFile=null,
/** @description ID of the existing Token Record in AIM, if applicable */
// @DataMember
// @ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query")
/** @var int|null */
public ?int $TokenPk=null,
/** @description Is this the customer's primary card? Defaults to false. */
// @DataMember
// @ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query")
/** @var bool|null */
public ?bool $Primary=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['TokenStr'])) $this->TokenStr = $o['TokenStr'];
if (isset($o['CardType'])) $this->CardType = $o['CardType'];
if (isset($o['LastFour'])) $this->LastFour = $o['LastFour'];
if (isset($o['Expiration'])) $this->Expiration = $o['Expiration'];
if (isset($o['ReasonOnFile'])) $this->ReasonOnFile = $o['ReasonOnFile'];
if (isset($o['TokenPk'])) $this->TokenPk = $o['TokenPk'];
if (isset($o['Primary'])) $this->Primary = $o['Primary'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->TokenStr)) $o['TokenStr'] = $this->TokenStr;
if (isset($this->CardType)) $o['CardType'] = $this->CardType;
if (isset($this->LastFour)) $o['LastFour'] = $this->LastFour;
if (isset($this->Expiration)) $o['Expiration'] = $this->Expiration;
if (isset($this->ReasonOnFile)) $o['ReasonOnFile'] = $this->ReasonOnFile;
if (isset($this->TokenPk)) $o['TokenPk'] = $this->TokenPk;
if (isset($this->Primary)) $o['Primary'] = $this->Primary;
return empty($o) ? new class(){} : $o;
}
}
/** @description PostServiceTicketRequires active-e Service Tickets Service */
// @DataContract
class PostServiceTicketRequest 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='',
/** @description Online reference number of this appointment */
// @DataMember
// @ApiMember(DataType="string", Description="Online reference number of this appointment", Name="RefNumber", ParameterType="query")
/** @var string|null */
public ?string $RefNumber=null,
/** @description Serial number of the item to be serviced */
// @DataMember
// @ApiMember(DataType="string", Description="Serial number of the item to be serviced", Name="SerialNumber", ParameterType="query")
/** @var string|null */
public ?string $SerialNumber=null,
/** @description The AIM customer account # of the customer. Optional. */
// @DataMember
// @ApiMember(DataType="integer", Description="The AIM customer account # of the customer. Optional.", Format="int32", Name="CustomerAcct", ParameterType="query")
/** @var int|null */
public ?int $CustomerAcct=null,
/** @description Customer Information */
// @DataMember
// @ApiMember(DataType="object", Description="Customer Information", Name="CustomerInfo", ParameterType="query")
/** @var CustomerInfo|null */
public ?CustomerInfo $CustomerInfo=null,
/** @description Additional Customer or Appointment info */
// @DataMember
// @ApiMember(DataType="array", Description="Additional Customer or Appointment info", Name="FormInputList", ParameterType="query")
/** @var array<FormInput>|null */
public ?array $FormInputList=null,
/** @description Credit Card info of the customer for this appointment */
// @DataMember
// @ApiMember(DataType="object", Description="Credit Card info of the customer for this appointment", Name="CcInfo", ParameterType="query")
/** @var CcInfo|null */
public ?CcInfo $CcInfo=null,
/** @description Notes on this appointment */
// @DataMember
// @ApiMember(DataType="string", Description="Notes on this appointment", Name="Notes", ParameterType="query")
/** @var string|null */
public ?string $Notes=null,
// @DataMember
/** @var string|null */
public ?string $VoiceRecording=null,
/** @description Description of the item to be serviced */
// @DataMember
// @ApiMember(DataType="string", Description="Description of the item to be serviced", Name="ItemDescription", ParameterType="query")
/** @var string|null */
public ?string $ItemDescription=null
) {
parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['RefNumber'])) $this->RefNumber = $o['RefNumber'];
if (isset($o['SerialNumber'])) $this->SerialNumber = $o['SerialNumber'];
if (isset($o['CustomerAcct'])) $this->CustomerAcct = $o['CustomerAcct'];
if (isset($o['CustomerInfo'])) $this->CustomerInfo = JsonConverters::from('CustomerInfo', $o['CustomerInfo']);
if (isset($o['FormInputList'])) $this->FormInputList = JsonConverters::fromArray('FormInput', $o['FormInputList']);
if (isset($o['CcInfo'])) $this->CcInfo = JsonConverters::from('CcInfo', $o['CcInfo']);
if (isset($o['Notes'])) $this->Notes = $o['Notes'];
if (isset($o['VoiceRecording'])) $this->VoiceRecording = $o['VoiceRecording'];
if (isset($o['ItemDescription'])) $this->ItemDescription = $o['ItemDescription'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->RefNumber)) $o['RefNumber'] = $this->RefNumber;
if (isset($this->SerialNumber)) $o['SerialNumber'] = $this->SerialNumber;
if (isset($this->CustomerAcct)) $o['CustomerAcct'] = $this->CustomerAcct;
if (isset($this->CustomerInfo)) $o['CustomerInfo'] = JsonConverters::to('CustomerInfo', $this->CustomerInfo);
if (isset($this->FormInputList)) $o['FormInputList'] = JsonConverters::toArray('FormInput', $this->FormInputList);
if (isset($this->CcInfo)) $o['CcInfo'] = JsonConverters::to('CcInfo', $this->CcInfo);
if (isset($this->Notes)) $o['Notes'] = $this->Notes;
if (isset($this->VoiceRecording)) $o['VoiceRecording'] = $this->VoiceRecording;
if (isset($this->ItemDescription)) $o['ItemDescription'] = $this->ItemDescription;
return empty($o) ? new class(){} : $o;
}
}
PHP PostServiceTicketRequest 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/PostServiceTicket HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PostServiceTicketRequest 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>
<CcInfo>
<CardType>String</CardType>
<Expiration>String</Expiration>
<LastFour>String</LastFour>
<Primary>false</Primary>
<ReasonOnFile>String</ReasonOnFile>
<TokenPk>0</TokenPk>
<TokenStr>String</TokenStr>
</CcInfo>
<CustomerAcct>0</CustomerAcct>
<CustomerInfo>
<Addr1>String</Addr1>
<Addr2>String</Addr2>
<City>String</City>
<Country>String</Country>
<Email>String</Email>
<Name>String</Name>
<Phone>String</Phone>
<St>String</St>
<WebId>0</WebId>
<Zip>String</Zip>
</CustomerInfo>
<FormInputList>
<FormInput>
<Encrypted>false</Encrypted>
<Key>String</Key>
<Value>String</Value>
</FormInput>
</FormInputList>
<ItemDescription>String</ItemDescription>
<Notes>String</Notes>
<RefNumber>String</RefNumber>
<SerialNumber>String</SerialNumber>
<VoiceRecording>String</VoiceRecording>
</PostServiceTicketRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PostServiceTicketResponse 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>
<WebRef>String</WebRef>
</PostServiceTicketResponse>