1Fetch Client API

SubscriptionEvents

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

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

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

    [<AllowNullLiteral>]
    type SubscriptionEventsDescription() = 
        member val EventType:WebhookSubscriptionEventType = new WebhookSubscriptionEventType() with get,set
        member val EventName:String = null with get,set
        member val EventDescription:String = null with get,set

    [<AllowNullLiteral>]
    type SubscriptionEventsResponse() = 
        inherit ApiServiceResponse()
        member val SubscriptionEventsDescriptions:ResizeArray<SubscriptionEventsDescription> = new ResizeArray<SubscriptionEventsDescription>() 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

    [<AllowNullLiteral>]
    type SubscriptionEvents() = 
        inherit ApiServiceRequest()

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