Northwind Web Services

CachedGetAllCustomers

Cached

The following routes are available for this service:
All Verbs	/cached/customers

<?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};


// @DataContract
class Customer implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string */
        public string $id='',

        // @DataMember
        /** @var string */
        public string $companyName='',

        // @DataMember
        /** @var string */
        public string $contactName='',

        // @DataMember
        /** @var string */
        public string $contactTitle='',

        // @DataMember
        /** @var string */
        public string $address='',

        // @DataMember
        /** @var string */
        public string $city='',

        // @DataMember
        /** @var string */
        public string $region='',

        // @DataMember
        /** @var string */
        public string $postalCode='',

        // @DataMember
        /** @var string */
        public string $country='',

        // @DataMember
        /** @var string */
        public string $phone='',

        // @DataMember
        /** @var string */
        public string $fax=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['companyName'])) $this->companyName = $o['companyName'];
        if (isset($o['contactName'])) $this->contactName = $o['contactName'];
        if (isset($o['contactTitle'])) $this->contactTitle = $o['contactTitle'];
        if (isset($o['address'])) $this->address = $o['address'];
        if (isset($o['city'])) $this->city = $o['city'];
        if (isset($o['region'])) $this->region = $o['region'];
        if (isset($o['postalCode'])) $this->postalCode = $o['postalCode'];
        if (isset($o['country'])) $this->country = $o['country'];
        if (isset($o['phone'])) $this->phone = $o['phone'];
        if (isset($o['fax'])) $this->fax = $o['fax'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->companyName)) $o['companyName'] = $this->companyName;
        if (isset($this->contactName)) $o['contactName'] = $this->contactName;
        if (isset($this->contactTitle)) $o['contactTitle'] = $this->contactTitle;
        if (isset($this->address)) $o['address'] = $this->address;
        if (isset($this->city)) $o['city'] = $this->city;
        if (isset($this->region)) $o['region'] = $this->region;
        if (isset($this->postalCode)) $o['postalCode'] = $this->postalCode;
        if (isset($this->country)) $o['country'] = $this->country;
        if (isset($this->phone)) $o['phone'] = $this->phone;
        if (isset($this->fax)) $o['fax'] = $this->fax;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class CustomersResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var array<Customer>|null */
        public ?array $results=null,

        // @DataMember
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['results'])) $this->results = JsonConverters::fromArray('Customer', $o['results']);
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->results)) $o['results'] = JsonConverters::toArray('Customer', $this->results);
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class CachedGetAllCustomers implements IGet, JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP CachedGetAllCustomers 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.

POST /cached/customers HTTP/1.1 
Host: northwind.netcore.io 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"results":[{"id":"String","companyName":"String","contactName":"String","contactTitle":"String","address":"String","city":"String","region":"String","postalCode":"String","country":"String","phone":"String","fax":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}