BokaMera.API.Host

<back to all web services

SyncToiCal

The following routes are available for this service:
GET/sync/icalsync/{companyid}/{token}Get iCals
<?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 SyncToiCal implements ICompany, JsonSerializable
{
    public function __construct(
        /** @description Enter the company, if blank and you are an admin, your company id will be used */
        // @ApiMember(Description="Enter the company, if blank and you are an admin, your company id will be used", ParameterType="path")
        /** @var string|null */
        public ?string $CompanyId=null,

        /** @description Query for specific Resources, default is all resources */
        // @ApiMember(Description="Query for specific Resources, default is all resources", IsRequired=true, ParameterType="query")
        /** @var int[] */
        public array $ResourceIds=[],

        /** @description ICalSync Token */
        // @ApiMember(Description="ICalSync Token", IsRequired=true, ParameterType="path")
        /** @var string */
        public string $Token='',

        /** @description If you want to include the schedule time slots */
        // @ApiMember(Description="If you want to include the schedule time slots", ParameterType="query")
        /** @var bool|null */
        public ?bool $IncludeSchedules=null
    ) {
    }

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

PHP SyncToiCal DTOs

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

HTTP + JSV

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

GET /sync/icalsync/{companyid}/{token} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}