| GET | /subscription/events | Get a list of subscription event types |
|---|
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 CommonService.Api.Models.Base;
using BusinessLogic.Entities;
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 SubscriptionEvents
: ApiServiceRequest
{
}
public partial class SubscriptionEventsDescription
{
public virtual WebhookSubscriptionEventType EventType { get; set; }
public virtual string EventName { get; set; }
public virtual string EventDescription { get; set; }
}
public partial class SubscriptionEventsResponse
: ApiServiceResponse
{
public SubscriptionEventsResponse()
{
SubscriptionEventsDescriptions = new List<SubscriptionEventsDescription>{};
}
public virtual List<SubscriptionEventsDescription> SubscriptionEventsDescriptions { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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: galaxymobile.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.Subscription">
<Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
<Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
<ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
<WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
<SubscriptionEventsDescriptions>
<SubscriptionEventsDescription>
<EventDescription>String</EventDescription>
<EventName>String</EventName>
<EventType>MessageReceived</EventType>
</SubscriptionEventsDescription>
</SubscriptionEventsDescriptions>
</SubscriptionEventsResponse>