WS-RESTRICTED_API Host [RESTRICTED_API] : D5290-staging

<back to all web services

api_metadatas

Requires Authentication
The following routes are available for this service:
GET/api_metadata/{record_class}
GET/api_metadata/{record_class}/{record_group_id}
<?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 api_metadata implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $am_operation_type=null,
        /** @var DateTime|null */
        public ?DateTime $am_operation_timestamp=null,
        /** @var string|null */
        public ?string $am_record_class=null,
        /** @var int|null */
        public ?int $am_record_group_id=null,
        /** @var string|null */
        public ?string $am_record_id=null,
        /** @var string|null */
        public ?string $am_record_json=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['am_operation_type'])) $this->am_operation_type = $o['am_operation_type'];
        if (isset($o['am_operation_timestamp'])) $this->am_operation_timestamp = JsonConverters::from('DateTime', $o['am_operation_timestamp']);
        if (isset($o['am_record_class'])) $this->am_record_class = $o['am_record_class'];
        if (isset($o['am_record_group_id'])) $this->am_record_group_id = $o['am_record_group_id'];
        if (isset($o['am_record_id'])) $this->am_record_id = $o['am_record_id'];
        if (isset($o['am_record_json'])) $this->am_record_json = $o['am_record_json'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->am_operation_type)) $o['am_operation_type'] = $this->am_operation_type;
        if (isset($this->am_operation_timestamp)) $o['am_operation_timestamp'] = JsonConverters::to('DateTime', $this->am_operation_timestamp);
        if (isset($this->am_record_class)) $o['am_record_class'] = $this->am_record_class;
        if (isset($this->am_record_group_id)) $o['am_record_group_id'] = $this->am_record_group_id;
        if (isset($this->am_record_id)) $o['am_record_id'] = $this->am_record_id;
        if (isset($this->am_record_json)) $o['am_record_json'] = $this->am_record_json;
        return empty($o) ? new class(){} : $o;
    }
}

/**
 * @template array of api_metadata
 */
class api_metadatasResponse extends \ArrayObject implements JsonSerializable
{
    public function __construct(api_metadata ...$items) {
        parent::__construct($items, \ArrayObject::STD_PROP_LIST);
    }
    
    /** @throws \Exception */
    public function append($value): void {
        if ($value instanceof api_metadata)
            parent::append($value);
        else
            throw new \Exception("Can only append a api_metadata to " . __CLASS__);
    }
    
    /** @throws Exception */
    public function fromMap($o): void {
        foreach ($o as $item) {
            $el = new api_metadata();
            $el->fromMap($item);
            $this->append($el);
        }
    }
    
    /** @throws Exception */
    public function jsonSerialize(): array {
        return parent::getArrayCopy();
    }
}

class api_metadatas implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $record_class=null,
        /** @var int|null */
        public ?int $record_group_id=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['record_class'])) $this->record_class = $o['record_class'];
        if (isset($o['record_group_id'])) $this->record_group_id = $o['record_group_id'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->record_class)) $o['record_class'] = $this->record_class;
        if (isset($this->record_group_id)) $o['record_group_id'] = $this->record_group_id;
        return empty($o) ? new class(){} : $o;
    }
}

PHP api_metadatas DTOs

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api_metadata/{record_class} HTTP/1.1 
Host: milliet.io 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[]