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

namespace WebService.ClientServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiServiceResponse() = 
        ///<summary>
        ///Information about the response.
        ///</summary>
        [<ApiMember(Description="Information about the response.", IsRequired=true)>]
        member val Description:String = null with get,set

        ///<summary>
        ///Heading or summary of the response.
        ///</summary>
        [<ApiMember(Description="Heading or summary of the response.", IsRequired=true)>]
        member val Heading:String = null with 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)>]
        member val WasSuccessful:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ApiServiceRequest() = 
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
        member val ApiKey:String = null with get,set

    type WebhookSubscriptionEventType =
        | DriverOnTheWay = 0
        | ArrivedAtWaypoint = 1
        | DepartedWaypoint = 2
        | OrderCompleted = 3
        | OrderCancelled = 4

    [<AllowNullLiteral>]
    type UpdateSubscription() = 
        inherit ApiServiceRequest()
        ///<summary>
        ///The event type being subscribed to
        ///</summary>
        [<ApiMember(Description="The event type being subscribed to", IsRequired=true)>]
        member val EventType:WebhookSubscriptionEventType = new WebhookSubscriptionEventType() with get,set

        ///<summary>
        ///The URL we should post the event data to
        ///</summary>
        [<ApiMember(Description="The URL we should post the event data to", IsRequired=true)>]
        member val SubscriptionUrl:String = null with get,set

F# 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: 1fetch.api.client.prod.86degrees.com 
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}