| 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.Subscription;
using WebService.ClientServiceModel.Base;
using BusinessLogic.Entities;
using CommonService.Api.Models.Base;
namespace BusinessLogic.Entities
{
public enum WebhookSubscriptionEventType
{
MessageReceived = 1,
}
}
namespace CommonService.Api.Models.Base
{
public partial class ApiServiceResponse
: IServiceResponse
{
public virtual string Description { get; set; }
public virtual string Heading { get; set; }
public virtual bool WasSuccessful { get; set; }
public virtual Object ModelState { 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; }
}
}
namespace WebService.ClientServiceModel.Subscription
{
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; }
}
}
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
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: galaxymobile.api.client.prod.86degrees.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"EventType":1,"SubscriptionUrl":"String","ApiKey":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}