<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.

import Foundation
import ServiceStack

/**
* Represents a request to find and retrieve a webhook subscription by its user unique identifier and name of subscribed event in an asynchronous operation.
*/
// @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 class FindWebhookSubscriptionAsync : FindWebhookSubscriptionBase
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

/**
* Specifies a request to find and retrieve a webhook subscription by its user unique identifier and name of subscribed event.
*/
// @Api(Description="Specifies a request to find and retrieve a webhook subscription by its user unique identifier and name of subscribed event.")
public class FindWebhookSubscriptionBase : IGet, Codable
{
    /**
    * 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"
    */
    // @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 var authSteuernummer:String

    /**
    * The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
    */
    // @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 var accountId:String

    /**
    * The unique identifier of the subscriber.
    */
    // @ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="EventName")
    public var eventName:String

    required public init(){}
}

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

    /**
    * The history of the subscription event.
    */
    // @ApiMember(Description="The history of the subscription event.", Name="History")
    public var history:[SubscriptionDeliveryResult] = []

    /**
    * The status of the response.
    */
    // @ApiMember(Description="The status of the response.", Name="ResponseStatus")
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class WebhookSubscription : Codable
{
    public var id:String
    public var name:String
    public var event:String
    public var isActive:Bool
    public var createdDateUtc:Date
    public var createdById:String
    public var lastModifiedDateUtc:Date
    public var config:SubscriptionConfig

    required public init(){}
}

public class SubscriptionConfig : Codable
{
    public var url:String
    public var contentType:String
    public var secret:String

    required public init(){}
}

public class SubscriptionDeliveryResult : Codable
{
    public var attemptedDateUtc:Date
    public var statusDescription:String
    public var statusCode:HttpStatusCode
    public var subscriptionId:String
    public var id:String
    public var eventId:String

    required public init(){}
}

Swift FindWebhookSubscriptionAsync DTOs

GET /async/webhooks/subscriptions/find HTTP/1.1 
Host: reportfiling.staging.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>