1Fetch Client API

SubscriptionList

The following routes are available for this service:
GET	/subscription	Get a list of subscription events that you are subscribed to

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


open class SubscriptionList : 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 SubscriptionListResponse : ApiServiceResponse()
{
    var Subscriptions:ArrayList<SubscriptionDetail> = ArrayList<SubscriptionDetail>()
}

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 SubscriptionDetail
{
    var EventType:WebhookSubscriptionEventType? = null
    var EventName:String? = null
    var SubscriptionUrl: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 SubscriptionList DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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

GET /subscription HTTP/1.1 
Host: api.1fetch.co.za 
Accept: application/xml

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

<SubscriptionListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</Heading>
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">false</WasSuccessful>
  <Subscriptions>
    <SubscriptionDetail>
      <EventName>String</EventName>
      <EventType>DriverOnTheWay</EventType>
      <SubscriptionUrl>String</SubscriptionUrl>
    </SubscriptionDetail>
  </Subscriptions>
</SubscriptionListResponse>