| 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 |
import Foundation
import ServiceStack
public class UpdateSubscription : 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 : String, Codable
{
case MessageReceived = 1
}
public class ApiServiceResponse : IServiceResponse, Codable
{
public var Description:String
public var heading:String
public var wasSuccessful:Bool
//modelState:Object ignored. Type could not be extended in Swift
required public init(){}
}
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.
PUT /subscription/{EventType} HTTP/1.1
Host: galaxymobile.api.client.prod.86degrees.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Subscription">
<ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</ApiKey>
<EventType>MessageReceived</EventType>
<SubscriptionUrl>String</SubscriptionUrl>
</UpdateSubscription>
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/CommonService.Api.Models.Base"> <Description>String</Description> <Heading>String</Heading> <ModelState /> <WasSuccessful>false</WasSuccessful> </ApiServiceResponse>