BokaMera.API.Host

TestWebhookEndpoint

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

The following routes are available for this service:
POST	/webhook/endpoints/{Id}/test	Test webhook endpoint by sending a sample message


export class TestWebhookEndpointResponse
{
    public MessageId: string;

    public constructor(init?: Partial<TestWebhookEndpointResponse>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="Invalid request", StatusCode=400)
// @ValidateRequest(Validator="IsAuthenticated")
export class TestWebhookEndpoint implements ICompany
{
    /** @description 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 CompanyId: string;

    /** @description The ID of the webhook endpoint to test. */
    // @ApiMember(Description="The ID of the webhook endpoint to test.", IsRequired=true, ParameterType="path")
    public Id: string;

    public constructor(init?: Partial<TestWebhookEndpoint>) { (Object as any).assign(this, init); }
}

TypeScript TestWebhookEndpoint 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.

POST /webhook/endpoints/{Id}/test HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TestWebhookEndpoint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Id>String</Id>
</TestWebhookEndpoint>

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

<TestWebhookEndpointResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <MessageId>String</MessageId>
</TestWebhookEndpointResponse>