<back to all web services

GetWebhookSubscription

Represents a request to retrieve a webhook subscription by its unique identifier, and retrieve its details.

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 retrieve a webhook subscription by its unique identifier, and retrieve its details.
    ///</summary>
    [Api(Description="Represents a request to retrieve a webhook subscription by its unique identifier, and retrieve its details.")]
    public partial class GetWebhookSubscription
        : GetWebhookSubscriptionBase
    {
    }

    ///<summary>
    ///Specifies a request to retrieve a webhook subscription by its unique identifier, and retrieve its details.
    ///</summary>
    [Api(Description="Specifies a request to retrieve a webhook subscription by its unique identifier, and retrieve its details.")]
    public partial class GetWebhookSubscriptionBase
        : IGet
    {
        ///<summary>
        ///The unique identifier of the subscriber.
        ///</summary>
        [ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="Id")]
        public virtual string Id { 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# GetWebhookSubscription DTOs

GET /sync/webhooks/subscriptions/{Id} HTTP/1.1 
Host: reportfiling.pwc.de 
Accept: application/xml

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>