| POST | /api/UpdateCustomer |
|---|
<?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 UpdateCustomerResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class LicenseInfo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $Number=null,
// @DataMember
/** @var string|null */
public ?string $Height=null,
// @DataMember
/** @var string|null */
public ?string $Weight=null,
// @DataMember
/** @var string|null */
public ?string $Hair=null,
// @DataMember
/** @var string|null */
public ?string $Eyes=null,
// @DataMember
/** @var string|null */
public ?string $Expiration=null,
// @DataMember
/** @var string|null */
public ?string $Birthday=null,
// @DataMember
/** @var string|null */
public ?string $Ethnicity=null,
// @DataMember
/** @var string|null */
public ?string $Gender=null,
// @DataMember
/** @var string|null */
public ?string $State=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Number'])) $this->Number = $o['Number'];
if (isset($o['Height'])) $this->Height = $o['Height'];
if (isset($o['Weight'])) $this->Weight = $o['Weight'];
if (isset($o['Hair'])) $this->Hair = $o['Hair'];
if (isset($o['Eyes'])) $this->Eyes = $o['Eyes'];
if (isset($o['Expiration'])) $this->Expiration = $o['Expiration'];
if (isset($o['Birthday'])) $this->Birthday = $o['Birthday'];
if (isset($o['Ethnicity'])) $this->Ethnicity = $o['Ethnicity'];
if (isset($o['Gender'])) $this->Gender = $o['Gender'];
if (isset($o['State'])) $this->State = $o['State'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Number)) $o['Number'] = $this->Number;
if (isset($this->Height)) $o['Height'] = $this->Height;
if (isset($this->Weight)) $o['Weight'] = $this->Weight;
if (isset($this->Hair)) $o['Hair'] = $this->Hair;
if (isset($this->Eyes)) $o['Eyes'] = $this->Eyes;
if (isset($this->Expiration)) $o['Expiration'] = $this->Expiration;
if (isset($this->Birthday)) $o['Birthday'] = $this->Birthday;
if (isset($this->Ethnicity)) $o['Ethnicity'] = $this->Ethnicity;
if (isset($this->Gender)) $o['Gender'] = $this->Gender;
if (isset($this->State)) $o['State'] = $this->State;
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;
}
}
/** @description UpdateCustomerRequires active-e Customer Service. */
// @DataContract
class UpdateCustomerRequest 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 Customer Acct # */
// @DataMember
// @ApiMember(DataType="integer", Description="Customer Acct #", Format="int32", IsRequired=true, Name="Acct", ParameterType="query")
/** @var int */
public int $Acct=0,
/** @description Location ID */
// @DataMember
// @ApiMember(DataType="integer", Description="Location ID", Format="int64", Name="LocationId", ParameterType="query")
/** @var int|null */
public ?int $LocationId=null,
/** @description Customer Default Id */
// @DataMember
// @ApiMember(DataType="integer", Description="Customer Default Id", Format="int64", Name="CustomerDefaultId", ParameterType="query")
/** @var int|null */
public ?int $CustomerDefaultId=null,
/** @description Tax Authority Id */
// @DataMember
// @ApiMember(DataType="integer", Description="Tax Authority Id", Format="int64", Name="TaxAuthorityId", ParameterType="query")
/** @var int|null */
public ?int $TaxAuthorityId=null,
// @DataMember
/** @var string|null */
public ?string $Name=null,
// @DataMember
/** @var string|null */
public ?string $Attn=null,
// @DataMember
/** @var string|null */
public ?string $Address1=null,
// @DataMember
/** @var string|null */
public ?string $Address2=null,
// @DataMember
/** @var string|null */
public ?string $City=null,
// @DataMember
/** @var string|null */
public ?string $State=null,
// @DataMember
/** @var string|null */
public ?string $Zip=null,
// @DataMember
/** @var string|null */
public ?string $Country=null,
// @DataMember
/** @var string|null */
public ?string $HomePhone=null,
// @DataMember
/** @var string|null */
public ?string $WorkPhone=null,
// @DataMember
/** @var string|null */
public ?string $CellPhone=null,
// @DataMember
/** @var string|null */
public ?string $Employer=null,
// @DataMember
/** @var string|null */
public ?string $SS=null,
// @DataMember
/** @var string|null */
public ?string $Email=null,
/** @description Email Method. Set this to Word, PDF, HTML, or None */
// @DataMember
// @ApiMember(DataType="string", Description="Email Method. Set this to Word, PDF, HTML, or None", Name="EmailMethod", ParameterType="query")
/** @var string|null */
public ?string $EmailMethod=null,
// @DataMember
/** @var string|null */
public ?string $Notes=null,
// @DataMember
/** @var LicenseInfo|null */
public ?LicenseInfo $DriversLicenseInfo=null,
/** @description If TRUE, all applicable settings from the customer default will be copied over to the customer. Generally only used when changing the customer default. */
// @DataMember
// @ApiMember(DataType="bool", Description="If TRUE, all applicable settings from the customer default will be copied over to the customer. Generally only used when changing the customer default.", Name="RefreshCustomerDefaults", ParameterType="query")
/** @var bool|null */
public ?bool $RefreshCustomerDefaults=null,
/** @description */
// @DataMember
// @ApiMember(DataType="array", Description="", Name="FormInputList", ParameterType="query")
/** @var array<FormInput>|null */
public ?array $FormInputList=null
) {
parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Acct'])) $this->Acct = $o['Acct'];
if (isset($o['LocationId'])) $this->LocationId = $o['LocationId'];
if (isset($o['CustomerDefaultId'])) $this->CustomerDefaultId = $o['CustomerDefaultId'];
if (isset($o['TaxAuthorityId'])) $this->TaxAuthorityId = $o['TaxAuthorityId'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Attn'])) $this->Attn = $o['Attn'];
if (isset($o['Address1'])) $this->Address1 = $o['Address1'];
if (isset($o['Address2'])) $this->Address2 = $o['Address2'];
if (isset($o['City'])) $this->City = $o['City'];
if (isset($o['State'])) $this->State = $o['State'];
if (isset($o['Zip'])) $this->Zip = $o['Zip'];
if (isset($o['Country'])) $this->Country = $o['Country'];
if (isset($o['HomePhone'])) $this->HomePhone = $o['HomePhone'];
if (isset($o['WorkPhone'])) $this->WorkPhone = $o['WorkPhone'];
if (isset($o['CellPhone'])) $this->CellPhone = $o['CellPhone'];
if (isset($o['Employer'])) $this->Employer = $o['Employer'];
if (isset($o['SS'])) $this->SS = $o['SS'];
if (isset($o['Email'])) $this->Email = $o['Email'];
if (isset($o['EmailMethod'])) $this->EmailMethod = $o['EmailMethod'];
if (isset($o['Notes'])) $this->Notes = $o['Notes'];
if (isset($o['DriversLicenseInfo'])) $this->DriversLicenseInfo = JsonConverters::from('LicenseInfo', $o['DriversLicenseInfo']);
if (isset($o['RefreshCustomerDefaults'])) $this->RefreshCustomerDefaults = $o['RefreshCustomerDefaults'];
if (isset($o['FormInputList'])) $this->FormInputList = JsonConverters::fromArray('FormInput', $o['FormInputList']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Acct)) $o['Acct'] = $this->Acct;
if (isset($this->LocationId)) $o['LocationId'] = $this->LocationId;
if (isset($this->CustomerDefaultId)) $o['CustomerDefaultId'] = $this->CustomerDefaultId;
if (isset($this->TaxAuthorityId)) $o['TaxAuthorityId'] = $this->TaxAuthorityId;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Attn)) $o['Attn'] = $this->Attn;
if (isset($this->Address1)) $o['Address1'] = $this->Address1;
if (isset($this->Address2)) $o['Address2'] = $this->Address2;
if (isset($this->City)) $o['City'] = $this->City;
if (isset($this->State)) $o['State'] = $this->State;
if (isset($this->Zip)) $o['Zip'] = $this->Zip;
if (isset($this->Country)) $o['Country'] = $this->Country;
if (isset($this->HomePhone)) $o['HomePhone'] = $this->HomePhone;
if (isset($this->WorkPhone)) $o['WorkPhone'] = $this->WorkPhone;
if (isset($this->CellPhone)) $o['CellPhone'] = $this->CellPhone;
if (isset($this->Employer)) $o['Employer'] = $this->Employer;
if (isset($this->SS)) $o['SS'] = $this->SS;
if (isset($this->Email)) $o['Email'] = $this->Email;
if (isset($this->EmailMethod)) $o['EmailMethod'] = $this->EmailMethod;
if (isset($this->Notes)) $o['Notes'] = $this->Notes;
if (isset($this->DriversLicenseInfo)) $o['DriversLicenseInfo'] = JsonConverters::to('LicenseInfo', $this->DriversLicenseInfo);
if (isset($this->RefreshCustomerDefaults)) $o['RefreshCustomerDefaults'] = $this->RefreshCustomerDefaults;
if (isset($this->FormInputList)) $o['FormInputList'] = JsonConverters::toArray('FormInput', $this->FormInputList);
return empty($o) ? new class(){} : $o;
}
}
PHP UpdateCustomerRequest 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/UpdateCustomer HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateCustomerRequest 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>
<Address1>String</Address1>
<Address2>String</Address2>
<Attn>String</Attn>
<CellPhone>String</CellPhone>
<City>String</City>
<Country>String</Country>
<CustomerDefaultId>0</CustomerDefaultId>
<DriversLicenseInfo>
<Birthday>String</Birthday>
<Ethnicity>String</Ethnicity>
<Expiration>String</Expiration>
<Eyes>String</Eyes>
<Gender>String</Gender>
<Hair>String</Hair>
<Height>String</Height>
<Number>String</Number>
<State>String</State>
<Weight>String</Weight>
</DriversLicenseInfo>
<Email>String</Email>
<EmailMethod>String</EmailMethod>
<Employer>String</Employer>
<FormInputList>
<FormInput>
<Encrypted>false</Encrypted>
<Key>String</Key>
<Value>String</Value>
</FormInput>
</FormInputList>
<HomePhone>String</HomePhone>
<LocationId>0</LocationId>
<Name>String</Name>
<Notes>String</Notes>
<RefreshCustomerDefaults>false</RefreshCustomerDefaults>
<SS>String</SS>
<State>String</State>
<TaxAuthorityId>0</TaxAuthorityId>
<WorkPhone>String</WorkPhone>
<Zip>String</Zip>
</UpdateCustomerRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<UpdateCustomerResponse 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>
</UpdateCustomerResponse>