BokaMera.API.Host

GetReferenceTypes

The following routes are available for this service:
GET	/externalreferencestypes	Get reference types	Get reference types

<?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 ExternalReferenceTypeQueryResponse implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ReferenceTypeId=0,
        /** @var string */
        public string $ReferenceTypeName='',
        /** @var string */
        public string $ReferenceTypeDescription=''
    ) {
    }

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

class GetReferenceTypes implements ICompany, JsonSerializable
{
    public function __construct(
        /** @description The company id, if empty will use the company id for the user you are logged in with. */
        // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
        /** @var string|null */
        public ?string $CompanyId=null
    ) {
    }

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

PHP GetReferenceTypes 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 /externalreferencestypes HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ReferenceTypeId":0,"ReferenceTypeName":"String","ReferenceTypeDescription":"String"}