| POST | /v1/outrightpurchase/validate | Validate Outright Purchase |
|---|
<?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};
class OutrightPurchaseDiscount implements JsonSerializable
{
public function __construct(
/** @var string */
public string $BaumusterNST='',
/** @var float */
public float $DiscountPercentage=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['BaumusterNST'])) $this->BaumusterNST = $o['BaumusterNST'];
if (isset($o['DiscountPercentage'])) $this->DiscountPercentage = $o['DiscountPercentage'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->BaumusterNST)) $o['BaumusterNST'] = $this->BaumusterNST;
if (isset($this->DiscountPercentage)) $o['DiscountPercentage'] = $this->DiscountPercentage;
return empty($o) ? new class(){} : $o;
}
}
class OutrightPurchaseFleetCustomer implements JsonSerializable
{
public function __construct(
/** @var string */
public string $CustomerIdentifier='',
/** @var string */
public string $CompanyName='',
/** @var string */
public string $Title='',
/** @var string */
public string $FirstName='',
/** @var string */
public string $LastName='',
/** @var string */
public string $Email='',
/** @var string */
public string $PhoneNumber='',
/** @var string */
public string $HouseNumber='',
/** @var string */
public string $AddressLine2='',
/** @var string */
public string $Town='',
/** @var string */
public string $County='',
/** @var string */
public string $PostCode='',
/** @var array<OutrightPurchaseDiscount>|null */
public ?array $OutrightPurchaseCustomerDiscounts=null,
/** @var bool|null */
public ?bool $ImportSucessful=null,
/** @var bool|null */
public ?bool $IsEligibleCOPConverter=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CustomerIdentifier'])) $this->CustomerIdentifier = $o['CustomerIdentifier'];
if (isset($o['CompanyName'])) $this->CompanyName = $o['CompanyName'];
if (isset($o['Title'])) $this->Title = $o['Title'];
if (isset($o['FirstName'])) $this->FirstName = $o['FirstName'];
if (isset($o['LastName'])) $this->LastName = $o['LastName'];
if (isset($o['Email'])) $this->Email = $o['Email'];
if (isset($o['PhoneNumber'])) $this->PhoneNumber = $o['PhoneNumber'];
if (isset($o['HouseNumber'])) $this->HouseNumber = $o['HouseNumber'];
if (isset($o['AddressLine2'])) $this->AddressLine2 = $o['AddressLine2'];
if (isset($o['Town'])) $this->Town = $o['Town'];
if (isset($o['County'])) $this->County = $o['County'];
if (isset($o['PostCode'])) $this->PostCode = $o['PostCode'];
if (isset($o['OutrightPurchaseCustomerDiscounts'])) $this->OutrightPurchaseCustomerDiscounts = JsonConverters::fromArray('OutrightPurchaseDiscount', $o['OutrightPurchaseCustomerDiscounts']);
if (isset($o['ImportSucessful'])) $this->ImportSucessful = $o['ImportSucessful'];
if (isset($o['IsEligibleCOPConverter'])) $this->IsEligibleCOPConverter = $o['IsEligibleCOPConverter'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CustomerIdentifier)) $o['CustomerIdentifier'] = $this->CustomerIdentifier;
if (isset($this->CompanyName)) $o['CompanyName'] = $this->CompanyName;
if (isset($this->Title)) $o['Title'] = $this->Title;
if (isset($this->FirstName)) $o['FirstName'] = $this->FirstName;
if (isset($this->LastName)) $o['LastName'] = $this->LastName;
if (isset($this->Email)) $o['Email'] = $this->Email;
if (isset($this->PhoneNumber)) $o['PhoneNumber'] = $this->PhoneNumber;
if (isset($this->HouseNumber)) $o['HouseNumber'] = $this->HouseNumber;
if (isset($this->AddressLine2)) $o['AddressLine2'] = $this->AddressLine2;
if (isset($this->Town)) $o['Town'] = $this->Town;
if (isset($this->County)) $o['County'] = $this->County;
if (isset($this->PostCode)) $o['PostCode'] = $this->PostCode;
if (isset($this->OutrightPurchaseCustomerDiscounts)) $o['OutrightPurchaseCustomerDiscounts'] = JsonConverters::toArray('OutrightPurchaseDiscount', $this->OutrightPurchaseCustomerDiscounts);
if (isset($this->ImportSucessful)) $o['ImportSucessful'] = $this->ImportSucessful;
if (isset($this->IsEligibleCOPConverter)) $o['IsEligibleCOPConverter'] = $this->IsEligibleCOPConverter;
return empty($o) ? new class(){} : $o;
}
}
class ValidateOutRightPurchaseResponse implements JsonSerializable
{
public function __construct(
/** @var OutrightPurchaseFleetCustomer|null */
public ?OutrightPurchaseFleetCustomer $OutrightPurchaseFleetCustomer=null,
/** @var bool|null */
public ?bool $IsBackOrder=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['OutrightPurchaseFleetCustomer'])) $this->OutrightPurchaseFleetCustomer = JsonConverters::from('OutrightPurchaseFleetCustomer', $o['OutrightPurchaseFleetCustomer']);
if (isset($o['IsBackOrder'])) $this->IsBackOrder = $o['IsBackOrder'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->OutrightPurchaseFleetCustomer)) $o['OutrightPurchaseFleetCustomer'] = JsonConverters::to('OutrightPurchaseFleetCustomer', $this->OutrightPurchaseFleetCustomer);
if (isset($this->IsBackOrder)) $o['IsBackOrder'] = $this->IsBackOrder;
return empty($o) ? new class(){} : $o;
}
}
class ValidateOutRightPurchaseRequest extends ValidateOutRightPurchaseRequest implements IPost, JsonSerializable
{
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
return empty($o) ? new class(){} : $o;
}
}
PHP ValidateOutRightPurchaseRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/outrightpurchase/validate HTTP/1.1
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Criteria:
{
Reference: String,
Bm7NST: String,
IsBackOrder: False
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
OutrightPurchaseFleetCustomer:
{
CustomerIdentifier: String,
CompanyName: String,
Title: String,
FirstName: String,
LastName: String,
Email: String,
PhoneNumber: String,
HouseNumber: String,
AddressLine2: String,
Town: String,
County: String,
PostCode: String,
OutrightPurchaseCustomerDiscounts:
[
{
BaumusterNST: String,
DiscountPercentage: 0
}
],
ImportSucessful: False,
IsEligibleCOPConverter: False
},
IsBackOrder: False
}