| POST,OPTIONS | /v1/import/{Type}/preview |
|---|
<?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 ImportRowResult implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Line=0,
/** @var string|null */
public ?string $Action=null,
/** @var string|null */
public ?string $Field=null,
/** @var string|null */
public ?string $Message=null,
/** @var string|null */
public ?string $Summary=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Line'])) $this->Line = $o['Line'];
if (isset($o['Action'])) $this->Action = $o['Action'];
if (isset($o['Field'])) $this->Field = $o['Field'];
if (isset($o['Message'])) $this->Message = $o['Message'];
if (isset($o['Summary'])) $this->Summary = $o['Summary'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Line)) $o['Line'] = $this->Line;
if (isset($this->Action)) $o['Action'] = $this->Action;
if (isset($this->Field)) $o['Field'] = $this->Field;
if (isset($this->Message)) $o['Message'] = $this->Message;
if (isset($this->Summary)) $o['Summary'] = $this->Summary;
return empty($o) ? new class(){} : $o;
}
}
class ImportResult implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $ImportType=null,
/** @var string|null */
public ?string $FileName=null,
/** @var bool|null */
public ?bool $DryRun=null,
/** @var int */
public int $ImportBatchId=0,
/** @var int */
public int $TotalRows=0,
/** @var int */
public int $NewRows=0,
/** @var int */
public int $UpdatedRows=0,
/** @var int */
public int $SkippedRows=0,
/** @var int */
public int $ErrorRows=0,
/** @var array<ImportRowResult>|null */
public ?array $Rows=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ImportType'])) $this->ImportType = $o['ImportType'];
if (isset($o['FileName'])) $this->FileName = $o['FileName'];
if (isset($o['DryRun'])) $this->DryRun = $o['DryRun'];
if (isset($o['ImportBatchId'])) $this->ImportBatchId = $o['ImportBatchId'];
if (isset($o['TotalRows'])) $this->TotalRows = $o['TotalRows'];
if (isset($o['NewRows'])) $this->NewRows = $o['NewRows'];
if (isset($o['UpdatedRows'])) $this->UpdatedRows = $o['UpdatedRows'];
if (isset($o['SkippedRows'])) $this->SkippedRows = $o['SkippedRows'];
if (isset($o['ErrorRows'])) $this->ErrorRows = $o['ErrorRows'];
if (isset($o['Rows'])) $this->Rows = JsonConverters::fromArray('ImportRowResult', $o['Rows']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ImportType)) $o['ImportType'] = $this->ImportType;
if (isset($this->FileName)) $o['FileName'] = $this->FileName;
if (isset($this->DryRun)) $o['DryRun'] = $this->DryRun;
if (isset($this->ImportBatchId)) $o['ImportBatchId'] = $this->ImportBatchId;
if (isset($this->TotalRows)) $o['TotalRows'] = $this->TotalRows;
if (isset($this->NewRows)) $o['NewRows'] = $this->NewRows;
if (isset($this->UpdatedRows)) $o['UpdatedRows'] = $this->UpdatedRows;
if (isset($this->SkippedRows)) $o['SkippedRows'] = $this->SkippedRows;
if (isset($this->ErrorRows)) $o['ErrorRows'] = $this->ErrorRows;
if (isset($this->Rows)) $o['Rows'] = JsonConverters::toArray('ImportRowResult', $this->Rows);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
class ImportPreviewRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Type=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Type'])) $this->Type = $o['Type'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Type)) $o['Type'] = $this->Type;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/import/{Type}/preview HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Type":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ImportType":"String","FileName":"String","DryRun":false,"ImportBatchId":0,"TotalRows":0,"NewRows":0,"UpdatedRows":0,"SkippedRows":0,"ErrorRows":0,"Rows":[{"Line":0,"Action":"String","Field":"String","Message":"String","Summary":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}