Report Filing Service

<back to all web services

BatchDeleteWebhookSubscriptions

DeleteBatchSubscriptionsWebhooksSync

Represents a request to delete webhook subscriptions.

Requires Authentication
The following routes are available for this service:
POST/sync/webhooks/subscriptions/delete
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    /**
    * Represents a request to delete webhook subscriptions.
    */
    @Api(Description="Represents a request to delete webhook subscriptions.")
    public static class BatchDeleteWebhookSubscriptions extends BatchDeleteWebhookSubscriptionsBase
    {
        
    }

    /**
    * Specifies a request to delete webhook subscriptions.
    */
    @Api(Description="Specifies a request to delete webhook subscriptions.")
    public static class BatchDeleteWebhookSubscriptionsBase implements IPost
    {
        /**
        * The subscriptions to delete.
        */
        @ApiMember(Description="The subscriptions to delete.", IsRequired=true, Name="Subscriptions")
        public ArrayList<WebhookSubscription> subscriptions = null;
        
        public ArrayList<WebhookSubscription> getSubscriptions() { return subscriptions; }
        public BatchDeleteWebhookSubscriptionsBase setSubscriptions(ArrayList<WebhookSubscription> value) { this.subscriptions = value; return this; }
    }

    public static class WebhookSubscription
    {
        public String id = null;
        public String name = null;
        public String event = null;
        public Boolean isActive = null;
        public Date createdDateUtc = null;
        public String createdById = null;
        public Date lastModifiedDateUtc = null;
        public SubscriptionConfig config = null;
        
        public String getId() { return id; }
        public WebhookSubscription setId(String value) { this.id = value; return this; }
        public String getName() { return name; }
        public WebhookSubscription setName(String value) { this.name = value; return this; }
        public String getEvent() { return event; }
        public WebhookSubscription setEvent(String value) { this.event = value; return this; }
        public Boolean getIsActive() { return isActive; }
        public WebhookSubscription setIsActive(Boolean value) { this.isActive = value; return this; }
        public Date getCreatedDateUtc() { return createdDateUtc; }
        public WebhookSubscription setCreatedDateUtc(Date value) { this.createdDateUtc = value; return this; }
        public String getCreatedById() { return createdById; }
        public WebhookSubscription setCreatedById(String value) { this.createdById = value; return this; }
        public Date getLastModifiedDateUtc() { return lastModifiedDateUtc; }
        public WebhookSubscription setLastModifiedDateUtc(Date value) { this.lastModifiedDateUtc = value; return this; }
        public SubscriptionConfig getConfig() { return config; }
        public WebhookSubscription setConfig(SubscriptionConfig value) { this.config = value; return this; }
    }

    public static class SubscriptionConfig
    {
        public String url = null;
        public String contentType = null;
        public String secret = null;
        
        public String getUrl() { return url; }
        public SubscriptionConfig setUrl(String value) { this.url = value; return this; }
        public String getContentType() { return contentType; }
        public SubscriptionConfig setContentType(String value) { this.contentType = value; return this; }
        public String getSecret() { return secret; }
        public SubscriptionConfig setSecret(String value) { this.secret = value; return this; }
    }

}

Java BatchDeleteWebhookSubscriptions 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 /sync/webhooks/subscriptions/delete HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BatchDeleteWebhookSubscriptions 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>
</BatchDeleteWebhookSubscriptions>
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>