Report Filing Service

SearchWebhookSubscriptions

SearchSubscriptionsWebhooksSync

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

The following routes are available for this service:
GET	/sync/webhooks/subscriptions/search


/** @description Specifies a request to get the subscriptions for a specific event. */
// @Api(Description="Specifies a request to get the subscriptions for a specific event.")
export class SearchWebhookSubscriptionsBase implements IGet
{
    /** @description The names of the subscribed events. .A subscriber can subscribe to more than one event. */
    // @ApiMember(Description="The names of the subscribed events. .A subscriber can subscribe to more than one event.", IsRequired=true, Name="EventName")
    public eventName: string;

    public constructor(init?: Partial<SearchWebhookSubscriptionsBase>) { (Object as any).assign(this, init); }
}

/** @description Represents a request to get the subscriptions for a specific event. */
// @Api(Description="Represents a request to get the subscriptions for a specific event.")
export class SearchWebhookSubscriptions extends SearchWebhookSubscriptionsBase
{

    public constructor(init?: Partial<SearchWebhookSubscriptions>) { super(init); (Object as any).assign(this, init); }
}

TypeScript SearchWebhookSubscriptions 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 /sync/webhooks/subscriptions/search 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
			}
		}
	}
]