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
namespace PwC.Elmaas.Core.Services.Contracts.Webhooks.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SubscriptionConfig() = 
        member val Url:String = null with get,set
        member val ContentType:String = null with get,set
        member val Secret:String = null with get,set

    [<AllowNullLiteral>]
    type WebhookSubscription() = 
        member val Id:String = null with get,set
        member val Name:String = null with get,set
        member val Event:String = null with get,set
        member val IsActive:Boolean = new Boolean() with get,set
        member val CreatedDateUtc:DateTime = new DateTime() with get,set
        member val CreatedById:String = null with get,set
        member val LastModifiedDateUtc:DateTime = new DateTime() with get,set
        member val Config:SubscriptionConfig = null with get,set

    ///<summary>
    ///Specifies a request to delete webhook subscriptions.
    ///</summary>
    [<Api(Description="Specifies a request to delete webhook subscriptions.")>]
    [<AllowNullLiteral>]
    type BatchDeleteWebhookSubscriptionsBase() = 
        interface IPost
        ///<summary>
        ///The subscriptions to delete.
        ///</summary>
        [<ApiMember(Description="The subscriptions to delete.", IsRequired=true, Name="Subscriptions")>]
        member val Subscriptions:ResizeArray<WebhookSubscription> = new ResizeArray<WebhookSubscription>() with get,set

    ///<summary>
    ///Represents a request to delete webhook subscriptions in an asynchronous operation.
    ///</summary>
    [<Api(Description="Represents a request to delete webhook subscriptions in an asynchronous operation.")>]
    [<AllowNullLiteral>]
    type BatchDeleteWebhookSubscriptionsAsync() = 
        inherit BatchDeleteWebhookSubscriptionsBase()

F# BatchDeleteWebhookSubscriptionsAsync 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 /async/webhooks/subscriptions/delete HTTP/1.1 
Host: reportfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BatchDeleteWebhookSubscriptionsAsync xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Webhooks.Requests">
  <Subscriptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/ServiceStack.Webhooks.ServiceModel.Types">
    <d2p1:WebhookSubscription>
      <d2p1:Config>
        <d2p1:ContentType>String</d2p1:ContentType>
        <d2p1:Secret>String</d2p1:Secret>
        <d2p1:Url>String</d2p1:Url>
      </d2p1:Config>
      <d2p1:CreatedById>String</d2p1:CreatedById>
      <d2p1:CreatedDateUtc>0001-01-01T00:00:00</d2p1:CreatedDateUtc>
      <d2p1:Event>String</d2p1:Event>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:IsActive>false</d2p1:IsActive>
      <d2p1:LastModifiedDateUtc>0001-01-01T00:00:00</d2p1:LastModifiedDateUtc>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:WebhookSubscription>
  </Subscriptions>
</BatchDeleteWebhookSubscriptionsAsync>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfSubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Webhooks.Responses">
  <SubscriptionResponse>
    <History xmlns:d3p1="http://schemas.datacontract.org/2004/07/ServiceStack.Webhooks.ServiceModel.Types">
      <d3p1:SubscriptionDeliveryResult>
        <d3p1:AttemptedDateUtc>0001-01-01T00:00:00</d3p1:AttemptedDateUtc>
        <d3p1:EventId>String</d3p1:EventId>
        <d3p1:Id>String</d3p1:Id>
        <d3p1:StatusCode>Continue</d3p1:StatusCode>
        <d3p1:StatusDescription>String</d3p1:StatusDescription>
        <d3p1:SubscriptionId>String</d3p1:SubscriptionId>
      </d3p1:SubscriptionDeliveryResult>
    </History>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <Subscription xmlns:d3p1="http://schemas.datacontract.org/2004/07/ServiceStack.Webhooks.ServiceModel.Types">
      <d3p1:Config>
        <d3p1:ContentType>String</d3p1:ContentType>
        <d3p1:Secret>String</d3p1:Secret>
        <d3p1:Url>String</d3p1:Url>
      </d3p1:Config>
      <d3p1:CreatedById>String</d3p1:CreatedById>
      <d3p1:CreatedDateUtc>0001-01-01T00:00:00</d3p1:CreatedDateUtc>
      <d3p1:Event>String</d3p1:Event>
      <d3p1:Id>String</d3p1:Id>
      <d3p1:IsActive>false</d3p1:IsActive>
      <d3p1:LastModifiedDateUtc>0001-01-01T00:00:00</d3p1:LastModifiedDateUtc>
      <d3p1:Name>String</d3p1:Name>
    </Subscription>
  </SubscriptionResponse>
</ArrayOfSubscriptionResponse>