BokaMera.API.Host

CheckSitePathValid

The following routes are available for this service:
GET	/companies/checksitepathvalid	Check if company with sitepath is valid	This service is used to check if sitepath on company is valid (free and correct).

<?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 CheckCompanySitePathIsValidResponse implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $Valid=null,
        /** @var string|null */
        public ?string $Message=null
    ) {
    }

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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
class CheckSitePathValid implements JsonSerializable
{
    public function __construct(
        /** @description The sitepath to the company. */
        // @ApiMember(Description="The sitepath to the company.")
        /** @var string|null */
        public ?string $SitePath=null
    ) {
    }

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

PHP CheckSitePathValid DTOs

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

HTTP + XML

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

GET /companies/checksitepathvalid HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml

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

<CheckCompanySitePathIsValidResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Message>String</Message>
  <Valid>false</Valid>
</CheckCompanySitePathIsValidResponse>