Report Filing Service

<back to all web services

BatchDeleteWebhookSubscriptionsAsync

DeleteBatchSubscriptionsWebhooksAsync

Represents a request to delete webhook subscriptions in an asynchronous operation.

Requires Authentication
The following routes are available for this service:
POST/async/webhooks/subscriptions/delete

export class SubscriptionConfig
{
    public url: string;
    public contentType: string;
    public secret: string;

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

export class WebhookSubscription
{
    public id: string;
    public name: string;
    public event: string;
    public isActive: boolean;
    public createdDateUtc: string;
    public createdById: string;
    public lastModifiedDateUtc: string;
    public config: SubscriptionConfig;

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

/** @description Specifies a request to delete webhook subscriptions. */
// @Api(Description="Specifies a request to delete webhook subscriptions.")
export class BatchDeleteWebhookSubscriptionsBase implements IPost
{
    /** @description The subscriptions to delete. */
    // @ApiMember(Description="The subscriptions to delete.", IsRequired=true, Name="Subscriptions")
    public subscriptions: WebhookSubscription[];

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

/** @description Represents a request to delete webhook subscriptions in an asynchronous operation. */
// @Api(Description="Represents a request to delete webhook subscriptions in an asynchronous operation.")
export class BatchDeleteWebhookSubscriptionsAsync extends BatchDeleteWebhookSubscriptionsBase
{

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

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

POST /async/webhooks/subscriptions/delete HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"subscriptions":[{"id":"String","name":"String","event":"String","isActive":false,"createdDateUtc":"\/Date(-62135596800000-0000)\/","createdById":"String","lastModifiedDateUtc":"\/Date(-62135596800000-0000)\/","config":{"url":"String","contentType":"String","secret":"String"}}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[{"subscription":{"id":"String","name":"String","event":"String","isActive":false,"createdDateUtc":"\/Date(-62135596800000-0000)\/","createdById":"String","lastModifiedDateUtc":"\/Date(-62135596800000-0000)\/","config":{"url":"String","contentType":"String","secret":"String"}},"history":[{"attemptedDateUtc":"\/Date(-62135596800000-0000)\/","statusDescription":"String","statusCode":"Continue","subscriptionId":"String","id":"String","eventId":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}]