| POST,OPTIONS | /v1/records/entry |
|---|
<?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 RecordsOkResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var bool|null */
public ?bool $Ok=null,
/** @var int */
public int $Id=0,
/** @var string|null */
public ?string $Key=null,
/** @var array<string>|null */
public ?array $Matches=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['Ok'])) $this->Ok = $o['Ok'];
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Key'])) $this->Key = $o['Key'];
if (isset($o['Matches'])) $this->Matches = JsonConverters::fromArray('string', $o['Matches']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->Ok)) $o['Ok'] = $this->Ok;
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Key)) $o['Key'] = $this->Key;
if (isset($this->Matches)) $o['Matches'] = JsonConverters::toArray('string', $this->Matches);
return empty($o) ? new class(){} : $o;
}
}
class RecordCreateRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Name=null,
/** @var int|null */
public ?int $SeriesId=null,
/** @var string|null */
public ?string $Classification=null,
/** @var string|null */
public ?string $Format=null,
/** @var string|null */
public ?string $TriggerDate=null,
/** @var string|null */
public ?string $MetaJson=null,
/** @var string|null */
public ?string $FilesJson=null,
/** @var string|null */
public ?string $Warehouse=null,
/** @var string|null */
public ?string $Aisle=null,
/** @var string|null */
public ?string $Shelf=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['SeriesId'])) $this->SeriesId = $o['SeriesId'];
if (isset($o['Classification'])) $this->Classification = $o['Classification'];
if (isset($o['Format'])) $this->Format = $o['Format'];
if (isset($o['TriggerDate'])) $this->TriggerDate = $o['TriggerDate'];
if (isset($o['MetaJson'])) $this->MetaJson = $o['MetaJson'];
if (isset($o['FilesJson'])) $this->FilesJson = $o['FilesJson'];
if (isset($o['Warehouse'])) $this->Warehouse = $o['Warehouse'];
if (isset($o['Aisle'])) $this->Aisle = $o['Aisle'];
if (isset($o['Shelf'])) $this->Shelf = $o['Shelf'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->SeriesId)) $o['SeriesId'] = $this->SeriesId;
if (isset($this->Classification)) $o['Classification'] = $this->Classification;
if (isset($this->Format)) $o['Format'] = $this->Format;
if (isset($this->TriggerDate)) $o['TriggerDate'] = $this->TriggerDate;
if (isset($this->MetaJson)) $o['MetaJson'] = $this->MetaJson;
if (isset($this->FilesJson)) $o['FilesJson'] = $this->FilesJson;
if (isset($this->Warehouse)) $o['Warehouse'] = $this->Warehouse;
if (isset($this->Aisle)) $o['Aisle'] = $this->Aisle;
if (isset($this->Shelf)) $o['Shelf'] = $this->Shelf;
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 /v1/records/entry HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<RecordCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Aisle>String</Aisle>
<Classification>String</Classification>
<FilesJson>String</FilesJson>
<Format>String</Format>
<MetaJson>String</MetaJson>
<Name>String</Name>
<SeriesId>0</SeriesId>
<Shelf>String</Shelf>
<TriggerDate>String</TriggerDate>
<Warehouse>String</Warehouse>
</RecordCreateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<RecordsOkResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Id>0</Id>
<Key>String</Key>
<Matches xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Matches>
<Ok>false</Ok>
<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>
</RecordsOkResponse>