| Requires any of the roles: | Client, Admin, Partner |
<?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 BatchErrorsResponse implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Records=0,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Records'])) $this->Records = $o['Records'];
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Records)) $o['Records'] = $this->Records;
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
class BatchErrorsRequest implements JsonSerializable
{
public function __construct(
/** @var int */
public int $BatchId=0,
// @DataMember(Order=3)
// @Required()
/** @var string */
public string $Type='',
// @DataMember(Order=4)
/** @var string|null */
public ?string $Message=null,
/** @var int */
public int $Row=0,
/** @var string|null */
public ?string $Code=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['BatchId'])) $this->BatchId = $o['BatchId'];
if (isset($o['Type'])) $this->Type = $o['Type'];
if (isset($o['Message'])) $this->Message = $o['Message'];
if (isset($o['Row'])) $this->Row = $o['Row'];
if (isset($o['Code'])) $this->Code = $o['Code'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->BatchId)) $o['BatchId'] = $this->BatchId;
if (isset($this->Type)) $o['Type'] = $this->Type;
if (isset($this->Message)) $o['Message'] = $this->Message;
if (isset($this->Row)) $o['Row'] = $this->Row;
if (isset($this->Code)) $o['Code'] = $this->Code;
return empty($o) ? new class(){} : $o;
}
}
/**
* @template array of BatchErrorsRequest
*/
class UploadBatchErrors extends \ArrayObject implements JsonSerializable
{
public function __construct(BatchErrorsRequest ...$items) {
parent::__construct($items, \ArrayObject::STD_PROP_LIST);
}
/** @throws \Exception */
public function append($value): void {
if ($value instanceof BatchErrorsRequest)
parent::append($value);
else
throw new \Exception("Can only append a BatchErrorsRequest to " . __CLASS__);
}
/** @throws Exception */
public function fromMap($o): void {
foreach ($o as $item) {
$el = new BatchErrorsRequest();
$el->fromMap($item);
$this->append($el);
}
}
/** @throws Exception */
public function jsonSerialize(): array {
return parent::getArrayCopy();
}
}
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 /xml/reply/UploadBatchErrors HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ArrayOfBatchErrorsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<BatchErrorsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
<Records>0</Records>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</BatchErrorsResponse>