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

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 retrieve all specified subscriptions.
    ///</summary>
    [<Api(Description="Specifies a request to retrieve all specified subscriptions.")>]
    [<AllowNullLiteral>]
    type ListWebhookSubscriptionsBase() = 
        interface IPost
        ///<summary>
        ///The unique identifiers of the subscriptions.
        ///</summary>
        [<ApiMember(Description="The unique identifiers of the subscriptions.", IsRequired=true, Name="Ids")>]
        member val Ids:ResizeArray<String> = new ResizeArray<String>() with get,set

    ///<summary>
    ///Represents a request to retrieve all specified subscriptions.
    ///</summary>
    [<Api(Description="Represents a request to retrieve all specified subscriptions.")>]
    [<AllowNullLiteral>]
    type ListWebhookSubscriptions() = 
        inherit ListWebhookSubscriptionsBase()

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