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 Foundation
import ServiceStack

/**
* 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 class SearchWebhookSubscriptions : SearchWebhookSubscriptionsBase
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

/**
* 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 class SearchWebhookSubscriptionsBase : IGet, Codable
{
    /**
    * 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 var eventName:String

    required public init(){}
}


Swift SearchWebhookSubscriptions 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.

GET /sync/webhooks/subscriptions/search HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: text/csv
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"}}}]