1Fetch Client API

<back to all web services

SubscriptionList

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class SubscriptionList extends ApiServiceRequest
    {
        
    }

    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 class SubscriptionListResponse extends ApiServiceResponse
    {
        public ArrayList<SubscriptionDetail> Subscriptions = null;
        
        public ArrayList<SubscriptionDetail> getSubscriptions() { return Subscriptions; }
        public SubscriptionListResponse setSubscriptions(ArrayList<SubscriptionDetail> value) { this.Subscriptions = value; return this; }
    }

    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; }
    }

    public static class SubscriptionDetail
    {
        public WebhookSubscriptionEventType EventType = null;
        public String EventName = null;
        public String SubscriptionUrl = null;
        
        public WebhookSubscriptionEventType getEventType() { return EventType; }
        public SubscriptionDetail setEventType(WebhookSubscriptionEventType value) { this.EventType = value; return this; }
        public String getEventName() { return EventName; }
        public SubscriptionDetail setEventName(String value) { this.EventName = value; return this; }
        public String getSubscriptionUrl() { return SubscriptionUrl; }
        public SubscriptionDetail setSubscriptionUrl(String value) { this.SubscriptionUrl = 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; }
    }

}

Java SubscriptionList DTOs

GET /subscription HTTP/1.1 
Host: api.1fetch.co.za 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Subscriptions: 
	[
		{
			EventType: 0,
			EventName: String,
			SubscriptionUrl: String
		}
	],
	Description: String,
	Heading: String,
	WasSuccessful: False
}