BokaMera.API.Host

<back to all web services

ListWebhookMessageAttempts

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/webhook/messages/{MessageId}/attemptsList webhook message attempts
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class ListWebhookMessageAttempts : 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")
    override var CompanyId:UUID? = null

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

    /**
    * Pagination iterator.
    */
    @ApiMember(Description="Pagination iterator.")
    open var Iterator:String? = null

    /**
    * Maximum number of attempts to return.
    */
    @ApiMember(Description="Maximum number of attempts to return.")
    open var Limit:Int? = null

    /**
    * Filter by message status. 0 = Success, 1 = Pending, 2 = Fail, 3 = Sending.
    */
    @ApiMember(Description="Filter by message status. 0 = Success, 1 = Pending, 2 = Fail, 3 = Sending.")
    open var Status:Int? = null

    /**
    * Filter by event types.
    */
    @ApiMember(Description="Filter by event types.")
    open var EventTypes:ArrayList<String>? = null

    /**
    * Filter by endpoint ID.
    */
    @ApiMember(Description="Filter by endpoint ID.")
    open var EndpointId:String? = null

    /**
    * Filter attempts before this date.
    */
    @ApiMember(Description="Filter attempts before this date.")
    open var Before:Date? = null

    /**
    * Filter attempts after this date.
    */
    @ApiMember(Description="Filter attempts after this date.")
    open var After:Date? = null
}

open class ListMessageAttemptsResponse
{
    open var Attempts:ArrayList<WebhookMessageAttempt> = ArrayList<WebhookMessageAttempt>()
    open var Done:Boolean? = null
    open var Iterator:String? = null
}

open class WebhookMessageAttempt
{
    open var Id:String? = null
    open var MessageId:String? = null
    open var EndpointId:String? = null
    open var Url:String? = null
    open var Status:String? = null
    open var ResponseStatusCode:Int? = null
    open var Timestamp:Date? = null
    open var TriggerType:String? = null
}

Kotlin ListWebhookMessageAttempts 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/messages/{MessageId}/attempts HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Attempts":[{"Id":"String","MessageId":"String","EndpointId":"String","Url":"String","Status":"String","ResponseStatusCode":0,"TriggerType":"String"}],"Done":false,"Iterator":"String"}