BokaMera.API.Host

ListWebhookEndpointAttempts

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
GET	/webhook/endpoints/{EndpointId}/attempts	List webhook endpoint attempts

using System;
using System.IO;
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
{
    public partial class ListMessageAttemptsResponse
    {
        public virtual List<WebhookMessageAttempt> Attempts { get; set; } = [];
        public virtual bool Done { get; set; }
        public virtual string? Iterator { get; set; }
    }

    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    [ValidateRequest("IsAuthenticated")]
    public partial class ListWebhookEndpointAttempts
        : 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 virtual Guid CompanyId { 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 EndpointId { get; set; }

        ///<summary>
        ///Pagination iterator.
        ///</summary>
        [ApiMember(Description="Pagination iterator.")]
        public virtual string? Iterator { get; set; }

        ///<summary>
        ///Maximum number of attempts to return.
        ///</summary>
        [ApiMember(Description="Maximum number of attempts to return.")]
        public virtual int? Limit { get; set; }

        ///<summary>
        ///Filter by message status. 0 = Success, 1 = Pending, 2 = Fail, 3 = Sending.
        ///</summary>
        [ApiMember(Description="Filter by message status. 0 = Success, 1 = Pending, 2 = Fail, 3 = Sending.")]
        public virtual int? Status { get; set; }

        ///<summary>
        ///Filter by event types.
        ///</summary>
        [ApiMember(Description="Filter by event types.")]
        public virtual List<string>? EventTypes { get; set; }

        ///<summary>
        ///Filter attempts before this date.
        ///</summary>
        [ApiMember(Description="Filter attempts before this date.")]
        public virtual DateTime? Before { get; set; }

        ///<summary>
        ///Filter attempts after this date.
        ///</summary>
        [ApiMember(Description="Filter attempts after this date.")]
        public virtual DateTime? After { get; set; }
    }

    public partial class WebhookMessageAttempt
    {
        public virtual string Id { get; set; }
        public virtual string MessageId { get; set; }
        public virtual string EndpointId { get; set; }
        public virtual string Url { get; set; }
        public virtual string Status { get; set; }
        public virtual int? ResponseStatusCode { get; set; }
        public virtual DateTime Timestamp { get; set; }
        public virtual string TriggerType { get; set; }
    }

}

C# ListWebhookEndpointAttempts 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/{EndpointId}/attempts HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ListMessageAttemptsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Attempts>
    <WebhookMessageAttempt>
      <EndpointId>String</EndpointId>
      <Id>String</Id>
      <MessageId>String</MessageId>
      <ResponseStatusCode>0</ResponseStatusCode>
      <Status>String</Status>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
      <TriggerType>String</TriggerType>
      <Url>String</Url>
    </WebhookMessageAttempt>
  </Attempts>
  <Done>false</Done>
  <Iterator>String</Iterator>
</ListMessageAttemptsResponse>