1Fetch Client API

AddSubscription

The following routes are available for this service:
POST	/subscription/{EventType}	Subscribe to an event with a url we should post to
POST	/subscription	Subscribe to an event with a url we should post to

import Foundation
import ServiceStack

public class AddSubscription : ApiServiceRequest, ILogRequest
{
    /**
    * The event type being subscribed to
    */
    // @ApiMember(Description="The event type being subscribed to", IsRequired=true)
    public var eventType:WebhookSubscriptionEventType

    /**
    * The URL we should post the event data to
    */
    // @ApiMember(Description="The URL we should post the event data to", IsRequired=true)
    public var subscriptionUrl:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case eventType
        case subscriptionUrl
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        eventType = try container.decodeIfPresent(WebhookSubscriptionEventType.self, forKey: .eventType)
        subscriptionUrl = try container.decodeIfPresent(String.self, forKey: .subscriptionUrl)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if eventType != nil { try container.encode(eventType, forKey: .eventType) }
        if subscriptionUrl != nil { try container.encode(subscriptionUrl, forKey: .subscriptionUrl) }
    }
}

public class ApiServiceRequest : IServiceRequest, IHasApiKey, Codable
{
    /**
    * The API Key required for authentication
    */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public var apiKey:String

    required public init(){}
}

public enum WebhookSubscriptionEventType : Int, Codable
{
    case DriverOnTheWay = 0
    case ArrivedAtWaypoint = 1
    case DepartedWaypoint = 2
    case OrderCompleted = 3
    case OrderCancelled = 4
}

public class ApiServiceResponse : IServiceResponse, Codable
{
    /**
    * Information about the response.
    */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    public var Description:String

    /**
    * Heading or summary of the response.
    */
    // @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    public var heading:String

    /**
    * Did the intended operation for this response complete successfully?
    */
    // @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    public var wasSuccessful:Bool

    required public init(){}
}

Swift AddSubscription 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.

POST /subscription/{EventType} HTTP/1.1 
Host: 1fetch.api.client.prod.86degrees.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</ApiKey>
  <EventType>DriverOnTheWay</EventType>
  <SubscriptionUrl>String</SubscriptionUrl>
</AddSubscription>

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

<ApiServiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">
  <Description>String</Description>
  <Heading>String</Heading>
  <WasSuccessful>false</WasSuccessful>
</ApiServiceResponse>