1Fetch Client API

SubscriptionEvents

The following routes are available for this service:
GET	/subscription/events	Get a list of subscription event types

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ClientServiceModel;
using WebService.ClientServiceModel.Base;
using BusinessLogic.Entities;

namespace BusinessLogic.Entities
{
    public enum WebhookSubscriptionEventType
    {
        DriverOnTheWay = 0,
        ArrivedAtWaypoint = 1,
        DepartedWaypoint = 2,
        OrderCompleted = 3,
        OrderCancelled = 4,
    }

}

namespace WebService.ClientServiceModel
{
    public partial class SubscriptionEvents
        : ApiServiceRequest
    {
    }

    public partial class SubscriptionEventsDescription
    {
        public virtual WebhookSubscriptionEventType EventType { get; set; }
        public virtual string EventName { get; set; }
        public virtual string EventDescription { get; set; }
    }

    public partial class SubscriptionEventsResponse
        : ApiServiceResponse
    {
        public SubscriptionEventsResponse()
        {
            SubscriptionEventsDescriptions = new List<SubscriptionEventsDescription>{};
        }

        public virtual List<SubscriptionEventsDescription> SubscriptionEventsDescriptions { get; set; }
    }

}

namespace WebService.ClientServiceModel.Base
{
    public partial class ApiServiceRequest
        : IServiceRequest, IHasApiKey
    {
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
        public virtual string ApiKey { get; set; }
    }

    public partial class ApiServiceResponse
        : IServiceResponse
    {
        ///<summary>
        ///Information about the response.
        ///</summary>
        [ApiMember(Description="Information about the response.", IsRequired=true)]
        public virtual string Description { get; set; }

        ///<summary>
        ///Heading or summary of the response.
        ///</summary>
        [ApiMember(Description="Heading or summary of the response.", IsRequired=true)]
        public virtual string Heading { get; set; }

        ///<summary>
        ///Did the intended operation for this response complete successfully?
        ///</summary>
        [ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)]
        public virtual bool WasSuccessful { get; set; }
    }

}

C# SubscriptionEvents 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/events HTTP/1.1 
Host: api.1fetch.co.za 
Accept: application/xml

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

<SubscriptionEventsResponse 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>
  <SubscriptionEventsDescriptions>
    <SubscriptionEventsDescription>
      <EventDescription>String</EventDescription>
      <EventName>String</EventName>
      <EventType>DriverOnTheWay</EventType>
    </SubscriptionEventsDescription>
  </SubscriptionEventsDescriptions>
</SubscriptionEventsResponse>