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.*;

public class dtos
{

    @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
    @ValidateRequest(Validator="IsAuthenticated")
    public static class ListWebhookEndpoint implements 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")
        public UUID CompanyId = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public ListWebhookEndpoint setCompanyId(UUID value) { this.CompanyId = value; return this; }
    }

    public static class ListEndpointsResponse
    {
        public ArrayList<WebhookEndpoint> Endpoints = null;
        
        public ArrayList<WebhookEndpoint> getEndpoints() { return Endpoints; }
        public ListEndpointsResponse setEndpoints(ArrayList<WebhookEndpoint> value) { this.Endpoints = value; return this; }
    }

    public static class WebhookEndpoint
    {
        public String Description = null;
        public String Url = null;
        public String Id = null;
        public Boolean Disabled = null;
        public ArrayList<String> EventTypes = null;
        
        public String getDescription() { return Description; }
        public WebhookEndpoint setDescription(String value) { this.Description = value; return this; }
        public String getUrl() { return Url; }
        public WebhookEndpoint setUrl(String value) { this.Url = value; return this; }
        public String getId() { return Id; }
        public WebhookEndpoint setId(String value) { this.Id = value; return this; }
        public Boolean isDisabled() { return Disabled; }
        public WebhookEndpoint setDisabled(Boolean value) { this.Disabled = value; return this; }
        public ArrayList<String> getEventTypes() { return EventTypes; }
        public WebhookEndpoint setEventTypes(ArrayList<String> value) { this.EventTypes = value; return this; }
    }

}

Java ListWebhookEndpoint DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: testapi.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Endpoints":[{"Description":"String","Url":"String","Id":"String","Disabled":false,"EventTypes":["String"]}]}