Report Filing Service

<back to all web services

SearchWebhookSubscriptions

SearchSubscriptionsWebhooksSync

Represents a request to get the subscriptions for a specific event.

Requires Authentication
The following routes are available for this service:
GET/sync/webhooks/subscriptions/search
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports PwC.Elmaas.Core.Services.Contracts.Webhooks.Requests

Namespace Global

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

        '''<Summary>
        '''Represents a request to get the subscriptions for a specific event.
        '''</Summary>
        <Api(Description:="Represents a request to get the subscriptions for a specific event.")>
        Public Partial Class SearchWebhookSubscriptions
            Inherits SearchWebhookSubscriptionsBase
        End Class

        '''<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.")>
        Public Partial Class SearchWebhookSubscriptionsBase
            Implements 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")>
            Public Overridable Property EventName As String
        End Class
    End Namespace
End Namespace

VB.NET SearchWebhookSubscriptions DTOs

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

HTTP + X-MSGPACK

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

GET /sync/webhooks/subscriptions/search HTTP/1.1 
Host: reportfiling.pwc.de 
Accept: application/x-msgpack
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
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"}}}]