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 'package:servicestack/servicestack.dart';

class WebhookEndpoint implements IConvertible
{
    String? Description;
    String? Url;
    String? Id;
    bool? Disabled;
    List<String>? EventTypes;

    WebhookEndpoint({this.Description,this.Url,this.Id,this.Disabled,this.EventTypes});
    WebhookEndpoint.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Description = json['Description'];
        Url = json['Url'];
        Id = json['Id'];
        Disabled = json['Disabled'];
        EventTypes = JsonConverters.fromJson(json['EventTypes'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Description': Description,
        'Url': Url,
        'Id': Id,
        'Disabled': Disabled,
        'EventTypes': JsonConverters.toJson(EventTypes,'List<String>',context!)
    };

    getTypeName() => "WebhookEndpoint";
    TypeContext? context = _ctx;
}

class ListEndpointsResponse implements IConvertible
{
    List<WebhookEndpoint>? Endpoints;

    ListEndpointsResponse({this.Endpoints});
    ListEndpointsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Endpoints = JsonConverters.fromJson(json['Endpoints'],'List<WebhookEndpoint>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Endpoints': JsonConverters.toJson(Endpoints,'List<WebhookEndpoint>',context!)
    };

    getTypeName() => "ListEndpointsResponse";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class ListWebhookEndpoint implements ICompany, IConvertible
{
    /**
    * 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")
    String? CompanyId;

    ListWebhookEndpoint({this.CompanyId});
    ListWebhookEndpoint.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId
    };

    getTypeName() => "ListWebhookEndpoint";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
    'WebhookEndpoint': TypeInfo(TypeOf.Class, create:() => WebhookEndpoint()),
    'ListEndpointsResponse': TypeInfo(TypeOf.Class, create:() => ListEndpointsResponse()),
    'List<WebhookEndpoint>': TypeInfo(TypeOf.Class, create:() => <WebhookEndpoint>[]),
    'ListWebhookEndpoint': TypeInfo(TypeOf.Class, create:() => ListWebhookEndpoint()),
});

Dart ListWebhookEndpoint DTOs

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

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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