Report Filing Service

GetWebhookSubscriptionAsync

GetSubscriptionsWebhooksAsync

Represents a request to retrieve a webhook subscription by its unique identifier, and retrieve its details in an asynchronous operation.

The following routes are available for this service:
GET	/async/webhooks/subscriptions/{Id}

namespace PwC.Elmaas.Core.Services.Contracts.Webhooks.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SubscriptionConfig() = 
        member val Url:String = null with get,set
        member val ContentType:String = null with get,set
        member val Secret:String = null with get,set

    [<AllowNullLiteral>]
    type WebhookSubscription() = 
        member val Id:String = null with get,set
        member val Name:String = null with get,set
        member val Event:String = null with get,set
        member val IsActive:Boolean = new Boolean() with get,set
        member val CreatedDateUtc:DateTime = new DateTime() with get,set
        member val CreatedById:String = null with get,set
        member val LastModifiedDateUtc:DateTime = new DateTime() with get,set
        member val Config:SubscriptionConfig = null with get,set

    [<AllowNullLiteral>]
    type SubscriptionDeliveryResult() = 
        member val AttemptedDateUtc:DateTime = new DateTime() with get,set
        member val StatusDescription:String = null with get,set
        member val StatusCode:HttpStatusCode = new HttpStatusCode() with get,set
        member val SubscriptionId:String = null with get,set
        member val Id:String = null with get,set
        member val EventId:String = null with get,set

    ///<summary>
    ///Represents a service response that encapsulates a webhook subscription.
    ///</summary>
    [<Api(Description="Represents a service response that encapsulates a webhook subscription.")>]
    [<AllowNullLiteral>]
    type SubscriptionResponse() = 
        ///<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")>]
        member val Subscription:WebhookSubscription = null with get,set

        ///<summary>
        ///The history of the subscription event.
        ///</summary>
        [<ApiMember(Description="The history of the subscription event.", Name="History")>]
        member val History:ResizeArray<SubscriptionDeliveryResult> = new ResizeArray<SubscriptionDeliveryResult>() with get,set

        ///<summary>
        ///The status of the response.
        ///</summary>
        [<ApiMember(Description="The status of the response.", Name="ResponseStatus")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<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.")>]
    [<AllowNullLiteral>]
    type GetWebhookSubscriptionBase() = 
        interface IGet
        ///<summary>
        ///The unique identifier of the subscriber.
        ///</summary>
        [<ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="Id")>]
        member val Id:String = null with get,set

    ///<summary>
    ///Represents a request to retrieve a webhook subscription by its unique identifier, and retrieve its details in an asynchronous operation.
    ///</summary>
    [<Api(Description="Represents a request to retrieve a webhook subscription by its unique identifier, and retrieve its details in an asynchronous operation.")>]
    [<AllowNullLiteral>]
    type GetWebhookSubscriptionAsync() = 
        inherit GetWebhookSubscriptionBase()

F# GetWebhookSubscriptionAsync DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /async/webhooks/subscriptions/{Id} HTTP/1.1 
Host: reportfiling.pwc.de 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	subscription: 
	{
		id: String,
		name: String,
		event: String,
		isActive: False,
		createdDateUtc: 0001-01-01,
		createdById: String,
		lastModifiedDateUtc: 0001-01-01,
		config: 
		{
			url: String,
			contentType: String,
			secret: String
		}
	},
	history: 
	[
		{
			attemptedDateUtc: 0001-01-01,
			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
		}
	}
}