SDS.APIs.Legacy.EanCodeBook

<back to all web services

EanCodeBookRequest

Get metering points from www.eancodeboek.nl

The following routes are available for this service:
GET/eancodebook/{Postcode}/{HouseNumber}
<?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};


/** @description Get metering points from www.eancodeboek.nl */
// @Api(Description="Get metering points from www.eancodeboek.nl")
class EanCodeBookRequest implements JsonSerializable
{
    public function __construct(
        /** @description Postcode, format: 1234AB */
        // @ApiMember(DataType="string", Description="Postcode, format: 1234AB", IsRequired=true, Name="Postcode")
        /** @var string */
        public string $Postcode='',

        /** @description Housenumber, format: integer number */
        // @ApiMember(DataType="integer", Description="Housenumber, format: integer number", IsRequired=true, Name="HouseNumber")
        /** @var int */
        public int $HouseNumber=0,

        /** @description OPTIONAL: don't put data in wrapper */
        // @ApiMember(DataType="boolean", Description="OPTIONAL: don't put data in wrapper", Name="OnlyPayload")
        /** @var bool|null */
        public ?bool $OnlyPayload=null
    ) {
    }

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

PHP EanCodeBookRequest 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 /eancodebook/{Postcode}/{HouseNumber} HTTP/1.1 
Host: ean.smartdatasolutions.nl 
Accept: text/jsonl