| POST | /v1/BackOrder/ValidateBulkStatusAllocations | Validates back order references and statuses provided in a csv file for allocation to active back orders. | Reads a csv file and parses a list of back order references, MBUK assistance statuses and messages for validation before allocation to active back orders. |
|---|
<?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 ValidateBackOrderBulkStatusAllocationsRequest implements JsonSerializable
{
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
return empty($o) ? new class(){} : $o;
}
}
class BackOrderStatusAllocation implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Row=0,
/** @var string|null */
public ?string $BackOrderReference=null,
/** @var string|null */
public ?string $Status=null,
/** @var string|null */
public ?string $Message=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Row'])) $this->Row = $o['Row'];
if (isset($o['BackOrderReference'])) $this->BackOrderReference = $o['BackOrderReference'];
if (isset($o['Status'])) $this->Status = $o['Status'];
if (isset($o['Message'])) $this->Message = $o['Message'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Row)) $o['Row'] = $this->Row;
if (isset($this->BackOrderReference)) $o['BackOrderReference'] = $this->BackOrderReference;
if (isset($this->Status)) $o['Status'] = $this->Status;
if (isset($this->Message)) $o['Message'] = $this->Message;
return empty($o) ? new class(){} : $o;
}
}
class InvalidBackOrderStatusAllocation extends BackOrderStatusAllocation implements JsonSerializable
{
/**
* @param int $Row
* @param string|null $BackOrderReference
* @param string|null $Status
* @param string|null $Message
*/
public function __construct(
int $Row=0,
?string $BackOrderReference=null,
?string $Status=null,
?string $Message=null,
/** @var string */
public string $ValidationMessage=''
) {
parent::__construct($Row,$BackOrderReference,$Status,$Message);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['ValidationMessage'])) $this->ValidationMessage = $o['ValidationMessage'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->ValidationMessage)) $o['ValidationMessage'] = $this->ValidationMessage;
return empty($o) ? new class(){} : $o;
}
}
class BackOrderBulkStatusAllocation implements JsonSerializable
{
public function __construct(
/** @var int */
public int $TotalBackOrders=0,
/** @var int */
public int $ValidBackOrders=0,
/** @var int */
public int $InvalidBackOrders=0,
/** @var array<BackOrderStatusAllocation>|null */
public ?array $Valid=null,
/** @var array<InvalidBackOrderStatusAllocation>|null */
public ?array $Invalid=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['TotalBackOrders'])) $this->TotalBackOrders = $o['TotalBackOrders'];
if (isset($o['ValidBackOrders'])) $this->ValidBackOrders = $o['ValidBackOrders'];
if (isset($o['InvalidBackOrders'])) $this->InvalidBackOrders = $o['InvalidBackOrders'];
if (isset($o['Valid'])) $this->Valid = JsonConverters::fromArray('BackOrderStatusAllocation', $o['Valid']);
if (isset($o['Invalid'])) $this->Invalid = JsonConverters::fromArray('InvalidBackOrderStatusAllocation', $o['Invalid']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->TotalBackOrders)) $o['TotalBackOrders'] = $this->TotalBackOrders;
if (isset($this->ValidBackOrders)) $o['ValidBackOrders'] = $this->ValidBackOrders;
if (isset($this->InvalidBackOrders)) $o['InvalidBackOrders'] = $this->InvalidBackOrders;
if (isset($this->Valid)) $o['Valid'] = JsonConverters::toArray('BackOrderStatusAllocation', $this->Valid);
if (isset($this->Invalid)) $o['Invalid'] = JsonConverters::toArray('InvalidBackOrderStatusAllocation', $this->Invalid);
return empty($o) ? new class(){} : $o;
}
}
class BackOrderBulkStatusAllocationsResponse implements JsonSerializable
{
public function __construct(
/** @var string */
public string $Message='',
/** @var BackOrderBulkStatusAllocation|null */
public ?BackOrderBulkStatusAllocation $BackOrders=null,
/** @var bool|null */
public ?bool $Successful=null,
/** @var string */
public string $Filename=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Message'])) $this->Message = $o['Message'];
if (isset($o['BackOrders'])) $this->BackOrders = JsonConverters::from('BackOrderBulkStatusAllocation', $o['BackOrders']);
if (isset($o['Successful'])) $this->Successful = $o['Successful'];
if (isset($o['Filename'])) $this->Filename = $o['Filename'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Message)) $o['Message'] = $this->Message;
if (isset($this->BackOrders)) $o['BackOrders'] = JsonConverters::to('BackOrderBulkStatusAllocation', $this->BackOrders);
if (isset($this->Successful)) $o['Successful'] = $this->Successful;
if (isset($this->Filename)) $o['Filename'] = $this->Filename;
return empty($o) ? new class(){} : $o;
}
}
PHP ValidateBackOrderBulkStatusAllocationsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/BackOrder/ValidateBulkStatusAllocations HTTP/1.1
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Message":"One or more errors in file","BackOrders":{"TotalBackOrders":2,"ValidBackOrders":1,"InvalidBackOrders":1,"Valid":[{"Row":0,"BackOrderReference":"String","Status":"String","Message":"String"}],"Invalid":[{"ValidationMessage":"String","Row":0,"BackOrderReference":"String","Status":"String","Message":"String"}]},"Successful":false,"Filename":"String"}