BokaMera.API.Host

<back to all web services

UpdateWebhookEndpoint

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/webhook/endpoints/{id}Update webhook endpoint
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 UpdateWebhookEndpoint : 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

    /**
    * The webhook endpoint URL.
    */
    @ApiMember(Description="The webhook endpoint URL.", IsRequired=true)
    var Url:String? = null

    /**
    * The ID of the webhook endpoint.
    */
    @ApiMember(Description="The ID of the webhook endpoint.", IsRequired=true, ParameterType="path")
    var Id:String? = null

    /**
    * List of event types. At least one event type is required.
    */
    @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.")
    var EventTypes:ArrayList<String> = ArrayList<String>()

    var Description:String? = null
    var Disabled:Boolean? = null
}

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 UpdateWebhookEndpoint 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/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>