Report Filing Service

<back to all web services

BatchGetWebhookSubscriptionsAsync

GetBatchSubscriptionsWebhooksAsync

Represents a request to lists all subscriptions of an ELMA user that is specified by the provided user details in an asynchronous operation.

Requires Authentication
The following routes are available for this service:
GET/async/webhooks/subscriptions

/** @description Specifies a request to lists all subscriptions of an ELMA user that is specified by the provided user details. */
// @Api(Description="Specifies a request to lists all subscriptions of an ELMA user that is specified by the provided user details.")
export class BatchGetWebhookSubscriptionsBase implements IGet
{
    /** @description The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information" */
    // @ApiMember(Description="The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under \"My BOP\" under the \"Registration Information\"", IsRequired=true, Name="AuthSteuernummer")
    public authSteuernummer: string;

    /** @description The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9). */
    // @ApiMember(Description="The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).", IsRequired=true, Name="AccountId")
    public accountId: string;

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

/** @description Represents a request to lists all subscriptions of an ELMA user that is specified by the provided user details in an asynchronous operation. */
// @Api(Description="Represents a request to lists all subscriptions of an ELMA user that is specified by the provided user details in an asynchronous operation.")
export class BatchGetWebhookSubscriptionsAsync extends BatchGetWebhookSubscriptionsBase
{

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

TypeScript BatchGetWebhookSubscriptionsAsync DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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