Report Filing Service

ListWebhookSubscriptions

ListSubscriptionsWebhooksSync

Represents a request to retrieve all specified subscriptions.

The following routes are available for this service:
POST	/sync/webhooks/subscriptions/list

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 retrieve all specified subscriptions.
        '''</Summary>
        <Api(Description:="Represents a request to retrieve all specified subscriptions.")>
        Public Partial Class ListWebhookSubscriptions
            Inherits ListWebhookSubscriptionsBase
        End Class

        '''<Summary>
        '''Specifies a request to retrieve all specified subscriptions.
        '''</Summary>
        <Api(Description:="Specifies a request to retrieve all specified subscriptions.")>
        Public Partial Class ListWebhookSubscriptionsBase
            Implements IPost
            Public Sub New()
                Ids = New List(Of String)
            End Sub

            '''<Summary>
            '''The unique identifiers of the subscriptions.
            '''</Summary>
            <ApiMember(Description:="The unique identifiers of the subscriptions.", IsRequired:=true, Name:="Ids")>
            Public Overridable Property Ids As List(Of String)
        End Class
    End Namespace
End Namespace

VB.NET ListWebhookSubscriptions 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.

POST /sync/webhooks/subscriptions/list HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ids: 
	[
		String
	]
}

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
			}
		}
	}
]