1Fetch Client API

TestSubscription

The following routes are available for this service:
GET,POST	/subscription/test	Fire a test to one of your webhooks
GET,POST	/subscription/test/{EventType}	Fire a test to one of your webhooks

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 TestSubscription
        : ApiServiceRequest, ILogRequest
    {
        ///<summary>
        ///The event type being subscribed to
        ///</summary>
        [ApiMember(Description="The event type being subscribed to", IsRequired=true)]
        public virtual WebhookSubscriptionEventType EventType { 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# TestSubscription DTOs

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

HTTP + OTHER

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

POST /subscription/test HTTP/1.1 
Host: api.1fetch.co.za 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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

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

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