1Fetch Client API

UpdateSubscription

The following routes are available for this service:
PUT	/subscription/{EventType}	Update your subscription to an event with a url we should post to
PUT	/subscription	Update your subscription to an event with a url we should post to

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


open class UpdateSubscription : ApiServiceRequest(), ILogRequest
{
    /**
    * The event type being subscribed to
    */
    @ApiMember(Description="The event type being subscribed to", IsRequired=true)
    var EventType:WebhookSubscriptionEventType? = null

    /**
    * The URL we should post the event data to
    */
    @ApiMember(Description="The URL we should post the event data to", IsRequired=true)
    var SubscriptionUrl:String? = null
}

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
}

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),
}

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
}

Kotlin UpdateSubscription 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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /subscription/{EventType} HTTP/1.1 
Host: api.1fetch.co.za 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"EventType":0,"SubscriptionUrl":"String","ApiKey":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Description":"String","Heading":"String","WasSuccessful":false}