BokaMera.API.Host

<back to all web services

ListWebhookEndpoint

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/webhook/endpointsList webhook endpoints
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 ListEndpointsResponse
            Public Sub New()
                Endpoints = New List(Of WebhookEndpoint)
            End Sub

            Public Overridable Property Endpoints As List(Of WebhookEndpoint)
        End Class

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class ListWebhookEndpoint
            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)
        End Class

        Public Partial Class WebhookEndpoint
            Public Sub New()
                EventTypes = New List(Of String)
            End Sub

            Public Overridable Property Description As String
            Public Overridable Property Url As String
            Public Overridable Property Id As String
            Public Overridable Property Disabled As Boolean
            Public Overridable Property EventTypes As List(Of String)
        End Class
    End Namespace
End Namespace

VB.NET ListWebhookEndpoint DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /webhook/endpoints HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Endpoints":[{"Description":"String","Url":"String","Id":"String","Disabled":false,"EventTypes":["String"]}]}