Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /webhook/settings | Enable or disable webhook feature for the company | Sets the webhook feature flag for the company identified by the API key in the header |
---|
<?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 WebhookSettingsResponse implements JsonSerializable
{
public function __construct(
/** @var bool|null */
public ?bool $Enabled=null,
/** @var string|null */
public ?string $Message=null,
/** @var string */
public string $CompanyId=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Enabled'])) $this->Enabled = $o['Enabled'];
if (isset($o['Message'])) $this->Message = $o['Message'];
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Enabled)) $o['Enabled'] = $this->Enabled;
if (isset($this->Message)) $o['Message'] = $this->Message;
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
return empty($o) ? new class(){} : $o;
}
}
class UpdateWebhookSettingsRequest 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='',
// @Required()
// @ApiMember()
/** @var bool|null */
public ?bool $Enabled=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['Enabled'])) $this->Enabled = $o['Enabled'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->Enabled)) $o['Enabled'] = $this->Enabled;
return empty($o) ? new class(){} : $o;
}
}
PHP UpdateWebhookSettingsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /webhook/settings HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateWebhookSettingsRequest 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>
<Enabled>false</Enabled>
</UpdateWebhookSettingsRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <WebhookSettingsResponse 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> <Enabled>false</Enabled> <Message>String</Message> </WebhookSettingsResponse>