sfgboxapi

<back to all web services

IntroductionLookup

Requires Authentication
The following routes are available for this service:
GET/introduction
<?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 Paging implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $pageNumber=0,
        /** @var int */
        public int $pageSize=0
    ) {
    }

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

class IntroductionLookup implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $id=0,
        /** @var int */
        public int $tenantsId=0,
        /** @var string|null */
        public ?string $name=null,
        /** @var Paging|null */
        public ?Paging $paging=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['tenantsId'])) $this->tenantsId = $o['tenantsId'];
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['paging'])) $this->paging = JsonConverters::from('Paging', $o['paging']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->tenantsId)) $o['tenantsId'] = $this->tenantsId;
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->paging)) $o['paging'] = JsonConverters::to('Paging', $this->paging);
        return empty($o) ? new class(){} : $o;
    }
}

PHP IntroductionLookup DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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

GET /introduction HTTP/1.1 
Host: api.sfgtec.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{Unable to show example output for type 'IEnumerable`1' using the custom 'other' filter}Cannot dynamically create an instance of type 'System.Collections.Generic.IEnumerable`1[sfgboxapi.ServiceModel.IntroductionLookupResponse]'. Reason: Cannot create an instance of an interface.