Report Filing Service

<back to all web services

SearchWebhookSubscriptions

SearchSubscriptionsWebhooksSync

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

Requires Authentication
The following routes are available for this service:
GET/sync/webhooks/subscriptions/search
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 get the subscriptions for a specific event.
    */
    @Api(Description="Represents a request to get the subscriptions for a specific event.")
    public static class SearchWebhookSubscriptions extends SearchWebhookSubscriptionsBase
    {
        
    }

    /**
    * Specifies a request to get the subscriptions for a specific event.
    */
    @Api(Description="Specifies a request to get the subscriptions for a specific event.")
    public static class SearchWebhookSubscriptionsBase implements IGet
    {
        /**
        * 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 String eventName = null;
        
        public String getEventName() { return eventName; }
        public SearchWebhookSubscriptionsBase setEventName(String value) { this.eventName = value; return this; }
    }

}

Java SearchWebhookSubscriptions DTOs

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

HTTP + X-MSGPACK

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: application/x-msgpack
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
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"}}}]