Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /webhook/endpoints/{id} | Update webhook endpoint |
---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
namespace BokaMera.API.ServiceModel.Dtos
{
[ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
[ValidateRequest("IsAuthenticated")]
public partial class UpdateWebhookEndpoint
: ICompany
{
public UpdateWebhookEndpoint()
{
EventTypes = new List<string>{};
}
///<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 virtual Guid? CompanyId { get; set; }
///<summary>
///The webhook endpoint URL.
///</summary>
[ApiMember(Description="The webhook endpoint URL.", IsRequired=true)]
public virtual string Url { get; set; }
///<summary>
///The ID of the webhook endpoint.
///</summary>
[ApiMember(Description="The ID of the webhook endpoint.", IsRequired=true, ParameterType="path")]
public virtual string Id { get; set; }
///<summary>
///List of event types. At least one event type is required.
///</summary>
[ApiMember(Description="List of event types. At least one event type is required.", IsRequired=true)]
[Validate("NotEmpty", ErrorCode="At least one event type is required.")]
public virtual List<string> EventTypes { get; set; }
public virtual string Description { get; set; }
public virtual bool Disabled { get; set; }
}
public partial class WebhookEndpoint
{
public WebhookEndpoint()
{
EventTypes = new List<string>{};
}
public virtual string Description { get; set; }
public virtual string Url { get; set; }
public virtual string Id { get; set; }
public virtual bool Disabled { get; set; }
public virtual List<string> EventTypes { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Url: String,
Id: String,
EventTypes:
[
String
],
Description: String,
Disabled: False
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Description: String, Url: String, Id: String, Disabled: False, EventTypes: [ String ] }