| 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 |
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 UpdateSubscription
: 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; }
///<summary>
///The URL we should post the event data to
///</summary>
[ApiMember(Description="The URL we should post the event data to", IsRequired=true)]
public virtual string SubscriptionUrl { 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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
Content-Type: text/csv
Content-Length: length
{"EventType":0,"SubscriptionUrl":"String","ApiKey":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Description":"String","Heading":"String","WasSuccessful":false}