<back to all web services

FindWebhookSubscriptionAsync

Represents a request to find and retrieve a webhook subscription by its user unique identifier and name of subscribed event in an asynchronous operation.

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using PwC.Elmaas.Core.Services.Contracts.Webhooks.Requests;
using PwC.Elmaas.Core.Services.Contracts.Webhooks.Responses;
using ServiceStack.Webhooks.ServiceModel.Types;

namespace PwC.Elmaas.Core.Services.Contracts.Webhooks.Requests
{
    ///<summary>
    ///Represents a request to find and retrieve a webhook subscription by its user unique identifier and name of subscribed event in an asynchronous operation.
    ///</summary>
    [Api(Description="Represents a request to find and retrieve a webhook subscription by its user unique identifier and name of subscribed event in an asynchronous operation.")]
    public partial class FindWebhookSubscriptionAsync
        : FindWebhookSubscriptionBase
    {
    }

    ///<summary>
    ///Specifies a request to find and retrieve a webhook subscription by its user unique identifier and name of subscribed event.
    ///</summary>
    [Api(Description="Specifies a request to find and retrieve a webhook subscription by its user unique identifier and name of subscribed event.")]
    public partial class FindWebhookSubscriptionBase
        : IGet
    {
        ///<summary>
        ///The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information"
        ///</summary>
        [ApiMember(Description="The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under \"My BOP\" under the \"Registration Information\"", IsRequired=true, Name="AuthSteuernummer")]
        public virtual string AuthSteuernummer { get; set; }

        ///<summary>
        ///The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
        ///</summary>
        [ApiMember(Description="The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).", IsRequired=true, Name="AccountId")]
        public virtual string AccountId { get; set; }

        ///<summary>
        ///The unique identifier of the subscriber.
        ///</summary>
        [ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="EventName")]
        public virtual string EventName { get; set; }
    }

}

namespace PwC.Elmaas.Core.Services.Contracts.Webhooks.Responses
{
    ///<summary>
    ///Represents a service response that encapsulates a webhook subscription.
    ///</summary>
    [Api(Description="Represents a service response that encapsulates a webhook subscription.")]
    public partial class SubscriptionResponse
    {
        public SubscriptionResponse()
        {
            History = new List<SubscriptionDeliveryResult>{};
        }

        ///<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")]
        public virtual WebhookSubscription Subscription { get; set; }

        ///<summary>
        ///The history of the subscription event.
        ///</summary>
        [ApiMember(Description="The history of the subscription event.", Name="History")]
        public virtual List<SubscriptionDeliveryResult> History { get; set; }

        ///<summary>
        ///The status of the response.
        ///</summary>
        [ApiMember(Description="The status of the response.", Name="ResponseStatus")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace ServiceStack.Webhooks.ServiceModel.Types
{
    public partial class SubscriptionConfig
    {
        public virtual string Url { get; set; }
        public virtual string ContentType { get; set; }
        public virtual string Secret { get; set; }
    }

    public partial class SubscriptionDeliveryResult
    {
        public virtual DateTime AttemptedDateUtc { get; set; }
        public virtual string StatusDescription { get; set; }
        public virtual HttpStatusCode StatusCode { get; set; }
        public virtual string SubscriptionId { get; set; }
        public virtual string Id { get; set; }
        public virtual string EventId { get; set; }
    }

    public partial class WebhookSubscription
    {
        public virtual string Id { get; set; }
        public virtual string Name { get; set; }
        public virtual string Event { get; set; }
        public virtual bool IsActive { get; set; }
        public virtual DateTime CreatedDateUtc { get; set; }
        public virtual string CreatedById { get; set; }
        public virtual DateTime LastModifiedDateUtc { get; set; }
        public virtual SubscriptionConfig Config { get; set; }
    }

}

C# FindWebhookSubscriptionAsync DTOs

GET /async/webhooks/subscriptions/find HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}