<back to all web services

DeleteWebhookSubscriptionAsync

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

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Represents a request to delete a webhook subscription in an asynchronous operation.
    */
    @Api(Description="Represents a request to delete a webhook subscription in an asynchronous operation.")
    public static class DeleteWebhookSubscriptionAsync extends DeleteWebhookSubscriptionBase
    {
        
    }

    /**
    * Specifies a request to delete a webhook subscription.
    */
    @Api(Description="Specifies a request to delete a webhook subscription.")
    public static class DeleteWebhookSubscriptionBase implements IPost
    {
        /**
        * The unique identifier of the subscriber.
        */
        @ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="Id")
        public String id = null;

        /**
        * The secret of the to-be-deleted webhook subscription. This secret is used to authenticate the owner of the webhook subscription.
        */
        @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")
        public String secret = null;
        
        public String getId() { return id; }
        public DeleteWebhookSubscriptionBase setId(String value) { this.id = value; return this; }
        public String getSecret() { return secret; }
        public DeleteWebhookSubscriptionBase setSecret(String value) { this.secret = value; return this; }
    }

    /**
    * Represents a service response that encapsulates a webhook subscription.
    */
    @Api(Description="Represents a service response that encapsulates a webhook subscription.")
    public static class SubscriptionResponse
    {
        /**
        * 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.
        */
        @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")
        public WebhookSubscription subscription = null;

        /**
        * The history of the subscription event.
        */
        @ApiMember(Description="The history of the subscription event.", Name="History")
        public ArrayList<SubscriptionDeliveryResult> history = null;

        /**
        * The status of the response.
        */
        @ApiMember(Description="The status of the response.", Name="ResponseStatus")
        public ResponseStatus responseStatus = null;
        
        public WebhookSubscription getSubscription() { return subscription; }
        public SubscriptionResponse setSubscription(WebhookSubscription value) { this.subscription = value; return this; }
        public ArrayList<SubscriptionDeliveryResult> getHistory() { return history; }
        public SubscriptionResponse setHistory(ArrayList<SubscriptionDeliveryResult> value) { this.history = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public SubscriptionResponse setResponseStatus(ResponseStatus value) { this.responseStatus = 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; }
    }

    public static class SubscriptionDeliveryResult
    {
        public Date attemptedDateUtc = null;
        public String statusDescription = null;
        public HttpStatusCode statusCode = null;
        public String subscriptionId = null;
        public String id = null;
        public String eventId = null;
        
        public Date getAttemptedDateUtc() { return attemptedDateUtc; }
        public SubscriptionDeliveryResult setAttemptedDateUtc(Date value) { this.attemptedDateUtc = value; return this; }
        public String getStatusDescription() { return statusDescription; }
        public SubscriptionDeliveryResult setStatusDescription(String value) { this.statusDescription = value; return this; }
        public HttpStatusCode getStatusCode() { return statusCode; }
        public SubscriptionDeliveryResult setStatusCode(HttpStatusCode value) { this.statusCode = value; return this; }
        public String getSubscriptionId() { return subscriptionId; }
        public SubscriptionDeliveryResult setSubscriptionId(String value) { this.subscriptionId = value; return this; }
        public String getId() { return id; }
        public SubscriptionDeliveryResult setId(String value) { this.id = value; return this; }
        public String getEventId() { return eventId; }
        public SubscriptionDeliveryResult setEventId(String value) { this.eventId = value; return this; }
    }

}

Java DeleteWebhookSubscriptionAsync DTOs

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>