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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    /**
    * 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.")
    public static class BatchGetWebhookSubscriptionsAsync extends BatchGetWebhookSubscriptionsBase
    {
        
    }

    /**
    * 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.")
    public static class BatchGetWebhookSubscriptionsBase implements IGet
    {
        /**
        * 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 String authSteuernummer = null;

        /**
        * 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 String accountId = null;
        
        public String getAuthSteuernummer() { return authSteuernummer; }
        public BatchGetWebhookSubscriptionsBase setAuthSteuernummer(String value) { this.authSteuernummer = value; return this; }
        public String getAccountId() { return accountId; }
        public BatchGetWebhookSubscriptionsBase setAccountId(String value) { this.accountId = value; return this; }
    }

}

Java BatchGetWebhookSubscriptionsAsync 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 /async/webhooks/subscriptions HTTP/1.1 
Host: reportfiling.staging.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
			}
		}
	}
]