Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
GET | /webhook/endpoints/{Id} | Get endpoint |
---|
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;
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class GetWebhookEndpoint 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;
/**
* The ID of the webhook endpoint.
*/
// @ApiMember(Description="The ID of the webhook endpoint.", IsRequired=true, ParameterType="path")
String? Id;
GetWebhookEndpoint({this.CompanyId,this.Id});
GetWebhookEndpoint.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CompanyId = json['CompanyId'];
Id = json['Id'];
return this;
}
Map<String, dynamic> toJson() => {
'CompanyId': CompanyId,
'Id': Id
};
getTypeName() => "GetWebhookEndpoint";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
'WebhookEndpoint': TypeInfo(TypeOf.Class, create:() => WebhookEndpoint()),
'GetWebhookEndpoint': TypeInfo(TypeOf.Class, create:() => GetWebhookEndpoint()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /webhook/endpoints/{Id} HTTP/1.1 Host: api.bokamera.se Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <WebhookEndpoint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <Description>String</Description> <Disabled>false</Disabled> <EventTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>String</d2p1:string> </EventTypes> <Id>String</Id> <Url>String</Url> </WebhookEndpoint>