POST | /sync/webhooks/subscriptions/list |
---|
/** @description Specifies a request to retrieve all specified subscriptions. */
// @Api(Description="Specifies a request to retrieve all specified subscriptions.")
export class ListWebhookSubscriptionsBase implements IPost
{
/** @description The unique identifiers of the subscriptions. */
// @ApiMember(Description="The unique identifiers of the subscriptions.", IsRequired=true, Name="Ids")
public ids: string[];
public constructor(init?: Partial<ListWebhookSubscriptionsBase>) { (Object as any).assign(this, init); }
}
/** @description Represents a request to retrieve all specified subscriptions. */
// @Api(Description="Represents a request to retrieve all specified subscriptions.")
export class ListWebhookSubscriptions extends ListWebhookSubscriptionsBase
{
public constructor(init?: Partial<ListWebhookSubscriptions>) { super(init); (Object as any).assign(this, init); }
}
TypeScript ListWebhookSubscriptions 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
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.staging.pwc.de
Accept: application/json
Content-Type: application/json
Content-Length: length
{"ids":["String"]}
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"}}}]