BokaMera.API.Host

CreateWebhookEndpoint

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
POST	/webhook/endpoints	Create webhook endpoint

<?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 WebhookEndpoint implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Description=null,
        /** @var string|null */
        public ?string $Url=null,
        /** @var string|null */
        public ?string $Id=null,
        /** @var bool|null */
        public ?bool $Disabled=null,
        /** @var array<string>|null */
        public ?array $EventTypes=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['Url'])) $this->Url = $o['Url'];
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['Disabled'])) $this->Disabled = $o['Disabled'];
        if (isset($o['EventTypes'])) $this->EventTypes = JsonConverters::fromArray('string', $o['EventTypes']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->Url)) $o['Url'] = $this->Url;
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->Disabled)) $o['Disabled'] = $this->Disabled;
        if (isset($this->EventTypes)) $o['EventTypes'] = JsonConverters::toArray('string', $this->EventTypes);
        return empty($o) ? new class(){} : $o;
    }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class CreateWebhookEndpoint 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.", IsRequired=true, ParameterType="query")
        /** @var string */
        public string $CompanyId='',

        /** @description The webhook endpoint URL. */
        // @ApiMember(Description="The webhook endpoint URL.", IsRequired=true)
        /** @var string */
        public string $Url='',

        /** @description List of event types. At least one event type is required. */
        // @ApiMember(Description="List of event types. At least one event type is required.", IsRequired=true)
        // @Validate(Validator="NotEmpty", ErrorCode="At least one event type is required.")
        /** @var array<string>|null */
        public ?array $EventTypes=null,

        /** @var string|null */
        public ?string $Description=null,
        // @ApiMember()
        /** @var bool|null */
        public ?bool $Disabled=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
        if (isset($o['Url'])) $this->Url = JsonConverters::from('string', $o['Url']);
        if (isset($o['EventTypes'])) $this->EventTypes = JsonConverters::fromArray('string', $o['EventTypes']);
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['Disabled'])) $this->Disabled = $o['Disabled'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
        if (isset($this->Url)) $o['Url'] = JsonConverters::to('string', $this->Url);
        if (isset($this->EventTypes)) $o['EventTypes'] = JsonConverters::toArray('string', $this->EventTypes);
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->Disabled)) $o['Disabled'] = $this->Disabled;
        return empty($o) ? new class(){} : $o;
    }
}

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

POST /webhook/endpoints HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateWebhookEndpoint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Description>String</Description>
  <Disabled>false</Disabled>
  <EventTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EventTypes>
  <Url i:nil="true" />
</CreateWebhookEndpoint>

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

<WebhookEndpoint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Description>String</Description>
  <Disabled>false</Disabled>
  <EventTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EventTypes>
  <Id>String</Id>
  <Url>String</Url>
</WebhookEndpoint>