| GET,OPTIONS | /v1/terminology/admin |
|---|
<?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 IndustryPack implements JsonSerializable
{
public function __construct(
/** @var string */
public string $PackId='',
/** @var string|null */
public ?string $Code=null,
/** @var string|null */
public ?string $Name=null,
/** @var bool|null */
public ?bool $IsActive=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['PackId'])) $this->PackId = $o['PackId'];
if (isset($o['Code'])) $this->Code = $o['Code'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['IsActive'])) $this->IsActive = $o['IsActive'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->PackId)) $o['PackId'] = $this->PackId;
if (isset($this->Code)) $o['Code'] = $this->Code;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->IsActive)) $o['IsActive'] = $this->IsActive;
return empty($o) ? new class(){} : $o;
}
}
class TermOverride implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $TermKey=null,
/** @var string|null */
public ?string $Label=null,
/** @var string|null */
public ?string $CreatedBy=null,
/** @var DateTime|null */
public ?DateTime $CreatedAt=null,
/** @var DateTime|null */
public ?DateTime $UpdatedAt=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['TermKey'])) $this->TermKey = $o['TermKey'];
if (isset($o['Label'])) $this->Label = $o['Label'];
if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
if (isset($o['CreatedAt'])) $this->CreatedAt = JsonConverters::from('DateTime', $o['CreatedAt']);
if (isset($o['UpdatedAt'])) $this->UpdatedAt = JsonConverters::from('DateTime', $o['UpdatedAt']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->TermKey)) $o['TermKey'] = $this->TermKey;
if (isset($this->Label)) $o['Label'] = $this->Label;
if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
if (isset($this->CreatedAt)) $o['CreatedAt'] = JsonConverters::to('DateTime', $this->CreatedAt);
if (isset($this->UpdatedAt)) $o['UpdatedAt'] = JsonConverters::to('DateTime', $this->UpdatedAt);
return empty($o) ? new class(){} : $o;
}
}
class TerminologyAdminResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var array<IndustryPack>|null */
public ?array $Packs=null,
/** @var string|null */
public ?string $SelectedPackId=null,
/** @var array<string,string>|null */
public ?array $Terms=null,
/** @var array<TermOverride>|null */
public ?array $Overrides=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['Packs'])) $this->Packs = JsonConverters::fromArray('IndustryPack', $o['Packs']);
if (isset($o['SelectedPackId'])) $this->SelectedPackId = $o['SelectedPackId'];
if (isset($o['Terms'])) $this->Terms = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['Terms']);
if (isset($o['Overrides'])) $this->Overrides = JsonConverters::fromArray('TermOverride', $o['Overrides']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->Packs)) $o['Packs'] = JsonConverters::toArray('IndustryPack', $this->Packs);
if (isset($this->SelectedPackId)) $o['SelectedPackId'] = $this->SelectedPackId;
if (isset($this->Terms)) $o['Terms'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->Terms);
if (isset($this->Overrides)) $o['Overrides'] = JsonConverters::toArray('TermOverride', $this->Overrides);
return empty($o) ? new class(){} : $o;
}
}
class TerminologyAdminRequest implements JsonSerializable
{
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
return empty($o) ? new class(){} : $o;
}
}
PHP TerminologyAdminRequest 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.
GET /v1/terminology/admin HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Packs:
[
{
PackId: 00000000000000000000000000000000,
Code: String,
Name: String,
IsActive: False
}
],
SelectedPackId: 00000000000000000000000000000000,
Terms:
{
String: String
},
Overrides:
[
{
TermKey: String,
Label: String,
CreatedBy: String,
CreatedAt: 0001-01-01,
UpdatedAt: 0001-01-01
}
]
}