| POST | /api/AddCustomer |
|---|
<?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 BindableObject implements JsonSerializable
{
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class DependantRecord implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $Name=null,
// @DataMember
/** @var string|null */
public ?string $OnlineId=null,
// @DataMember
/** @var string|null */
public ?string $SchoolDistrict=null,
// @DataMember
/** @var string|null */
public ?string $School=null,
// @DataMember
/** @var int */
public int $Id=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['OnlineId'])) $this->OnlineId = $o['OnlineId'];
if (isset($o['SchoolDistrict'])) $this->SchoolDistrict = $o['SchoolDistrict'];
if (isset($o['School'])) $this->School = $o['School'];
if (isset($o['Id'])) $this->Id = $o['Id'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->OnlineId)) $o['OnlineId'] = $this->OnlineId;
if (isset($this->SchoolDistrict)) $o['SchoolDistrict'] = $this->SchoolDistrict;
if (isset($this->School)) $o['School'] = $this->School;
if (isset($this->Id)) $o['Id'] = $this->Id;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class CustomerDefaultInfo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var int */
public int $Id=0,
// @DataMember
/** @var string|null */
public ?string $Desc=null,
// @DataMember
/** @var string|null */
public ?string $ShortDesc=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Desc'])) $this->Desc = $o['Desc'];
if (isset($o['ShortDesc'])) $this->ShortDesc = $o['ShortDesc'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Desc)) $o['Desc'] = $this->Desc;
if (isset($this->ShortDesc)) $o['ShortDesc'] = $this->ShortDesc;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class TaxAuthorityInfo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var int */
public int $Id=0,
// @DataMember
/** @var string|null */
public ?string $Desc=null,
// @DataMember
/** @var string|null */
public ?string $ShortDesc=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Desc'])) $this->Desc = $o['Desc'];
if (isset($o['ShortDesc'])) $this->ShortDesc = $o['ShortDesc'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Desc)) $o['Desc'] = $this->Desc;
if (isset($this->ShortDesc)) $o['ShortDesc'] = $this->ShortDesc;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class LocationInfo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var int */
public int $Id=0,
// @DataMember
/** @var string|null */
public ?string $Desc=null,
// @DataMember
/** @var string|null */
public ?string $ShortDesc=null,
// @DataMember
/** @var string|null */
public ?string $Region=null,
// @DataMember
/** @var float */
public float $Latitude=0.0,
// @DataMember
/** @var float */
public float $Longitude=0.0,
// @DataMember
/** @var string|null */
public ?string $InStorePickup=null,
// @DataMember
/** @var bool|null */
public ?bool $Active=null,
// @DataMember
/** @var int|null */
public ?int $CashSaleAcct=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Desc'])) $this->Desc = $o['Desc'];
if (isset($o['ShortDesc'])) $this->ShortDesc = $o['ShortDesc'];
if (isset($o['Region'])) $this->Region = $o['Region'];
if (isset($o['Latitude'])) $this->Latitude = $o['Latitude'];
if (isset($o['Longitude'])) $this->Longitude = $o['Longitude'];
if (isset($o['InStorePickup'])) $this->InStorePickup = $o['InStorePickup'];
if (isset($o['Active'])) $this->Active = $o['Active'];
if (isset($o['CashSaleAcct'])) $this->CashSaleAcct = $o['CashSaleAcct'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Desc)) $o['Desc'] = $this->Desc;
if (isset($this->ShortDesc)) $o['ShortDesc'] = $this->ShortDesc;
if (isset($this->Region)) $o['Region'] = $this->Region;
if (isset($this->Latitude)) $o['Latitude'] = $this->Latitude;
if (isset($this->Longitude)) $o['Longitude'] = $this->Longitude;
if (isset($this->InStorePickup)) $o['InStorePickup'] = $this->InStorePickup;
if (isset($this->Active)) $o['Active'] = $this->Active;
if (isset($this->CashSaleAcct)) $o['CashSaleAcct'] = $this->CashSaleAcct;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class AdditionalDetail implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var DateTime */
public DateTime $CreationDate=new DateTime(),
// @DataMember
/** @var DateTime */
public DateTime $LastModifiedDate=new DateTime(),
// @DataMember
/** @var string|null */
public ?string $Notes=null,
// @DataMember
/** @var CustomerDefaultInfo|null */
public ?CustomerDefaultInfo $CustomerDefault=null,
// @DataMember
/** @var TaxAuthorityInfo|null */
public ?TaxAuthorityInfo $TaxAuthority=null,
// @DataMember
/** @var bool|null */
public ?bool $CanCharge=null,
// @DataMember
/** @var string|null */
public ?string $PopupNotes=null,
// @DataMember
/** @var string|null */
public ?string $DlNumber=null,
// @DataMember
/** @var string|null */
public ?string $Phone2=null,
// @DataMember
/** @var string|null */
public ?string $Phone3=null,
// @DataMember
/** @var string|null */
public ?string $Phone4=null,
// @DataMember
/** @var LocationInfo|null */
public ?LocationInfo $Location=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CreationDate'])) $this->CreationDate = JsonConverters::from('DateTime', $o['CreationDate']);
if (isset($o['LastModifiedDate'])) $this->LastModifiedDate = JsonConverters::from('DateTime', $o['LastModifiedDate']);
if (isset($o['Notes'])) $this->Notes = $o['Notes'];
if (isset($o['CustomerDefault'])) $this->CustomerDefault = JsonConverters::from('CustomerDefaultInfo', $o['CustomerDefault']);
if (isset($o['TaxAuthority'])) $this->TaxAuthority = JsonConverters::from('TaxAuthorityInfo', $o['TaxAuthority']);
if (isset($o['CanCharge'])) $this->CanCharge = $o['CanCharge'];
if (isset($o['PopupNotes'])) $this->PopupNotes = $o['PopupNotes'];
if (isset($o['DlNumber'])) $this->DlNumber = $o['DlNumber'];
if (isset($o['Phone2'])) $this->Phone2 = $o['Phone2'];
if (isset($o['Phone3'])) $this->Phone3 = $o['Phone3'];
if (isset($o['Phone4'])) $this->Phone4 = $o['Phone4'];
if (isset($o['Location'])) $this->Location = JsonConverters::from('LocationInfo', $o['Location']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CreationDate)) $o['CreationDate'] = JsonConverters::to('DateTime', $this->CreationDate);
if (isset($this->LastModifiedDate)) $o['LastModifiedDate'] = JsonConverters::to('DateTime', $this->LastModifiedDate);
if (isset($this->Notes)) $o['Notes'] = $this->Notes;
if (isset($this->CustomerDefault)) $o['CustomerDefault'] = JsonConverters::to('CustomerDefaultInfo', $this->CustomerDefault);
if (isset($this->TaxAuthority)) $o['TaxAuthority'] = JsonConverters::to('TaxAuthorityInfo', $this->TaxAuthority);
if (isset($this->CanCharge)) $o['CanCharge'] = $this->CanCharge;
if (isset($this->PopupNotes)) $o['PopupNotes'] = $this->PopupNotes;
if (isset($this->DlNumber)) $o['DlNumber'] = $this->DlNumber;
if (isset($this->Phone2)) $o['Phone2'] = $this->Phone2;
if (isset($this->Phone3)) $o['Phone3'] = $this->Phone3;
if (isset($this->Phone4)) $o['Phone4'] = $this->Phone4;
if (isset($this->Location)) $o['Location'] = JsonConverters::to('LocationInfo', $this->Location);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class CustomerSearchRecord extends BindableObject implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var int */
public int $Pk=0,
// @DataMember
/** @var int */
public int $Acct=0,
// @DataMember
/** @var string|null */
public ?string $Last=null,
// @DataMember
/** @var string|null */
public ?string $Name=null,
// @DataMember
/** @var string|null */
public ?string $Addr1=null,
// @DataMember
/** @var string|null */
public ?string $Addr2=null,
// @DataMember
/** @var string|null */
public ?string $City=null,
// @DataMember
/** @var string|null */
public ?string $St=null,
// @DataMember
/** @var string|null */
public ?string $Zip=null,
// @DataMember
/** @var string|null */
public ?string $Phone=null,
// @DataMember
/** @var string|null */
public ?string $Email=null,
// @DataMember
/** @var bool|null */
public ?bool $OpenInvoices=null,
// @DataMember
/** @var bool|null */
public ?bool $RentalActivity=null,
// @DataMember
/** @var string|null */
public ?string $StLoc=null,
// @DataMember
/** @var bool|null */
public ?bool $Hold=null,
// @DataMember
/** @var string|null */
public ?string $Barcode=null,
// @DataMember
/** @var int */
public int $Color=0,
// @DataMember
/** @var array<DependantRecord>|null */
public ?array $DependantInfo=null,
// @DataMember
/** @var AdditionalDetail|null */
public ?AdditionalDetail $AdditionalDetails=null,
// @DataMember
/** @var string|null */
public ?string $MatchedOn=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Pk'])) $this->Pk = $o['Pk'];
if (isset($o['Acct'])) $this->Acct = $o['Acct'];
if (isset($o['Last'])) $this->Last = $o['Last'];
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['Phone'])) $this->Phone = $o['Phone'];
if (isset($o['Email'])) $this->Email = $o['Email'];
if (isset($o['OpenInvoices'])) $this->OpenInvoices = $o['OpenInvoices'];
if (isset($o['RentalActivity'])) $this->RentalActivity = $o['RentalActivity'];
if (isset($o['StLoc'])) $this->StLoc = $o['StLoc'];
if (isset($o['Hold'])) $this->Hold = $o['Hold'];
if (isset($o['Barcode'])) $this->Barcode = $o['Barcode'];
if (isset($o['Color'])) $this->Color = $o['Color'];
if (isset($o['DependantInfo'])) $this->DependantInfo = JsonConverters::fromArray('DependantRecord', $o['DependantInfo']);
if (isset($o['AdditionalDetails'])) $this->AdditionalDetails = JsonConverters::from('AdditionalDetail', $o['AdditionalDetails']);
if (isset($o['MatchedOn'])) $this->MatchedOn = $o['MatchedOn'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Pk)) $o['Pk'] = $this->Pk;
if (isset($this->Acct)) $o['Acct'] = $this->Acct;
if (isset($this->Last)) $o['Last'] = $this->Last;
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->Phone)) $o['Phone'] = $this->Phone;
if (isset($this->Email)) $o['Email'] = $this->Email;
if (isset($this->OpenInvoices)) $o['OpenInvoices'] = $this->OpenInvoices;
if (isset($this->RentalActivity)) $o['RentalActivity'] = $this->RentalActivity;
if (isset($this->StLoc)) $o['StLoc'] = $this->StLoc;
if (isset($this->Hold)) $o['Hold'] = $this->Hold;
if (isset($this->Barcode)) $o['Barcode'] = $this->Barcode;
if (isset($this->Color)) $o['Color'] = $this->Color;
if (isset($this->DependantInfo)) $o['DependantInfo'] = JsonConverters::toArray('DependantRecord', $this->DependantInfo);
if (isset($this->AdditionalDetails)) $o['AdditionalDetails'] = JsonConverters::to('AdditionalDetail', $this->AdditionalDetails);
if (isset($this->MatchedOn)) $o['MatchedOn'] = $this->MatchedOn;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class AddCustomerResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null,
// @DataMember
/** @var int|null */
public ?int $Id=null,
/** @description Only returned if PerformDuplicateCheck parameter was passed in and possible duplicates were found. If this is returned, the customer record was *not* created. */
// @DataMember
// @ApiMember(DataType="string", Description="Only returned if PerformDuplicateCheck parameter was passed in and possible duplicates were found. If this is returned, the customer record was *not* created.", Name="PossibleDuplicates")
/** @var array<CustomerSearchRecord>|null */
public ?array $PossibleDuplicates=null
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['PossibleDuplicates'])) $this->PossibleDuplicates = JsonConverters::fromArray('CustomerSearchRecord', $o['PossibleDuplicates']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->PossibleDuplicates)) $o['PossibleDuplicates'] = JsonConverters::toArray('CustomerSearchRecord', $this->PossibleDuplicates);
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 AddCustomerRequires active-e Customer Service. */
// @DataContract
class AddCustomerRequest 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 Location ID */
// @DataMember
// @ApiMember(DataType="integer", Description="Location ID", Format="int64", IsRequired=true, Name="LocationId", ParameterType="query")
/** @var int */
public int $LocationId=0,
/** @description Customer Default Id */
// @DataMember
// @ApiMember(DataType="integer", Description="Customer Default Id", Format="int64", IsRequired=true, Name="CustomerDefaultId", ParameterType="query")
/** @var int */
public int $CustomerDefaultId=0,
/** @description Tax Authority Id */
// @DataMember
// @ApiMember(DataType="integer", Description="Tax Authority Id", Format="int64", IsRequired=true, Name="TaxAuthorityId", ParameterType="query")
/** @var int */
public int $TaxAuthorityId=0,
// @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 */
// @DataMember
// @ApiMember(DataType="array", Description="", Name="FormInputList", ParameterType="query")
/** @var array<FormInput>|null */
public ?array $FormInputList=null,
/** @description Can be SKIP, CHECK, or CHECKONLY. Defaults to SKIP. SKIP will not do a duplicate check. CHECK will do a duplicate check and the customer will not added if duplicates are found. CHECKONLY will just do a duplicate check; the customer will not be added. Duplicate check logic is based on the AIM system variable CustDupCheck. */
// @DataMember
// @ApiMember(Description="Can be SKIP, CHECK, or CHECKONLY. Defaults to SKIP. SKIP will not do a duplicate check. CHECK will do a duplicate check and the customer will not added if duplicates are found. CHECKONLY will just do a duplicate check; the customer will not be added. Duplicate check logic is based on the AIM system variable CustDupCheck.", Name="DuplicateCheckMode")
/** @var string|null */
public ?string $DuplicateCheckMode=null
) {
parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
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['FormInputList'])) $this->FormInputList = JsonConverters::fromArray('FormInput', $o['FormInputList']);
if (isset($o['DuplicateCheckMode'])) $this->DuplicateCheckMode = $o['DuplicateCheckMode'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
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->FormInputList)) $o['FormInputList'] = JsonConverters::toArray('FormInput', $this->FormInputList);
if (isset($this->DuplicateCheckMode)) $o['DuplicateCheckMode'] = $this->DuplicateCheckMode;
return empty($o) ? new class(){} : $o;
}
}
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/AddCustomer HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AddCustomerRequest 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>
<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>
<DuplicateCheckMode>String</DuplicateCheckMode>
<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>
<SS>String</SS>
<State>String</State>
<TaxAuthorityId>0</TaxAuthorityId>
<WorkPhone>String</WorkPhone>
<Zip>String</Zip>
</AddCustomerRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AddCustomerResponse 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>
<Id>0</Id>
<PossibleDuplicates xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
<d2p1:CustomerSearchRecord>
<d2p1:Acct>0</d2p1:Acct>
<d2p1:AdditionalDetails>
<d2p1:CanCharge>false</d2p1:CanCharge>
<d2p1:CreationDate>0001-01-01T00:00:00</d2p1:CreationDate>
<d2p1:CustomerDefault>
<d2p1:Desc>String</d2p1:Desc>
<d2p1:Id>0</d2p1:Id>
<d2p1:ShortDesc>String</d2p1:ShortDesc>
</d2p1:CustomerDefault>
<d2p1:DlNumber>String</d2p1:DlNumber>
<d2p1:LastModifiedDate>0001-01-01T00:00:00</d2p1:LastModifiedDate>
<d2p1:Location>
<d2p1:Active>false</d2p1:Active>
<d2p1:CashSaleAcct>0</d2p1:CashSaleAcct>
<d2p1:Desc>String</d2p1:Desc>
<d2p1:Id>0</d2p1:Id>
<d2p1:InStorePickup>String</d2p1:InStorePickup>
<d2p1:Latitude>0</d2p1:Latitude>
<d2p1:Longitude>0</d2p1:Longitude>
<d2p1:Region>String</d2p1:Region>
<d2p1:ShortDesc>String</d2p1:ShortDesc>
</d2p1:Location>
<d2p1:Notes>String</d2p1:Notes>
<d2p1:Phone2>String</d2p1:Phone2>
<d2p1:Phone3>String</d2p1:Phone3>
<d2p1:Phone4>String</d2p1:Phone4>
<d2p1:PopupNotes>String</d2p1:PopupNotes>
<d2p1:TaxAuthority>
<d2p1:Desc>String</d2p1:Desc>
<d2p1:Id>0</d2p1:Id>
<d2p1:ShortDesc>String</d2p1:ShortDesc>
</d2p1:TaxAuthority>
</d2p1:AdditionalDetails>
<d2p1:Addr1>String</d2p1:Addr1>
<d2p1:Addr2>String</d2p1:Addr2>
<d2p1:Barcode>String</d2p1:Barcode>
<d2p1:City>String</d2p1:City>
<d2p1:Color>0</d2p1:Color>
<d2p1:DependantInfo>
<d2p1:CustomerSearchRecord.DependantRecord>
<d2p1:Id>0</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
<d2p1:OnlineId>String</d2p1:OnlineId>
<d2p1:School>String</d2p1:School>
<d2p1:SchoolDistrict>String</d2p1:SchoolDistrict>
</d2p1:CustomerSearchRecord.DependantRecord>
</d2p1:DependantInfo>
<d2p1:Email>String</d2p1:Email>
<d2p1:Hold>false</d2p1:Hold>
<d2p1:Last>String</d2p1:Last>
<d2p1:MatchedOn>String</d2p1:MatchedOn>
<d2p1:Name>String</d2p1:Name>
<d2p1:OpenInvoices>false</d2p1:OpenInvoices>
<d2p1:Phone>String</d2p1:Phone>
<d2p1:Pk>0</d2p1:Pk>
<d2p1:RentalActivity>false</d2p1:RentalActivity>
<d2p1:St>String</d2p1:St>
<d2p1:StLoc>String</d2p1:StLoc>
<d2p1:Zip>String</d2p1:Zip>
</d2p1:CustomerSearchRecord>
</PossibleDuplicates>
</AddCustomerResponse>