Report Filing Service

DeleteWebhookSubscriptionAsync

DeleteSubscriptionsWebhooksAsync

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

The following routes are available for this service:
POST	/async/webhooks/subscriptions/{Id}/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

    [<AllowNullLiteral>]
    type SubscriptionDeliveryResult() = 
        member val AttemptedDateUtc:DateTime = new DateTime() with get,set
        member val StatusDescription:String = null with get,set
        member val StatusCode:HttpStatusCode = new HttpStatusCode() with get,set
        member val SubscriptionId:String = null with get,set
        member val Id:String = null with get,set
        member val EventId:String = null with get,set

    ///<summary>
    ///Represents a service response that encapsulates a webhook subscription.
    ///</summary>
    [<Api(Description="Represents a service response that encapsulates a webhook subscription.")>]
    [<AllowNullLiteral>]
    type SubscriptionResponse() = 
        ///<summary>
        ///The encapsulated webhook subscription of the response. The secret of the webhook subscription is encrypted and can only be decrypted by the owner of the private key.
        ///</summary>
        [<ApiMember(Description="The encapsulated webhook subscription of the response. The secret of the webhook subscription is encrypted and can only be decrypted by the owner of the private key.", Name="Subscription")>]
        member val Subscription:WebhookSubscription = null with get,set

        ///<summary>
        ///The history of the subscription event.
        ///</summary>
        [<ApiMember(Description="The history of the subscription event.", Name="History")>]
        member val History:ResizeArray<SubscriptionDeliveryResult> = new ResizeArray<SubscriptionDeliveryResult>() with get,set

        ///<summary>
        ///The status of the response.
        ///</summary>
        [<ApiMember(Description="The status of the response.", Name="ResponseStatus")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Specifies a request to delete a webhook subscription.
    ///</summary>
    [<Api(Description="Specifies a request to delete a webhook subscription.")>]
    [<AllowNullLiteral>]
    type DeleteWebhookSubscriptionBase() = 
        interface IPost
        ///<summary>
        ///The unique identifier of the subscriber.
        ///</summary>
        [<ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="Id")>]
        member val Id:String = null with get,set

        ///<summary>
        ///The secret of the to-be-deleted webhook subscription. This secret is used to authenticate the owner of the webhook subscription.
        ///</summary>
        [<ApiMember(Description="The secret of the to-be-deleted webhook subscription. This secret is used to authenticate the owner of the webhook subscription.", IsRequired=true, Name="Secret")>]
        member val Secret:String = null with get,set

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

F# DeleteWebhookSubscriptionAsync 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/{Id}/delete HTTP/1.1 
Host: reportfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DeleteWebhookSubscriptionAsync xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Webhooks.Requests">
  <Id>String</Id>
  <Secret>String</Secret>
</DeleteWebhookSubscriptionAsync>

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

<SubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Webhooks.Responses">
  <History xmlns:d2p1="http://schemas.datacontract.org/2004/07/ServiceStack.Webhooks.ServiceModel.Types">
    <d2p1:SubscriptionDeliveryResult>
      <d2p1:AttemptedDateUtc>0001-01-01T00:00:00</d2p1:AttemptedDateUtc>
      <d2p1:EventId>String</d2p1:EventId>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:StatusCode>Continue</d2p1:StatusCode>
      <d2p1:StatusDescription>String</d2p1:StatusDescription>
      <d2p1:SubscriptionId>String</d2p1:SubscriptionId>
    </d2p1:SubscriptionDeliveryResult>
  </History>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Subscription xmlns:d2p1="http://schemas.datacontract.org/2004/07/ServiceStack.Webhooks.ServiceModel.Types">
    <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>
  </Subscription>
</SubscriptionResponse>