| GET | /subscription/events | Get a list of subscription event types |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class SubscriptionEvents : ApiServiceRequest()
{
}
open class ApiServiceRequest : IServiceRequest, IHasApiKey
{
/**
* The API Key required for authentication
*/
@ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
var ApiKey:String? = null
}
open class SubscriptionEventsResponse : ApiServiceResponse()
{
var SubscriptionEventsDescriptions:ArrayList<SubscriptionEventsDescription> = ArrayList<SubscriptionEventsDescription>()
}
open class ApiServiceResponse : IServiceResponse
{
/**
* Information about the response.
*/
@ApiMember(Description="Information about the response.", IsRequired=true)
var Description:String? = null
/**
* Heading or summary of the response.
*/
@ApiMember(Description="Heading or summary of the response.", IsRequired=true)
var Heading:String? = 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)
var WasSuccessful:Boolean? = null
}
open class SubscriptionEventsDescription
{
var EventType:WebhookSubscriptionEventType? = null
var EventName:String? = null
var EventDescription:String? = null
}
enum class WebhookSubscriptionEventType(val value:Int)
{
@SerializedName("0") DriverOnTheWay(0),
@SerializedName("1") ArrivedAtWaypoint(1),
@SerializedName("2") DepartedWaypoint(2),
@SerializedName("3") OrderCompleted(3),
@SerializedName("4") OrderCancelled(4),
}
Kotlin SubscriptionEvents DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /subscription/events HTTP/1.1 Host: api.1fetch.co.za Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
SubscriptionEventsDescriptions:
[
{
EventType: 0,
EventName: String,
EventDescription: String
}
],
Description: String,
Heading: String,
WasSuccessful: False
}