Report Filing Service

<back to all web services

SearchWebhookSubscriptionsAsync

SearchSubscriptionsWebhooksAsync

Represents a request to get the subscriptions for a specific event in an asynchronous operation.

Requires Authentication
The following routes are available for this service:
GET/async/webhooks/subscriptions/search
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

    ///<summary>
    ///Specifies a request to get the subscriptions for a specific event.
    ///</summary>
    [<Api(Description="Specifies a request to get the subscriptions for a specific event.")>]
    [<AllowNullLiteral>]
    type SearchWebhookSubscriptionsBase() = 
        interface IGet
        ///<summary>
        ///The names of the subscribed events. .A subscriber can subscribe to more than one event.
        ///</summary>
        [<ApiMember(Description="The names of the subscribed events. .A subscriber can subscribe to more than one event.", IsRequired=true, Name="EventName")>]
        member val EventName:String = null with get,set

    ///<summary>
    ///Represents a request to get the subscriptions for a specific event in an asynchronous operation.
    ///</summary>
    [<Api(Description="Represents a request to get the subscriptions for a specific event in an asynchronous operation.")>]
    [<AllowNullLiteral>]
    type SearchWebhookSubscriptionsAsync() = 
        inherit SearchWebhookSubscriptionsBase()

F# SearchWebhookSubscriptionsAsync DTOs

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

HTTP + OTHER

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

GET /async/webhooks/subscriptions/search 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"}}}]