| DELETE | /subscription/{EventType} | Unsubscribe from an event notification | |
|---|---|---|---|
| DELETE | /subscription | Unsubscribe from an event notification |
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class DeleteSubscription extends ApiServiceRequest implements ILogRequest
{
/**
* The event type being removed
*/
@ApiMember(Description="The event type being removed", IsRequired=true)
public WebhookSubscriptionEventType EventType = null;
public WebhookSubscriptionEventType getEventType() { return EventType; }
public DeleteSubscription setEventType(WebhookSubscriptionEventType value) { this.EventType = value; return this; }
}
public static class ApiServiceRequest implements IServiceRequest, IHasApiKey
{
/**
* The API Key required for authentication
*/
@ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public String ApiKey = null;
public String getApiKey() { return ApiKey; }
public ApiServiceRequest setApiKey(String value) { this.ApiKey = value; return this; }
}
public static enum WebhookSubscriptionEventType
{
@SerializedName("0") DriverOnTheWay(0),
@SerializedName("1") ArrivedAtWaypoint(1),
@SerializedName("2") DepartedWaypoint(2),
@SerializedName("3") OrderCompleted(3),
@SerializedName("4") OrderCancelled(4);
private final int value;
WebhookSubscriptionEventType(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
public static class ApiServiceResponse implements IServiceResponse
{
/**
* Information about the response.
*/
@ApiMember(Description="Information about the response.", IsRequired=true)
public String Description = null;
/**
* Heading or summary of the response.
*/
@ApiMember(Description="Heading or summary of the response.", IsRequired=true)
public String Heading = null;
/**
* Did the intended operation for this response complete successfully?
*/
@ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
public Boolean WasSuccessful = null;
public String getDescription() { return Description; }
public ApiServiceResponse setDescription(String value) { this.Description = value; return this; }
public String getHeading() { return Heading; }
public ApiServiceResponse setHeading(String value) { this.Heading = value; return this; }
public Boolean isWasSuccessful() { return WasSuccessful; }
public ApiServiceResponse setWasSuccessful(Boolean value) { this.WasSuccessful = value; return this; }
}
}
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.
DELETE /subscription/{EventType} HTTP/1.1
Host: api.1fetch.co.za
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Description":"String","Heading":"String","WasSuccessful":false}