| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /webhook/endpoints/{id} | Update webhook endpoint |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebhookEndpoint:
description: Optional[str] = None
url: Optional[str] = None
id: Optional[str] = None
disabled: bool = False
event_types: Optional[List[str]] = None
# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateWebhookEndpoint(ICompany):
# @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.", IsRequired=true, ParameterType="query")
company_id: Optional[str] = None
"""
The company id, if empty will use the company id for the user you are logged in with.
"""
# @ApiMember(Description="The webhook endpoint URL.", IsRequired=true)
url: Optional[str] = None
"""
The webhook endpoint URL.
"""
# @ApiMember(Description="The ID of the webhook endpoint.", IsRequired=true, ParameterType="path")
id: Optional[str] = None
"""
The ID of the webhook endpoint.
"""
# @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.")
event_types: Optional[List[str]] = None
"""
List of event types. At least one event type is required.
"""
description: Optional[str] = None
disabled: bool = False
Python UpdateWebhookEndpoint 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/endpoints/{id} HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateWebhookEndpoint 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>
<Id>String</Id>
<Url>String</Url>
</UpdateWebhookEndpoint>
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>