BokaMera.API.Host

<back to all web services

UpdateWebhookSettingsRequest

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/webhook/settingsEnable or disable webhook feature for the companySets the webhook feature flag for the company identified by the API key in the header
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class UpdateWebhookSettingsRequest
            Implements ICompany
            '''<Summary>
            '''The company id, if empty will use the company id for the user you are logged in with.
            '''</Summary>
            <ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.", IsRequired:=true, ParameterType:="query")>
            Public Overridable Property CompanyId As Nullable(Of Guid)

            <Required>
            <ApiMember>
            Public Overridable Property Enabled As Boolean
        End Class

        Public Partial Class WebhookSettingsResponse
            Public Overridable Property Enabled As Boolean
            Public Overridable Property Message As String
            Public Overridable Property CompanyId As Guid
        End Class
    End Namespace
End Namespace

VB.NET UpdateWebhookSettingsRequest 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.

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>