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
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


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

/**
* Specifies a request to delete webhook subscriptions.
*/
@Api(Description="Specifies a request to delete webhook subscriptions.")
open class BatchDeleteWebhookSubscriptionsBase : IPost
{
    /**
    * The subscriptions to delete.
    */
    @ApiMember(Description="The subscriptions to delete.", IsRequired=true, Name="Subscriptions")
    var subscriptions:ArrayList<WebhookSubscription> = ArrayList<WebhookSubscription>()
}

open class WebhookSubscription
{
    var id:String? = null
    var name:String? = null
    var event:String? = null
    var isActive:Boolean? = null
    var createdDateUtc:Date? = null
    var createdById:String? = null
    var lastModifiedDateUtc:Date? = null
    var config:SubscriptionConfig? = null
}

open class SubscriptionConfig
{
    var url:String? = null
    var contentType:String? = null
    var secret:String? = null
}

Kotlin 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.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"}}}]