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
import java.math.*
import java.util.*
import net.servicestack.client.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class ListWebhookEndpoint : ICompany
{
    /**
    * 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 CompanyId:UUID? = null
}

open class ListEndpointsResponse
{
    var Endpoints:ArrayList<WebhookEndpoint> = ArrayList<WebhookEndpoint>()
}

open class WebhookEndpoint
{
    var Description:String? = null
    var Url:String? = null
    var Id:String? = null
    var Disabled:Boolean? = null
    var EventTypes:ArrayList<String> = ArrayList<String>()
}

Kotlin ListWebhookEndpoint 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.

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

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