Report Filing Service

<back to all web services

ListWebhookSubscriptions

ListSubscriptionsWebhooksSync

Represents a request to retrieve all specified subscriptions.

Requires Authentication
The following routes are available for this service:
POST/sync/webhooks/subscriptions/list
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 retrieve all specified subscriptions.
    */
    @Api(Description="Represents a request to retrieve all specified subscriptions.")
    public static class ListWebhookSubscriptions extends ListWebhookSubscriptionsBase
    {
        
    }

    /**
    * Specifies a request to retrieve all specified subscriptions.
    */
    @Api(Description="Specifies a request to retrieve all specified subscriptions.")
    public static class ListWebhookSubscriptionsBase implements IPost
    {
        /**
        * The unique identifiers of the subscriptions.
        */
        @ApiMember(Description="The unique identifiers of the subscriptions.", IsRequired=true, Name="Ids")
        public ArrayList<String> ids = null;
        
        public ArrayList<String> getIds() { return ids; }
        public ListWebhookSubscriptionsBase setIds(ArrayList<String> value) { this.ids = value; return this; }
    }

}

Java ListWebhookSubscriptions DTOs

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

HTTP + CSV

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.pwc.de 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ids":["String"]}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}]